Class GraphQLSchemaManager

Hierarchy

GraphQLSchemaManager

Index

Constructors

constructor

Properties

_graphQlSchemaStringPromise? _resolveManagers graphQlSchemaHooks schemaManager

Constructors

constructor

new GraphQLSchemaManager(schemaManager: SchemaManager, _resolveManagers: ResolverManager[]): GraphQLSchemaManager
Parameters
- schemaManager: SchemaManager
- _resolveManagers: ResolverManager[]
Returns GraphQLSchemaManager
- Defined in src/graphql/GraphQLSchemaManager.ts:48

Properties

`Protected` `Optional` _graphQlSchemaStringPromise

_graphQlSchemaStringPromise?: Promise<string>

`Protected` _resolveManagers

_resolveManagers: ResolverManager[]

graphQlSchemaHooks

graphQlSchemaHooks: GraphQlSchemaHooks

`Protected` `Readonly` schemaManager

schemaManager: SchemaManager

Methods

_appendLine

_appendLine(data: string): string
Parameters
- data: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:278

_getGraphQLCreateMutationSchemaString

_getGraphQLCreateMutationSchemaString(item: string): string
Generates Create mutation schema string for a given entity type.
Parameters
- item: string
  
  Entity type name.
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:407

_getGraphQLDeleteMutationSchemaString

_getGraphQLDeleteMutationSchemaString(item: string): string
Generates Delete mutation schema string for a given entity type.
Parameters
- item: string
  
  Entity type name.
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:370

_getGraphQLForTraits

_getGraphQLForTraits(item: string, type: TraitHandlerType, extraData?: string): string
This method is the internal class method called by getGraphQLQueriesForTraits() and getGraphQLMutationsForTraits() it is used to process the traits for both the Vertex's and the Edges/Relationships
Parameters
- item: string
- type: TraitHandlerType
- Optional extraData: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:495

_getGraphQLUpdateMutationSchemaString

_getGraphQLUpdateMutationSchemaString(item: string): string
Generates Update mutation schema string for a given entity type.
Parameters
- item: string
  
  Entity type name.
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:428

_getRelationshipsProperties

_getRelationshipsProperties(entityTypeName: string, actions: RelationshipAction[], optionalArguments?: boolean): string
Returns a list of relationships exposed as GraphQL mutation arguments.
Parameters
- entityTypeName: string
  
  Entity type name.
- actions: RelationshipAction[]
  
  The relationship actions to be executed.
- optionalArguments: boolean = false
  
  Make all arguments optional. Useful for Update mutations.
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:562

`Protected` _getSchemaProperties

_getSchemaProperties(schemaItem: SchemaItem<SchemaItemType>, __namedParameters: GetSchemaPropertiesParams): string
This method is used to generate a list of properties for a schema item.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
  
  Schema item object
- __namedParameters: GetSchemaPropertiesParams
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:612

_includeComma

_includeComma(flag: boolean): "" | ","
Parameters
- flag: boolean
Returns "" | ","
- Defined in src/graphql/GraphQLSchemaManager.ts:1004

_processRelationshipsFor

_processRelationshipsFor(sourceVertexName: string): string
Process the relationship for a specified vertex.

TODO KBN-308: Filter out properties which shouldn't be listed. TODO https://io1dev.atlassian.net/browse/KBN-308

Returns
GraphQL fragment
Parameters
- sourceVertexName: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:805

_processRelationshipsIn

_processRelationshipsIn(edge: TheItemsSchema): string
This function is to handle the incoming edges to a vertex we are check if the inverse has been set and if it needs to be included in the graphql vertex

TODO KBN-308 Implement excluding connections listing TODO https://io1dev.atlassian.net/browse/KBN-308
Parameters
- edge: TheItemsSchema
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:1016

_processRelationshipsOut

_processRelationshipsOut(edge: TheItemsSchema, inline?: boolean): string
Process a vertexs defined outgoing edges called by _processRelationshipsFor()

TODO KBN-308 Implement excluding connections listing TODO https://io1dev.atlassian.net/browse/KBN-308

Returns
GraphQL fragment
Parameters
- edge: TheItemsSchema
- inline: boolean = false
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:865

_relationshipRequired

_relationshipRequired(relationship: VertexRelationship): boolean
Checks if given relationship should be required in GraphQL mutation schema.
Parameters
- relationship: VertexRelationship
Returns boolean
- Defined in src/graphql/GraphQLSchemaManager.ts:382

`Private` buildGraphQLResolvers

buildGraphQLResolvers(): Promise<IResolvers<any, any, Record<string, any>, any>>
Private
Builds GraphQL resolvers for fields defined in schema.

Returns
An object containing GraphQL fields resolvers.

Returns Promise<IResolvers<any, any, Record<string, any>, any>>
- Defined in src/graphql/GraphQLSchemaManager.ts:179

generateGraphQLSchemaString

generateGraphQLSchemaString(): Promise<string>
This method is used to generate the GraphQL schema.

Returns Promise<string>
- Defined in src/graphql/GraphQLSchemaManager.ts:95

getConnectionForMany

getConnectionForMany(edge: TheItemsSchema, inline: boolean): string
Parameters
- edge: TheItemsSchema
- inline: boolean
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:960

getEdge

getEdge(edgeName: string): string
Parameters
- edgeName: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:283

getGlobalGraphQLEnums

getGlobalGraphQLEnums(): Promise<string>
Returns Promise<string>
- Defined in src/graphql/GraphQLSchemaManager.ts:208

getGraphQLConnectionEdges

getGraphQLConnectionEdges(): string
This method is used to include all the dynamically defined Connections and their corresponding edges.

Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:302

getGraphQLMutationsForTraits

getGraphQLMutationsForTraits(item: string, mutationsData: string): string
This method is used to generate the required Mutations Schema data for Traits
Parameters
- item: string
  
  This is the name of the Vertexs whos outgoing relationships the trait schema is generated for.
- mutationsData: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:486

getGraphQLMutationsForVertex

getGraphQLMutationsForVertex(item: string): string
This method is used to generate the GraphQL Mutations schema string required for the defined entity.
Parameters
- item: string
  
  Entity type name.
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:342

getGraphQLQueriesForTraits

getGraphQLQueriesForTraits(item: string, type?: TraitHandlerType): string
This method is used to generate the required Query Schema data for Traits
Parameters
- item: string
  
  This is the name of the Vertex that the trait schema is generated for
- type: TraitHandlerType = 'query'
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:467

getGraphQLQueriesForVertex

getGraphQLQueriesForVertex(item: string): string
This method is used to generate the Queries required for the entity for the GraphQL definition.

Returns
GraphQL fragment
Parameters
- item: string
  
  Vertex name
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:720

getGraphQLSchemaForVertex

getGraphQLSchemaForVertex(item: string): string
This method is used to generate the GraphQL schema for an entity.

Returns
GraphQL fragment
Parameters
- item: string
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:746

getGraphQLType

getGraphQLType(type: JsonSchemaItemType, list?: boolean, required?: boolean): string
This method is used to convert from a jsonschema type to a graphql schema
Parameters
- type: JsonSchemaItemType
- list: boolean = false
- required: boolean = false
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:69

getGraphQLTypesForTraits

getGraphQLTypesForTraits(): Promise<string>
Traits can have GraphQL type which they can define as part of generating the GraphQL schema a check is made against the active traits which have been defined. Each trait will be processed only once.

Returns
Additional types defined by traits.

Returns Promise<string>
- Defined in src/graphql/GraphQLSchemaManager.ts:261

getGraphQLUnionsSchemaString

getGraphQLUnionsSchemaString(): string
This methods loads all the unions that were loaded to GraphQL

Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:270

getGraphQLVertexForTraits

getGraphQLVertexForTraits(item: string, type?: TraitHandlerType): string
This method is used to generate the required Query Schema data for Traits
Parameters
- item: string
  
  This is the name of the Vertex that the trait schema is generated for
- type: TraitHandlerType = 'vertex'
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:457

getGraphQLVertexQueriesForTraits

getGraphQLVertexQueriesForTraits(item: string): string
This method is used to generate the required Vertex Schema data for Traits
Parameters
- item: string
  
  This is the name of the Vertex that the trait schema is generated for
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:476

getInverseConnectionForMany

getInverseConnectionForMany(edge: TheItemsSchema, inline: boolean): string
Parameters
- edge: TheItemsSchema
- inline: boolean
Returns string
- Defined in src/graphql/GraphQLSchemaManager.ts:907

getInverseRelationshipsFor

getInverseRelationshipsFor(sourceVertexName: string): void
Used only for debugging purposes
Parameters
- sourceVertexName: string
Returns void
- Defined in src/graphql/GraphQLSchemaManager.ts:1085

getRelationshipsFor

getRelationshipsFor(sourceVertexName: string): void
Used only for debugging purposes
Parameters
- sourceVertexName: string
Returns void
- Defined in src/graphql/GraphQLSchemaManager.ts:1071

tapHooks

tapHooks(): void
Returns void
- Defined in src/graphql/GraphQLSchemaManager.ts:61

Class GraphQLSchemaManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

schemaManager: SchemaManager

_resolveManagers: ResolverManager[]

Returns GraphQLSchemaManager

Properties

Protected Optional _graphQlSchemaStringPromise

Protected _resolveManagers

graphQlSchemaHooks

Protected Readonly schemaManager

Methods

_appendLine

Parameters

data: string

Returns string

_getGraphQLCreateMutationSchemaString

Parameters

item: string

Returns string

_getGraphQLDeleteMutationSchemaString

Parameters

item: string

Returns string

_getGraphQLForTraits

Parameters

item: string

type: TraitHandlerType

Optional extraData: string

Returns string

_getGraphQLUpdateMutationSchemaString

Parameters

item: string

Returns string

_getRelationshipsProperties

Parameters

entityTypeName: string

actions: RelationshipAction[]

optionalArguments: boolean = false

Returns string

Protected _getSchemaProperties

Parameters

schemaItem: SchemaItem<SchemaItemType>

__namedParameters: GetSchemaPropertiesParams

Returns string

_includeComma

Parameters

flag: boolean

Returns "" | ","

_processRelationshipsFor

Returns

Parameters

sourceVertexName: string

Returns string

_processRelationshipsIn

Parameters

edge: TheItemsSchema

Returns string

_processRelationshipsOut

Returns

Parameters

edge: TheItemsSchema

inline: boolean = false

Returns string

_relationshipRequired

Parameters

relationship: VertexRelationship

Returns boolean

Private buildGraphQLResolvers

Returns

Returns Promise<IResolvers<any, any, Record<string, any>, any>>

generateGraphQLSchemaString

Returns Promise<string>

getConnectionForMany

`Protected` `Optional` _graphQlSchemaStringPromise

`Protected` _resolveManagers

`Protected` `Readonly` schemaManager

`Optional` extraData: string

`Protected` _getSchemaProperties

`Private` buildGraphQLResolvers