Class DataObjectsTrait

The DataObjectsTrait is used to enable a specified property of a vertex to to be parsed for html objects, if the html objects have been defined as part of the trait configuration (see below) an edge will be added to the targeted vertex, below is an example of a HTML Object that can be parsed by this Trait and defines two data objects that can be managed.

Example HTML:

<object
 data-klarity-widget-type="mention"
 data-klarity-widget-data="{'id':'aebe2fcc-e69c-8a64-819d-f370f3988ece'}">
</object>

Usage:

traits:
  - type: data_objects
    targetProperty:
      - body
    typeAttributeName: data-klarity-widget-type
    dataAttributeName: data-klarity-widget-data
    objects:
    - dataObjectType: mention
      edgeType: mentions
      targetVertexType: User
    - dataObjectType: answer
      edgeType: usesAnswer
      targetVertexType: Answer
    - dataObjectType: hashtag
      edgeType: hasTag
      targetVertexType: Tag
      targetVertexFilter: vocabulary.machine_name:hashtag

Hierarchy

Trait<DataObjectsTraitConfig>
- DataObjectsTrait

Constructors

constructor

new DataObjectsTrait(_schemaManager: SchemaManager, _dataSourceWrapper: DataSourceWrapper): DataObjectsTrait
Parameters
- _schemaManager: SchemaManager
- _dataSourceWrapper: DataSourceWrapper
Returns DataObjectsTrait
Overrides Trait.constructor
- Defined in src/traits/DataObjectsTrait.ts:150

Properties

`Protected` `Optional` _config

_config?: DataObjectsTraitConfig

Trait instance configuration.

`Private` `Optional` _dataAttributeName

_dataAttributeName?: string

`Protected` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Private` `Optional` _edges

_edges?: string[]

`Protected` _global

_global: boolean = false

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

`Private` `Optional` _objects

_objects?: DataObjectConfig[]

`Protected` _schemaManager

_schemaManager: SchemaManager

`Private` `Optional` _targetProperties

_targetProperties?: {
    property: string;
    rawProperty: string;
    subProperty?: string;
}[]

`Private` `Optional` _targetVertexFilters

_targetVertexFilters?: string[]

`Private` `Optional` _targetVertices

_targetVertices?: string[]

`Protected` `Optional` _type

_type?: "data_objects"

Trait type.

`Private` `Optional` _typeAttributeName

_typeAttributeName?: string

`Private` `Optional` _types

_types?: string[]

Methods

_getTraitStorage

_getTraitStorage(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): DataObjectStorage
Helper method which initializes/returns DataObjectStorage object.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns DataObjectStorage
- Defined in src/traits/DataObjectsTrait.ts:536

addObjectConnection

addObjectConnection(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, context: KosmosUserContext<object>, targetId: string, targetType: string, targetProperty: PropertyObject): Promise<void>
This function is used to validate the target and add the defined edge between the current entity and the target.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: any
- context: KosmosUserContext<object>
- targetId: string
- targetType: string
- targetProperty: PropertyObject
Returns Promise<void>
- Defined in src/traits/DataObjectsTrait.ts:355

getDataFieldObjects

getDataFieldObjects(fieldData?: string): any[]
This method is used to extract the html objects which have been included in filedData string. It returns a map of arrays of the data contained in the string.
Parameters
- Optional fieldData: string
Returns any[]
- Defined in src/traits/DataObjectsTrait.ts:496

getTargetProperties

getTargetProperties(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): PropertyObject[]
This function is used to retrieve the argument property and checks if a sub property has been defined and return that in a list for each defined property.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns PropertyObject[]
- Defined in src/traits/DataObjectsTrait.ts:338

getTargetProperty

getTargetProperty(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, property: string, subProperty?: string): undefined | string
This function is used to retrieve the argument property and checks if a sub property has been defined and return that.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- property: string
- Optional subProperty: string
Returns undefined | string
- Defined in src/traits/DataObjectsTrait.ts:325

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/DataObjectsTrait.ts:518

hookIntoSchemaManager

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

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

listObjectConnections

listObjectConnections(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, property: string): Promise<any[]>
This function is used to get a list of defined edges that exist between the source entity and the target entity type.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: any
- property: string
Returns Promise<any[]>
- Defined in src/traits/DataObjectsTrait.ts:460

makeGlobal

makeGlobal(): DataObjectsTrait
Makes this Trait instance global.

Returns DataObjectsTrait
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(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, disabledDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
After the Vertex has been created make sure to attach it to the schema
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: any
- disabledDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/DataObjectsTrait.ts:212

postUpdate

postUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, disabledDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
post-update hook implementation. This function checks for the specified type, which items have been added or removed and processes them accordingly.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: any
- disabledDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/DataObjectsTrait.ts:250

preCreate

preCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): void
This function is the preCreate and will be called before the entity is created, to prevent the preUpdate and postUpdate being called on a create (which can happen due to interaction with other traits).
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns void
- Defined in src/traits/DataObjectsTrait.ts:202

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

removeObjectConnection

removeObjectConnection(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any, context: KosmosUserContext<object>, edgeId: string, edgeLabel: string): Promise<void>
This function is used to check that a defined edge exists between the source entity and the target exists and to then delete the edge.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: any
- context: KosmosUserContext<object>
- edgeId: string
- edgeLabel: string
Returns Promise<void>
- Defined in src/traits/DataObjectsTrait.ts:429

setConfig

setConfig(config: DataObjectsTraitConfig): void
Configuration setter.
Parameters
- config: DataObjectsTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/DataObjectsTrait.ts:157

traitConfig

traitConfig(): DataObjectsTraitConfig
Returns DataObjectsTraitConfig
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/DataObjectsTrait.ts:193

Class DataObjectsTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_schemaManager: SchemaManager

_dataSourceWrapper: DataSourceWrapper

Returns DataObjectsTrait

Properties

Protected Optional _config

Private Optional _dataAttributeName

Protected _dataSourceWrapper

Private Optional _edges

Protected _global

Private Optional _objects

Protected _schemaManager

Private Optional _targetProperties

Private Optional _targetVertexFilters

Private Optional _targetVertices

Protected Optional _type

Private Optional _typeAttributeName

Private Optional _types

Methods

_getTraitStorage

Parameters

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

Returns DataObjectStorage

addObjectConnection

Parameters

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

item: any

context: KosmosUserContext<object>

targetId: string

targetType: string

targetProperty: PropertyObject

Returns Promise<void>

getDataFieldObjects

Parameters

Optional fieldData: string

Returns any[]

getTargetProperties

Parameters

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

Returns PropertyObject[]

getTargetProperty

Parameters

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

property: string

Optional subProperty: string

Returns undefined | string

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

listObjectConnections

Parameters

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

item: any

property: string

Returns Promise<any[]>

makeGlobal

Returns DataObjectsTrait

name

Returns string

postCreate

Parameters

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

item: any

disabledDatasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

Returns Promise<void>

postUpdate

Parameters

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

`Protected` `Optional` _config

`Private` `Optional` _dataAttributeName

`Protected` _dataSourceWrapper

`Private` `Optional` _edges

`Protected` _global

`Private` `Optional` _objects

`Protected` _schemaManager

`Private` `Optional` _targetProperties

`Private` `Optional` _targetVertexFilters

`Private` `Optional` _targetVertices

`Protected` `Optional` _type

`Private` `Optional` _typeAttributeName

`Private` `Optional` _types

`Optional` fieldData: string

`Optional` subProperty: string

`Optional` callbackName: string

`Static` traitTypeName