Class AuthorTrait

The Author trait adds author connection field to GraphQL types.

Usage:

traits:
  - type: author
    allow_change_author: true
    check_membership:
      target:
        type: Organisation
        edge: hasOrganisation
        direction: out
      user:
        type: Organisation
        edge: memberOf
        direction: out

Settings:

allow_change_author - allows to change author via update mutation
check_membership - before updating author - compare membership of target entity and old author if it doesn't match - can update authorship. Works only if allow_change_author is true

Hierarchy

Trait<AuthorTraitConfig>
- AuthorTrait

Constructors

constructor

new AuthorTrait(graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, _graphqlSchemaManager: GraphQLSchemaManager): AuthorTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- _graphqlSchemaManager: GraphQLSchemaManager
Returns AuthorTrait
Overrides Trait.constructor
- Defined in src/traits/AuthorTrait.ts:99

Properties

_allowChangeAuthor

_allowChangeAuthor: boolean = false

`Protected` `Optional` _config

_config?: AuthorTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

_targetMembership

_targetMembership: null | MembershipDefinition = null

`Protected` `Optional` _type

_type?: "author"

Trait type.

`Optional` _userEntity

_userEntity?: string

_userMembership

_userMembership: null | MembershipDefinition = null

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

Methods

`Private` canChangeAuthor

canChangeAuthor(currentAuthorId: string, entityId: string, context: KosmosUserContext<object>): Promise<void>
Validate changing author against trait config
Parameters
- currentAuthorId: string
  
  author of entity before update
- entityId: string
  
  entity id
- context: KosmosUserContext<object>
  
  kosmos user context
Returns Promise<void>
- Defined in src/traits/AuthorTrait.ts:240

`Private` createAuthorEdge

createAuthorEdge(itemId: string, newAuthorId: string, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Parameters
- itemId: string
- newAuthorId: string
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<void>
- Defined in src/traits/AuthorTrait.ts:266

`Private` deleteAuthorEdge

deleteAuthorEdge(item: Record<string, any>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Parameters
- item: Record<string, any>
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<void>
- Defined in src/traits/AuthorTrait.ts:283

getAuthor

getAuthor(datasourceWrapper: DataSourceWrapper, data: any): Promise<null | ItemWithId>
This method is used to get the value of the GraphQL 'author' property
Parameters
- datasourceWrapper: DataSourceWrapper
- data: any
Returns Promise<null | ItemWithId>
- Defined in src/traits/AuthorTrait.ts:156

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/AuthorTrait.ts:365

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

`Private` loadMembership

loadMembership(definition: MembershipDefinition, context: KosmosUserContext<object>, forEntity: string): Promise<any[]>
Loads related entity by definition object

Returns
Entity or null
Parameters
- definition: MembershipDefinition
  
  description of relationships between vertices
- context: KosmosUserContext<object>
  
  kosmos user context
- forEntity: string
  
  target entity
Returns Promise<any[]>
- Defined in src/traits/AuthorTrait.ts:219

makeGlobal

makeGlobal(): AuthorTrait
Makes this Trait instance global.

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

mutationItemSchema

mutationItemSchema(schemaString: string, target: string, type: any): string
Parameters
- schemaString: string
- target: string
- type: any
Returns string
- Defined in src/traits/AuthorTrait.ts:143

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

postCreate

postCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, datasourceWrapper: DataSourceWrapper, context: any): Promise<void>
After the vertex has been created, add an edge pointing to its author.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data
- item: any
  
  The data of the item that was created
- datasourceWrapper: DataSourceWrapper
  
  Data source wrapper
- context: any
  
  User Context
Returns Promise<void>
- Defined in src/traits/AuthorTrait.ts:179

`Private` postUpdate

postUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, datasourceWrapper: DataSourceWrapper, context: any): Promise<void>
Handle transferring authorship of entity

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data
- item: any
  
  The data of the item that was updated
- datasourceWrapper: DataSourceWrapper
  
  Legacy to be removed
- context: any
  
  User Context
Returns Promise<void>
- Defined in src/traits/AuthorTrait.ts:329

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(schemaString: string): string
Parameters
- schemaString: string
Returns string
- Defined in src/traits/AuthorTrait.ts:136

setConfig

setConfig(config: AuthorTraitConfig): void
AuthorTrait config setter
Parameters
- config: AuthorTraitConfig
  
  This configuration object.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/AuthorTrait.ts:115

traitConfig

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

`Private` updateAuthorProperty

updateAuthorProperty(itemId: string, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<null | Record<string, any>>
Parameters
- itemId: string
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<null | Record<string, any>>
- Defined in src/traits/AuthorTrait.ts:300

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/AuthorTrait.ts:132

Class AuthorTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

_graphqlSchemaManager: GraphQLSchemaManager

Returns AuthorTrait

Properties

_allowChangeAuthor

Protected Optional _config

Protected _global

Protected Readonly _graphqlSchemaManager

_targetMembership

Protected Optional _type

Optional _userEntity

_userMembership

Protected Readonly dataSourceWrapper

Protected Readonly graphqlSchemaManager

Methods

Private canChangeAuthor

Parameters

currentAuthorId: string

entityId: string

context: KosmosUserContext<object>

Returns Promise<void>

Private createAuthorEdge

Parameters

itemId: string

newAuthorId: string

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

Returns Promise<void>

Private deleteAuthorEdge

Parameters

item: Record<string, any>

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

Returns Promise<void>

getAuthor

Parameters

datasourceWrapper: DataSourceWrapper

data: any

Returns Promise<null | ItemWithId>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

Private loadMembership

Returns

Parameters

definition: MembershipDefinition

context: KosmosUserContext<object>

forEntity: string

Returns Promise<any[]>

makeGlobal

Returns AuthorTrait

mutationItemSchema

Parameters

schemaString: string

target: string

type: any

Returns string

name

Returns string

postCreate

Parameters

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

item: any

datasourceWrapper: DataSourceWrapper

context: any

Returns Promise<void>

Private postUpdate

Returns

Parameters

`Protected` `Optional` _config

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` `Optional` _type

`Optional` _userEntity

`Protected` `Readonly` dataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

`Private` canChangeAuthor

`Private` createAuthorEdge

`Private` deleteAuthorEdge

`Private` loadMembership

`Private` postUpdate

`Private` updateAuthorProperty

`Optional` callbackName: string

`Static` traitTypeName