@medusajs/orchestration
v2.22.7
Published
Medusa utilities to orchestrate modules
Keywords
Readme
Low-level transaction orchestration for Medusa: the engine that executes workflow steps, tracks their state, and runs compensation when a step fails. It powers the Workflows SDK and the Workflow Engine modules; to build workflows, use @medusajs/framework/workflows-sdk instead. When you need its classes or types directly, such as when building a custom workflow engine, import them from @medusajs/framework/orchestration, which re-exports this package; importing @medusajs/orchestration directly is discouraged.
At a glance
| | |
| --- | --- |
| Package | @medusajs/orchestration |
| Type | Core library |
| Import from | @medusajs/framework/orchestration |
Features
TransactionOrchestratorandDistributedTransactionto run a flow of steps and track its state.LocalWorkflow,GlobalWorkflow, andWorkflowManagerto register and run workflow definitions.DistributedTransactionStorageandDistributedSchedulerStorageabstract classes that workflow engines implement to persist executions and scheduled workflows.- Step error classes, such as
PermanentStepFailureErrorandSkipStepResponse, and state enums, such asTransactionState.
Installation
No separate installation is needed in a Medusa application. It's installed with @medusajs/framework.
