Class BulkOperationTrait

Bulk Operation Trait adds global GraphQL interface interface for bulk operation usage Usage:

traits:
  - type: bulk_operation

Provides global mutation bulkOperation that triggers related step machine

Hierarchy

Trait<BulkOperationTraitConfig>
- BulkOperationTrait

Constructors

constructor

new BulkOperationTrait(graphqlSchemaManager: GraphQLSchemaManager, stepFunctionsClient: StepFunctions, config: RuntimeConfig, baseDirectory: string): BulkOperationTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- stepFunctionsClient: StepFunctions
- config: RuntimeConfig
- baseDirectory: string
Returns BulkOperationTrait
Overrides Trait.constructor
- Defined in src/traits/BulkOperationTrait.ts:53

Properties

`Protected` `Optional` _config

_config?: BulkOperationTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Protected` `Optional` _type

_type?: "bulk_operation"

Trait type.

`Private` baseDirectory

baseDirectory: string

`Protected` config

config: RuntimeConfig

`Private` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

logger

logger: Logger

`Protected` stepFunctionsClient

stepFunctionsClient: StepFunctions

`Static` schemaModified

schemaModified: boolean = false

Methods

bulkOperation

bulkOperation(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<string>
GraphQL mutation resolver to mark a message as read or unread.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<string>
- Defined in src/traits/BulkOperationTrait.ts:73

bulkOperationStatus

bulkOperationStatus(_parent: unknown, args: Record<string, any>): Promise<BulkOperationStatus>
Retrieves the status of a bulk operation.

Async

Returns
A promise that resolves to an object representing the status of the bulk operation.

Throws
Throws an error if the JWT secret is not configured, if the JWT verification fails, or if there is an error retrieving the operation status.
Parameters
- _parent: unknown
  
  The parent object. This is a standard parameter in GraphQL resolvers.
- args: Record<string, any>
  
  An object containing the arguments passed to the function.
Returns Promise<BulkOperationStatus>
- Defined in src/traits/BulkOperationTrait.ts:146

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/BulkOperationTrait.ts:241

hookIntoSchemaManager

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

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

`Private` loadOperation

loadOperation(operationName: string): Promise<Operation>
Load and validate the GraphQL mutation for a predefined bulk operation.

Returns
An Operation object representing loaded operation.

Throws
An Error if the operation cannot be loaded and validated.
Parameters
- operationName: string
  
  The name of the predefined bulk operation to load.
Returns Promise<Operation>
- Defined in src/traits/BulkOperationTrait.ts:289

makeGlobal

makeGlobal(): BulkOperationTrait
Makes this Trait instance global.

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

mutationSchema

mutationSchema(schemaString: string): string
This is where any GraphQL mutations entries that are required by the trait are added.

Returns
The GraphQL schema string, including our additions.
Parameters
- schemaString: string
  
  The original GraphQL schema string.
Returns string
- Defined in src/traits/BulkOperationTrait.ts:201

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

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

querySchemaGlobal

querySchemaGlobal(schemaString: string): string
This is where any GraphQL mutations entries that are required by the trait are added.

Returns
The GraphQL schema string, including our additions.
Parameters
- schemaString: string
  
  The original GraphQL schema string.
Returns string
- Defined in src/traits/BulkOperationTrait.ts:223

setConfig

setConfig(config: BulkOperationTraitConfig): void
Configuration setter.
Parameters
- config: BulkOperationTraitConfig
  
  The new configuration.
Returns void
Inherited from Trait.setConfig
- Defined in src/traits/Trait.ts:124

traitConfig

traitConfig(): BulkOperationTraitConfig
Returns BulkOperationTraitConfig
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/BulkOperationTrait.ts:66

Class BulkOperationTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

stepFunctionsClient: StepFunctions

config: RuntimeConfig

baseDirectory: string

Returns BulkOperationTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Private baseDirectory

Protected config

Private graphqlSchemaManager

logger

Protected stepFunctionsClient

Static schemaModified

Methods

bulkOperation

Parameters

_parent: unknown

args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<string>

bulkOperationStatus

Async

Returns

Throws

Parameters

_parent: unknown

args: Record<string, any>

Returns Promise<BulkOperationStatus>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

Private loadOperation

Returns

Throws

Parameters

operationName: string

Returns Promise<Operation>

makeGlobal

Returns BulkOperationTrait

mutationSchema

Returns

Parameters

schemaString: string

Returns string

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

querySchemaGlobal

Returns

Parameters

schemaString: string

Returns string

setConfig

Parameters

config: BulkOperationTraitConfig

Returns void

traitConfig

Returns BulkOperationTraitConfig

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Private` baseDirectory

`Protected` config

`Private` graphqlSchemaManager

`Protected` stepFunctionsClient

`Static` schemaModified

`Private` loadOperation

`Optional` callbackName: string

`Static` traitTypeName