Class GraphQLUpdateHandler

UpdateHandler plugin for GraphQL. Runs the specified mutation with the specified variables, with the credentials of the service user.

Hierarchy

UpdateHandler
- GraphQLUpdateHandler

Index

Constructors

constructor

new GraphQLUpdateHandler(config: RuntimeConfig, dataSourceWrapper: DataSourceWrapper, clientFactory: (() => GraphQLClientInterface)): GraphQLUpdateHandler
Parameters
- config: RuntimeConfig
- dataSourceWrapper: DataSourceWrapper
- clientFactory: (() => GraphQLClientInterface)
  - - (): GraphQLClientInterface
    - Returns GraphQLClientInterface
Returns GraphQLUpdateHandler
Overrides UpdateHandler.constructor
- Defined in src/updates/GraphQLUpdateHandler.ts:23

Properties

`Private` client

client: GraphQLClientInterface

`Protected` config

config: RuntimeConfig

`Protected` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

Methods

execute

execute(entityId: string, context: any, params: any, config: ManagedUpdatesTraitConfig): Promise<any>
Execute the handler.
Parameters
- entityId: string
- context: any
- params: any
- config: ManagedUpdatesTraitConfig
Returns Promise<any>
Overrides UpdateHandler.execute
- Defined in src/updates/GraphQLUpdateHandler.ts:77

`Private` getActualId

getActualId(entityId: string, definition: IdDefinition, config: ManagedUpdatesTraitConfig, context: KosmosUserContext<object>): Promise<any>
Returns id that described in config.

If definition.vertex is equal to vertex - returns entity id. If definition.vertex is not equal to vertex - executes following gremlin query:

g.V({entityId}).out().hasLabel(definition.vertex).has({machine_name}, {definition.value})
Parameters
- entityId: string
  
  id of entity to update
- definition: IdDefinition
  
  definition of id from script
- config: ManagedUpdatesTraitConfig
  
  vertex trait config
- context: KosmosUserContext<object>
  
  user context
Returns Promise<any>
- Defined in src/updates/GraphQLUpdateHandler.ts:125

getSchema

getSchema(): {
    additionalProperties: boolean;
    id: string;
    properties: {
        id: {
            properties: {
                value: {
                    type: string;
                };
                vertex: {
                    type: string;
                };
            };
            type: string;
        };
        mutation: {
            type: string;
        };
        variables: {
            additionalProperties: {
                type: string[];
            };
        };
    };
    required: string[];
    type: string;
}
This method should return handler's schema.

Returns {
    additionalProperties: boolean;
    id: string;
    properties: {
        id: {
            properties: {
                value: {
                    type: string;
                };
                vertex: {
                    type: string;
                };
            };
            type: string;
        };
        mutation: {
            type: string;
        };
        variables: {
            additionalProperties: {
                type: string[];
            };
        };
    };
    required: string[];
    type: string;
}
- additionalProperties: boolean
- id: string
- properties: {
      id: {
          properties: {
              value: {
                  type: string;
              };
              vertex: {
                  type: string;
              };
          };
          type: string;
      };
      mutation: {
          type: string;
      };
      variables: {
          additionalProperties: {
              type: string[];
          };
      };
  }
  - id: {
        properties: {
            value: {
                type: string;
            };
            vertex: {
                type: string;
            };
        };
        type: string;
    }
    - properties: {
          value: {
              type: string;
          };
          vertex: {
              type: string;
          };
      }
      - value: {
        type: string;
        }
        
        type: string
      - vertex: {
        type: string;
        }
        
        type: string
    - type: string
  - mutation: {
    type: string;
    }
    - type: string
  - variables: {
        additionalProperties: {
            type: string[];
        };
    }
    - additionalProperties: {
      type: string[];
      }
      - type: string[]
- required: string[]
- type: string
Overrides UpdateHandler.getSchema
- Defined in src/updates/GraphQLUpdateHandler.ts:42

`Static` getName

getName(): string
This method should return handler's machine name.

Returns string
Overrides UpdateHandler.getName
- Defined in src/updates/GraphQLUpdateHandler.ts:35

Class GraphQLUpdateHandler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: RuntimeConfig

dataSourceWrapper: DataSourceWrapper

clientFactory: (() => GraphQLClientInterface)

Returns GraphQLClientInterface

Returns GraphQLUpdateHandler

Properties

Private client

Protected config

Protected dataSourceWrapper

Methods

execute

Parameters

entityId: string

context: any

params: any

config: ManagedUpdatesTraitConfig

Returns Promise<any>

Private getActualId

Parameters

entityId: string

definition: IdDefinition

config: ManagedUpdatesTraitConfig

context: KosmosUserContext<object>

Returns Promise<any>

getSchema

Returns { additionalProperties: boolean; id: string; properties: { id: { properties: { value: { type: string; }; vertex: { type: string; }; }; type: string; }; mutation: { type: string; }; variables: { additionalProperties: { type: string[]; }; }; }; required: string[]; type: string; }

additionalProperties: boolean

id: string

properties: { id: { properties: { value: { type: string; }; vertex: { type: string; }; }; type: string; }; mutation: { type: string; }; variables: { additionalProperties: { type: string[]; }; }; }

id: { properties: { value: { type: string; }; vertex: { type: string; }; }; type: string; }

properties: { value: { type: string; }; vertex: { type: string; }; }

value: { type: string; }

type: string

vertex: { type: string; }

type: string

type: string

mutation: { type: string; }

type: string

variables: { additionalProperties: { type: string[]; }; }

additionalProperties: { type: string[]; }

type: string[]

required: string[]

type: string

Static getName

Returns string

Settings

Member Visibility

Theme

`Private` client

`Protected` config

`Protected` dataSourceWrapper

`Private` getActualId

Returns {
additionalProperties: boolean;
id: string;
properties: {
id: {
properties: {
value: {
type: string;
};
vertex: {
type: string;
};
};
type: string;
};
mutation: {
type: string;
};
variables: {
additionalProperties: {
type: string[];
};
};
};
required: string[];
type: string;
}

properties: {
id: {
properties: {
value: {
type: string;
};
vertex: {
type: string;
};
};
type: string;
};
mutation: {
type: string;
};
variables: {
additionalProperties: {
type: string[];
};
};
}

id: {
properties: {
value: {
type: string;
};
vertex: {
type: string;
};
};
type: string;
}

properties: {
value: {
type: string;
};
vertex: {
type: string;
};
}

value: {
type: string;
}

vertex: {
type: string;
}

mutation: {
type: string;
}

variables: {
additionalProperties: {
type: string[];
};
}

additionalProperties: {
type: string[];
}

`Static` getName