Class ReactionTrait

The ReactionTrait is used to allow submitting events to a message bus.

Hierarchy

Trait<ReactionTraitConfig>
- ReactionTrait

Constructors

constructor

new ReactionTrait(graphqlSchemaManager: GraphQLSchemaManager, generator: ReactionsEventGenerator, config: RuntimeConfig): ReactionTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- generator: ReactionsEventGenerator
- config: RuntimeConfig
Returns ReactionTrait
Overrides Trait.constructor
- Defined in src/traits/ReactionTrait.ts:112

Properties

`Protected` `Optional` _config

_config?: ReactionTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Optional` _type

_type?: "reaction"

Trait type.

`Protected` config

config: RuntimeConfig

controlTriggersEnabled

controlTriggersEnabled: boolean

`Private` generator

generator: ReactionsEventGenerator

`Private` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

logger

logger: Logger

`Static` reactionsEnabled

reactionsEnabled: boolean = true

`Static` reactionsMutationAdded

reactionsMutationAdded: boolean = false

Methods

`Private` _getHookByAction

_getHookByAction(schemaItem: SchemaItem<SchemaItemType>, hookName: string): AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions>
Private
Returns entity schema hook by its name.

Returns
AsyncHook
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  Entity schema.
- hookName: string
  
  Hook name.
Returns AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions>
- Defined in src/traits/ReactionTrait.ts:323

edgePostCreate

edgePostCreate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, something: unknown): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- something: unknown
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:264

edgePostDelete

edgePostDelete(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, something: unknown): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- something: unknown
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:299

edgePostUpdate

edgePostUpdate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, edge: unknown): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- edge: unknown
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:282

enableReactions

enableReactions(_parent: unknown, args: Record<string, any>): Promise<boolean>
Parameters
- _parent: unknown
- args: Record<string, any>
Returns Promise<boolean>
- Defined in src/traits/ReactionTrait.ts:152

`Protected` getHookName

getHookName(stage: EventStage, action: EventName): string
Helper method retuning hook name.

Returns
The hook name e.g. 'preCreate'
Parameters
- stage: EventStage
  
  Entity processing stage, e.g. 'pre'.
- action: EventName
  
  Entity action, e.g. 'create'.
Returns string
- Defined in src/traits/ReactionTrait.ts:356

getLabel

getLabel(): string
Returns string
- Defined in src/traits/ReactionTrait.ts:215

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<"vertex"> | SchemaItem<"edge">): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<"vertex"> | SchemaItem<"edge">
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/ReactionTrait.ts:168

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): ReactionTrait
Makes this Trait instance global.

Returns ReactionTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

mutationSchema

mutationSchema(schemaString: string): string
Parameters
- schemaString: string
Returns string
- Defined in src/traits/ReactionTrait.ts:137

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

setConfig

setConfig(config: ReactionTraitConfig): void
Configuration setter.
Parameters
- config: ReactionTraitConfig
  
  The new configuration.
Returns void
Inherited from Trait.setConfig
- Defined in src/traits/Trait.ts:124

traitConfig

traitConfig(): ReactionTraitConfig
Returns ReactionTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

vertexPostCreate

vertexPostCreate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, entity: ItemWithId): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- entity: ItemWithId
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:222

vertexPostDelete

vertexPostDelete(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, entity: ItemWithId): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- entity: ItemWithId
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:248

vertexPostUpdate

vertexPostUpdate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, entity: ItemWithId): Promise<void>
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- entity: ItemWithId
Returns Promise<void>
- Defined in src/traits/ReactionTrait.ts:235

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/ReactionTrait.ts:133

Class ReactionTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

generator: ReactionsEventGenerator

config: RuntimeConfig

Returns ReactionTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Protected config

controlTriggersEnabled

Private generator

Private graphqlSchemaManager

logger

Static reactionsEnabled

Static reactionsMutationAdded

Methods

Private _getHookByAction

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

hookName: string

edgePostCreate

Parameters

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

something: unknown

Returns Promise<void>

edgePostDelete

Parameters

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

something: unknown

Returns Promise<void>

edgePostUpdate

Parameters

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

edge: unknown

Returns Promise<void>

enableReactions

Parameters

_parent: unknown

args: Record<string, any>

Returns Promise<boolean>

Protected getHookName

Returns

Parameters

stage: EventStage

action: EventName

Returns string

getLabel

Returns string

hookIntoSchema

Parameters

schemaItem: SchemaItem<"vertex"> | SchemaItem<"edge">

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ReactionTrait

mutationSchema

Parameters

schemaString: string

Returns string

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Protected` config

`Private` generator

`Private` graphqlSchemaManager

`Static` reactionsEnabled

`Static` reactionsMutationAdded

`Private` _getHookByAction

`Protected` getHookName

`Optional` callbackName: string

`Static` traitTypeName