workflow / Exports / WorkflowPlugin
Interface: WorkflowPlugin
Core workflow plugin interface
Hierarchy
WorkflowPlugin
Table of contents
Properties
- name
- version
- description
- config
- beforeNodeCreate
- afterNodeCreate
- beforeNodeUpdate
- afterNodeUpdate
- beforeNodeDelete
- afterNodeDelete
- beforeEdgeCreate
- afterEdgeCreate
- beforeEdgeUpdate
- afterEdgeUpdate
- beforeEdgeDelete
- afterEdgeDelete
- beforeSnapshot
- afterSnapshot
- initialize
- configure
- destroy
- getCapabilities
- healthCheck
Properties
name
• Readonly name: string
Plugin identification
Defined in
interfaces/workflow-plugin.ts:81
version
• Readonly version: string
Defined in
interfaces/workflow-plugin.ts:82
description
• Readonly description: string
Defined in
interfaces/workflow-plugin.ts:83
config
• config: PluginConfig
Plugin configuration
Defined in
interfaces/workflow-plugin.ts:88
beforeNodeCreate
• Optional beforeNodeCreate: PluginHookHandler<WorkflowNode, WorkflowNode>
Lifecycle hooks (all optional)
Defined in
interfaces/workflow-plugin.ts:93
afterNodeCreate
• Optional afterNodeCreate: PluginHookHandler<WorkflowNode, void>
Defined in
interfaces/workflow-plugin.ts:94
beforeNodeUpdate
• Optional beforeNodeUpdate: PluginHookHandler<{ node: WorkflowNode ; updates: Partial<WorkflowNode> }, Partial<WorkflowNode>>
Defined in
interfaces/workflow-plugin.ts:95
afterNodeUpdate
• Optional afterNodeUpdate: PluginHookHandler<{ oldNode: WorkflowNode ; newNode: WorkflowNode }, void>
Defined in
interfaces/workflow-plugin.ts:96
beforeNodeDelete
• Optional beforeNodeDelete: PluginHookHandler<WorkflowNode, boolean>
Defined in
interfaces/workflow-plugin.ts:97
afterNodeDelete
• Optional afterNodeDelete: PluginHookHandler<WorkflowNode, void>
Defined in
interfaces/workflow-plugin.ts:98
beforeEdgeCreate
• Optional beforeEdgeCreate: PluginHookHandler<WorkflowEdge, WorkflowEdge>
Defined in
interfaces/workflow-plugin.ts:100
afterEdgeCreate
• Optional afterEdgeCreate: PluginHookHandler<WorkflowEdge, void>
Defined in
interfaces/workflow-plugin.ts:101
beforeEdgeUpdate
• Optional beforeEdgeUpdate: PluginHookHandler<{ edge: WorkflowEdge ; updates: Partial<WorkflowEdge> }, Partial<WorkflowEdge>>
Defined in
interfaces/workflow-plugin.ts:102
afterEdgeUpdate
• Optional afterEdgeUpdate: PluginHookHandler<{ oldEdge: WorkflowEdge ; newEdge: WorkflowEdge }, void>
Defined in
interfaces/workflow-plugin.ts:103
beforeEdgeDelete
• Optional beforeEdgeDelete: PluginHookHandler<WorkflowEdge, boolean>
Defined in
interfaces/workflow-plugin.ts:104
afterEdgeDelete
• Optional afterEdgeDelete: PluginHookHandler<WorkflowEdge, void>
Defined in
interfaces/workflow-plugin.ts:105
beforeSnapshot
• Optional beforeSnapshot: PluginHookHandler<WorkflowSnapshot, WorkflowSnapshot>
Defined in
interfaces/workflow-plugin.ts:107
afterSnapshot
• Optional afterSnapshot: PluginHookHandler<WorkflowSnapshot, void>
Defined in
interfaces/workflow-plugin.ts:108
initialize
• Optional initialize: (context: PluginContext) => void | Promise<void>
Plugin lifecycle methods
Type declaration
▸ (context): void | Promise<void>
Parameters
| Name | Type |
|---|---|
context | PluginContext |
Returns
void | Promise<void>
Defined in
interfaces/workflow-plugin.ts:113
configure
• Optional configure: (config: PluginConfig) => void
Type declaration
▸ (config): void
Parameters
| Name | Type |
|---|---|
config | PluginConfig |
Returns
void
Defined in
interfaces/workflow-plugin.ts:114
destroy
• Optional destroy: () => void | Promise<void>
Type declaration
▸ (): void | Promise<void>
Returns
void | Promise<void>
Defined in
interfaces/workflow-plugin.ts:115
getCapabilities
• Optional getCapabilities: () => { providesNodes?: string[] ; providesEdges?: string[] ; modifiesNodes?: string[] ; modifiesEdges?: string[] }
Plugin capabilities
Type declaration
▸ (): Object
Returns
Object
| Name | Type |
|---|---|
providesNodes? | string[] |
providesEdges? | string[] |
modifiesNodes? | string[] |
modifiesEdges? | string[] |
Defined in
interfaces/workflow-plugin.ts:120
healthCheck
• Optional healthCheck: () => Promise<{ healthy: boolean ; message?: string ; details?: Record<string, unknown> }>
Plugin health check
Type declaration
▸ (): Promise<{ healthy: boolean ; message?: string ; details?: Record<string, unknown> }>
Returns
Promise<{ healthy: boolean ; message?: string ; details?: Record<string, unknown> }>