@8medusa/orchestration 2.7.0

package/dist/workflow/workflow-manager.d.ts

@@ -0,0 +1,38 @@
+import { Context, MedusaContainer } from "@8medusa/types";
+import { DistributedTransactionType, TransactionMetadata, TransactionModelOptions, TransactionOrchestrator, TransactionStep, TransactionStepHandler, TransactionStepsDefinition } from "../transaction";
+export interface WorkflowDefinition {
+    id: string;
+    handler: (container: MedusaContainer, context?: Context) => TransactionStepHandler;
+    orchestrator: TransactionOrchestrator;
+    flow_: TransactionStepsDefinition;
+    handlers_: Map<string, {
+        invoke: WorkflowStepHandler;
+        compensate?: WorkflowStepHandler;
+    }>;
+    options: TransactionModelOptions;
+    requiredModules?: Set<string>;
+    optionalModules?: Set<string>;
+}
+export type WorkflowHandler = Map<string, {
+    invoke: WorkflowStepHandler;
+    compensate?: WorkflowStepHandler;
+}>;
+export type WorkflowStepHandlerArguments = {
+    container: MedusaContainer;
+    payload: unknown;
+    invoke: {
+        [actions: string]: unknown;
+    };
+    compensate: {
+        [actions: string]: unknown;
+    };
+    metadata: TransactionMetadata;
+    transaction: DistributedTransactionType;
+    step: TransactionStep;
+    orchestrator: TransactionOrchestrator;
+    context?: Context;
+};
+export type WorkflowStepHandler = (args: WorkflowStepHandlerArguments) => Promise<unknown>;
+declare const GlobalWorkflowManager: any;
+export { GlobalWorkflowManager as WorkflowManager };
+//# sourceMappingURL=workflow-manager.d.ts.map

package/dist/workflow/workflow-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-manager.d.ts","sourceRoot":"","sources":["../../src/workflow/workflow-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EACL,0BAA0B,EAG1B,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,eAAe,EACf,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,gBAAgB,CAAA;AAGvB,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,CACP,SAAS,EAAE,eAAe,EAC1B,OAAO,CAAC,EAAE,OAAO,KACd,sBAAsB,CAAA;IAC3B,YAAY,EAAE,uBAAuB,CAAA;IACrC,KAAK,EAAE,0BAA0B,CAAA;IACjC,SAAS,EAAE,GAAG,CACZ,MAAM,EACN;QAAE,MAAM,EAAE,mBAAmB,CAAC;QAAC,UAAU,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAClE,CAAA;IACD,OAAO,EAAE,uBAAuB,CAAA;IAChC,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC7B,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,eAAe,GAAG,GAAG,CAC/B,MAAM,EACN;IAAE,MAAM,EAAE,mBAAmB,CAAC;IAAC,UAAU,CAAC,EAAE,mBAAmB,CAAA;CAAE,CAClE,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAA;IACtC,UAAU,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAA;IAC1C,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,WAAW,EAAE,0BAA0B,CAAA;IACvC,IAAI,EAAE,eAAe,CAAA;IACrB,YAAY,EAAE,uBAAuB,CAAA;IACrC,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,CAChC,IAAI,EAAE,4BAA4B,KAC/B,OAAO,CAAC,OAAO,CAAC,CAAA;AAoLrB,QAAA,MAAM,qBAAqB,KAAyB,CAAA;AAEpD,OAAO,EAAE,qBAAqB,IAAI,eAAe,EAAE,CAAA"}

package/dist/workflow/workflow-manager.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowManager = void 0;
+const transaction_1 = require("../transaction");
+const scheduler_1 = require("./scheduler");
+class WorkflowManager {
+    static unregister(workflowId) {
+        const workflow = WorkflowManager.workflows.get(workflowId);
+        if (workflow?.options.schedule) {
+            this.scheduler.clearWorkflow(workflow);
+        }
+        WorkflowManager.workflows.delete(workflowId);
+    }
+    static unregisterAll() {
+        WorkflowManager.workflows.clear();
+        this.scheduler.clear();
+    }
+    static getWorkflows() {
+        return WorkflowManager.workflows;
+    }
+    static getWorkflow(workflowId) {
+        return WorkflowManager.workflows.get(workflowId);
+    }
+    static getTransactionDefinition(workflowId) {
+        if (!WorkflowManager.workflows.has(workflowId)) {
+            throw new Error(`Workflow with id "${workflowId}" not found.`);
+        }
+        const workflow = WorkflowManager.workflows.get(workflowId);
+        return new transaction_1.OrchestratorBuilder(workflow.flow_);
+    }
+    static getEmptyTransactionDefinition() {
+        return new transaction_1.OrchestratorBuilder();
+    }
+    static register(workflowId, flow, handlers, options = {}, requiredModules, optionalModules) {
+        const finalFlow = flow instanceof transaction_1.OrchestratorBuilder ? flow.build() : flow;
+        if (WorkflowManager.workflows.has(workflowId)) {
+            const excludeStepUuid = (key, value) => {
+                return key === "uuid" ? undefined : value;
+            };
+            const areStepsEqual = finalFlow
+                ? JSON.stringify(finalFlow, excludeStepUuid) ===
+                    JSON.stringify(WorkflowManager.workflows.get(workflowId).flow_, excludeStepUuid)
+                : true;
+            if (!areStepsEqual) {
+                throw new Error(`Workflow with id "${workflowId}" and step definition already exists.`);
+            }
+        }
+        const workflow = {
+            id: workflowId,
+            flow_: finalFlow,
+            orchestrator: new transaction_1.TransactionOrchestrator({
+                id: workflowId,
+                definition: finalFlow ?? {},
+                options,
+            }),
+            handler: WorkflowManager.buildHandlers(handlers),
+            handlers_: handlers,
+            options,
+            requiredModules,
+            optionalModules,
+        };
+        WorkflowManager.workflows.set(workflowId, workflow);
+        if (options.schedule) {
+            this.scheduler.scheduleWorkflow(workflow);
+        }
+    }
+    static update(workflowId, flow, handlers, options = {}, requiredModules, optionalModules) {
+        if (!WorkflowManager.workflows.has(workflowId)) {
+            throw new Error(`Workflow with id "${workflowId}" not found.`);
+        }
+        const workflow = WorkflowManager.workflows.get(workflowId);
+        for (const [key, value] of handlers.entries()) {
+            workflow.handlers_.set(key, value);
+        }
+        const finalFlow = flow instanceof transaction_1.OrchestratorBuilder ? flow.build() : flow;
+        const updatedOptions = { ...workflow.options, ...options };
+        WorkflowManager.workflows.set(workflowId, {
+            id: workflowId,
+            flow_: finalFlow,
+            orchestrator: new transaction_1.TransactionOrchestrator({
+                id: workflowId,
+                definition: finalFlow,
+                options,
+            }),
+            handler: WorkflowManager.buildHandlers(workflow.handlers_),
+            handlers_: workflow.handlers_,
+            options: updatedOptions,
+            requiredModules,
+            optionalModules,
+        });
+    }
+    static buildHandlers(handlers) {
+        return (container, context) => {
+            return async (actionId, handlerType, payload, transaction, step, orchestrator) => {
+                const command = handlers.get(actionId);
+                if (!command) {
+                    throw new Error(`Handler for action "${actionId}" not found.`);
+                }
+                else if (!command[handlerType]) {
+                    throw new Error(`"${handlerType}" handler for action "${actionId}" not found.`);
+                }
+                const { invoke, compensate, payload: input } = payload.context;
+                const { metadata } = payload;
+                return await command[handlerType]({
+                    container,
+                    payload: input,
+                    invoke,
+                    compensate,
+                    metadata,
+                    transaction: transaction,
+                    step,
+                    orchestrator,
+                    context,
+                });
+            };
+        };
+    }
+}
+WorkflowManager.workflows = new Map();
+WorkflowManager.scheduler = new scheduler_1.WorkflowScheduler();
+global.WorkflowManager ??= WorkflowManager;
+const GlobalWorkflowManager = global.WorkflowManager;
+exports.WorkflowManager = GlobalWorkflowManager;
+//# sourceMappingURL=workflow-manager.js.map

package/dist/workflow/workflow-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-manager.js","sourceRoot":"","sources":["../../src/workflow/workflow-manager.ts"],"names":[],"mappings":";;;AACA,gDAUuB;AACvB,2CAA+C;AAwC/C,MAAM,eAAe;IAInB,MAAM,CAAC,UAAU,CAAC,UAAkB;QAClC,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC1D,IAAI,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QACxC,CAAC;QAED,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IAC9C,CAAC;IAED,MAAM,CAAC,aAAa;QAClB,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;QACjC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,YAAY;QACjB,OAAO,eAAe,CAAC,SAAS,CAAA;IAClC,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,UAAkB;QACnC,OAAO,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAClD,CAAC;IAED,MAAM,CAAC,wBAAwB,CAAC,UAAU;QACxC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,qBAAqB,UAAU,cAAc,CAAC,CAAA;QAChE,CAAC;QAED,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAE,CAAA;QAC3D,OAAO,IAAI,iCAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAChD,CAAC;IAED,MAAM,CAAC,6BAA6B;QAClC,OAAO,IAAI,iCAAmB,EAAE,CAAA;IAClC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,UAAkB,EAClB,IAAkE,EAClE,QAAyB,EACzB,UAAmC,EAAE,EACrC,eAA6B,EAC7B,eAA6B;QAE7B,MAAM,SAAS,GAAG,IAAI,YAAY,iCAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;QAE3E,IAAI,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACrC,OAAO,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAA;YAC3C,CAAC,CAAA;YAED,MAAM,aAAa,GAAG,SAAS;gBAC7B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC;oBAC1C,IAAI,CAAC,SAAS,CACZ,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,KAAK,EAChD,eAAe,CAChB;gBACH,CAAC,CAAC,IAAI,CAAA;YAER,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CACb,qBAAqB,UAAU,uCAAuC,CACvE,CAAA;YACH,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,SAAU;YACjB,YAAY,EAAE,IAAI,qCAAuB,CAAC;gBACxC,EAAE,EAAE,UAAU;gBACd,UAAU,EAAE,SAAS,IAAI,EAAE;gBAC3B,OAAO;aACR,CAAC;YACF,OAAO,EAAE,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC;YAChD,SAAS,EAAE,QAAQ;YACnB,OAAO;YACP,eAAe;YACf,eAAe;SAChB,CAAA;QAED,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QACnD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED,MAAM,CAAC,MAAM,CACX,UAAkB,EAClB,IAAsD,EACtD,QAGC,EACD,UAAmC,EAAE,EACrC,eAA6B,EAC7B,eAA6B;QAE7B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,qBAAqB,UAAU,cAAc,CAAC,CAAA;QAChE,CAAC;QAED,MAAM,QAAQ,GAAG,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAE,CAAA;QAE3D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9C,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,YAAY,iCAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;QAC3E,MAAM,cAAc,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,CAAA;QAE1D,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE;YACxC,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,SAAS;YAChB,YAAY,EAAE,IAAI,qCAAuB,CAAC;gBACxC,EAAE,EAAE,UAAU;gBACd,UAAU,EAAE,SAAS;gBACrB,OAAO;aACR,CAAC;YACF,OAAO,EAAE,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC1D,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,OAAO,EAAE,cAAc;YACvB,eAAe;YACf,eAAe;SAChB,CAAC,CAAA;IACJ,CAAC;IAEM,MAAM,CAAC,aAAa,CACzB,QAGC;QAED,OAAO,CACL,SAA0B,EAC1B,OAAiB,EACO,EAAE;YAC1B,OAAO,KAAK,EACV,QAAgB,EAChB,WAAmC,EACnC,OAAY,EACZ,WAAuC,EACvC,IAAqB,EACrB,YAAqC,EACrC,EAAE;gBACF,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;gBAEtC,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,cAAc,CAAC,CAAA;gBAChE,CAAC;qBAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CACb,IAAI,WAAW,yBAAyB,QAAQ,cAAc,CAC/D,CAAA;gBACH,CAAC;gBAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,OAAO,CAAA;gBAC9D,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAA;gBAE5B,OAAO,MAAM,OAAO,CAAC,WAAW,CAAE,CAAC;oBACjC,SAAS;oBACT,OAAO,EAAE,KAAK;oBACd,MAAM;oBACN,UAAU;oBACV,QAAQ;oBACR,WAAW,EAAE,WAAyC;oBACtD,IAAI;oBACJ,YAAY;oBACZ,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC,CAAA;QACH,CAAC,CAAA;IACH,CAAC;;AA7KgB,yBAAS,GAAoC,IAAI,GAAG,EAAE,CAAA;AACtD,yBAAS,GAAG,IAAI,6BAAiB,EAAE,CAAA;AA+KtD,MAAM,CAAC,eAAe,KAAK,eAAe,CAAA;AAC1C,MAAM,qBAAqB,GAAG,MAAM,CAAC,eAAe,CAAA;AAElB,gDAAe"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@8medusa/orchestration",
+  "version": "2.7.0",
+  "description": "Medusa utilities to orchestrate modules",
+  "main": "dist/index.js",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/core/orchestration"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__fixtures__",
+    "!dist/**/__mocks__"
+  ],
+  "author": "Medusa",
+  "license": "MIT",
+  "devDependencies": {
+    "@mikro-orm/core": "6.4.3",
+    "@mikro-orm/knex": "6.4.3",
+    "@mikro-orm/migrations": "6.4.3",
+    "@mikro-orm/postgresql": "6.4.3",
+    "@swc/core": "^1.7.28",
+    "@swc/jest": "^0.2.36",
+    "awilix": "^8.0.1",
+    "jest": "^29.7.0",
+    "pg": "^8.13.0",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "@8medusa/types": "2.7.0",
+    "@8medusa/utils": "2.7.0"
+  },
+  "peerDependencies": {
+    "@mikro-orm/core": "6.4.3",
+    "@mikro-orm/knex": "6.4.3",
+    "@mikro-orm/migrations": "6.4.3",
+    "@mikro-orm/postgresql": "6.4.3",
+    "awilix": "^8.0.1",
+    "express": "^4.21.0",
+    "pg": "^8.13.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc --build",
+    "watch": "tsc --build --watch",
+    "test": "jest --runInBand --bail --forceExit"
+  }
+}