Class JsonContentTrait

The JsonContentTrait is used to enable adding multiple json fields to an entity. A schema vertex must be defined along with the property which is used as the name of the schema.

For each field a name must be defined and optionally a type which is used to hold the name of the applied schema if ones is defined. If one is not defined the field will not be validated against a schema.

Usage:

traits:
  - type: json_content
    schema:
      vertex: Schema
      property: name
      edge: usesSchema
    fields:
      - name: jsonData
        type: type
      - name: profile
    storage:
       name: json-content
       revisions: true

Hierarchy

Trait<JsonContentTraitConfig>
- JsonContentTrait

Index

Constructors

constructor

Properties

_config? _dataSourceWrapper _externalStorageManager _global _graphqlSchemaManager _jsonContentSchemaManager _mutationFields _retainRevisions _schemaManager _storageEngine _type? _validatorFactory

Constructors

constructor

new JsonContentTrait(_graphqlSchemaManager: GraphQLSchemaManager, _dataSourceWrapper: DataSourceWrapper, _jsonContentSchemaManager: JsonContentSchemaManager, _validatorFactory: (() => KosmosSchemaValidator), _externalStorageManager: ExternalStorageManager, _schemaManager: SchemaManager): JsonContentTrait
Parameters
- _graphqlSchemaManager: GraphQLSchemaManager
- _dataSourceWrapper: DataSourceWrapper
- _jsonContentSchemaManager: JsonContentSchemaManager
- _validatorFactory: (() => KosmosSchemaValidator)
  - - (): KosmosSchemaValidator
    - Returns KosmosSchemaValidator
- _externalStorageManager: ExternalStorageManager
- _schemaManager: SchemaManager
Returns JsonContentTrait
Overrides Trait.constructor
- Defined in src/traits/JsonContentTrait.ts:102

Properties

`Protected` `Optional` _config

_config?: JsonContentTraitConfig

Trait instance configuration.

`Protected` `Readonly` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Protected` `Readonly` _externalStorageManager

_externalStorageManager: ExternalStorageManager

`Protected` _global

_global: boolean = false

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

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` `Readonly` _jsonContentSchemaManager

_jsonContentSchemaManager: JsonContentSchemaManager

`Protected` _mutationFields

_mutationFields: Record<string, string> = {}

`Protected` _retainRevisions

_retainRevisions: boolean = false

`Protected` `Readonly` _schemaManager

_schemaManager: SchemaManager

`Protected` _storageEngine

_storageEngine: any = undefined

`Protected` `Optional` _type

_type?: "json_content"

Trait type.

`Protected` `Readonly` _validatorFactory

_validatorFactory: (() => KosmosSchemaValidator)

Type declaration

- (): KosmosSchemaValidator
- Returns KosmosSchemaValidator

Methods

_connectWithSchema

_connectWithSchema(context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, schema: EntityObject): Promise<Record<string, any>>
Parameters
- context: KosmosUserContext<object>
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: ItemWithId
- schema: EntityObject
Returns Promise<Record<string, any>>
- Defined in src/traits/JsonContentTrait.ts:878

_disconnectFromSchema

_disconnectFromSchema(context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId): Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
} | IteratorResult<ItemWithIdAndLabel, any>>
Parameters
- context: KosmosUserContext<object>
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: ItemWithId
Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
} | IteratorResult<ItemWithIdAndLabel, any>>
- Defined in src/traits/JsonContentTrait.ts:898

_getJSONTypes

_getJSONTypes(): string[]
This function is used to return a list of array types.

Returns
Array of the defined json field types.

Returns string[]
- Defined in src/traits/JsonContentTrait.ts:497

_getTraitStorage

_getTraitStorage(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): JsonContentTraitStorage
Helper method which initializes/returns JsonContentTrait storage object.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
Returns JsonContentTraitStorage
- Defined in src/traits/JsonContentTrait.ts:1227

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/JsonContentTrait.ts:812

hookIntoSchemaManager

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

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

jsonHandler

jsonHandler(...traitData: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]): Promise<string>
This function handles the filtering and deserialisation of the json field
Parameters
- Rest ...traitData: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]
  
  The trait data object
Returns Promise<string>
- Defined in src/traits/JsonContentTrait.ts:508

loadEntity

loadEntity(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<null | EntityObject>
Utility function used to load and entity by id.

Returns
The entity object or NULL.
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<null | EntityObject>
- Defined in src/traits/JsonContentTrait.ts:774

`Private` loadSchemas

loadSchemas(context: KosmosUserContext<object>, data?: Record<string, any>, originalItem?: null | EntityObject): Promise<KosmosSchema[]>
Returns schemas for every JSON field of entity
Parameters
- context: KosmosUserContext<object>
- Optional data: Record<string, any>
- Optional originalItem: null | EntityObject
Returns Promise<KosmosSchema[]>
- Defined in src/traits/JsonContentTrait.ts:1202

makeGlobal

makeGlobal(): JsonContentTrait
Makes this Trait instance global.

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

mutationSchema

mutationSchema(schemaString: string, source: string): string
Add mutation to enable the JSON field to be updated.

Returns
GraphQL schema segment for inclusion in main graphql doc.
Parameters
- schemaString: string
  
  The existing schema string.
- source: string
  
  String name of the source vertex that the trait is connected to.
Returns string
- Defined in src/traits/JsonContentTrait.ts:185

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: ItemWithId, legacyDatasourceWrapper: 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>>
  
  The trait data object
- item: ItemWithId
  
  The item being created
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:276

postUpdate

postUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: Record<string, any>): Promise<void>
Called after vertex is updated.

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities
- data: Record<string, any>
  
  The item being updated.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:444

postView

postView(item: any): Promise<void>
Post-view hook implementation, handles replacing the keyed data with the content from the storage engine

Returns
Parameters
- item: any
  
  The current item being retrieved
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:219

preAddRelationship

preAddRelationship(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: RelationshipData, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Pre add relationship hook implementation.

Validate new relation

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
- data: RelationshipData
  
  The data to update.
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object; not used.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:367

preCreate

preCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Before the entity is created check if a schema is being defined that it exists and is available to the user.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data.
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:253

preRemoveRelationship

preRemoveRelationship(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: RelationshipData, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Pre remove relationship hook implementation.

Validate relation to remove

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
- data: RelationshipData
  
  The data to update.
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object; not used.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:408

preUpdate

preUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: Record<string, any>, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Pre-update hook implementation.

Validate new schema for JSON field if it was changed

Returns
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object
- data: Record<string, any>
  
  The data to update.
- legacyDatasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object; not used.
- context: KosmosUserContext<object>
  
  The user context.
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:331

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
This function is used to implement the query schema for the trait.

Returns
GraphQL schema segment for inclusion in main graphql doc.
Parameters
- schemaString: string
  
  The existing schema thats passed in.
Returns string
- Defined in src/traits/JsonContentTrait.ts:167

saveEntity

saveEntity(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, validate?: boolean): Promise<boolean>
Utility function used to save a json entity to storage.

Returns
Boolean indication if saving was successful.
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
- item: ItemWithId
  
  The json data to be stored.
- validate: boolean = true
Returns Promise<boolean>
- Defined in src/traits/JsonContentTrait.ts:795

`Private` selectRelationsFromSchemas

selectRelationsFromSchemas(relationType: "required" | "disabled", entityType: string, schemas: KosmosSchema[]): TheItemsSchema[]
Returns list of relations for entity based on schemas
Parameters
- relationType: "required" | "disabled"
- entityType: string
- schemas: KosmosSchema[]
  
  list of schemas for entity
Returns TheItemsSchema[]
- Defined in src/traits/JsonContentTrait.ts:1174

setConfig

setConfig(config: JsonContentTraitConfig): void
Configuration setter.
Parameters
- config: JsonContentTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/JsonContentTrait.ts:122

traitConfig

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

updateData

updateData(...traitData: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]): Promise<boolean>
This function handles updating json fields. Most likely will be deprecated soon.
Parameters
- Rest ...traitData: [datasourceWrapper: DataSourceWrapper, data: TraitDataObject<any, any, Promise<any>>]
  
  The trait data object
Returns Promise<boolean>
- Defined in src/traits/JsonContentTrait.ts:566

updateMutationName

updateMutationName(schemaItemName: string, field: JsonContentTraitConfigField): string
Parameters
- schemaItemName: string
- field: JsonContentTraitConfigField
Returns string
- Defined in src/traits/JsonContentTrait.ts:240

updateRelationshipAfterChangingType

updateRelationshipAfterChangingType(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, context: KosmosUserContext<object>, entity: EntityObject, newSchemaName: string): Promise<void>
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- context: KosmosUserContext<object>
- entity: EntityObject
- newSchemaName: string
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:1000

updateVertexField

updateVertexField(traitData: any, fieldName: string): Promise<void>
Helper function for updating vertex field.
Parameters
- traitData: any
- fieldName: string
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:537

`Private` validateDisabledRelations

validateDisabledRelations(args: Record<string, any>, disabledRelations: TheItemsSchema[]): void
Throws error when query arguments contain forbidden relations
Parameters
- args: Record<string, any>
- disabledRelations: TheItemsSchema[]
  
  list of disabled relations
Returns void
- Defined in src/traits/JsonContentTrait.ts:1124

validateEntityBeforeCreate

validateEntityBeforeCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, context: KosmosUserContext<object>): Promise<void>
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:657

validateJsonData

validateJsonData(context: KosmosUserContext<object>, schemaName: string, data: ItemWithId): Promise<void>
This function is used to validate json which has been string encoded against a defined schema.
Parameters
- context: KosmosUserContext<object>
  
  The users context
- schemaName: string
- data: ItemWithId
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:750

validateJsonFieldsBeforeUpdate

validateJsonFieldsBeforeUpdate(originalItem: EntityObject, data: Record<string, any>, context: KosmosUserContext<object>): Promise<void>
Parameters
- originalItem: EntityObject
- data: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:714

`Private` validateRelationsBeforeCreate

validateRelationsBeforeCreate(args: Record<string, any>, target: string, context: KosmosUserContext<object>): Promise<void>
Throws error when query arguments contain forbidden relations or don't contain required
Parameters
- args: Record<string, any>
- target: string
- context: KosmosUserContext<object>
  
  user context
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:1074

`Private` validateRelationsBeforeUpdate

validateRelationsBeforeUpdate(originalItem: EntityObject, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: Record<string, any>, context: KosmosUserContext<object>): Promise<void>
Throws error when query arguments contain forbidden relations
Parameters
- originalItem: EntityObject
  
  item to update
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  trait data
- data: Record<string, any>
- context: KosmosUserContext<object>
  
  user context
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:1102

validateRelationshipModification

validateRelationshipModification(relation: RelationshipData, entityType: string, entityId: string, modificationType: "remove" | "create", context: KosmosUserContext<object>, inverse?: boolean): Promise<void>
Throws error when relation isn't valid
Parameters
- relation: RelationshipData
  
  relation to create / remove
- entityType: string
  
  entity type to validate
- entityId: string
  
  entity id to validate
- modificationType: "remove" | "create"
  
  action with edge
- context: KosmosUserContext<object>
  
  user context
- inverse: boolean = false
Returns Promise<void>
- Defined in src/traits/JsonContentTrait.ts:929

`Private` validateRequiredRelations

validateRequiredRelations(args: Record<string, any>, requiredRelations: TheItemsSchema[]): void
Throws error when query arguments don't contain all required relations
Parameters
- args: Record<string, any>
- requiredRelations: TheItemsSchema[]
Returns void
- Defined in src/traits/JsonContentTrait.ts:1147

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/JsonContentTrait.ts:157

Class JsonContentTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_graphqlSchemaManager: GraphQLSchemaManager

_dataSourceWrapper: DataSourceWrapper

_jsonContentSchemaManager: JsonContentSchemaManager

_validatorFactory: (() => KosmosSchemaValidator)

Returns KosmosSchemaValidator

_externalStorageManager: ExternalStorageManager

_schemaManager: SchemaManager

Returns JsonContentTrait

Properties

Protected Optional _config

Protected Readonly _dataSourceWrapper

Protected Readonly _externalStorageManager

Protected _global

Protected Readonly _graphqlSchemaManager

Protected Readonly _jsonContentSchemaManager

Protected _mutationFields

Protected _retainRevisions

Protected Readonly _schemaManager

Protected _storageEngine

Protected Optional _type

Protected Readonly _validatorFactory

Type declaration

Returns KosmosSchemaValidator

Methods

_connectWithSchema

Parameters

context: KosmosUserContext<object>

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

item: ItemWithId

schema: EntityObject

Returns Promise<Record<string, any>>

_disconnectFromSchema

Parameters

context: KosmosUserContext<object>

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

item: ItemWithId

Returns Promise<{ done: boolean; value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>; } | IteratorResult<ItemWithIdAndLabel, any>>

_getJSONTypes

Returns

Returns string[]

_getTraitStorage

Parameters

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

Returns JsonContentTraitStorage

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

jsonHandler

Parameters

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

Returns Promise<string>

loadEntity

Returns

Parameters

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

Returns Promise<null | EntityObject>

Private loadSchemas

Parameters

context: KosmosUserContext<object>

Optional data: Record<string, any>

Optional originalItem: null | EntityObject

Returns Promise<KosmosSchema[]>

makeGlobal

Returns JsonContentTrait

mutationSchema

Returns

Parameters

schemaString: string

`Protected` `Optional` _config

`Protected` `Readonly` _dataSourceWrapper

`Protected` `Readonly` _externalStorageManager

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` `Readonly` _jsonContentSchemaManager

`Protected` _mutationFields

`Protected` _retainRevisions

`Protected` `Readonly` _schemaManager

`Protected` _storageEngine

`Protected` `Optional` _type

`Protected` `Readonly` _validatorFactory

Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
} | IteratorResult<ItemWithIdAndLabel, any>>

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

`Private` loadSchemas

`Optional` data: Record<string, any>

`Optional` originalItem: null | EntityObject