@8medusa/workflows-sdk 2.7.0

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

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHook = createHook;
+const utils_1 = require("@8medusa/utils");
+const create_step_1 = require("./create-step");
+const create_step_handler_1 = require("./helpers/create-step-handler");
+const helpers_1 = require("./helpers");
+const NOOP_RESULT = Symbol.for("NOOP");
+/**
+ * Expose a hook in your workflow where you can inject custom functionality as a step function.
+ *
+ * A handler hook can later be registered to consume the hook and perform custom functionality.
+ *
+ * Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks).
+ *
+ * @param name - The hook's name. This is used when the hook handler is registered to consume the workflow.
+ * @param input - The input to pass to the hook handler.
+ * @returns A workflow hook.
+ *
+ * @example
+ * import {
+ *   createStep,
+ *   createHook,
+ *   createWorkflow,
+ *   WorkflowResponse,
+ * } from "@8medusa/framework/workflows-sdk"
+ * import { createProductStep } from "./steps/create-product"
+ *
+ * export const myWorkflow = createWorkflow(
+ *   "my-workflow",
+ *   function (input) {
+ *     const product = createProductStep(input)
+ *     const productCreatedHook = createHook(
+ *       "productCreated",
+ *       { productId: product.id }
+ *     )
+ *
+ *     return new WorkflowResponse(product, {
+ *       hooks: [productCreatedHook],
+ *     })
+ *   }
+ * )
+ */
+function createHook(name, input, options = {}) {
+    const context = global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerContext];
+    const getHookResultStep = (0, create_step_1.createStep)(`get-${name}-result`, (_, context) => {
+        const result = context[" getStepResult"](name);
+        if (result === NOOP_RESULT) {
+            return new helpers_1.StepResponse(undefined);
+        }
+        if (options.resultValidator) {
+            return options.resultValidator.parse(result);
+        }
+        if (result === undefined) {
+            return new helpers_1.StepResponse(undefined);
+        }
+        return result;
+    }, () => void 0);
+    context.hookBinder(name, function () {
+        /**
+         * We start by registering a new step within the workflow. This will be a noop
+         * step that can be replaced (optionally) by the workflow consumer.
+         */
+        (0, create_step_1.createStep)(name, (_) => new helpers_1.StepResponse(NOOP_RESULT), () => void 0)(input);
+        function hook(invokeFn, compensateFn) {
+            const handlers = create_step_handler_1.createStepHandler.bind(this)({
+                stepName: name,
+                input,
+                invokeFn,
+                compensateFn,
+            });
+            if (this.hooks_.registered.includes(name)) {
+                throw new Error(`Cannot define multiple hook handlers for the ${name} hook`);
+            }
+            this.hooks_.registered.push(name);
+            this.handlers.set(name, handlers);
+        }
+        return hook;
+    });
+    return {
+        __type: utils_1.OrchestrationUtils.SymbolWorkflowHook,
+        name,
+        getResult() {
+            if ("cachedResult" in this) {
+                return this.cachedResult;
+            }
+            const result = getHookResultStep();
+            this["cachedResult"] = result;
+            return result;
+        },
+    };
+}
+//# sourceMappingURL=create-hook.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-hook.js","sourceRoot":"","sources":["../../../src/utils/composer/create-hook.ts"],"names":[],"mappings":";;AAkEA,gCA2EC;AA5ID,0CAAmD;AAEnD,+CAAkE;AAClE,uEAAiE;AACjE,uCAAwC;AAExC,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAwBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,UAAU,CACxB,IAAU,EACV,KAAmB,EACnB,UAEI,EAAE;IAEN,MAAM,OAAO,GAAG,MAAM,CACpB,0BAAkB,CAAC,mCAAmC,CACtB,CAAA;IAElC,MAAM,iBAAiB,GAAG,IAAA,wBAAU,EAClC,OAAO,IAAI,SAAS,EACpB,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE;QACb,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;YAC3B,OAAO,IAAI,sBAAY,CAAC,SAAS,CAAC,CAAA;QACpC,CAAC;QACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC9C,CAAC;QACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,IAAI,sBAAY,CAAC,SAAS,CAAC,CAAA;QACpC,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC,EACD,GAAG,EAAE,CAAC,KAAK,CAAC,CACb,CAAA;IAED,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE;QACvB;;;WAGG;QACH,IAAA,wBAAU,EACR,IAAI,EACJ,CAAC,CAAe,EAAE,EAAE,CAAC,IAAI,sBAAY,CAAC,WAAW,CAAC,EAClD,GAAG,EAAE,CAAC,KAAK,CAAC,CACb,CAAC,KAAK,CAAC,CAAA;QAER,SAAS,IAAI,CAE0B,QAAuE,EAAE,YAAyD;YACvK,MAAM,QAAQ,GAAG,uCAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5C,QAAQ,EAAE,IAAI;gBACd,KAAK;gBACL,QAAQ;gBACR,YAAY;aACb,CAAC,CAAA;YAEF,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CACb,gDAAgD,IAAI,OAAO,CAC5D,CAAA;YACH,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACnC,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,MAAM,EAAE,0BAAkB,CAAC,kBAAkB;QAC7C,IAAI;QACJ,SAAS;YACP,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC,YAAY,CAAA;YAC1B,CAAC;YACD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAA;YAClC,IAAI,CAAC,cAAc,CAAC,GAAG,MAAM,CAAA;YAC7B,OAAO,MAAM,CAAA;QACf,CAAC;KACyC,CAAA;AAC9C,CAAC"}

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

@@ -0,0 +1,134 @@
+import { TransactionStepsDefinition } from "@8medusa/orchestration";
+import { StepResponse } from "./helpers";
+import { StepExecutionContext, StepFunction, StepFunctionResult, WorkflowData } 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`.
+ */
+export type InvokeFn<TInput, TOutput, TCompensateInput> = (
+/**
+ * The input of the step.
+ */
+input: TInput, 
+/**
+ * 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.
+ */
+export type CompensateFn<T> = (
+/**
+ * The argument passed to the compensation function.
+ */
+input: T | undefined, 
+/**
+ * The step's context.
+ */
+context: StepExecutionContext) => unknown | Promise<unknown>;
+export type LocalStepConfig = {
+    name?: string;
+} & Omit<TransactionStepsDefinition, "next" | "uuid" | "action">;
+export interface ApplyStepOptions<TStepInputs extends {
+    [K in keyof TInvokeInput]: WorkflowData<TInvokeInput[K]>;
+}, TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput> {
+    stepName: string;
+    stepConfig?: TransactionStepsDefinition;
+    input?: TStepInputs;
+    invokeFn: InvokeFn<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>;
+    compensateFn?: CompensateFn<TInvokeResultCompensateInput>;
+}
+/**
+ * @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 stepConfig
+ * @param input
+ * @param invokeFn
+ * @param compensateFn
+ */
+export declare function applyStep<TInvokeInput, TStepInput extends {
+    [K in keyof TInvokeInput]: WorkflowData<TInvokeInput[K]>;
+}, TInvokeResultOutput, TInvokeResultCompensateInput>({ stepName, stepConfig, input, invokeFn, compensateFn, }: ApplyStepOptions<TStepInput, TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>): StepFunctionResult<TInvokeResultOutput>;
+/**
+ * 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
+ * } from "@8medusa/framework/workflows-sdk"
+ *
+ * interface CreateProductInput {
+ *   title: string
+ * }
+ *
+ * export const createProductStep = createStep(
+ *   "createProductStep",
+ *   async function (
+ *     input: CreateProductInput,
+ *     { container }
+ *   ) {
+ *     const productModuleService = container.resolve(
+ *       "product"
+ *     )
+ *     const product = await productModuleService.createProducts(input)
+ *     return new StepResponse({
+ *       product
+ *     }, {
+ *       product_id: product.id
+ *     })
+ *   },
+ *   async function (
+ *     input,
+ *     { container }
+ *   ) {
+ *     if (!input) {
+ *       return
+ *     }
+ *     const productModuleService = container.resolve(
+ *       "product"
+ *     )
+ *     await productModuleService.deleteProducts([input.product_id])
+ *   }
+ * )
+ */
+export declare function createStep<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>(
+/**
+ * The name of the step or its configuration.
+ */
+nameOrConfig: string | ({
+    name: string;
+} & Omit<TransactionStepsDefinition, "next" | "uuid" | "action">), 
+/**
+ * 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>;
+//# sourceMappingURL=create-step.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-step.d.ts","sourceRoot":"","sources":["../../../src/utils/composer/create-step.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAI3B,MAAM,wBAAwB,CAAA;AAG/B,OAAO,EAAgB,YAAY,EAAE,MAAM,WAAW,CAAA;AAGtD,OAAO,EAEL,oBAAoB,EACpB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACb,MAAM,QAAQ,CAAA;AAEf;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,gBAAgB,IAAI;AACxD;;GAEG;AACH,KAAK,EAAE,MAAM;AACb;;GAEG;AACH,OAAO,EAAE,oBAAoB,KAE3B,IAAI,GACJ,YAAY,CACV,OAAO,EACP,gBAAgB,SAAS,SAAS,GAAG,OAAO,GAAG,gBAAgB,CAChE,GACD,OAAO,CAAC,IAAI,GAAG,YAAY,CACzB,OAAO,EACP,gBAAgB,SAAS,SAAS,GAAG,OAAO,GAAG,gBAAgB,CAChE,CAAC,CAAA;AAEN;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;AAC5B;;GAEG;AACH,KAAK,EAAE,CAAC,GAAG,SAAS;AACpB;;GAEG;AACH,OAAO,EAAE,oBAAoB,KAC1B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CACpD,0BAA0B,EAC1B,MAAM,GAAG,MAAM,GAAG,QAAQ,CAC3B,CAAA;AAED,MAAM,WAAW,gBAAgB,CAC/B,WAAW,SAAS;KACjB,CAAC,IAAI,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CACzD,EACD,YAAY,EACZ,mBAAmB,EACnB,4BAA4B;IAE5B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,0BAA0B,CAAA;IACvC,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAChB,YAAY,EACZ,mBAAmB,EACnB,4BAA4B,CAC7B,CAAA;IACD,YAAY,CAAC,EAAE,YAAY,CAAC,4BAA4B,CAAC,CAAA;CAC1D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CACvB,YAAY,EACZ,UAAU,SAAS;KAChB,CAAC,IAAI,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CACzD,EACD,mBAAmB,EACnB,4BAA4B,EAC5B,EACA,QAAQ,EACR,UAAe,EACf,KAAK,EACL,QAAQ,EACR,YAAY,GACb,EAAE,gBAAgB,CACjB,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,4BAA4B,CAC7B,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,CA4G1C;AA2FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,UAAU,CACxB,YAAY,EACZ,mBAAmB,EACnB,4BAA4B;AAE5B;;GAEG;AACH,YAAY,EACR,MAAM,GACN,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CACtB,0BAA0B,EAC1B,MAAM,GAAG,MAAM,GAAG,QAAQ,CAC3B,CAAC;AACN;;;GAGG;AACH,QAAQ,EAAE,QAAQ,CAChB,YAAY,EACZ,mBAAmB,EACnB,4BAA4B,CAC7B;AACD;;;;;GAKG;AACH,YAAY,CAAC,EAAE,YAAY,CAAC,4BAA4B,CAAC,GACxD,YAAY,CAAC,YAAY,EAAE,mBAAmB,CAAC,CA0CjD"}

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

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyStep = applyStep;
+exports.createStep = createStep;
+const orchestration_1 = require("@8medusa/orchestration");
+const utils_1 = require("@8medusa/utils");
+const ulid_1 = require("ulid");
+const helpers_1 = require("./helpers");
+const create_step_handler_1 = require("./helpers/create-step-handler");
+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 stepConfig
+ * @param input
+ * @param invokeFn
+ * @param compensateFn
+ */
+function applyStep({ stepName, stepConfig = {}, input, invokeFn, compensateFn, }) {
+    return function () {
+        if (!this.workflowId) {
+            throw new Error("createStep must be used inside a createWorkflow definition");
+        }
+        const handler = create_step_handler_1.createStepHandler.bind(this)({
+            stepName,
+            input,
+            invokeFn,
+            compensateFn,
+        });
+        wrapAsyncHandler(stepConfig, handler);
+        stepConfig.uuid = (0, ulid_1.ulid)();
+        stepConfig.noCompensation = !compensateFn;
+        this.flow.addAction(stepName, stepConfig);
+        this.isAsync ||= !!(stepConfig.async || stepConfig.compensateAsync);
+        if (!this.handlers.has(stepName)) {
+            this.handlers.set(stepName, handler);
+        }
+        const ret = {
+            __type: utils_1.OrchestrationUtils.SymbolWorkflowStep,
+            __step__: stepName,
+        };
+        const refRet = (0, proxy_1.proxify)(ret);
+        refRet.config = (localConfig) => {
+            const newStepName = localConfig.name ?? stepName;
+            const newConfig = {
+                async: false,
+                compensateAsync: false,
+                ...stepConfig,
+                ...localConfig,
+            };
+            delete localConfig.name;
+            const handler = create_step_handler_1.createStepHandler.bind(this)({
+                stepName: newStepName,
+                input,
+                invokeFn,
+                compensateFn,
+            });
+            wrapAsyncHandler(stepConfig, handler);
+            this.handlers.set(newStepName, handler);
+            this.flow.replaceAction(stepConfig.uuid, newStepName, newConfig);
+            this.isAsync ||= !!(newConfig.async || newConfig.compensateAsync);
+            ret.__step__ = newStepName;
+            orchestration_1.WorkflowManager.update(this.workflowId, this.flow, this.handlers);
+            if (global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerCondition]) {
+                const flagSteps = global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerCondition].steps;
+                const idx = flagSteps.findIndex((a) => a.__step__ === ret.__step__);
+                if (idx > -1) {
+                    flagSteps.splice(idx, 1);
+                }
+                flagSteps.push(refRet);
+            }
+            return refRet;
+        };
+        refRet.if = (input, condition) => {
+            if (typeof condition !== "function") {
+                throw new Error("Condition must be a function");
+            }
+            wrapConditionalStep(input, condition, handler);
+            this.handlers.set(ret.__step__, handler);
+            return refRet;
+        };
+        if (global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerCondition]) {
+            global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerCondition].steps.push(refRet);
+        }
+        return refRet;
+    };
+}
+/**
+ * @internal
+ *
+ * Internal function to handle async steps to be automatically marked as completed after they are executed.
+ *
+ * @param stepConfig
+ * @param handle
+ */
+function wrapAsyncHandler(stepConfig, handle) {
+    if (stepConfig.async) {
+        if (typeof handle.invoke === "function") {
+            const originalInvoke = handle.invoke;
+            handle.invoke = async (stepArguments) => {
+                const response = (await originalInvoke(stepArguments));
+                if (response?.output?.__type !==
+                    utils_1.OrchestrationUtils.SymbolWorkflowStepResponse) {
+                    return;
+                }
+                stepArguments.step.definition.backgroundExecution = true;
+                return response;
+            };
+        }
+    }
+    if (stepConfig.compensateAsync) {
+        if (typeof handle.compensate === "function") {
+            const originalCompensate = handle.compensate;
+            handle.compensate = async (stepArguments) => {
+                const response = (await originalCompensate(stepArguments));
+                if (response?.output?.__type !==
+                    utils_1.OrchestrationUtils.SymbolWorkflowStepResponse) {
+                    return;
+                }
+                stepArguments.step.definition.backgroundExecution = true;
+                return response;
+            };
+        }
+    }
+}
+/**
+ * @internal
+ *
+ * Internal function to handle conditional steps.
+ *
+ * @param condition
+ * @param handle
+ */
+function wrapConditionalStep(input, condition, handle) {
+    const originalInvoke = handle.invoke;
+    handle.invoke = async (stepArguments) => {
+        const args = await (0, helpers_1.resolveValue)(input, stepArguments);
+        const canContinue = await condition(args, stepArguments);
+        if (stepArguments.step.definition?.async) {
+            stepArguments.step.definition.backgroundExecution = true;
+        }
+        if (!canContinue) {
+            return helpers_1.StepResponse.skip();
+        }
+        return await originalInvoke(stepArguments);
+    };
+}
+/**
+ * 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
+ * } from "@8medusa/framework/workflows-sdk"
+ *
+ * interface CreateProductInput {
+ *   title: string
+ * }
+ *
+ * export const createProductStep = createStep(
+ *   "createProductStep",
+ *   async function (
+ *     input: CreateProductInput,
+ *     { container }
+ *   ) {
+ *     const productModuleService = container.resolve(
+ *       "product"
+ *     )
+ *     const product = await productModuleService.createProducts(input)
+ *     return new StepResponse({
+ *       product
+ *     }, {
+ *       product_id: product.id
+ *     })
+ *   },
+ *   async function (
+ *     input,
+ *     { container }
+ *   ) {
+ *     if (!input) {
+ *       return
+ *     }
+ *     const productModuleService = container.resolve(
+ *       "product"
+ *     )
+ *     await productModuleService.deleteProducts([input.product_id])
+ *   }
+ * )
+ */
+function createStep(
+/**
+ * The name of the step or its configuration.
+ */
+nameOrConfig, 
+/**
+ * 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 = ((0, utils_1.isString)(nameOrConfig) ? nameOrConfig : nameOrConfig.name) ?? invokeFn.name;
+    const config = (0, utils_1.isString)(nameOrConfig) ? {} : nameOrConfig;
+    const returnFn = function (input) {
+        const context = global[utils_1.OrchestrationUtils.SymbolMedusaWorkflowComposerContext];
+        if (!context) {
+            throw new Error("createStep must be used inside a createWorkflow definition");
+        }
+        return context.stepBinder(applyStep({
+            stepName,
+            stepConfig: config,
+            input,
+            invokeFn,
+            compensateFn,
+        }));
+    };
+    returnFn.__type = utils_1.OrchestrationUtils.SymbolWorkflowStepBind;
+    returnFn.__step__ = stepName;
+    return returnFn;
+}
+//# 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":";;AAuGA,8BA8HC;AA4ID,gCAwEC;AAzbD,0DAK+B;AAC/B,0CAA6D;AAC7D,+BAA2B;AAC3B,uCAAsD;AACtD,uEAAiE;AACjE,2CAAyC;AAiFzC;;;;;;;;;;;GAWG;AACH,SAAgB,SAAS,CAOvB,EACA,QAAQ,EACR,UAAU,GAAG,EAAE,EACf,KAAK,EACL,QAAQ,EACR,YAAY,GAMb;IACC,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,MAAM,OAAO,GAAG,uCAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,QAAQ;YACR,KAAK;YACL,QAAQ;YACR,YAAY;SACb,CAAC,CAAA;QAEF,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAErC,UAAU,CAAC,IAAI,GAAG,IAAA,WAAI,GAAE,CAAA;QACxB,UAAU,CAAC,cAAc,GAAG,CAAC,YAAY,CAAA;QAEzC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;QAEzC,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,eAAe,CAAC,CAAA;QAEnE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACtC,CAAC;QAED,MAAM,GAAG,GAAG;YACV,MAAM,EAAE,0BAAkB,CAAC,kBAAkB;YAC7C,QAAQ,EAAE,QAAQ;SACnB,CAAA;QAED,MAAM,MAAM,GAAG,IAAA,eAAO,EAAC,GAAG,CAKzB,CAAA;QAED,MAAM,CAAC,MAAM,GAAG,CACd,WAGC,EACD,EAAE;YACF,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,IAAI,QAAQ,CAAA;YAChD,MAAM,SAAS,GAAG;gBAChB,KAAK,EAAE,KAAK;gBACZ,eAAe,EAAE,KAAK;gBACtB,GAAG,UAAU;gBACb,GAAG,WAAW;aACf,CAAA;YAED,OAAO,WAAW,CAAC,IAAI,CAAA;YAEvB,MAAM,OAAO,GAAG,uCAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,QAAQ,EAAE,WAAW;gBACrB,KAAK;gBACL,QAAQ;gBACR,YAAY;aACb,CAAC,CAAA;YAEF,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAErC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;YAEvC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAA;YACjE,IAAI,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,eAAe,CAAC,CAAA;YAEjE,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAA;YAC1B,+BAAe,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;YAEjE,IAAI,MAAM,CAAC,0BAAkB,CAAC,qCAAqC,CAAC,EAAE,CAAC;gBACrE,MAAM,SAAS,GACb,MAAM,CAAC,0BAAkB,CAAC,qCAAqC,CAAC,CAAC,KAAK,CAAA;gBAExE,MAAM,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAA;gBACnE,IAAI,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;oBACb,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBAC1B,CAAC;gBACD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACxB,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC,CAAA;QACD,MAAM,CAAC,EAAE,GAAG,CACV,KAAU,EACV,SAAmD,EAChB,EAAE;YACrC,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;YACjD,CAAC;YAED,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;YAC9C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YAExC,OAAO,MAAM,CAAA;QACf,CAAC,CAAA;QAED,IAAI,MAAM,CAAC,0BAAkB,CAAC,qCAAqC,CAAC,EAAE,CAAC;YACrE,MAAM,CACJ,0BAAkB,CAAC,qCAAqC,CACzD,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACtB,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,UAAsC,EACtC,MAGC;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACxC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAA;YAEpC,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,aAA2C,EAAE,EAAE;gBACpE,MAAM,QAAQ,GAAG,CAAC,MAAM,cAAc,CAAC,aAAa,CAAC,CAAQ,CAAA;gBAC7D,IACE,QAAQ,EAAE,MAAM,EAAE,MAAM;oBACxB,0BAAkB,CAAC,0BAA0B,EAC7C,CAAC;oBACD,OAAM;gBACR,CAAC;gBAED,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAA;gBACxD,OAAO,QAAQ,CAAA;YACjB,CAAC,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC;QAC/B,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YAC5C,MAAM,kBAAkB,GAAG,MAAM,CAAC,UAAW,CAAA;YAC7C,MAAM,CAAC,UAAU,GAAG,KAAK,EACvB,aAA2C,EAC3C,EAAE;gBACF,MAAM,QAAQ,GAAG,CAAC,MAAM,kBAAkB,CAAC,aAAa,CAAC,CAAQ,CAAA;gBAEjE,IACE,QAAQ,EAAE,MAAM,EAAE,MAAM;oBACxB,0BAAkB,CAAC,0BAA0B,EAC7C,CAAC;oBACD,OAAM;gBACR,CAAC;gBACD,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAA;gBAExD,OAAO,QAAQ,CAAA;YACjB,CAAC,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAC1B,KAAU,EACV,SAAmD,EACnD,MAGC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAA;IACpC,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,aAA2C,EAAE,EAAE;QACpE,MAAM,IAAI,GAAG,MAAM,IAAA,sBAAY,EAAC,KAAK,EAAE,aAAa,CAAC,CAAA;QACrD,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAExD,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC;YACzC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAA;QAC1D,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,sBAAY,CAAC,IAAI,EAAE,CAAA;QAC5B,CAAC;QAED,OAAO,MAAM,cAAc,CAAC,aAAa,CAAC,CAAA;IAC5C,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,SAAgB,UAAU;AAKxB;;GAEG;AACH,YAKM;AACN;;;GAGG;AACH,QAIC;AACD;;;;;GAKG;AACH,YAAyD;IAEzD,MAAM,QAAQ,GACZ,CAAC,IAAA,gBAAQ,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAA;IAC9E,MAAM,MAAM,GAAG,IAAA,gBAAQ,EAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAA;IAEzD,MAAM,QAAQ,GAAG,UACf,KAIa;QAEb,MAAM,OAAO,GAAG,MAAM,CACpB,0BAAkB,CAAC,mCAAmC,CACtB,CAAA;QAElC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,OAAO,OAAO,CAAC,UAAU,CACvB,SAAS,CAKP;YACA,QAAQ;YACR,UAAU,EAAE,MAAM;YAClB,KAAK;YACL,QAAQ;YACR,YAAY;SACb,CAAC,CACH,CAAA;IACH,CAAoD,CAAA;IAEpD,QAAQ,CAAC,MAAM,GAAG,0BAAkB,CAAC,sBAAsB,CAAA;IAC3D,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAE5B,OAAO,QAAQ,CAAA;AACjB,CAAC"}

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

@@ -0,0 +1,71 @@
+import { TransactionModelOptions } from "@8medusa/orchestration";
+import { WorkflowResponse } from "./helpers/workflow-response";
+import { ReturnWorkflow, WorkflowData } from "./type";
+/**
+ * This function creates a workflow with the provided name and a constructor function.
+ * The constructor function builds the workflow from steps created by the {@link createStep} function.
+ * The returned workflow is an exported workflow of type {@link ReturnWorkflow}, meaning it's not executed right away. To execute it,
+ * invoke the exported workflow, then run its `run` method.
+ *
+ * @typeParam TData - The type of the input passed to the composer function.
+ * @typeParam TResult - The type of the output returned by the composer function.
+ * @typeParam THooks - The type of hooks defined in the workflow.
+ *
+ * @returns The created workflow. You can later execute the workflow by invoking it, then using its `run` method.
+ *
+ * @example
+ * import {
+ *   createWorkflow,
+ *   WorkflowResponse
+ * } from "@8medusa/framework/workflows-sdk"
+ * import { MedusaRequest, MedusaResponse } from "@8medusa/framework/http"
+ * import {
+ *   createProductStep,
+ *   getProductStep,
+ * } from "./steps"
+ *
+ * interface WorkflowInput {
+ *  title: string
+ * }
+ *
+ * const myWorkflow = createWorkflow(
+ *   "my-workflow",
+ *   (input: WorkflowInput) => {
+ *    // Everything here will be executed and resolved later
+ *    // during the execution. Including the data access.
+ *
+ *     const product = createProductStep(input)
+ *     return new WorkflowResponse(getProductStep(product.id))
+ *   }
+ * )
+ *
+ * export async function GET(
+ *   req: MedusaRequest,
+ *   res: MedusaResponse
+ * ) {
+ *   const { result: product } = await myWorkflow(req.scope)
+ *     .run({
+ *       input: {
+ *         title: "Shirt"
+ *       }
+ *     })
+ *
+ *   res.json({
+ *     product
+ *   })
+ * }
+ */
+export declare function createWorkflow<TData, TResult, THooks extends any[]>(
+/**
+ * The name of the workflow or its configuration.
+ */
+nameOrConfig: string | ({
+    name: string;
+} & TransactionModelOptions), 
+/**
+ * The constructor function that is executed when the `run` method in {@link ReturnWorkflow} is used.
+ * The function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.
+ * You'll have to use the {@link transform} function if you need to directly manipulate data.
+ */
+composer: (input: WorkflowData<TData>) => void | WorkflowResponse<TResult, THooks>): ReturnWorkflow<TData, TResult, THooks>;
+//# sourceMappingURL=create-workflow.d.ts.map

package/dist/utils/composer/create-workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-workflow.d.ts","sourceRoot":"","sources":["../../../src/utils/composer/create-workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EAGxB,MAAM,wBAAwB,CAAA;AAiB/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAGL,cAAc,EAEd,YAAY,EACb,MAAM,QAAQ,CAAA;AAIf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE;AACjE;;GAEG;AACH,YAAY,EAAE,MAAM,GAAG,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,uBAAuB,CAAC;AACnE;;;;GAIG;AACH,QAAQ,EAAE,CACR,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,KACvB,IAAI,GAAG,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,GAC5C,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAwKxC"}