Class ComputedTrait

The base Trait class.

Any core Kosmos or custom application traits must inherit this class and must declare it's own configuration type extending TraitConfigBase interface.

Hierarchy

Trait<ComputedTraitConfig>
- ComputedTrait

Constructors

constructor

new ComputedTrait(_graphqlSchemaManager: GraphQLSchemaManager, _schemaManager: SchemaManager, _dataSourceWrapper: DataSourceWrapper): ComputedTrait
Parameters
- _graphqlSchemaManager: GraphQLSchemaManager
- _schemaManager: SchemaManager
- _dataSourceWrapper: DataSourceWrapper
Returns ComputedTrait
Overrides Trait.constructor
- Defined in src/traits/ComputedTrait.ts:110

Properties

`Protected` `Optional` _config

_config?: ComputedTraitConfig

Trait instance configuration.

`Protected` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Protected` _global

_global: boolean = false

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

`Protected` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` _schemaManager

_schemaManager: SchemaManager

`Protected` `Optional` _type

_type?: "computed"

Trait type.

Methods

_computeField

_computeField(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem): Promise<void>
Compute field based of template of traversal.
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: StoredKosmosItem
Returns Promise<void>
- Defined in src/traits/ComputedTrait.ts:322

`Private` _computedTemplate

_computedTemplate(fieldConfig: undefined | ComputedFields<string>, data: Record<string, any>): string
This method to compute the traversal
Parameters
- fieldConfig: undefined | ComputedFields<string>
- data: Record<string, any>
Returns string
- Defined in src/traits/ComputedTrait.ts:187

`Private` _computedTraversal

_computedTraversal(fieldConfig: undefined | ComputedFields<string>, data: Record<string, any>, context: KosmosUserContext<object>): Promise<null | string | number | boolean>
This method to compute the traversal
Parameters
- fieldConfig: undefined | ComputedFields<string>
- data: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<null | string | number | boolean>
- Defined in src/traits/ComputedTrait.ts:215

`Private` _formatTraversal

_formatTraversal(type: string, query: TraitGraphQuery<any>, excludeFields: Record<string, any>): Promise<null | string | number | boolean>
This method is used to format traversal to a given type
Parameters
- type: string
- query: TraitGraphQuery<any>
- excludeFields: Record<string, any>
Returns Promise<null | string | number | boolean>
- Defined in src/traits/ComputedTrait.ts:247

`Private` _mapType

_mapType<T>(type: {
type: keyof ReturnTypeMap;
}[]): MapType<T>
This private method is used to map type to for query schema.
Type Parameters
- T extends keyof ReturnTypeMap
Parameters
- type: {
  type: keyof ReturnTypeMap;
  }[]
Returns MapType<T>
- Defined in src/traits/ComputedTrait.ts:163

getComputedFieldResolver

getComputedFieldResolver(fieldName: string): ((datasourceWrapper: DataSourceWrapper, data: any) => any)
Inherit Doc
Parameters
- fieldName: string
Returns ((datasourceWrapper: DataSourceWrapper, data: any) => any)
- - (datasourceWrapper: DataSourceWrapper, data: any): any
  - Parameters
    - datasourceWrapper: DataSourceWrapper
    - data: any
    Returns any
- Defined in src/traits/ComputedTrait.ts:353

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/ComputedTrait.ts:362

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

Returns ComputedTrait
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

postCreate

postCreate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem): Promise<void>
Post-create hook implementation.

Inherit Doc
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: StoredKosmosItem
Returns Promise<void>
- Defined in src/traits/ComputedTrait.ts:300

postUpdate

postUpdate(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem): Promise<void>
Post-update hook implementation.

Inherit Doc
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: StoredKosmosItem
Returns Promise<void>
- Defined in src/traits/ComputedTrait.ts:312

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

querySchema

querySchema(...__namedParameters: [schemaString: string, source: string]): string
This method is used to hook in the field change to the vertex that the AncestorTrait has been attached to.

Returns
Parameters
- Rest ...__namedParameters: [schemaString: string, source: string]
Returns string
- Defined in src/traits/ComputedTrait.ts:144

setConfig

setConfig(config: ComputedTraitConfig): void
Configuration setter.
Parameters
- config: ComputedTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ComputedTrait.ts:128

traitConfig

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

updateVertexField

updateVertexField(context: KosmosUserContext<object>, id: string, fieldName: string, change: undefined | null | string | number | boolean): Promise<void>
Helper function for updating vertex field.
Parameters
- context: KosmosUserContext<object>
- id: string
- fieldName: string
- change: undefined | null | string | number | boolean
Returns Promise<void>
- Defined in src/traits/ComputedTrait.ts:280

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/ComputedTrait.ts:121

Class ComputedTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_graphqlSchemaManager: GraphQLSchemaManager

_schemaManager: SchemaManager

_dataSourceWrapper: DataSourceWrapper

Returns ComputedTrait

Properties

Protected Optional _config

Protected _dataSourceWrapper

Protected _global

Protected _graphqlSchemaManager

Protected _schemaManager

Protected Optional _type

Methods

_computeField

Parameters

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

item: StoredKosmosItem

Returns Promise<void>

Private _computedTemplate

Parameters

fieldConfig: undefined | ComputedFields<string>

data: Record<string, any>

Returns string

Private _computedTraversal

Parameters

fieldConfig: undefined | ComputedFields<string>

data: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<null | string | number | boolean>

Private _formatTraversal

Parameters

type: string

query: TraitGraphQuery<any>

excludeFields: Record<string, any>

Returns Promise<null | string | number | boolean>

Private _mapType

Type Parameters

T extends keyof ReturnTypeMap

Parameters

type: { type: keyof ReturnTypeMap; }[]

Returns MapType<T>

getComputedFieldResolver

Inherit Doc

Parameters

fieldName: string

Returns ((datasourceWrapper: DataSourceWrapper, data: any) => any)

Parameters

datasourceWrapper: DataSourceWrapper

data: any

Returns any

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ComputedTrait

name

Returns string

postCreate

Inherit Doc

Parameters

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

item: StoredKosmosItem

Returns Promise<void>

postUpdate

Inherit Doc

Parameters

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

item: StoredKosmosItem

Returns Promise<void>

`Protected` `Optional` _config

`Protected` _dataSourceWrapper

`Protected` _global

`Protected` _graphqlSchemaManager

`Protected` _schemaManager

`Protected` `Optional` _type

`Private` _computedTemplate

`Private` _computedTraversal

`Private` _formatTraversal

`Private` _mapType

type: {
type: keyof ReturnTypeMap;
}[]

`Rest` ...__namedParameters: [schemaString: string, source: string]

`Optional` callbackName: string

`Static` traitTypeName