Class JsonContentBehavioursTrait

The Json Content Behaviours Trait.

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

Requires jsonContent (JsonContentTrait) trait to be applied first.

Usage:

traits:
  - type: json_content
    schema:
      vertex: Schema
      property: name
      edge: usesSchema
    fields:
      - name: jsonData
        type: type
      - name: profile
  - type: json_content_behaviours

Ref BehavioursTrait for details about how Behaviours works.

Hierarchy

Trait<JsonContentBehavioursTraitConfig>
- JsonContentBehavioursTrait

Constructors

constructor

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

Properties

`Protected` `Optional` _config

_config?: JsonContentBehavioursTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Private` _jsonContentBehaviourConfig

_jsonContentBehaviourConfig: undefined | JsonContentTraitConfig

JSON Content Trait configuration.

`Protected` `Optional` _type

_type?: "json_content_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

`Protected` `Readonly` jsonContentSchemaManager

jsonContentSchemaManager: JsonContentSchemaManager

`Protected` `Readonly` schemaManager

schemaManager: SchemaManager

Accessors

`Protected` jsonContentBehaviourConfig

get jsonContentBehaviourConfig(): JsonContentTraitConfig
Returns related JsonContentTrait configuration.

Returns JsonContentTraitConfig
- Defined in src/traits/JsonContentBehavioursTrait.ts:185

Methods

`Private` behaviourEntityTypeName

behaviourEntityTypeName(schemaItemLabel: string, jsonSchemaName: string): string
Parameters
- schemaItemLabel: string
- jsonSchemaName: string
Returns string
- Defined in src/traits/JsonContentBehavioursTrait.ts:560

`Private` getAllBehaviours

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

Returns string[]
- Defined in src/traits/JsonContentBehavioursTrait.ts:366

`Private` getBehaviourInstanceTypeName

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

`Private` getDisableBehaviourResolver

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

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns DisableSchemaBehaviourResolver
- Defined in src/traits/JsonContentBehavioursTrait.ts:427

`Private` getEnableBehaviourResolver

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

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns EnableSchemaBehaviourResolver
- Defined in src/traits/JsonContentBehavioursTrait.ts:379

`Private` getListBehavioursResolver

getListBehavioursResolver(schemaItem: SchemaItem<SchemaItemType>): ListSchemaBehavioursResolver
Returns the list query resolver for a given schema item.

Returns
The GraphQL resolver callback instance.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  The schema item.
Returns ListSchemaBehavioursResolver
- Defined in src/traits/JsonContentBehavioursTrait.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/JsonContentBehavioursTrait.ts:195

`Private` getQueryFieldName

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

`Protected` getSchemaNameByEntityId

getSchemaNameByEntityId(context: KosmosUserContext<object>, entityId: string): Promise<string>
Retrieves schema name by entity ID.
Parameters
- context: KosmosUserContext<object>
  
  The user context
- entityId: string
  
  The entity ID.
Returns Promise<string>
- Defined in src/traits/JsonContentBehavioursTrait.ts:539

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/JsonContentBehavioursTrait.ts:239

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

Returns JsonContentBehavioursTrait
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: JsonContentBehavioursTraitConfig): void
Configuration setter.
Parameters
- config: JsonContentBehavioursTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/JsonContentBehavioursTrait.ts:169

traitConfig

traitConfig(): JsonContentBehavioursTraitConfig
Returns JsonContentBehavioursTraitConfig
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.

Determines Schema type for given entity, 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/JsonContentBehavioursTrait.ts:479

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/JsonContentBehavioursTrait.ts:162

Class JsonContentBehavioursTrait

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

behavioursInstanceManager: BehavioursInstanceManager

behavioursSchemaManager: BehavioursSchemaManager

graphQlSchemaManager: GraphQLSchemaManager

schemaManager: SchemaManager

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

accessControl: AccessControl

jsonContentSchemaManager: JsonContentSchemaManager

Returns JsonContentBehavioursTrait

Properties

Protected Optional _config

Protected _global

Private _jsonContentBehaviourConfig

Protected Optional _type

Protected Readonly accessControl

Protected Readonly behaviours

Protected Readonly behavioursInstanceManager

Protected Readonly behavioursSchemaManager

Protected Readonly graphQlSchemaManager

Protected Readonly jsonContentSchemaManager

Protected Readonly schemaManager

Accessors

Protected jsonContentBehaviourConfig

Returns JsonContentTraitConfig

Methods

Private behaviourEntityTypeName

Parameters

schemaItemLabel: string

jsonSchemaName: string

Returns string

Private getAllBehaviours

Returns string[]

Private getBehaviourInstanceTypeName

Parameters

schemaItemLabel: string

Returns string

Private getDisableBehaviourResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns DisableSchemaBehaviourResolver

Private getEnableBehaviourResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns EnableSchemaBehaviourResolver

Private getListBehavioursResolver

Returns

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns ListSchemaBehavioursResolver

Private getMutationFieldName

Parameters

vertexLabel: string

type: "enable" | "disable"

Returns string

Private getQueryFieldName

Parameters

vertexLabel: string

type: "list"

Returns string

Protected getSchemaNameByEntityId

Parameters

context: KosmosUserContext<object>

entityId: string

Returns Promise<string>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

`Protected` `Optional` _config

`Protected` _global

`Private` _jsonContentBehaviourConfig

`Protected` `Optional` _type

`Protected` `Readonly` accessControl

`Protected` `Readonly` behaviours

`Protected` `Readonly` behavioursInstanceManager

`Protected` `Readonly` behavioursSchemaManager

`Protected` `Readonly` graphQlSchemaManager

`Protected` `Readonly` jsonContentSchemaManager

`Protected` `Readonly` schemaManager

`Protected` jsonContentBehaviourConfig

`Private` behaviourEntityTypeName

`Private` getAllBehaviours

`Private` getBehaviourInstanceTypeName

`Private` getDisableBehaviourResolver

`Private` getEnableBehaviourResolver

`Private` getListBehavioursResolver

`Private` getMutationFieldName

`Private` getQueryFieldName

`Protected` getSchemaNameByEntityId

`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