Class ConnectionTrait

The Connection Trait is used to allow an edge the ability to add GraphQL mutation methods to an entity to add and remove connection between defined vertices.

Usage:

traits:
  - type: connection
    unique: true # optional

Hierarchy

Trait<ConnectionTraitConfig>
- ConnectionTrait

Constructors

constructor

new ConnectionTrait(_schemaManager: SchemaManager, _graphQlSchemaManager: GraphQLSchemaManager, _dataSourceWrapper: DataSourceWrapper, accessControl: AccessControl): ConnectionTrait
Parameters
- _schemaManager: SchemaManager
- _graphQlSchemaManager: GraphQLSchemaManager
- _dataSourceWrapper: DataSourceWrapper
- accessControl: AccessControl
Returns ConnectionTrait
Overrides Trait.constructor
- Defined in src/traits/ConnectionTrait.ts:53

Properties

`Protected` `Optional` _config

_config?: ConnectionTraitConfig

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

`Private` _properties

_properties: Record<string, SchemaItemProperty | SchemaItemArrayProperty> = {}

`Private` _relationships

_relationships: Record<string, {
relationship: VertexRelationship;
source: string;
}> = {}

`Protected` _schemaManager

_schemaManager: SchemaManager

`Protected` `Optional` _type

_type?: "connection"

Trait type.

`Private` `Optional` _unique

_unique?: boolean

Used to define if the user can only create a single connection between the source and dest vertices. Here we default to false. An example use case would be for like connections where a user can only like a post once.

`Protected` `Readonly` accessControl

accessControl: AccessControl

Methods

`Private` _loadEntities

_loadEntities(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<ItemWithIdAndLabel[]>
Loads connection source/destination entities.
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<ItemWithIdAndLabel[]>
- Defined in src/traits/ConnectionTrait.ts:301

addConnection

addConnection(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<boolean>
This method which has been registered using the addMutationHandler() will be called from the super.process(), when the trait has been activated a connection will be created between the src and destination vertices.
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<boolean>
- Defined in src/traits/ConnectionTrait.ts:171

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/ConnectionTrait.ts:358

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

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

mutationSchema

mutationSchema(schemaString: string, source: string, relationship?: null | VertexRelationship): string
This is where any GraphQL mutation entries that are rquired by the trait are added.

Returns
Returns graphql schema segment for inclusion in main graphql doc.
Parameters
- schemaString: string
- source: string
  
  String name of the source vertex that the trait is connected to
- Optional relationship: null | VertexRelationship
  
  JSON Object of the relationship, can be null where trait is not attached to a relationship.
Returns string
- Defined in src/traits/ConnectionTrait.ts:92

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

removeConnection

removeConnection(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<boolean>
This method which has been registered using the addMutationHandler() will be called from the super.process() when the trait has been activated the connection will be deleted is the user has valid access rights.
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<boolean>
- Defined in src/traits/ConnectionTrait.ts:229

setConfig

setConfig(config: ConnectionTraitConfig): void
ConnectionTrait config setter.
Parameters
- config: ConnectionTraitConfig
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ConnectionTrait.ts:71

traitConfig

traitConfig(): ConnectionTraitConfig
Returns ConnectionTraitConfig
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/ConnectionTrait.ts:79

Class ConnectionTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_schemaManager: SchemaManager

_graphQlSchemaManager: GraphQLSchemaManager

_dataSourceWrapper: DataSourceWrapper

accessControl: AccessControl

Returns ConnectionTrait

Properties

Protected Optional _config

Protected _dataSourceWrapper

Protected _global

Protected _graphQlSchemaManager

Private _properties

Private _relationships

Protected _schemaManager

Protected Optional _type

Private Optional _unique

Protected Readonly accessControl

Methods

Private _loadEntities

Parameters

datasourceWrapper: DataSourceWrapper

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

Returns Promise<ItemWithIdAndLabel[]>

addConnection

Parameters

datasourceWrapper: DataSourceWrapper

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

Returns Promise<boolean>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ConnectionTrait

mutationSchema

Returns

Parameters

schemaString: string

source: string

Optional relationship: null | VertexRelationship

Returns string

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

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

Returns Promise<RT>

removeConnection

Parameters

datasourceWrapper: DataSourceWrapper

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

Returns Promise<boolean>

setConfig

Parameters

config: ConnectionTraitConfig

Returns void

traitConfig

Returns ConnectionTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

`Protected` `Optional` _config

`Protected` _dataSourceWrapper

`Protected` _global

`Protected` _graphQlSchemaManager

`Private` _properties

`Private` _relationships

`Protected` _schemaManager

`Protected` `Optional` _type

`Private` `Optional` _unique

`Protected` `Readonly` accessControl

`Private` _loadEntities

`Optional` relationship: null | VertexRelationship

`Optional` callbackName: string

`Static` traitTypeName