Class EventTrait

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

Example of adding this trait :

Usage:

traits:
  - type: event
    pre:
      create: myapp.myentity.create
      view: myapp.myentity.view
      update: myapp.myentity.update
      delete: myapp.myentity.delete
    post:
      create: myapp.myentity.created

Hierarchy

Trait<EventTraitConfig>
- EventTrait

Index

Constructors

constructor

new EventTrait(_eventQueue: EventQueue): EventTrait
EventTrait constructor.
Parameters
- _eventQueue: EventQueue
Returns EventTrait
Overrides Trait.constructor
- Defined in src/traits/EventTrait.ts:66

Properties

`Protected` `Optional` _config

_config?: EventTraitConfig

Trait instance configuration.

`Protected` _eventQueue

_eventQueue: EventQueue

`Protected` _global

_global: boolean = false

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

`Protected` `Optional` _type

_type?: "event"

Trait type.

Methods

`Private` _getEventData

_getEventData(hookName: string, context: KosmosUserContext<object>, args: VertexSchemaHooksParams): EventData
Private
Returns event data to be sent to message bus.

Returns
Parameters
- hookName: string
  
  {string} - Hook name. Used to determine which hook arguments to extract.
- context: KosmosUserContext<object>
  
  User context.
- args: VertexSchemaHooksParams
  
  {VertexSchemaHooksParams} - Hook arguments array.
Returns EventData
- Defined in src/traits/EventTrait.ts:171

`Private` _getEventHandler

_getEventHandler(hookName: string, eventDetailType: string): ((...args: VertexSchemaHooksParams) => Promise<void>)
Private
Returns a pre-configured hook handler for a given action.

Returns
Parameters
- hookName: string
  
  Entity hook name.
- eventDetailType: string
  
  AWS EventBridge event detail type.
Returns ((...args: VertexSchemaHooksParams) => Promise<void>)
- - (...args: VertexSchemaHooksParams): Promise<void>
  - Private
    Returns a pre-configured hook handler for a given action.
    
    Returns
    Parameters
    - Rest ...args: VertexSchemaHooksParams
    Returns Promise<void>
- Defined in src/traits/EventTrait.ts:123

`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<[uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[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<unknown, UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, relationshipData: RelationshipData, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions>
Private
Returns entity schema hook by it's name.

Returns
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<[uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[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<unknown, UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, targetId: string, edge: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions> | AsyncSeriesHook<[traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, relationshipData: RelationshipData, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>], UnsetAdditionalOptions>
- Defined in src/traits/EventTrait.ts:283

`Private` _sendEventMessage

_sendEventMessage(eventDetailType: string, eventData: object, context: KosmosUserContext<object>): undefined | Promise<void>
Private
Sends event message to EventBridge.

Returns
Promise
Parameters
- eventDetailType: string
  
  AWS EventBridge event detail type.
- eventData: object
  
  Event data.
- context: KosmosUserContext<object>
  
  User context.
Returns undefined | Promise<void>
- Defined in src/traits/EventTrait.ts:150

`Protected` getHookName

getHookName(stage: "pre" | "post", action: string): string
Helper method retuning hook name.

Returns
Parameters
- stage: "pre" | "post"
  
  Entity processing stage.
- action: string
  
  Entity action.
Returns string
- Defined in src/traits/EventTrait.ts:313

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/EventTrait.ts:84

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(): EventTrait
Makes this Trait instance global.

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

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: EventTraitConfig): void
Configuration setter.
Parameters
- config: EventTraitConfig
  
  The new configuration.
Returns void
Inherited from Trait.setConfig
- Defined in src/traits/Trait.ts:124

traitConfig

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

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/EventTrait.ts:73

Class EventTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_eventQueue: EventQueue

Returns EventTrait

Properties

Protected Optional _config

Protected _eventQueue

Protected _global

Protected Optional _type

Methods

Private _getEventData

Returns

Parameters

hookName: string

context: KosmosUserContext<object>

args: VertexSchemaHooksParams

Returns EventData

Private _getEventHandler

Returns

Parameters

hookName: string

eventDetailType: string

Returns ((...args: VertexSchemaHooksParams) => Promise<void>)

Returns

Parameters

Rest ...args: VertexSchemaHooksParams

Returns Promise<void>

Private _getHookByAction

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

hookName: string

Private _sendEventMessage

Returns

Parameters

eventDetailType: string

eventData: object

context: KosmosUserContext<object>

Returns undefined | Promise<void>

Protected getHookName

Returns

Parameters

stage: "pre" | "post"

action: string

Returns string

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns EventTrait

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

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

Returns Promise<RT>

setConfig

Parameters

config: EventTraitConfig

Returns void

traitConfig

Returns EventTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

`Protected` `Optional` _config

`Protected` _eventQueue

`Protected` _global

`Protected` `Optional` _type

`Private` _getEventData

`Private` _getEventHandler

`Rest` ...args: VertexSchemaHooksParams

`Private` _getHookByAction

`Private` _sendEventMessage

`Protected` getHookName

`Optional` callbackName: string

`Static` traitTypeName