Interface IWorkflowStore

Interface implemented by persistence layers capable of storing workflow state.

interface IWorkflowStore {
    createInstance(data, initialTasks): Promise<WorkflowInstance>;
    getInstance(workflowId): Promise<null | WorkflowInstance>;
    updateInstance(workflowId, patch): Promise<null | WorkflowInstance>;
    updateTasks(workflowId, updates): Promise<null | WorkflowInstance>;
    appendEvents(events): Promise<void>;
    listInstances(options?): Promise<WorkflowInstance[]>;
    buildProgressUpdate(workflowId, sinceTimestamp?): Promise<null | WorkflowProgressUpdate>;
}

Implemented by

InMemoryWorkflowStore

Index

Methods

createInstance getInstance updateInstance updateTasks appendEvents listInstances buildProgressUpdate

Methods

createInstance

createInstance(data, initialTasks): Promise<WorkflowInstance>
Persists a newly created workflow instance and its initial tasks snapshot.
Parameters
- data: WorkflowCreateInput
- initialTasks: Record<string, WorkflowTaskInstance>
Returns Promise<WorkflowInstance>
- Defined in core/workflows/storage/IWorkflowStore.ts:59

getInstance

getInstance(workflowId): Promise<null | WorkflowInstance>
Retrieves a workflow instance by identifier.
Parameters
- workflowId: string
Returns Promise<null | WorkflowInstance>
- Defined in core/workflows/storage/IWorkflowStore.ts:67

updateInstance

updateInstance(workflowId, patch): Promise<null | WorkflowInstance>
Applies a partial update to the workflow instance metadata/state.
Parameters
- workflowId: string
- patch: Partial<Pick<WorkflowInstance, "agencyState" | "status" | "updatedAt" | "metadata" | "context" | "roleAssignments">>
Returns Promise<null | WorkflowInstance>
- Defined in core/workflows/storage/IWorkflowStore.ts:72

updateTasks

updateTasks(workflowId, updates): Promise<null | WorkflowInstance>
Applies updates to one or more tasks within a workflow instance atomically.
Parameters
- workflowId: string
- updates: WorkflowTaskUpdate[]
Returns Promise<null | WorkflowInstance>
- Defined in core/workflows/storage/IWorkflowStore.ts:85

appendEvents

appendEvents(events): Promise<void>
Appends workflow events for auditing/streaming purposes.
Parameters
- events: WorkflowEvent[]
Returns Promise<void>
- Defined in core/workflows/storage/IWorkflowStore.ts:90

listInstances

listInstances(options?): Promise<WorkflowInstance[]>
Lists workflow instances matching the supplied filters.
Parameters
- Optional options: WorkflowQueryOptions
Returns Promise<WorkflowInstance[]>
- Defined in core/workflows/storage/IWorkflowStore.ts:95

buildProgressUpdate

buildProgressUpdate(workflowId, sinceTimestamp?): Promise<null | WorkflowProgressUpdate>
Produces a payload representing the current workflow snapshot and optionally recent events.
Parameters
- workflowId: string
- Optional sinceTimestamp: string
Returns Promise<null | WorkflowProgressUpdate>
- Defined in core/workflows/storage/IWorkflowStore.ts:100