Class AncestorTrait

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<AncestorTraitConfig>
- AncestorTrait

Constructors

constructor

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

Properties

`Private` _additionalProperties

_additionalProperties: Record<string, ScalarTypes> = {}

`Protected` `Optional` _config

_config?: AncestorTraitConfig

Trait instance configuration.

`Protected` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Private` _depth

_depth: number = MAX_DEPTH

`Protected` _global

_global: boolean = false

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

`Protected` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Private` _parents

_parents: ParentItem[] = []

`Protected` _schemaManager

_schemaManager: SchemaManager

`Protected` `Optional` _type

_type?: "ancestor"

Trait type.

Methods

getAncestors

getAncestors(...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]): Promise<Ancestor[]>
This method is used to get the vertex's Ancestors.
Parameters
- Rest ...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]
Returns Promise<Ancestor[]>
- Defined in src/traits/AncestorTrait.ts:216

getHierarchy

getHierarchy(datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>, entityId: string, maxDepth: number, edge: undefined | string, direction: undefined | ParentDirection): Promise<Record<string, any>>
This functions returns the hierarchy of ancestors for a given vertex.

Returns
The hierarchy array of ancestors.
Parameters
- datasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
  
  The user context
- entityId: string
  
  The id of the current vertex
- maxDepth: number
- edge: undefined | string
- direction: undefined | ParentDirection
Returns Promise<Record<string, any>>
- Defined in src/traits/AncestorTrait.ts:309

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/AncestorTrait.ts:366

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

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

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/AncestorTrait.ts:201

setConfig

setConfig(config: AncestorTraitConfig): void
AncestorTrait config setter.
Parameters
- config: AncestorTraitConfig
Returns void
Overrides Trait.setConfig
- Defined in src/traits/AncestorTrait.ts:169

traitConfig

traitConfig(): AncestorTraitConfig
Returns AncestorTraitConfig
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/AncestorTrait.ts:188

Class AncestorTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_graphqlSchemaManager: GraphQLSchemaManager

_schemaManager: SchemaManager

_dataSourceWrapper: DataSourceWrapper

Returns AncestorTrait

Properties

Private _additionalProperties

Protected Optional _config

Protected _dataSourceWrapper

Private _depth

Protected _global

Protected _graphqlSchemaManager

Private _parents

Protected _schemaManager

Protected Optional _type

Methods

getAncestors

Parameters

Rest ...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]

Returns Promise<Ancestor[]>

getHierarchy

Returns

Parameters

datasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

entityId: string

maxDepth: number

edge: undefined | string

direction: undefined | ParentDirection

Returns Promise<Record<string, any>>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns AncestorTrait

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

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

Returns Promise<RT>

querySchema

Returns

Parameters

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

Returns string

setConfig

Parameters

config: AncestorTraitConfig

Returns void

traitConfig

Returns AncestorTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

`Private` _additionalProperties

`Protected` `Optional` _config

`Protected` _dataSourceWrapper

`Private` _depth

`Protected` _global

`Protected` _graphqlSchemaManager

`Private` _parents

`Protected` _schemaManager

`Protected` `Optional` _type

`Rest` ...__namedParameters: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]

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

`Optional` callbackName: string

`Static` traitTypeName