Class SchemaManager

SchemaManager class is responsible fo loading registered schemas and to validate data against those schemas.

Hierarchy

SchemaManager

Index

Constructors

Properties

_graphSchema? _namedEdges _onLoadConnectorsCallback? _queriesConnectors? _schemaBase _schemaItemsLoadPromise? _schemaItemsNamesPromise _schemaLoadPromise? _schemaLoaded _schemas _traitFactory _unionSchema? _unionsByName? _v runtimeHooks schemaHooks

Constructors

constructor

new SchemaManager(_schemaBase: string, _traitFactory: TraitFactoryCallback, _v: Validator): SchemaManager
This function is used to load a json schema from the schema directory
Parameters
- _schemaBase: string
- _traitFactory: TraitFactoryCallback
- _v: Validator
Returns SchemaManager
- Defined in src/schema/SchemaManager.ts:175

Properties

`Protected` `Optional` _graphSchema

_graphSchema?: GraphYmlSchema

`Protected` `Readonly` _namedEdges

_namedEdges: NamedEdge[] = []

`Private` `Optional` _onLoadConnectorsCallback

_onLoadConnectorsCallback?: ((connectors: QueryConnector[]) => void)

Type declaration

- (connectors: QueryConnector[]): void
- Parameters
  - connectors: QueryConnector[]
  Returns void

`Private` `Optional` _queriesConnectors

_queriesConnectors?: QueryConnector[]

`Protected` `Readonly` _schemaBase

_schemaBase: string

`Protected` `Optional` _schemaItemsLoadPromise

_schemaItemsLoadPromise?: Promise<void>

`Protected` `Readonly` _schemaItemsNamesPromise

_schemaItemsNamesPromise: Record<SchemaItemType, undefined | Promise<string[]>> = ...

`Protected` `Optional` _schemaLoadPromise

_schemaLoadPromise?: Promise<void>

`Protected` _schemaLoaded

_schemaLoaded: boolean = false

`Protected` `Readonly` _schemas

_schemas: SchemasByName = {}

`Protected` `Readonly` _traitFactory

_traitFactory: TraitFactoryCallback

`Protected` `Optional` _unionSchema

_unionSchema?: SchemaUnion[]

`Private` `Optional` _unionsByName

_unionsByName?: Record<string, SchemaUnion>

`Protected` `Readonly` _v

_v: Validator

runtimeHooks

runtimeHooks: SchemaManagerRuntimeHooks

schemaHooks

schemaHooks: SchemaManagerSchemaHooks

Methods

addNamedEdge

addNamedEdge(edgeName: string, sourceType: string, destinationType: string, name: string, edgeRelationshipName?: string): void
Parameters
- edgeName: string
- sourceType: string
- destinationType: string
- name: string
- Optional edgeRelationshipName: string
Returns void
- Defined in src/schema/SchemaManager.ts:1084

`Private` alterUnions

alterUnions(): void
Allow traits to alter the union schema.

This is not a hook because it needs to be done before the traits are fully initialized and have tapped the hooks.

It iterates over all trait instances on all schemas, and calls traitInstance.alterUnions(type, conf, schemaManager, unions) on each trait instance that has such a method. The pseudo-hook's parameters are documented on the TraitAlterUnions generic interface in Trait.ts.

Returns void
- Defined in src/schema/SchemaManager.ts:290

checkIfVertexPropertyIsRequired

checkIfVertexPropertyIsRequired(type: string, fieldname: string): boolean
This method is used to check if a vertex property is required, this is used by the GraphConnector to check if a property is required before it can be deleted.

Returns
Whether property is required.
Parameters
- type: string
  
  The name of the type
- fieldname: string
  
  The name of the field of the entity.
Returns boolean
- Defined in src/schema/SchemaManager.ts:835

`Protected` checkVertexRelationship

checkVertexRelationship(ownVertexName: string, connector: QueryConnector, direction: "in" | "out"): null | VertexRelationship
Returns vertex relationship for a given query connector.

Example of vertex relationship.

{ vertexName: "Pod", direction: "in/out", relationship: "hasParent", type: "oneToOne", required: true inverse:"", }
Parameters
- ownVertexName: string
  
  An own vertex name.
- connector: QueryConnector
- direction: "in" | "out"
  
  Direction of the edge to the vertex in/out.
Returns null | VertexRelationship
- Defined in src/schema/SchemaManager.ts:983

connectorsLoaded

connectorsLoaded(): Promise<QueryConnector[]>
Returns Promise<QueryConnector[]>
- Defined in src/schema/SchemaManager.ts:498

finalizeSchema

finalizeSchema(): void
Finalizes the schema and properties metadata for all schema items.

TODO: Make this method protected, call it in loadSchemas(). TODO:

See
GraphQLSchemaManager.generateGraphQLSchemaString().

Returns void
- Defined in src/schema/SchemaManager.ts:864

getConnectors

getConnectors(): QueryConnector[]
Returns QueryConnector[]
- Defined in src/schema/SchemaManager.ts:880

getEdgeRelationshipName

getEdgeRelationshipName(edge: TheItemsSchema): string
Parameters
- edge: TheItemsSchema
Returns string
- Defined in src/schema/SchemaManager.ts:890

getGlobalTraits

getGlobalTraits(): Trait<TraitConfigBase<string>>[]
Retrieves a list of static instances of all Traits being used.

Returns Trait<TraitConfigBase<string>>[]
- Defined in src/schema/SchemaManager.ts:210

getGraphSchema

getGraphSchema(): GraphYmlSchema
Returns GraphYmlSchema
- Defined in src/schema/SchemaManager.ts:1033

getNamedEdges

getNamedEdges(): NamedEdge[]
Returns NamedEdge[]
- Defined in src/schema/SchemaManager.ts:1102

getParentDefs

getParentDefs(vertex: string, known?: string[]): ParentsDefinitions
Get all the definitions needed for finding the ancestors of a vertex type.

Returns an object with possible ancestor vertex types as keys, and their parent rule definition arrays as values.
Parameters
- vertex: string
- known: string[] = []
Returns ParentsDefinitions
- Defined in src/schema/SchemaManager.ts:1049

getSchemaItem

getSchemaItem<ItemType>(type: string, strict?: boolean): SchemaItem<ItemType>
Returns previously loaded schema item for a given item type.

TODO: Make this method private, expose separate methods for edge and vertex instead.

Returns
The SchemaItem object.
Type Parameters
- ItemType extends SchemaItemType = SchemaItemType
Parameters
- type: string
  
  Item type.
- strict: boolean = true
  
  throw an error if there is no such schema. Default is true.
Returns SchemaItem<ItemType>
- Defined in src/schema/SchemaManager.ts:763

getSchemaPlural

getSchemaPlural(name: string): string
This method is used to get the plural of a vertex, it checks if one has been defined as part of the definition and if not we add an s
Parameters
- name: string
Returns string
- Defined in src/schema/SchemaManager.ts:906

getSchemaType

getSchemaType(schema_name: string): SchemaItemType
Get the schema type for a schema name.

Returns
The schema type (e.g. 'vertex')
Parameters
- schema_name: string
  
  The schema name (e.g. 'User')
Returns SchemaItemType
- Defined in src/schema/SchemaManager.ts:682

getSchemaUnionTypes

getSchemaUnionTypes(name: string): undefined | [string, ...string[]]
Returns a list of types that a union contains, otherwise undefined

Returns
The types that the union contains
Parameters
- name: string
  
  Name of the union to locate
Returns undefined | [string, ...string[]]
- Defined in src/schema/SchemaManager.ts:781

getSchemaUnions

getSchemaUnions(): SchemaUnion[]
Returns the entries of all unions

Returns SchemaUnion[]
- Defined in src/schema/SchemaManager.ts:795

getVertexRelationships

getVertexRelationships(vertexName: string, include?: "inverse" | "both" | "direct"): VertexRelationship[]
This is used to find the Node relationships required for a node to be created, this is defined in the relationship as requried. see graph.json
Parameters
- vertexName: string
  
  Vertex / entity type label.
- include: "inverse" | "both" | "direct" = 'direct'
  
  Whether to include inverse connections.
Returns VertexRelationship[]
- Defined in src/schema/SchemaManager.ts:917

`Private` initializeTraits

initializeTraits(): void
Initialize traits by calling the initializeTraits() method on each schema.

Returns void
- Defined in src/schema/SchemaManager.ts:330

listEdgeSchemaNames

listEdgeSchemaNames(): Promise<string[]>
Returns a list of the Edge schemas names

Deprecated
use listSchemaItemsNames() instead.

Returns Promise<string[]>
- Defined in src/schema/SchemaManager.ts:539

listEdgesWithTrait

listEdgesWithTrait(name: string): string[]
Retrieves a list of Edges on which a trait is enabled.
Parameters
- name: string
Returns string[]
- Defined in src/schema/SchemaManager.ts:236

listSchemaItemsNames

listSchemaItemsNames(type: SchemaItemType): Promise<string[]>
Returns a list of schema items names.
Parameters
- type: SchemaItemType
Returns Promise<string[]>
- Defined in src/schema/SchemaManager.ts:511

listVertexSchemaNames

listVertexSchemaNames(): Promise<string[]>
Return a list of the vertex schema as and array

Deprecated
use listSchemaItemsNames() instead.

Returns Promise<string[]>
- Defined in src/schema/SchemaManager.ts:530

listVerticesWithTrait

listVerticesWithTrait(name: string): string[]
Retrieves a list of Vertices on which a trait is enabled.
Parameters
- name: string
Returns string[]
- Defined in src/schema/SchemaManager.ts:222

`Protected` loadGraphSchema

loadGraphSchema(): Promise<void>
This method is used to load the graph.yml file from the filesystem.

The graph.yml file contains the allowed vertices and edges/releationships that can be added to the graph. The actual definitions of each vertex are described in a seperate JSON schema file as are the edges/releationships.

Returns Promise<void>
- Defined in src/schema/SchemaManager.ts:341

`Protected` loadQueryConnectors

loadQueryConnectors(): Promise<void>
Returns Promise<void>
- Defined in src/schema/SchemaManager.ts:405

`Private` loadSchema

loadSchema(schema_name: string, schema_type: SchemaItemType): Promise<SchemaItem<SchemaItemType>>
This function is used to load an edge or a vertex schema from the schema directory.
Parameters
- schema_name: string
  
  The name of the schema item to process.
- schema_type: SchemaItemType
  
  The type of the schema file either edge or vertex.
Returns Promise<SchemaItem<SchemaItemType>>
- Defined in src/schema/SchemaManager.ts:552

`Protected` loadSchemaItems

loadSchemaItems(): Promise<void>
Loads schema items.

Returns Promise<void>
- Defined in src/schema/SchemaManager.ts:312

loadSchemas

loadSchemas(): Promise<void>
Loads schemas configuration.

This method should be called to initialize the schema manager.

Returns Promise<void>
- Defined in src/schema/SchemaManager.ts:252

`Protected` loadUnionSchema

loadUnionSchema(): Promise<void>
Returns Promise<void>
- Defined in src/schema/SchemaManager.ts:371

`Private` setSchemaUnions

setSchemaUnions(unionSchema: SchemaUnion[]): void
Set the union schema.

Use this instead of just assigning the property to avoid breaking external references.
Parameters
- unionSchema: SchemaUnion[]
  
  the new union schema
Returns void
- Defined in src/schema/SchemaManager.ts:813

validate

validate(schema_name: string, data: any, schema_type: SchemaItemType, action: SchemaValidationAction): boolean
This method is used to validate json data against a named schema against and schema type.
Parameters
- schema_name: string
  
  Name of the schema to use for the validation.
- data: any
  
  JSON data to be validated
- schema_type: SchemaItemType
  
  The type of schema Edge/schema
- action: SchemaValidationAction
  
  The action to perform.
Returns boolean
- Defined in src/schema/SchemaManager.ts:696

validateEdge

validateEdge(schema_name: string, data: any, action: SchemaValidationAction): boolean
This method is used to validate json data structure against the defined schema for the named edge.

Throws
Error if schema is not valid.
Parameters
- schema_name: string
- data: any
- action: SchemaValidationAction
Returns boolean
- Defined in src/schema/SchemaManager.ts:672

validateVertex

validateVertex(schema_name: string, data: any, action: SchemaValidationAction): boolean
This method is used to validate json data structure against the defined schema for the named vertex.

Throws
Error if schema is not valid.
Parameters
- schema_name: string
- data: any
- action: SchemaValidationAction
Returns boolean
- Defined in src/schema/SchemaManager.ts:653

vertexTypeMatches

vertexTypeMatches(type: string, expected: string): boolean
Checks if given vertex type matches expected vertex or enum schema type.
Parameters
- type: string
  
  vertex type name
- expected: string
  
  expected vertex or union type
Returns boolean
- Defined in src/schema/SchemaManager.ts:850

Class SchemaManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_schemaBase: string

_traitFactory: TraitFactoryCallback

_v: Validator

Returns SchemaManager

Properties

Protected Optional _graphSchema

Protected Readonly _namedEdges

Private Optional _onLoadConnectorsCallback

Type declaration

Parameters

connectors: QueryConnector[]

Returns void

Private Optional _queriesConnectors

Protected Readonly _schemaBase

Protected Optional _schemaItemsLoadPromise

Protected Readonly _schemaItemsNamesPromise

Protected Optional _schemaLoadPromise

Protected _schemaLoaded

Protected Readonly _schemas

Protected Readonly _traitFactory

Protected Optional _unionSchema

Private Optional _unionsByName

Protected Readonly _v

runtimeHooks

schemaHooks

Methods

addNamedEdge

Parameters

edgeName: string

sourceType: string

destinationType: string

name: string

Optional edgeRelationshipName: string

Returns void

Private alterUnions

Returns void

checkIfVertexPropertyIsRequired

Returns

Parameters

type: string

fieldname: string

Returns boolean

Protected checkVertexRelationship

Parameters

ownVertexName: string

connector: QueryConnector

direction: "in" | "out"

Returns null | VertexRelationship

connectorsLoaded

Returns Promise<QueryConnector[]>

finalizeSchema

See

Returns void

getConnectors

Returns QueryConnector[]

getEdgeRelationshipName

Parameters

edge: TheItemsSchema

Returns string

getGlobalTraits

Returns Trait<TraitConfigBase<string>>[]

getGraphSchema

Returns GraphYmlSchema

getNamedEdges

Returns NamedEdge[]

getParentDefs

Parameters

vertex: string

known: string[] = []

Returns ParentsDefinitions

getSchemaItem

`Protected` `Optional` _graphSchema

`Protected` `Readonly` _namedEdges

`Private` `Optional` _onLoadConnectorsCallback

`Private` `Optional` _queriesConnectors

`Protected` `Readonly` _schemaBase

`Protected` `Optional` _schemaItemsLoadPromise

`Protected` `Readonly` _schemaItemsNamesPromise

`Protected` `Optional` _schemaLoadPromise

`Protected` _schemaLoaded

`Protected` `Readonly` _schemas

`Protected` `Readonly` _traitFactory

`Protected` `Optional` _unionSchema

`Private` `Optional` _unionsByName

`Protected` `Readonly` _v

`Optional` edgeRelationshipName: string

`Private` alterUnions

`Protected` checkVertexRelationship

`Private` initializeTraits

`Protected` loadGraphSchema

`Protected` loadQueryConnectors

`Private` loadSchema

`Protected` loadSchemaItems

`Protected` loadUnionSchema

`Private` setSchemaUnions