@medusajs/workflows-sdk 0.2.0-next-20231124140416

package/dist/helper/empty-handler.d.ts

@@ -0,0 +1 @@
+export declare const emptyHandler: any;

package/dist/helper/empty-handler.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emptyHandler = void 0;
+const emptyHandler = () => { };
+exports.emptyHandler = emptyHandler;
+//# sourceMappingURL=empty-handler.js.map

package/dist/helper/empty-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"empty-handler.js","sourceRoot":"","sources":["../../src/helper/empty-handler.ts"],"names":[],"mappings":";;;AAAO,MAAM,YAAY,GAAQ,GAAG,EAAE,GAAE,CAAC,CAAA;AAA5B,QAAA,YAAY,gBAAgB"}

package/dist/helper/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./merge-data";
+export * from "./empty-handler";
+export * from "./pipe";
+export * from "./workflow-export";

package/dist/helper/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./merge-data"), exports);
+__exportStar(require("./empty-handler"), exports);
+__exportStar(require("./pipe"), exports);
+__exportStar(require("./workflow-export"), exports);
+//# sourceMappingURL=index.js.map

package/dist/helper/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helper/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAC5B,kDAA+B;AAC/B,yCAAsB;AACtB,oDAAiC"}

package/dist/helper/merge-data.d.ts

@@ -0,0 +1,8 @@
+import { PipelineHandler } from "./pipe";
+/**
+ * Pipe utils that merges data from an object into a new object.
+ * The new object will have a target key with the merged data from the keys if specified.
+ * @param keys
+ * @param target
+ */
+export declare function mergeData<T extends Record<string, unknown> = Record<string, unknown>, TKeys extends keyof T = keyof T, Target extends "payload" | string = string>(keys?: TKeys[], target?: Target): PipelineHandler;

package/dist/helper/merge-data.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeData = void 0;
+const utils_1 = require("@medusajs/utils");
+/**
+ * Pipe utils that merges data from an object into a new object.
+ * The new object will have a target key with the merged data from the keys if specified.
+ * @param keys
+ * @param target
+ */
+function mergeData(keys = [], target) {
+    return async function ({ data }) {
+        const workingKeys = (keys.length ? keys : Object.keys(data));
+        const value = workingKeys.reduce((acc, key) => {
+            let targetAcc = { ...(target ? acc[target] : acc) };
+            targetAcc ?? (targetAcc = {});
+            if (Array.isArray(data[key])) {
+                targetAcc[key] = data[key];
+            }
+            else if ((0, utils_1.isObject)(data[key])) {
+                targetAcc = {
+                    ...targetAcc,
+                    ...data[key],
+                };
+            }
+            else {
+                targetAcc[key] = data[key];
+            }
+            if (target) {
+                acc[target] = {
+                    ...acc[target],
+                    ...targetAcc,
+                };
+            }
+            else {
+                acc = targetAcc;
+            }
+            return acc;
+        }, {});
+        return {
+            alias: target,
+            value: target ? value[target] : value,
+        };
+    };
+}
+exports.mergeData = mergeData;
+//# sourceMappingURL=merge-data.js.map

package/dist/helper/merge-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-data.js","sourceRoot":"","sources":["../../src/helper/merge-data.ts"],"names":[],"mappings":";;;AACA,2CAA0C;AAE1C;;;;;GAKG;AACH,SAAgB,SAAS,CAIvB,OAAgB,EAAE,EAAE,MAAe;IACnC,OAAO,KAAK,WAAW,EAAE,IAAI,EAAwB;QACnD,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAY,CAAA;QACvE,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC5C,IAAI,SAAS,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAA;YAC7D,SAAS,KAAT,SAAS,GAAK,EAAE,EAAA;YAEhB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAa,CAAC,CAAC,EAAE;gBACtC,SAAS,CAAC,GAAa,CAAC,GAAG,IAAI,CAAC,GAAa,CAAC,CAAA;aAC/C;iBAAM,IAAI,IAAA,gBAAQ,EAAC,IAAI,CAAC,GAAa,CAAC,CAAC,EAAE;gBACxC,SAAS,GAAG;oBACV,GAAG,SAAS;oBACZ,GAAI,IAAI,CAAC,GAAa,CAAY;iBACnC,CAAA;aACF;iBAAM;gBACL,SAAS,CAAC,GAAa,CAAC,GAAG,IAAI,CAAC,GAAa,CAAC,CAAA;aAC/C;YAED,IAAI,MAAM,EAAE;gBACV,GAAG,CAAC,MAAgB,CAAC,GAAG;oBACtB,GAAG,GAAG,CAAC,MAAgB,CAAC;oBACxB,GAAG,SAAS;iBACb,CAAA;aACF;iBAAM;gBACL,GAAG,GAAG,SAAS,CAAA;aAChB;YAED,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,OAAO;YACL,KAAK,EAAE,MAAM;YACb,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAgB,CAAC,CAAC,CAAC,CAAC,KAAK;SAChD,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AAvCD,8BAuCC"}

package/dist/helper/pipe.d.ts

@@ -0,0 +1,52 @@
+import { DistributedTransaction, TransactionMetadata, WorkflowStepHandler } from "@medusajs/orchestration";
+import { Context, MedusaContainer, SharedContext } from "@medusajs/types";
+export type WorkflowStepMiddlewareReturn = {
+    alias?: string;
+    value: any;
+};
+export type WorkflowStepMiddlewareInput = {
+    from: string;
+    alias?: string;
+};
+interface PipelineInput {
+    /**
+     * The alias of the input data to store in
+     */
+    inputAlias?: string;
+    /**
+     * Descriptors to get the data from
+     */
+    invoke?: WorkflowStepMiddlewareInput | WorkflowStepMiddlewareInput[];
+    compensate?: WorkflowStepMiddlewareInput | WorkflowStepMiddlewareInput[];
+    onComplete?: (args: WorkflowOnCompleteArguments) => Promise<void>;
+    /**
+     * Apply the data merging
+     */
+    merge?: boolean;
+    /**
+     * Store the merged data in a new key, if this is present no need to set merge: true
+     */
+    mergeAlias?: string;
+    /**
+     * Store the merged data from the chosen aliases, if this is present no need to set merge: true
+     */
+    mergeFrom?: string[];
+}
+export type WorkflowArguments<T = any> = {
+    container: MedusaContainer;
+    payload: unknown;
+    data: T;
+    metadata: TransactionMetadata;
+    context: Context | SharedContext;
+};
+export type WorkflowOnCompleteArguments<T = any> = {
+    container: MedusaContainer;
+    payload: unknown;
+    data: T;
+    metadata: TransactionMetadata;
+    transaction: DistributedTransaction;
+    context: Context | SharedContext;
+};
+export type PipelineHandler<T extends any = undefined> = (args: WorkflowArguments) => Promise<T extends undefined ? WorkflowStepMiddlewareReturn | WorkflowStepMiddlewareReturn[] : T>;
+export declare function pipe<T>(input: PipelineInput, ...functions: [...PipelineHandler[], PipelineHandler<T>]): WorkflowStepHandler;
+export {};

package/dist/helper/pipe.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pipe = void 0;
+const merge_data_1 = require("./merge-data");
+function pipe(input, ...functions) {
+    // Apply the aggregator just before the last handler
+    if ((input.merge || input.mergeAlias || input.mergeFrom) &&
+        functions.length) {
+        const handler = functions.pop();
+        functions.push((0, merge_data_1.mergeData)(input.mergeFrom, input.mergeAlias), handler);
+    }
+    return async ({ container, payload, invoke, compensate, metadata, transaction, context, }) => {
+        let data = {};
+        const original = {
+            invoke: invoke ?? {},
+            compensate: compensate ?? {},
+        };
+        if (input.inputAlias) {
+            Object.assign(original.invoke, { [input.inputAlias]: payload });
+        }
+        const dataKeys = ["invoke", "compensate"];
+        for (const key of dataKeys) {
+            if (!input[key]) {
+                continue;
+            }
+            if (!Array.isArray(input[key])) {
+                input[key] = [input[key]];
+            }
+            for (const action of input[key]) {
+                if (action.alias) {
+                    data[action.alias] = original[key][action.from];
+                }
+                else {
+                    data[action.from] = original[key][action.from];
+                }
+            }
+        }
+        let finalResult;
+        for (const fn of functions) {
+            let result = await fn({
+                container,
+                payload,
+                data,
+                metadata,
+                context: context,
+            });
+            if (Array.isArray(result)) {
+                for (const action of result) {
+                    if (action?.alias) {
+                        data[action.alias] = action.value;
+                    }
+                }
+            }
+            else if (result &&
+                "alias" in result) {
+                if (result.alias) {
+                    data[result.alias] = result.value;
+                }
+                else {
+                    data = result.value;
+                }
+            }
+            finalResult = result;
+        }
+        if (typeof input.onComplete === "function") {
+            const dataCopy = JSON.parse(JSON.stringify(data));
+            await input.onComplete({
+                container,
+                payload,
+                data: dataCopy,
+                metadata,
+                transaction,
+                context: context,
+            });
+        }
+        return finalResult;
+    };
+}
+exports.pipe = pipe;
+//# sourceMappingURL=pipe.js.map

package/dist/helper/pipe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../../src/helper/pipe.ts"],"names":[],"mappings":";;;AAMA,6CAAwC;AA8DxC,SAAgB,IAAI,CAClB,KAAoB,EACpB,GAAG,SAAqD;IAExD,oDAAoD;IACpD,IACE,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,SAAS,CAAC;QACpD,SAAS,CAAC,MAAM,EAChB;QACA,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,EAAG,CAAA;QAChC,SAAS,CAAC,IAAI,CAAC,IAAA,sBAAS,EAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAA;KACtE;IAED,OAAO,KAAK,EAAE,EACZ,SAAS,EACT,OAAO,EACP,MAAM,EACN,UAAU,EACV,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE,EAAE;QACH,IAAI,IAAI,GAAG,EAAE,CAAA;QAEb,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAM,IAAI,EAAE;YACpB,UAAU,EAAE,UAAU,IAAI,EAAE;SAC7B,CAAA;QAED,IAAI,KAAK,CAAC,UAAU,EAAE;YACpB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;SAChE;QAED,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;QACzC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACf,SAAQ;aACT;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC9B,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;aAC1B;YAED,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE;gBAC/B,IAAI,MAAM,CAAC,KAAK,EAAE;oBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;iBAChD;qBAAM;oBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;iBAC/C;aACF;SACF;QAED,IAAI,WAAW,CAAA;QACf,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE;YAC1B,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;gBACpB,SAAS;gBACT,OAAO;gBACP,IAAI;gBACJ,QAAQ;gBACR,OAAO,EAAE,OAAkB;aAC5B,CAAC,CAAA;YAEF,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACzB,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE;oBAC3B,IAAI,MAAM,EAAE,KAAK,EAAE;wBACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;qBAClC;iBACF;aACF;iBAAM,IACL,MAAM;gBACN,OAAO,IAAK,MAAuC,EACnD;gBACA,IAAK,MAAuC,CAAC,KAAK,EAAE;oBAClD,IAAI,CAAE,MAAuC,CAAC,KAAM,CAAC,GACnD,MACD,CAAC,KAAK,CAAA;iBACR;qBAAM;oBACL,IAAI,GAAI,MAAuC,CAAC,KAAK,CAAA;iBACtD;aACF;YAED,WAAW,GAAG,MAAM,CAAA;SACrB;QAED,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE;YAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;YACjD,MAAM,KAAK,CAAC,UAAU,CAAC;gBACrB,SAAS;gBACT,OAAO;gBACP,IAAI,EAAE,QAAQ;gBACd,QAAQ;gBACR,WAAW;gBACX,OAAO,EAAE,OAAkB;aAC5B,CAAC,CAAA;SACH;QAED,OAAO,WAAW,CAAA;IACpB,CAAC,CAAA;AACH,CAAC;AAlGD,oBAkGC"}

package/dist/helper/workflow-export.d.ts

@@ -0,0 +1,16 @@
+import { DistributedTransaction, LocalWorkflow, TransactionStepError } from "@medusajs/orchestration";
+import { Context, LoadedModule, MedusaContainer } from "@medusajs/types";
+export type FlowRunOptions<TData = unknown> = {
+    input?: TData;
+    context?: Context;
+    resultFrom?: string | string[];
+    throwOnError?: boolean;
+};
+export type WorkflowResult<TResult = unknown> = {
+    errors: TransactionStepError[];
+    transaction: DistributedTransaction;
+    result: TResult;
+};
+export declare const exportWorkflow: <TData = unknown, TResult = unknown>(workflowId: string, defaultResult?: string, dataPreparation?: ((data: TData) => Promise<unknown>) | undefined) => <TDataOverride = undefined, TResultOverride = undefined>(container?: LoadedModule[] | MedusaContainer) => Omit<LocalWorkflow, "run"> & {
+    run: (args?: FlowRunOptions<TDataOverride extends undefined ? TData : TDataOverride> | undefined) => Promise<WorkflowResult<TResultOverride extends undefined ? TResult : TResultOverride>>;
+};

package/dist/helper/workflow-export.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportWorkflow = void 0;
+const orchestration_1 = require("@medusajs/orchestration");
+const modules_sdk_1 = require("@medusajs/modules-sdk");
+const os_1 = require("os");
+const ulid_1 = require("ulid");
+const composer_1 = require("../utils/composer");
+const exportWorkflow = (workflowId, defaultResult, dataPreparation) => {
+    return function (container) {
+        if (!container) {
+            container = modules_sdk_1.MedusaModule.getLoadedModules().map((mod) => Object.values(mod)[0]);
+        }
+        const flow = new orchestration_1.LocalWorkflow(workflowId, container);
+        const originalRun = flow.run.bind(flow);
+        const newRun = async ({ input, context, throwOnError, resultFrom } = {
+            throwOnError: true,
+            resultFrom: defaultResult,
+        }) => {
+            resultFrom ?? (resultFrom = defaultResult);
+            throwOnError ?? (throwOnError = true);
+            if (typeof dataPreparation === "function") {
+                try {
+                    const copyInput = input ? JSON.parse(JSON.stringify(input)) : input;
+                    input = await dataPreparation(copyInput);
+                }
+                catch (err) {
+                    if (throwOnError) {
+                        throw new Error(`Data preparation failed: ${err.message}${os_1.EOL}${err.stack}`);
+                    }
+                    return {
+                        errors: [err],
+                    };
+                }
+            }
+            const transaction = await originalRun(context?.transactionId ?? (0, ulid_1.ulid)(), input, context);
+            const errors = transaction.getErrors(orchestration_1.TransactionHandlerType.INVOKE);
+            const failedStatus = [orchestration_1.TransactionState.FAILED, orchestration_1.TransactionState.REVERTED];
+            if (failedStatus.includes(transaction.getState()) && throwOnError) {
+                const errorMessage = errors
+                    ?.map((err) => `${err.error?.message}${os_1.EOL}${err.error?.stack}`)
+                    ?.join(`${os_1.EOL}`);
+                throw new Error(errorMessage);
+            }
+            let result = undefined;
+            if (resultFrom) {
+                if (Array.isArray(resultFrom)) {
+                    result = resultFrom.map((from) => {
+                        const res = transaction.getContext().invoke?.[from];
+                        return res?.__type === composer_1.SymbolWorkflowWorkflowData ? res.output : res;
+                    });
+                }
+                else {
+                    const res = transaction.getContext().invoke?.[resultFrom];
+                    result = res?.__type === composer_1.SymbolWorkflowWorkflowData ? res.output : res;
+                }
+            }
+            return {
+                errors,
+                transaction,
+                result,
+            };
+        };
+        flow.run = newRun;
+        return flow;
+    };
+};
+exports.exportWorkflow = exportWorkflow;
+//# sourceMappingURL=workflow-export.js.map

package/dist/helper/workflow-export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-export.js","sourceRoot":"","sources":["../../src/helper/workflow-export.ts"],"names":[],"mappings":";;;AAAA,2DAMgC;AAGhC,uDAAoD;AACpD,2BAAwB;AACxB,+BAA2B;AAC3B,gDAA8D;AAevD,MAAM,cAAc,GAAG,CAC5B,UAAkB,EAClB,aAAsB,EACtB,eAAmD,EACnD,EAAE;IACF,OAAO,UACL,SAA4C;QAY5C,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG,0BAAY,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAC7C,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAC/B,CAAA;SACF;QAED,MAAM,IAAI,GAAG,IAAI,6BAAa,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;QAErD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,MAAM,GAAG,KAAK,EAClB,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,KAAqB;YAC7D,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,aAAa;SAC1B,EACD,EAAE;YACF,UAAU,KAAV,UAAU,GAAK,aAAa,EAAA;YAC5B,YAAY,KAAZ,YAAY,GAAK,IAAI,EAAA;YAErB,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;gBACzC,IAAI;oBACF,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;oBACnE,KAAK,GAAG,MAAM,eAAe,CAAC,SAAkB,CAAC,CAAA;iBAClD;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,YAAY,EAAE;wBAChB,MAAM,IAAI,KAAK,CACb,4BAA4B,GAAG,CAAC,OAAO,GAAG,QAAG,GAAG,GAAG,CAAC,KAAK,EAAE,CAC5D,CAAA;qBACF;oBACD,OAAO;wBACL,MAAM,EAAE,CAAC,GAAG,CAAC;qBACd,CAAA;iBACF;aACF;YAED,MAAM,WAAW,GAAG,MAAM,WAAW,CACnC,OAAO,EAAE,aAAa,IAAI,IAAA,WAAI,GAAE,EAChC,KAAK,EACL,OAAO,CACR,CAAA;YAED,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,sCAAsB,CAAC,MAAM,CAAC,CAAA;YAEnE,MAAM,YAAY,GAAG,CAAC,gCAAgB,CAAC,MAAM,EAAE,gCAAgB,CAAC,QAAQ,CAAC,CAAA;YACzE,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,IAAI,YAAY,EAAE;gBACjE,MAAM,YAAY,GAAG,MAAM;oBACzB,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,QAAG,GAAG,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;oBAChE,EAAE,IAAI,CAAC,GAAG,QAAG,EAAE,CAAC,CAAA;gBAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;aAC9B;YAED,IAAI,MAAM,GAAQ,SAAS,CAAA;YAE3B,IAAI,UAAU,EAAE;gBACd,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;oBAC7B,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBAC/B,MAAM,GAAG,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;wBACnD,OAAO,GAAG,EAAE,MAAM,KAAK,qCAA0B,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA;oBACtE,CAAC,CAAC,CAAA;iBACH;qBAAM;oBACL,MAAM,GAAG,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAA;oBACzD,MAAM,GAAG,GAAG,EAAE,MAAM,KAAK,qCAA0B,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA;iBACvE;aACF;YAED,OAAO;gBACL,MAAM;gBACN,WAAW;gBACX,MAAM;aACP,CAAA;QACH,CAAC,CAAA;QACD,IAAI,CAAC,GAAG,GAAG,MAAa,CAAA;QAExB,OAAO,IAUN,CAAA;IACH,CAAC,CAAA;AACH,CAAC,CAAA;AAtGY,QAAA,cAAc,kBAsG1B"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./helper";
+export * from "./utils/composer";
+export * as Composer from "./utils/composer";

package/dist/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Composer = void 0;
+__exportStar(require("./helper"), exports);
+__exportStar(require("./utils/composer"), exports);
+exports.Composer = __importStar(require("./utils/composer"));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,mDAAgC;AAChC,6DAA4C"}

package/dist/utils/composer/create-step.d.ts

@@ -0,0 +1,105 @@
+import { StepResponse } from "./helpers";
+import { StepExecutionContext, StepFunction } from "./type";
+/**
+ * The type of invocation function passed to a step.
+ *
+ * @typeParam TInput - The type of the input that the function expects.
+ * @typeParam TOutput - The type of the output that the function returns.
+ * @typeParam TCompensateInput - The type of the input that the compensation function expects.
+ *
+ * @returns The expected output based on the type parameter `TOutput`.
+ */
+type InvokeFn<TInput extends object, TOutput, TCompensateInput> = (
+/**
+ * The input of the step.
+ */
+input: {
+    [Key in keyof TInput]: TInput[Key];
+}, 
+/**
+ * The step's context.
+ */
+context: StepExecutionContext) => void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> | Promise<void | StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>;
+/**
+ * The type of compensation function passed to a step.
+ *
+ * @typeParam T -
+ * The type of the argument passed to the compensation function. If not specified, then it will be the same type as the invocation function's output.
+ *
+ * @returns There's no expected type to be returned by the compensation function.
+ */
+type CompensateFn<T> = (
+/**
+ * The argument passed to the compensation function.
+ */
+input: T | undefined, 
+/**
+ * The step's context.
+ */
+context: StepExecutionContext) => unknown | Promise<unknown>;
+/**
+ * This function creates a {@link StepFunction} that can be used as a step in a workflow constructed by the {@link createWorkflow} function.
+ *
+ * @typeParam TInvokeInput - The type of the expected input parameter to the invocation function.
+ * @typeParam TInvokeResultOutput - The type of the expected output parameter of the invocation function.
+ * @typeParam TInvokeResultCompensateInput - The type of the expected input parameter to the compensation function.
+ *
+ * @returns A step function to be used in a workflow.
+ *
+ * @example
+ * import {
+ *   createStep,
+ *   StepResponse,
+ *   StepExecutionContext,
+ *   WorkflowData
+ * } from "@medusajs/workflows-sdk"
+ *
+ * interface CreateProductInput {
+ *   title: string
+ * }
+ *
+ * export const createProductStep = createStep(
+ *   "createProductStep",
+ *   async function (
+ *     input: CreateProductInput,
+ *     context
+ *   ) {
+ *     const productService = context.container.resolve(
+ *       "productService"
+ *     )
+ *     const product = await productService.create(input)
+ *     return new StepResponse({
+ *       product
+ *     }, {
+ *       product_id: product.id
+ *     })
+ *   },
+ *   async function (
+ *     input,
+ *     context
+ *   ) {
+ *     const productService = context.container.resolve(
+ *       "productService"
+ *     )
+ *     await productService.delete(input.product_id)
+ *   }
+ * )
+ */
+export declare function createStep<TInvokeInput extends object, TInvokeResultOutput, TInvokeResultCompensateInput>(
+/**
+ * The name of the step.
+ */
+name: string, 
+/**
+ * An invocation function that will be executed when the workflow is executed. The function must return an instance of {@link StepResponse}. The constructor of {@link StepResponse}
+ * accepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.
+ */
+invokeFn: InvokeFn<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>, 
+/**
+ * A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.
+ * It accepts as a parameter the second argument passed to the constructor of the {@link StepResponse} instance returned by the invocation function. If the
+ * invocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument
+ * passed to the `StepResponse` constructor instead.
+ */
+compensateFn?: CompensateFn<TInvokeResultCompensateInput>): StepFunction<TInvokeInput, TInvokeResultOutput>;
+export {};

package/dist/utils/composer/create-step.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStep = void 0;
+const helpers_1 = require("./helpers");
+const proxy_1 = require("./helpers/proxy");
+/**
+ * @internal
+ *
+ * Internal function to create the invoke and compensate handler for a step.
+ * This is where the inputs and context are passed to the underlying invoke and compensate function.
+ *
+ * @param stepName
+ * @param input
+ * @param invokeFn
+ * @param compensateFn
+ */
+function applyStep({ stepName, input, invokeFn, compensateFn, }) {
+    return function () {
+        if (!this.workflowId) {
+            throw new Error("createStep must be used inside a createWorkflow definition");
+        }
+        const handler = {
+            invoke: async (transactionContext) => {
+                const executionContext = {
+                    container: transactionContext.container,
+                    metadata: transactionContext.metadata,
+                    context: transactionContext.context,
+                };
+                const argInput = await (0, helpers_1.resolveValue)(input, transactionContext);
+                const stepResponse = await invokeFn.apply(this, [argInput, executionContext]);
+                const stepResponseJSON = stepResponse?.__type === helpers_1.SymbolWorkflowStepResponse
+                    ? stepResponse.toJSON()
+                    : stepResponse;
+                return {
+                    __type: helpers_1.SymbolWorkflowWorkflowData,
+                    output: stepResponseJSON,
+                };
+            },
+            compensate: compensateFn
+                ? async (transactionContext) => {
+                    const executionContext = {
+                        container: transactionContext.container,
+                        metadata: transactionContext.metadata,
+                        context: transactionContext.context,
+                    };
+                    const stepOutput = transactionContext.invoke[stepName]?.output;
+                    const invokeResult = stepOutput?.__type === helpers_1.SymbolWorkflowStepResponse
+                        ? stepOutput.compensateInput &&
+                            JSON.parse(JSON.stringify(stepOutput.compensateInput))
+                        : stepOutput && JSON.parse(JSON.stringify(stepOutput));
+                    const args = [invokeResult, executionContext];
+                    const output = await compensateFn.apply(this, args);
+                    return {
+                        output,
+                    };
+                }
+                : undefined,
+        };
+        this.flow.addAction(stepName, {
+            noCompensation: !compensateFn,
+        });
+        this.handlers.set(stepName, handler);
+        const ret = {
+            __type: helpers_1.SymbolWorkflowStep,
+            __step__: stepName,
+        };
+        return (0, proxy_1.proxify)(ret);
+    };
+}
+/**
+ * This function creates a {@link StepFunction} that can be used as a step in a workflow constructed by the {@link createWorkflow} function.
+ *
+ * @typeParam TInvokeInput - The type of the expected input parameter to the invocation function.
+ * @typeParam TInvokeResultOutput - The type of the expected output parameter of the invocation function.
+ * @typeParam TInvokeResultCompensateInput - The type of the expected input parameter to the compensation function.
+ *
+ * @returns A step function to be used in a workflow.
+ *
+ * @example
+ * import {
+ *   createStep,
+ *   StepResponse,
+ *   StepExecutionContext,
+ *   WorkflowData
+ * } from "@medusajs/workflows-sdk"
+ *
+ * interface CreateProductInput {
+ *   title: string
+ * }
+ *
+ * export const createProductStep = createStep(
+ *   "createProductStep",
+ *   async function (
+ *     input: CreateProductInput,
+ *     context
+ *   ) {
+ *     const productService = context.container.resolve(
+ *       "productService"
+ *     )
+ *     const product = await productService.create(input)
+ *     return new StepResponse({
+ *       product
+ *     }, {
+ *       product_id: product.id
+ *     })
+ *   },
+ *   async function (
+ *     input,
+ *     context
+ *   ) {
+ *     const productService = context.container.resolve(
+ *       "productService"
+ *     )
+ *     await productService.delete(input.product_id)
+ *   }
+ * )
+ */
+function createStep(
+/**
+ * The name of the step.
+ */
+name, 
+/**
+ * An invocation function that will be executed when the workflow is executed. The function must return an instance of {@link StepResponse}. The constructor of {@link StepResponse}
+ * accepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.
+ */
+invokeFn, 
+/**
+ * A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.
+ * It accepts as a parameter the second argument passed to the constructor of the {@link StepResponse} instance returned by the invocation function. If the
+ * invocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument
+ * passed to the `StepResponse` constructor instead.
+ */
+compensateFn) {
+    const stepName = name ?? invokeFn.name;
+    const returnFn = function (input) {
+        if (!global[helpers_1.SymbolMedusaWorkflowComposerContext]) {
+            throw new Error("createStep must be used inside a createWorkflow definition");
+        }
+        const stepBinder = global[helpers_1.SymbolMedusaWorkflowComposerContext].stepBinder;
+        return stepBinder(applyStep({
+            stepName,
+            input,
+            invokeFn,
+            compensateFn,
+        }));
+    };
+    returnFn.__type = helpers_1.SymbolWorkflowStepBind;
+    returnFn.__step__ = stepName;
+    return returnFn;
+}
+exports.createStep = createStep;
+//# sourceMappingURL=create-step.js.map

package/dist/utils/composer/create-step.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-step.js","sourceRoot":"","sources":["../../../src/utils/composer/create-step.ts"],"names":[],"mappings":";;;AAAA,uCAQkB;AAQlB,2CAAyC;AAsEzC;;;;;;;;;;GAUG;AACH,SAAS,SAAS,CAOhB,EACA,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,YAAY,GAMb;IACC,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;SACF;QAED,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE;gBACnC,MAAM,gBAAgB,GAAyB;oBAC7C,SAAS,EAAE,kBAAkB,CAAC,SAAS;oBACvC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ;oBACrC,OAAO,EAAE,kBAAkB,CAAC,OAAO;iBACpC,CAAA;gBAED,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAY,EAAC,KAAK,EAAE,kBAAkB,CAAC,CAAA;gBAC9D,MAAM,YAAY,GAA2B,MAAM,QAAQ,CAAC,KAAK,CAC/D,IAAI,EACJ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAC7B,CAAA;gBAED,MAAM,gBAAgB,GACpB,YAAY,EAAE,MAAM,KAAK,oCAA0B;oBACjD,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE;oBACvB,CAAC,CAAC,YAAY,CAAA;gBAElB,OAAO;oBACL,MAAM,EAAE,oCAA0B;oBAClC,MAAM,EAAE,gBAAgB;iBACzB,CAAA;YACH,CAAC;YACD,UAAU,EAAE,YAAY;gBACtB,CAAC,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE;oBAC3B,MAAM,gBAAgB,GAAyB;wBAC7C,SAAS,EAAE,kBAAkB,CAAC,SAAS;wBACvC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ;wBACrC,OAAO,EAAE,kBAAkB,CAAC,OAAO;qBACpC,CAAA;oBAED,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;oBAC9D,MAAM,YAAY,GAChB,UAAU,EAAE,MAAM,KAAK,oCAA0B;wBAC/C,CAAC,CAAC,UAAU,CAAC,eAAe;4BAC1B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;wBACxD,CAAC,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAA;oBAE1D,MAAM,IAAI,GAAG,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAA;oBAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;oBACnD,OAAO;wBACL,MAAM;qBACP,CAAA;gBACH,CAAC;gBACH,CAAC,CAAC,SAAS;SACd,CAAA;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC5B,cAAc,EAAE,CAAC,YAAY;SAC9B,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAEpC,MAAM,GAAG,GAAG;YACV,MAAM,EAAE,4BAAkB;YAC1B,QAAQ,EAAE,QAAQ;SACnB,CAAA;QAED,OAAO,IAAA,eAAO,EAAC,GAAG,CAAC,CAAA;IACrB,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,SAAgB,UAAU;AAKxB;;GAEG;AACH,IAAY;AACZ;;;GAGG;AACH,QAIC;AACD;;;;;GAKG;AACH,YAAyD;IAEzD,MAAM,QAAQ,GAAG,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAA;IAEtC,MAAM,QAAQ,GAAG,UAAU,KAE1B;QACC,IAAI,CAAC,MAAM,CAAC,6CAAmC,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;SACF;QAED,MAAM,UAAU,GACd,MAAM,CACJ,6CAAmC,CAEtC,CAAC,UAAU,CAAA;QAEZ,OAAO,UAAU,CACf,SAAS,CAKP;YACA,QAAQ;YACR,KAAK;YACL,QAAQ;YACR,YAAY;SACb,CAAC,CACH,CAAA;IACH,CAAC,CAAA;IAED,QAAQ,CAAC,MAAM,GAAG,gCAAsB,CAAA;IACxC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAE5B,OAAO,QAAsE,CAAA;AAC/E,CAAC;AA9DD,gCA8DC"}