Class BehavioursTrait

The Behaviours Trait.

Attaches all existing Behaviours to a given entity type, allows listing, enabling and disabling Behaviours.

TODO: Implement limiting Behaviours types per Behaviour Trait instance.

Usage:

traits:
  - type: behaviours

Mermaid

Services stack

%%{init:{"theme":"dark"}}%% flowchart TB KosmosConfig["Kosmos config"] GraphQLSchemaManager --initializes--> BehavioursTrait BehavioursTrait --adds fields and mutations--> GraphQLSchemaManager BehavioursTrait --retrieves Behaviours list-->KosmosConfig BehavioursTrait --stores/retrieves Behaviours configs--> BehavioursInstanceManager

%%{init:{"theme":"default"}}%% flowchart TB KosmosConfig["Kosmos config"] GraphQLSchemaManager --initializes--> BehavioursTrait BehavioursTrait --adds fields and mutations--> GraphQLSchemaManager BehavioursTrait --retrieves Behaviours list-->KosmosConfig BehavioursTrait --stores/retrieves Behaviours configs--> BehavioursInstanceManager

flowchart TB
    KosmosConfig["Kosmos config"]
    GraphQLSchemaManager --initializes--> BehavioursTrait
    BehavioursTrait --adds fields and mutations--> GraphQLSchemaManager
    BehavioursTrait --retrieves Behaviours list-->KosmosConfig
    BehavioursTrait --stores/retrieves Behaviours configs--> BehavioursInstanceManager

Mermaid

Kosmos GraphQL server initialization

%%{init:{"theme":"dark"}}%% sequenceDiagram participant GraphQLSchemaManager participant SchemaManager participant BehavioursTrait participant BehavioursSchemaManager GraphQLSchemaManager->>SchemaManager: Retrieves a schema items SchemaManager->>GraphQLSchemaManager: Schema items list loop For each schema item GraphQLSchemaManager->>BehavioursTrait: Triggers GraphQL schema hooks BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL query to list Behaviours and their statuses BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL mutations to enable/disable Behaviours BehavioursTrait->>BehavioursSchemaManager: Trigger registering in GraphQL schema BehavioursTrait->>GraphQLSchemaManager: Wraps Behaviours resolvers into wrapper, adds GraphQL queries, mutations, fields and corresponding wrapped resolvers end

%%{init:{"theme":"default"}}%% sequenceDiagram participant GraphQLSchemaManager participant SchemaManager participant BehavioursTrait participant BehavioursSchemaManager GraphQLSchemaManager->>SchemaManager: Retrieves a schema items SchemaManager->>GraphQLSchemaManager: Schema items list loop For each schema item GraphQLSchemaManager->>BehavioursTrait: Triggers GraphQL schema hooks BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL query to list Behaviours and their statuses BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL mutations to enable/disable Behaviours BehavioursTrait->>BehavioursSchemaManager: Trigger registering in GraphQL schema BehavioursTrait->>GraphQLSchemaManager: Wraps Behaviours resolvers into wrapper, adds GraphQL queries, mutations, fields and corresponding wrapped resolvers end

sequenceDiagram
    participant GraphQLSchemaManager
    participant SchemaManager
    participant BehavioursTrait
    participant BehavioursSchemaManager
    GraphQLSchemaManager->>SchemaManager: Retrieves a schema items
    SchemaManager->>GraphQLSchemaManager: Schema items list
    loop For each schema item
        GraphQLSchemaManager->>BehavioursTrait: Triggers GraphQL schema hooks
        BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL query to list Behaviours and their statuses
        BehavioursTrait->>GraphQLSchemaManager: Adds GraphQL mutations to enable/disable Behaviours
        BehavioursTrait->>BehavioursSchemaManager: Trigger registering in GraphQL schema
        BehavioursTrait->>GraphQLSchemaManager: Wraps Behaviours resolvers into wrapper, adds GraphQL queries, mutations, fields and corresponding wrapped resolvers
    end

Mermaid

Listing Behaviours

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager User->>Kosmos: GraphQL query retrieving Behaviours list Kosmos->>BehavioursTrait: Executes Behaviours listing resolver BehavioursTrait->>BehavioursInstanceManager: Retrieves tenant's active behaviours instances BehavioursInstanceManager->>BehavioursTrait: Returns list of all available behaviours and their statuses (active/inactive) BehavioursTrait->>Kosmos: Resolver response Kosmos->>User: GraphQL response

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager User->>Kosmos: GraphQL query retrieving Behaviours list Kosmos->>BehavioursTrait: Executes Behaviours listing resolver BehavioursTrait->>BehavioursInstanceManager: Retrieves tenant's active behaviours instances BehavioursInstanceManager->>BehavioursTrait: Returns list of all available behaviours and their statuses (active/inactive) BehavioursTrait->>Kosmos: Resolver response Kosmos->>User: GraphQL response

sequenceDiagram
    actor User
    participant Kosmos
    participant BehavioursTrait
    participant BehavioursInstanceManager
    User->>Kosmos: GraphQL query retrieving Behaviours list
    Kosmos->>BehavioursTrait: Executes Behaviours listing resolver
    BehavioursTrait->>BehavioursInstanceManager: Retrieves tenant's active behaviours instances
    BehavioursInstanceManager->>BehavioursTrait: Returns list of all available behaviours and their statuses (active/inactive)
    BehavioursTrait->>Kosmos: Resolver response
    Kosmos->>User: GraphQL response

Mermaid

Executing Behaviours queries/mutations

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager participant Behaviour Instance User->>Kosmos: GraphQL query/mutation Kosmos->>BehavioursTrait: Calls resolver wrapper BehavioursTrait->>BehavioursInstanceManager: Checks if Behavior instance exists BehavioursInstanceManager->>BehavioursTrait: Instance config opt no behaviour instance (behaviour not enabled) BehavioursTrait->>User: Error response end BehavioursTrait->>Behaviour Instance: Executes resolver with schema item and instance config Behaviour Instance->>Kosmos: Response Kosmos->>User: Response

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager participant Behaviour Instance User->>Kosmos: GraphQL query/mutation Kosmos->>BehavioursTrait: Calls resolver wrapper BehavioursTrait->>BehavioursInstanceManager: Checks if Behavior instance exists BehavioursInstanceManager->>BehavioursTrait: Instance config opt no behaviour instance (behaviour not enabled) BehavioursTrait->>User: Error response end BehavioursTrait->>Behaviour Instance: Executes resolver with schema item and instance config Behaviour Instance->>Kosmos: Response Kosmos->>User: Response

sequenceDiagram
    actor User
    participant Kosmos
    participant BehavioursTrait
    participant BehavioursInstanceManager
    participant Behaviour Instance
    User->>Kosmos: GraphQL query/mutation
    Kosmos->>BehavioursTrait: Calls resolver wrapper
    BehavioursTrait->>BehavioursInstanceManager: Checks if Behavior instance exists
    BehavioursInstanceManager->>BehavioursTrait: Instance config
    opt no behaviour instance (behaviour not enabled)
        BehavioursTrait->>User: Error response
    end
    BehavioursTrait->>Behaviour Instance: Executes resolver with schema item and instance config
    Behaviour Instance->>Kosmos: Response
    Kosmos->>User: Response

Mermaid

Enabling/Disabling Behaviours

%%{init:{"theme":"dark"}}%% sequenceDiagram actor Admin participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager Admin->>Kosmos: GraphQL enable/disable mutation Kosmos->>BehavioursTrait: Executes Behaviours enable/disable resolver BehavioursTrait->>BehavioursInstanceManager: Calls add/remove Behaviour method alt could be enabled/disabled BehavioursInstanceManager->>Kosmos: GraphQL mutation

%%{init:{"theme":"default"}}%% sequenceDiagram actor Admin participant Kosmos participant BehavioursTrait participant BehavioursInstanceManager Admin->>Kosmos: GraphQL enable/disable mutation Kosmos->>BehavioursTrait: Executes Behaviours enable/disable resolver BehavioursTrait->>BehavioursInstanceManager: Calls add/remove Behaviour method alt could be enabled/disabled BehavioursInstanceManager->>Kosmos: GraphQL mutation

sequenceDiagram
    actor Admin
    participant Kosmos
    participant BehavioursTrait
    participant BehavioursInstanceManager
    Admin->>Kosmos: GraphQL enable/disable mutation
    Kosmos->>BehavioursTrait: Executes Behaviours enable/disable resolver
    BehavioursTrait->>BehavioursInstanceManager: Calls add/remove Behaviour method
    alt could be enabled/disabled
        BehavioursInstanceManager->>Kosmos: GraphQL mutation

`true` response else already enabled/disabled BehavioursInstanceManager->>Kosmos: GraphQL mutation `false` response else input validation failure BehavioursInstanceManager->>Kosmos: error response end Kosmos->>Admin: GraphQL response

Hierarchy

Trait<BehavioursTraitConfig>
- BehavioursTrait

Constructors

constructor

new BehavioursTrait(behavioursInstanceManager: BehavioursInstanceManager, behavioursSchemaManager: BehavioursSchemaManager, graphQlSchemaManager: GraphQLSchemaManager, behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[], accessControl: AccessControl): BehavioursTrait
Parameters
- behavioursInstanceManager: BehavioursInstanceManager
- behavioursSchemaManager: BehavioursSchemaManager
- graphQlSchemaManager: GraphQLSchemaManager
- behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]
- accessControl: AccessControl
Returns BehavioursTrait
Overrides Trait.constructor
- Defined in src/traits/BehavioursTrait.ts:168

Properties

`Protected` `Optional` _config

_config?: BehavioursTraitConfig

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?: "behaviours"

Trait type.

`Protected` `Readonly` accessControl

accessControl: AccessControl

`Protected` `Readonly` behaviours

behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]

`Protected` `Readonly` behavioursInstanceManager

behavioursInstanceManager: BehavioursInstanceManager

`Protected` `Readonly` behavioursSchemaManager

behavioursSchemaManager: BehavioursSchemaManager

`Protected` `Readonly` graphQlSchemaManager

graphQlSchemaManager: GraphQLSchemaManager

`Static` `Private` hookedIntoAccessControl

hookedIntoAccessControl: boolean = false

Methods

`Private` getAllBehaviours

getAllBehaviours(): string[]
Returns machine names of all available Behaviours.

Returns string[]
- Defined in src/traits/BehavioursTrait.ts:342

`Private` getBehaviourInstanceTypeName

getBehaviourInstanceTypeName(schemaItemLabel: string): string
Returns name of GraphQL type corresponding BehavioursListResponseItem TS type.
Parameters
- schemaItemLabel: string
  
  The schema item label.
Returns string
- Defined in src/traits/BehavioursTrait.ts:242

`Private` getDisableBehaviourResolver

getDisableBehaviourResolver(schemaItem: SchemaItem<SchemaItemType>): DisableBehaviourResolver
Returns callback for the resolver callback to disable behaviour for a given schema item.

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns DisableBehaviourResolver
- Defined in src/traits/BehavioursTrait.ts:389

`Private` getEnableBehaviourResolver

getEnableBehaviourResolver(schemaItem: SchemaItem<SchemaItemType>): EnableBehaviourResolver
Returns callback for the resolver callback to enable behaviour for a given schema item.

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns EnableBehaviourResolver
- Defined in src/traits/BehavioursTrait.ts:355

`Private` getListBehavioursResolver

getListBehavioursResolver(schemaItem: SchemaItem<SchemaItemType>): KosmosGraphQLResolver<null, {}, Promise<BehavioursListResponseItem[]>>
Returns the list query resolver for a given schema item.

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns KosmosGraphQLResolver<null, {}, Promise<BehavioursListResponseItem[]>>
- Defined in src/traits/BehavioursTrait.ts:322

`Private` getMutationFieldName

getMutationFieldName(vertexLabel: string, type: "enable" | "disable"): string
Returns the enable/disable mutation type.
Parameters
- vertexLabel: string
- type: "enable" | "disable"
Returns string
- Defined in src/traits/BehavioursTrait.ts:205

`Private` getQueryFieldName

getQueryFieldName(vertexLabel: string, type: "list"): string
Returns the Behaviours list query name.
Parameters
- vertexLabel: string
- type: "list"
Returns string
- Defined in src/traits/BehavioursTrait.ts:224

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/BehavioursTrait.ts:247

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

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

traitConfig

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

`Private` wrapBehaviourResolver

wrapBehaviourResolver(...__namedParameters: [schemaItem: SchemaItem<SchemaItemType>, behaviourName: string, behaviourResolver: BehaviourGraphQlResolver<InstanceConfig<string>, any, Record<string, any>, Promise<any>, SchemaItemType>]): KosmosGraphQLResolver<any, Record<string, any>, Promise<any>>
Behaviour resolver wrapper.

Retrieves and verifies behaviour instance configuration, then executes the Behaviour resolver, passing in runtime behaviour instance configuration.
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<SchemaItemType>, behaviourName: string, behaviourResolver: BehaviourGraphQlResolver<InstanceConfig<string>, any, Record<string, any>, Promise<any>, SchemaItemType>]
Returns KosmosGraphQLResolver<any, Record<string, any>, Promise<any>>
- Defined in src/traits/BehavioursTrait.ts:427

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/BehavioursTrait.ts:198

Class BehavioursTrait

Mermaid

Services stack

Mermaid

Kosmos GraphQL server initialization

Mermaid

Listing Behaviours

Mermaid

Executing Behaviours queries/mutations

Mermaid

Enabling/Disabling Behaviours

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

behavioursInstanceManager: BehavioursInstanceManager

behavioursSchemaManager: BehavioursSchemaManager

graphQlSchemaManager: GraphQLSchemaManager

behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]

accessControl: AccessControl

Returns BehavioursTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Protected Readonly accessControl

Protected Readonly behaviours

Protected Readonly behavioursInstanceManager

Protected Readonly behavioursSchemaManager

Protected Readonly graphQlSchemaManager

Static Private hookedIntoAccessControl

Methods

Private getAllBehaviours

Returns string[]

Private getBehaviourInstanceTypeName

Parameters

schemaItemLabel: string

Returns string

Private getDisableBehaviourResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns DisableBehaviourResolver

Private getEnableBehaviourResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns EnableBehaviourResolver

Private getListBehavioursResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns KosmosGraphQLResolver<null, {}, Promise<BehavioursListResponseItem[]>>

Private getMutationFieldName

Parameters

vertexLabel: string

type: "enable" | "disable"

Returns string

Private getQueryFieldName

Parameters

vertexLabel: string

type: "list"

Returns string

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns BehavioursTrait

name

Returns string

process

Type Parameters

RT = any

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Protected` `Readonly` accessControl

`Protected` `Readonly` behaviours

`Protected` `Readonly` behavioursInstanceManager

`Protected` `Readonly` behavioursSchemaManager

`Protected` `Readonly` graphQlSchemaManager

`Static` `Private` hookedIntoAccessControl

`Private` getAllBehaviours

`Private` getBehaviourInstanceTypeName

`Private` getDisableBehaviourResolver

`Private` getEnableBehaviourResolver

`Private` getListBehavioursResolver

`Private` getMutationFieldName

`Private` getQueryFieldName

`Private` wrapBehaviourResolver

`Rest` ...__namedParameters: [schemaItem: SchemaItem<SchemaItemType>, behaviourName: string, behaviourResolver: BehaviourGraphQlResolver<InstanceConfig<string>, any, Record<string, any>, Promise<any>, SchemaItemType>]

`Optional` callbackName: string

`Static` traitTypeName