@acmekit/workflows-sdk 2.13.1

package/dist/utils/composer/transform.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transform = transform;
+const utils_1 = require("@acmekit/utils");
+const helpers_1 = require("./helpers");
+const proxy_1 = require("./helpers/proxy");
+function transform(values, ...functions) {
+    const uniqId = Math.random().toString(36).substring(2, 20);
+    const ret = {
+        __id: uniqId,
+        __type: utils_1.OrchestrationUtils.SymbolWorkflowStepTransformer,
+    };
+    const returnFn = async function (
+    // If a transformer is returned as the result of a workflow, then at this point the workflow is entirely done, in that case we have a TransactionContext
+    transactionContext) {
+        if ("transaction" in transactionContext) {
+            const temporaryDataKey = `${transactionContext.transaction.modelId}_${transactionContext.transaction.transactionId}_${uniqId}`;
+            ret.__temporary_storage_key ??= temporaryDataKey;
+            if (transactionContext.transaction.hasTemporaryData(ret.__temporary_storage_key)) {
+                return transactionContext.transaction.getTemporaryData(ret.__temporary_storage_key);
+            }
+        }
+        let stepValue = (0, helpers_1.resolveValue)(values, transactionContext);
+        if (stepValue instanceof Promise) {
+            stepValue = await stepValue;
+        }
+        let finalResult;
+        for (let i = 0; i < functions.length; i++) {
+            const fn = functions[i];
+            const arg = i === 0 ? stepValue : finalResult;
+            finalResult = fn.apply(fn, [arg, transactionContext]);
+            if (finalResult instanceof Promise) {
+                finalResult = await finalResult;
+            }
+        }
+        if ("transaction" in transactionContext) {
+            const temporaryDataKey = ret.__temporary_storage_key;
+            transactionContext.transaction.setTemporaryData(temporaryDataKey, finalResult);
+        }
+        return finalResult;
+    };
+    const proxyfiedRet = (0, proxy_1.proxify)(ret);
+    proxyfiedRet.__resolver = returnFn;
+    proxyfiedRet.__temporary_storage_key = null;
+    return proxyfiedRet;
+}
+//# sourceMappingURL=transform.js.map

package/dist/utils/composer/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../src/utils/composer/transform.ts"],"names":[],"mappings":";;AAgKA,8BAoEC;AAhOD,0CAAmD;AACnD,uCAAwC;AACxC,2CAAyC;AA0JzC,SAAgB,SAAS,CACvB,MAAmB,EACnB,GAAG,SAAqB;IAExB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAE1D,MAAM,GAAG,GAAG;QACV,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,0BAAkB,CAAC,6BAA6B;KAKzD,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK;IACpB,wJAAwJ;IACxJ,kBAAqE;QAErE,IAAI,aAAa,IAAI,kBAAkB,EAAE,CAAC;YACxC,MAAM,gBAAgB,GAAG,GAAG,kBAAkB,CAAC,WAAW,CAAC,OAAO,IAAI,kBAAkB,CAAC,WAAW,CAAC,aAAa,IAAI,MAAM,EAAE,CAAA;YAC9H,GAAG,CAAC,uBAAuB,KAAK,gBAAgB,CAAA;YAEhD,IACE,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CAC7C,GAAG,CAAC,uBAAuB,CAC5B,EACD,CAAC;gBACD,OAAO,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CACpD,GAAG,CAAC,uBAAuB,CAC5B,CAAA;YACH,CAAC;QACH,CAAC;QAED,IAAI,SAAS,GAAG,IAAA,sBAAY,EAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;QACxD,IAAI,SAAS,YAAY,OAAO,EAAE,CAAC;YACjC,SAAS,GAAG,MAAM,SAAS,CAAA;QAC7B,CAAC;QAED,IAAI,WAAW,CAAA;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACvB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAA;YAE7C,WAAW,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAA;YACrD,IAAI,WAAW,YAAY,OAAO,EAAE,CAAC;gBACnC,WAAW,GAAG,MAAM,WAAW,CAAA;YACjC,CAAC;QACH,CAAC;QAED,IAAI,aAAa,IAAI,kBAAkB,EAAE,CAAC;YACxC,MAAM,gBAAgB,GAAG,GAAG,CAAC,uBAAwB,CAAA;YACrD,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CAC7C,gBAAgB,EAChB,WAAW,CACZ,CAAA;QACH,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,IAAA,eAAO,EAE1B,GAA8B,CAAC,CAAA;IACjC,YAAY,CAAC,UAAU,GAAG,QAAe,CAAA;IACzC,YAAY,CAAC,uBAAuB,GAAG,IAAqB,CAAA;IAE5D,OAAO,YAAY,CAAA;AACrB,CAAC"}

package/dist/utils/composer/type.d.ts

@@ -0,0 +1,243 @@
+import { LocalWorkflow, OrchestratorBuilder, TransactionContext as OriginalWorkflowTransactionContext, TransactionModelOptions, TransactionPayload, TransactionStepsDefinition, WorkflowHandler } from "@acmekit/orchestration";
+import { Context, LoadedModule, AcmeKitContainer } from "@acmekit/types";
+import { ExportedWorkflow } from "../../helper";
+import { Hook } from "./create-hook";
+import { CompensateFn, InvokeFn } from "./create-step";
+export type StepFunctionResult<TOutput extends unknown | unknown[] = unknown> = (this: CreateWorkflowComposerContext) => WorkflowData<TOutput>;
+export type StepFunctionReturnConfig<TOutput> = {
+    config(config: {
+        name?: string;
+    } & Omit<TransactionStepsDefinition, "next" | "uuid" | "action">): WorkflowData<TOutput>;
+};
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type HookHandler = (...args: any[]) => void | Promise<void>;
+type ConvertHookToObject<THook> = THook extends Hook<infer Name, infer Input, infer Output> ? {
+    [K in Name]: <TCompensateInput>(invoke: InvokeFn<Input, Output, TCompensateInput>, compensate?: CompensateFn<TCompensateInput>) => void;
+} : never;
+/**
+ * Helper to convert an array of hooks to functions
+ */
+type ConvertHooksToFunctions<THooks extends any[]> = THooks extends [
+    infer A,
+    ...infer R
+] ? ConvertHookToObject<A> & ConvertHooksToFunctions<R> : {};
+export type Void = {
+    " $$type": "void";
+};
+/**
+ * A step function to be used in a workflow.
+ *
+ * @typeParam TInput - The type of the input of the step.
+ * @typeParam TOutput - The type of the output of the step.
+ */
+export type StepFunction<TInput, TOutput = unknown> = (KeysOfUnion<TInput> extends [] ? {
+    (): TOutput & {} extends never ? WorkflowData<Void> & StepFunctionReturnConfig<TOutput> : WorkflowData<TOutput> & StepFunctionReturnConfig<TOutput>;
+} : {
+    (input: WorkflowData<TInput> | TInput): WorkflowData<TOutput> & StepFunctionReturnConfig<TOutput>;
+}) & WorkflowDataProperties<TOutput>;
+export type WorkflowDataProperties<T = unknown> = {
+    __type: string;
+    __step__: string;
+};
+/**
+ * This type is used to encapsulate the input or output type of all utils.
+ *
+ * @typeParam T - The type of a step's input or result.
+ */
+export type WorkflowData<T = unknown> = (T extends Array<infer Item> ? Array<Item | WorkflowData<Item>> : T extends object ? {
+    [Key in keyof T]: T[Key] | WorkflowData<T[Key]>;
+} : T & WorkflowDataProperties<T>) & T & WorkflowDataProperties<T> & {
+    config(config: {
+        name?: string;
+    } & Omit<TransactionStepsDefinition, "next" | "uuid" | "action">): WorkflowData<T>;
+};
+export type CreateWorkflowComposerContext = {
+    __type: string;
+    hooks_: {
+        declared: string[];
+        registered: string[];
+    };
+    hooksCallback_: Record<string, HookHandler>;
+    workflowId: string;
+    flow: OrchestratorBuilder;
+    isAsync: boolean;
+    handlers: WorkflowHandler;
+    overriddenHandler: WorkflowHandler;
+    stepBinder: <TOutput = unknown>(fn: StepFunctionResult) => WorkflowData<TOutput>;
+    hookBinder: (name: string, fn: () => HookHandler) => void;
+    stepConditions_: Record<string, {
+        condition: (...args: any[]) => boolean | WorkflowData;
+        input: any;
+    }>;
+    parallelizeBinder: <TOutput extends (WorkflowData | undefined)[] = WorkflowData[]>(fn: (this: CreateWorkflowComposerContext) => TOutput) => TOutput;
+};
+/**
+ * The step's context.
+ */
+export interface StepExecutionContext {
+    /**
+     * The ID of the workflow.
+     */
+    workflowId: string;
+    /**
+     * The attempt number of the step.
+     */
+    attempt: number;
+    /**
+     * The idempoency key of the step.
+     */
+    idempotencyKey: string;
+    /**
+     * The idempoency key of the parent step.
+     */
+    parentStepIdempotencyKey?: string;
+    /**
+     * Whether to prevent release events.
+     */
+    preventReleaseEvents?: boolean;
+    /**
+     * The name of the step.
+     */
+    stepName: string;
+    /**
+     * The action of the step.
+     */
+    action: "invoke" | "compensate";
+    /**
+     * The container used to access resources, such as services, in the step.
+     */
+    container: AcmeKitContainer;
+    /**
+     * Metadata passed in the input.
+     */
+    metadata: TransactionPayload["metadata"];
+    /**
+     * {@inheritDoc types!Context}
+     */
+    context: Context;
+    /**
+     * A string indicating the ID of the group to aggregate the events to be emitted at a later point.
+     */
+    eventGroupId?: string;
+    /**
+     * A string indicating the ID of the current transaction.
+     */
+    transactionId?: string;
+    /**
+     * A string indicating the ID of the current run.
+     */
+    runId?: string;
+    /**
+     * Get access to the result returned by a named step. Returns undefined
+     * when step is not found or when nothing was returned.
+     *
+     * Adding a space hides the method from the autocomplete
+     */
+    " getStepResult"(stepId: string, action?: "invoke" | "compensate"): any;
+    /**
+     * Get access to the definition of the step.
+     */
+    " stepDefinition": TransactionStepsDefinition;
+}
+export type WorkflowTransactionContext = StepExecutionContext & OriginalWorkflowTransactionContext & {
+    invoke: {
+        [key: string]: {
+            output: any;
+        };
+    };
+};
+/**
+ * An exported workflow, which is the type of a workflow constructed by the {@link createWorkflow} function. The exported workflow can be invoked to create
+ * an executable workflow, optionally within a specified container. So, to execute the workflow, you must invoke the exported workflow, then run the
+ * `run` method of the exported workflow.
+ *
+ * @example
+ * To execute a workflow:
+ *
+ * ```ts
+ * myWorkflow()
+ *   .run({
+ *     input: {
+ *       name: "John"
+ *     }
+ *   })
+ *   .then(({ result }) => {
+ *     console.log(result)
+ *   })
+ * ```
+ *
+ * To specify the container of the workflow, you can pass it as an argument to the call of the exported workflow. This is necessary when executing the workflow
+ * within a AcmeKit resource such as an API Route or a Subscriber.
+ *
+ * For example:
+ *
+ * ```ts
+ * import type {
+ *   AcmeKitRequest,
+ *   AcmeKitResponse
+ * } from "@acmekit/acmekit";
+ * import myWorkflow from "../../../workflows/hello-world";
+ *
+ * export async function GET(
+ *   req: AcmeKitRequest,
+ *   res: AcmeKitResponse
+ * ) {
+ *   const { result } = await myWorkflow(req.scope)
+ *     .run({
+ *       input: {
+ *         name: req.query.name as string
+ *       }
+ *     })
+ *
+ *   res.send(result)
+ * }
+ * ```
+ */
+export type ReturnWorkflow<TData, TResult, THooks extends any[]> = {
+    <TDataOverride = undefined, TResultOverride = undefined>(container?: LoadedModule[] | AcmeKitContainer): Omit<LocalWorkflow, "run" | "registerStepSuccess" | "registerStepFailure" | "cancel" | "retryStep"> & ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>;
+} & {
+    /**
+     * This method executes the workflow as a step. Useful when running a workflow within another.
+     *
+     * Learn more in [this documentation](https://docs.acmekit.com/learn/fundamentals/workflows/execute-another-workflow).
+     *
+     * @param param0 - The options to execute the workflow.
+     * @returns The workflow's result
+     */
+    runAsStep: ({ input, }: {
+        /**
+         * The workflow's input.
+         */
+        input: TData | WorkflowData<TData>;
+    }) => ReturnType<StepFunction<TData, TResult>>;
+    /**
+     * This method executes a workflow.
+     *
+     * @param args - The options to execute the workflow.
+     * @returns Details of the workflow's execution, including its result.
+     */
+    run: <TDataOverride = undefined, TResultOverride = undefined>(...args: Parameters<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>["run"]>) => ReturnType<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>["run"]>;
+    /**
+     * This method retrieves the workflow's name.
+     */
+    getName: () => string;
+    /**
+     * This method sets the workflow's configurations.
+     */
+    config: (config: TransactionModelOptions) => void;
+    /**
+     * The workflow's exposed hooks, used to register a handler to consume the hook.
+     *
+     * Learn more in [this documentation](https://docs.acmekit.com/learn/fundamentals/workflows/workflow-hooks#how-to-consume-a-hook).
+     */
+    hooks: ConvertHooksToFunctions<THooks>;
+};
+/**
+ * Extract the raw type of the expected input data of a workflow.
+ *
+ * @example
+ * type WorkflowInputData = UnwrapWorkflowInputDataType<typeof myWorkflow>
+ */
+export type UnwrapWorkflowInputDataType<T extends ReturnWorkflow<any, any, any>> = T extends ReturnWorkflow<infer TData, infer R, infer THooks> ? TData : never;
+export {};
+//# sourceMappingURL=type.d.ts.map

package/dist/utils/composer/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/utils/composer/type.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,kBAAkB,IAAI,kCAAkC,EACxD,uBAAuB,EACvB,kBAAkB,EAClB,0BAA0B,EAC1B,eAAe,EAChB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAEtD,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,OAAO,GAAG,OAAO,EAAE,GAAG,OAAO,IAC1E,CAAC,IAAI,EAAE,6BAA6B,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAEhE,MAAM,MAAM,wBAAwB,CAAC,OAAO,IAAI;IAC9C,MAAM,CACJ,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAC9B,0BAA0B,EAC1B,MAAM,GAAG,MAAM,GAAG,QAAQ,CAC3B,GACA,YAAY,CAAC,OAAO,CAAC,CAAA;CACzB,CAAA;AAED,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;AACnD,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAElE,KAAK,mBAAmB,CAAC,KAAK,IAAI,KAAK,SAAS,IAAI,CAClD,MAAM,IAAI,EACV,MAAM,KAAK,EACX,MAAM,MAAM,CACb,GACG;KACG,CAAC,IAAI,IAAI,GAAG,CAAC,gBAAgB,EAC5B,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,gBAAgB,CAAC,EACjD,UAAU,CAAC,EAAE,YAAY,CAAC,gBAAgB,CAAC,KACxC,IAAI;CACV,GACD,KAAK,CAAA;AAET;;GAEG;AACH,KAAK,uBAAuB,CAAC,MAAM,SAAS,GAAG,EAAE,IAAI,MAAM,SAAS;IAClE,MAAM,CAAC;IACP,GAAG,MAAM,CAAC;CACX,GACG,mBAAmB,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,GACnD,EAAE,CAAA;AAEN,MAAM,MAAM,IAAI,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAExC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CACtB,MAAM,EACN,OAAO,GAAG,OAAO,IACf,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,GAE/B;IACE,IAAI,OAAO,GAAG,EAAE,SAAS,KAAK,GAC1B,YAAY,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,OAAO,CAAC,GACtD,YAAY,CAAC,OAAO,CAAC,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;CAC9D,GAED;IACE,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,GAC3D,wBAAwB,CAAC,OAAO,CAAC,CAAA;CACpC,CAAC,GACJ,sBAAsB,CAAC,OAAO,CAAC,CAAA;AAEjC,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAAI;IAChD,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAChE,KAAK,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,GAChC,CAAC,SAAS,MAAM,GAChB;KACG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAChD,GACD,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAChC,CAAC,GACD,sBAAsB,CAAC,CAAC,CAAC,GAAG;IAC1B,MAAM,CACJ,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAC9B,0BAA0B,EAC1B,MAAM,GAAG,MAAM,GAAG,QAAQ,CAC3B,GACA,YAAY,CAAC,CAAC,CAAC,CAAA;CACnB,CAAA;AAEH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAA;IACD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC3C,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,mBAAmB,CAAA;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,eAAe,CAAA;IACzB,iBAAiB,EAAE,eAAe,CAAA;IAClC,UAAU,EAAE,CAAC,OAAO,GAAG,OAAO,EAC5B,EAAE,EAAE,kBAAkB,KACnB,YAAY,CAAC,OAAO,CAAC,CAAA;IAC1B,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,WAAW,KAAK,IAAI,CAAA;IACzD,eAAe,EAAE,MAAM,CACrB,MAAM,EACN;QACE,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,GAAG,YAAY,CAAA;QACrD,KAAK,EAAE,GAAG,CAAA;KACX,CACF,CAAA;IACD,iBAAiB,EAAE,CACjB,OAAO,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,EAAE,GAAG,YAAY,EAAE,EAE7D,EAAE,EAAE,CAAC,IAAI,EAAE,6BAA6B,KAAK,OAAO,KACjD,OAAO,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;IAE/B;;OAEG;IACH,SAAS,EAAE,gBAAgB,CAAA;IAC3B;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAA;IACxC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,GAAG,CAAA;IAEvE;;OAEG;IACH,iBAAiB,EAAE,0BAA0B,CAAA;CAC9C;AAED,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,GAC3D,kCAAkC,GAAG;IACnC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,MAAM,EAAE,GAAG,CAAA;SAAE,CAAA;KAAE,CAAA;CAC3C,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE,IAAI;IACjE,CAAC,aAAa,GAAG,SAAS,EAAE,eAAe,GAAG,SAAS,EACrD,SAAS,CAAC,EAAE,YAAY,EAAE,GAAG,gBAAgB,GAC5C,IAAI,CACL,aAAa,EACX,KAAK,GACL,qBAAqB,GACrB,qBAAqB,GACrB,QAAQ,GACR,WAAW,CACd,GACC,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,CAAC,CAAA;CACnE,GAAG;IACF;;;;;;;OAOG;IACH,SAAS,EAAE,CAAC,EACV,KAAK,GACN,EAAE;QACD;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;KACnC,KAAK,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;IAC9C;;;;;OAKG;IACH,GAAG,EAAE,CAAC,aAAa,GAAG,SAAS,EAAE,eAAe,GAAG,SAAS,EAC1D,GAAG,IAAI,EAAE,UAAU,CACjB,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,CACxE,KACE,UAAU,CACb,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,CACxE,CAAA;IACD;;OAEG;IACH,OAAO,EAAE,MAAM,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAA;IACjD;;;;OAIG;IACH,KAAK,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAA;CACvC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IACrC,CAAC,SAAS,cAAc,CAAC,MAAM,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC,GAAG,KAAK,GAAG,KAAK,CAAA"}

package/dist/utils/composer/type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/dist/utils/composer/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/utils/composer/type.ts"],"names":[],"mappings":""}

package/dist/utils/composer/when.d.ts

@@ -0,0 +1,58 @@
+import { StepExecutionContext, WorkflowData } from "./type";
+type ConditionFunction<T extends object | WorkflowData> = (input: T extends WorkflowData<infer U> ? U : T extends object ? {
+    [K in keyof T]: T[K] extends WorkflowData<infer U> ? U : T[K];
+} : {}, context: StepExecutionContext) => boolean;
+type ThenFunc = <ThenResolver extends () => any>(resolver: ThenResolver) => ReturnType<ThenResolver> extends WorkflowData<infer ReturnedWorkflowData> ? WorkflowData<ReturnedWorkflowData> | undefined : ReturnType<ThenResolver>;
+/**
+ * This function allows you to execute steps only if a condition is satisfied. As you can't use if conditions in
+ * a workflow's constructor function, use `when-then` instead.
+ *
+ * Learn more about why you can't use if conditions and `when-then` in [this documentation](https://docs.acmekit.com/learn/fundamentals/workflows/conditions).
+ *
+ * @param values - The data to pass to the second parameter function.
+ * @param condition - A function that returns a boolean value, indicating whether the steps in `then` should be executed.
+ *
+ * @example
+ * import {
+ *   createWorkflow,
+ *   WorkflowResponse,
+ *   when,
+ * } from "@acmekit/framework/workflows-sdk"
+ * // step imports...
+ *
+ * export const workflow = createWorkflow(
+ *   "workflow",
+ *   function (input: {
+ *     is_active: boolean
+ *   }) {
+ *
+ *     const result = when(
+ *       input,
+ *       (input) => {
+ *         return input.is_active
+ *       }
+ *     ).then(() => {
+ *       const stepResult = isActiveStep()
+ *       return stepResult
+ *     })
+ *
+ *     // executed without condition
+ *     const anotherStepResult = anotherStep(result)
+ *
+ *     return new WorkflowResponse(
+ *       anotherStepResult
+ *     )
+ *   }
+ * )
+ */
+export declare function when<T extends object | WorkflowData, Then extends Function>(values: T, condition: ConditionFunction<T>): {
+    then: ThenFunc;
+};
+/**
+ * @internal
+ */
+export declare function when<T extends object | WorkflowData, Then extends Function>(name: string, values: T, condition: ConditionFunction<T>): {
+    then: ThenFunc;
+};
+export {};
+//# sourceMappingURL=when.d.ts.map

package/dist/utils/composer/when.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"when.d.ts","sourceRoot":"","sources":["../../../src/utils/composer/when.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAE3D,KAAK,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,IAAI,CACxD,KAAK,EAAE,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAClC,CAAC,GACD,CAAC,SAAS,MAAM,GAChB;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GACjE,EAAE,EACN,OAAO,EAAE,oBAAoB,KAC1B,OAAO,CAAA;AAEZ,KAAK,QAAQ,GAAG,CAAC,YAAY,SAAS,MAAM,GAAG,EAC7C,QAAQ,EAAE,YAAY,KACnB,UAAU,CAAC,YAAY,CAAC,SAAS,YAAY,CAAC,MAAM,oBAAoB,CAAC,GAC1E,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS,GAC9C,UAAU,CAAC,YAAY,CAAC,CAAA;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,EAAE,IAAI,SAAS,QAAQ,EACzE,MAAM,EAAE,CAAC,EACT,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC9B;IACD,IAAI,EAAE,QAAQ,CAAA;CACf,CAAA;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,EAAE,IAAI,SAAS,QAAQ,EACzE,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,EACT,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC9B;IACD,IAAI,EAAE,QAAQ,CAAA;CACf,CAAA"}

package/dist/utils/composer/when.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.when = when;
+const utils_1 = require("@acmekit/utils");
+const ulid_1 = require("ulid");
+const create_step_1 = require("./create-step");
+const step_response_1 = require("./helpers/step-response");
+/**
+ * @internal
+ */
+function when(...args) {
+    let [name, input, condition] = args;
+    if (args.length === 2) {
+        condition = input;
+        input = name;
+        name = undefined;
+    }
+    if (typeof condition !== "function") {
+        throw new Error(`"when condition" must be a function`);
+    }
+    global[utils_1.OrchestrationUtils.SymbolAcmeKitWorkflowComposerCondition] = {
+        input,
+        condition,
+        steps: [],
+    };
+    let thenCalled = false;
+    process.nextTick(() => {
+        if (!thenCalled) {
+            throw new Error(`".then" is missing after "when" condition`);
+        }
+    });
+    return {
+        then: (fn) => {
+            thenCalled = true;
+            const ret = fn();
+            let returnStep = ret;
+            const applyCondition = global[utils_1.OrchestrationUtils.SymbolAcmeKitWorkflowComposerCondition].steps;
+            if ((0, utils_1.isDefined)(ret) &&
+                ret?.__type !== utils_1.OrchestrationUtils.SymbolWorkflowStep) {
+                if (!(0, utils_1.isDefined)(name)) {
+                    name = "when-then-" + (0, ulid_1.ulid)();
+                    const context = global[utils_1.OrchestrationUtils.SymbolAcmeKitWorkflowComposerContext];
+                    console.warn(`${context.workflowId}: "when" name should be defined. A random one will be assigned to it, which is not recommended for production.\n`, condition.toString());
+                }
+                const retStep = (0, create_step_1.createStep)(name, ({ input }) => new step_response_1.StepResponse(input));
+                /**
+                 * object ret = { result, hooks }
+                 */
+                if ((0, utils_1.isObject)(ret) && "hooks" in ret && "result" in ret) {
+                    returnStep = {
+                        hooks: ret.hooks,
+                        result: retStep({ input: ret.result }),
+                    };
+                }
+                else {
+                    returnStep = retStep({ input: ret });
+                }
+            }
+            for (const step of applyCondition) {
+                step.if(input, condition);
+            }
+            delete global[utils_1.OrchestrationUtils.SymbolAcmeKitWorkflowComposerCondition];
+            return returnStep;
+        },
+    };
+}
+//# sourceMappingURL=when.js.map

package/dist/utils/composer/when.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"when.js","sourceRoot":"","sources":["../../../src/utils/composer/when.ts"],"names":[],"mappings":";;AAoFA,oBA4EC;AAhKD,0CAAwE;AACxE,+BAA2B;AAC3B,+CAA0C;AAC1C,2DAAsD;AA8EtD;;GAEG;AACH,SAAgB,IAAI,CAAC,GAAG,IAAI;IAC1B,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,IAAI,CAAA;IACnC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,KAAK,CAAA;QACjB,KAAK,GAAG,IAAI,CAAA;QACZ,IAAI,GAAG,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,0BAAkB,CAAC,sCAAsC,CAAC,GAAG;QAClE,KAAK;QACL,SAAS;QACT,KAAK,EAAE,EAAE;KACV,CAAA;IAED,IAAI,UAAU,GAAG,KAAK,CAAA;IACtB,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;QACpB,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;YACX,UAAU,GAAG,IAAI,CAAA;YACjB,MAAM,GAAG,GAAG,EAAE,EAAE,CAAA;YAChB,IAAI,UAAU,GAAG,GAAG,CAAA;YAEpB,MAAM,cAAc,GAClB,MAAM,CAAC,0BAAkB,CAAC,sCAAsC,CAAC,CAAC,KAAK,CAAA;YAEzE,IACE,IAAA,iBAAS,EAAC,GAAG,CAAC;gBACd,GAAG,EAAE,MAAM,KAAK,0BAAkB,CAAC,kBAAkB,EACrD,CAAC;gBACD,IAAI,CAAC,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC;oBACrB,IAAI,GAAG,YAAY,GAAG,IAAA,WAAI,GAAE,CAAA;oBAC5B,MAAM,OAAO,GACX,MAAM,CAAC,0BAAkB,CAAC,oCAAoC,CAAC,CAAA;oBAEjE,OAAO,CAAC,IAAI,CACV,GAAG,OAAO,CAAC,UAAU,kHAAkH,EACvI,SAAS,CAAC,QAAQ,EAAE,CACrB,CAAA;gBACH,CAAC;gBAED,MAAM,OAAO,GAAG,IAAA,wBAAU,EACxB,IAAI,EACJ,CAAC,EAAE,KAAK,EAAkB,EAAE,EAAE,CAAC,IAAI,4BAAY,CAAC,KAAK,CAAC,CACvD,CAAA;gBAED;;mBAEG;gBACH,IAAI,IAAA,gBAAQ,EAAC,GAAG,CAAC,IAAI,OAAO,IAAI,GAAG,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAC;oBACvD,UAAU,GAAG;wBACX,KAAK,EAAE,GAAG,CAAC,KAAK;wBAChB,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;qBACvC,CAAA;gBACH,CAAC;qBAAM,CAAC;oBACN,UAAU,GAAG,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;gBACtC,CAAC;YACH,CAAC;YAED,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;gBAClC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;YAC3B,CAAC;YAED,OAAO,MAAM,CAAC,0BAAkB,CAAC,sCAAsC,CAAC,CAAA;YAExE,OAAO,UAAU,CAAA;QACnB,CAAC;KACF,CAAA;AACH,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@acmekit/workflows-sdk",
+  "version": "2.13.1",
+  "description": "Set of workflows tooling for AcmeKit",
+  "main": "dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./composer": "./dist/utils/composer/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acmekit/acmekit",
+    "directory": "packages/core/workflows-sdk"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "author": "AcmeKit",
+  "license": "MIT",
+  "devDependencies": {
+    "@acmekit/types": "2.13.1"
+  },
+  "dependencies": {
+    "@acmekit/deps": "2.13.1",
+    "@acmekit/modules-sdk": "2.13.1",
+    "@acmekit/orchestration": "2.13.1",
+    "@acmekit/utils": "2.13.1",
+    "ulid": "^2.3.0"
+  },
+  "scripts": {
+    "build": "yarn run -T rimraf dist && yarn run -T tsc --build",
+    "watch": "yarn run -T tsc --build --watch",
+    "test": "../../../node_modules/.bin/jest --bail --forceExit --testPathPattern=src",
+    "test:run": "node ./dist/utils/_playground.js"
+  }
+}