@acmekit/core-flows 2.13.1

package/dist/locking/index.js

@@ -0,0 +1,19 @@
+"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("./steps/acquire-lock"), exports);
+__exportStar(require("./steps/release-lock"), exports);
+//# sourceMappingURL=index.js.map

package/dist/locking/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locking/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,uDAAoC"}

package/dist/locking/steps/acquire-lock.d.ts

@@ -0,0 +1,49 @@
+/**
+ * The keys to be locked
+ */
+export interface AcquireLockStepInput {
+    /**
+     * The keys to be locked
+     */
+    key: string | string[];
+    /**
+     * The maximum time (in seconds) to wait for acquiring the lock. If the lock cannot be acquired within this time, an error is thrown.
+     *
+     * @defaultValue 0
+     */
+    timeout?: number;
+    /**
+     * The time (in seconds) to wait between each retry to acquire the lock.
+     *
+     * @defaultValue 0.3
+     */
+    retryInterval?: number;
+    /**
+     * The expiration time (in seconds) for the lock. If the lock is already acquired and the owner is the same,
+     * the expiration time is extended by the value passed. If not specified, the lock does not expire.
+     */
+    ttl?: number;
+    /**
+     * The owner ID for the lock. If specified, only the owner can release the lock or extend its expiration time.
+     */
+    ownerId?: string;
+    /**
+     * The provider name to use for locking. If no provider is passed, the default provider
+     * (in-memory or the provider configured in acmekit-config.ts) will be used.
+     */
+    provider?: string;
+    executeOnSubWorkflow?: boolean;
+}
+export declare const acquireLockStepId = "acquire-lock-step";
+/**
+ * This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.acmekit.com/resources/infrastructure-modules/locking)
+ * guide.
+ *
+ * @example
+ * const data = acquireLockStep({
+ *   "key": "my-lock-key",
+ *   "ttl": 60
+ * })
+ */
+export declare const acquireLockStep: import("@acmekit/framework/workflows-sdk").StepFunction<AcquireLockStepInput, unknown>;
+//# sourceMappingURL=acquire-lock.d.ts.map

package/dist/locking/steps/acquire-lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acquire-lock.d.ts","sourceRoot":"","sources":["../../../src/locking/steps/acquire-lock.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,wFA+D3B,CAAA"}

package/dist/locking/steps/acquire-lock.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acquireLockStep = exports.acquireLockStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const promises_1 = require("timers/promises");
+exports.acquireLockStepId = "acquire-lock-step";
+/**
+ * This step acquires a lock for a given key. Learn more about locks in the [Locking Module](https://docs.acmekit.com/resources/infrastructure-modules/locking)
+ * guide.
+ *
+ * @example
+ * const data = acquireLockStep({
+ *   "key": "my-lock-key",
+ *   "ttl": 60
+ * })
+ */
+exports.acquireLockStep = (0, workflows_sdk_1.createStep)(exports.acquireLockStepId, async (data, { container, parentStepIdempotencyKey }) => {
+    const keys = Array.isArray(data.key)
+        ? data.key
+        : (0, utils_1.isDefined)(data.key)
+            ? [data.key]
+            : [];
+    if (!keys.length) {
+        return new workflows_sdk_1.StepResponse(void 0);
+    }
+    const isSubWorkflow = !!parentStepIdempotencyKey;
+    if (isSubWorkflow && !data.executeOnSubWorkflow) {
+        return workflows_sdk_1.StepResponse.skip();
+    }
+    const locking = container.resolve(utils_1.Modules.LOCKING);
+    const retryInterval = data.retryInterval ?? 0.3;
+    const tryUntil = Date.now() + (data.timeout ?? 0) * 1000;
+    while (true) {
+        try {
+            await locking.acquire(data.key, {
+                expire: data.ttl,
+                ownerId: data.ownerId,
+                provider: data.provider,
+            });
+            break;
+        }
+        catch (e) {
+            if (Date.now() >= tryUntil) {
+                throw e;
+            }
+        }
+        await (0, promises_1.setTimeout)(retryInterval * 1000);
+    }
+    return new workflows_sdk_1.StepResponse(void 0, {
+        keys,
+        ownerId: data.ownerId,
+        provider: data.provider,
+    });
+}, async (data, { container }) => {
+    if (!data?.keys?.length) {
+        return;
+    }
+    const locking = container.resolve(utils_1.Modules.LOCKING);
+    await locking.release(data.keys, {
+        ownerId: data.ownerId,
+        provider: data.provider,
+    });
+    return new workflows_sdk_1.StepResponse();
+});
+//# sourceMappingURL=acquire-lock.js.map

package/dist/locking/steps/acquire-lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"acquire-lock.js","sourceRoot":"","sources":["../../../src/locking/steps/acquire-lock.ts"],"names":[],"mappings":";;;AAAA,oDAA6D;AAC7D,oEAA2E;AAC3E,8CAA4C;AAuC/B,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;;;GASG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EACH,IAA0B,EAC1B,EAAE,SAAS,EAAE,wBAAwB,EAAE,EACvC,EAAE;IACF,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAClC,CAAC,CAAC,IAAI,CAAC,GAAG;QACV,CAAC,CAAC,IAAA,iBAAS,EAAC,IAAI,CAAC,GAAG,CAAC;YACrB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YACZ,CAAC,CAAC,EAAE,CAAA;IAEN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,CAAC,wBAAwB,CAAA;IAChD,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,OAAO,4BAAY,CAAC,IAAI,EAAS,CAAA;IACnC,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,GAAG,CAAA;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAA;IAExD,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC9B,MAAM,EAAE,IAAI,CAAC,GAAG;gBAChB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAA;YACF,MAAK;QACP,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC3B,MAAM,CAAC,CAAA;YACT,CAAC;QACH,CAAC;QAED,MAAM,IAAA,qBAAU,EAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE;QAC9B,IAAI;QACJ,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,IAAS,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACjC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC,CAAA;IAEF,OAAO,IAAI,4BAAY,EAAE,CAAA;AAC3B,CAAC,CACF,CAAA"}

package/dist/locking/steps/release-lock.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The locked keys to be released
+ */
+export interface ReleaseLockStepInput {
+    /**
+     * The keys to be released
+     */
+    key: string | string[];
+    /**
+     * The ID of the lock's owner. The lock can be released either if it doesn't have an owner,
+     * or if its owner ID matches the one passed in this property.
+     */
+    ownerId?: string;
+    /**
+     * The provider name to use for locking. If no provider is passed,
+     * the default provider (in-memory or the provider configured in acmekit-config.ts) will be used.
+     */
+    provider?: string;
+    executeOnSubWorkflow?: boolean;
+}
+export declare const releaseLockStepId = "release-lock-step";
+/**
+ * This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.acmekit.com/resources/infrastructure-modules/locking)
+ * guide.
+ *
+ * @example
+ * const data = releaseLockStep({
+ *   key: "my-lock-key"
+ * })
+ */
+export declare const releaseLockStep: import("@acmekit/framework/workflows-sdk").StepFunction<ReleaseLockStepInput, unknown>;
+//# sourceMappingURL=release-lock.d.ts.map

package/dist/locking/steps/release-lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-lock.d.ts","sourceRoot":"","sources":["../../../src/locking/steps/release-lock.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,wFA8B3B,CAAA"}

package/dist/locking/steps/release-lock.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.releaseLockStep = exports.releaseLockStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.releaseLockStepId = "release-lock-step";
+/**
+ * This step releases a lock for a given key. Learn more about locks in the [Locking Module](https://docs.acmekit.com/resources/infrastructure-modules/locking)
+ * guide.
+ *
+ * @example
+ * const data = releaseLockStep({
+ *   key: "my-lock-key"
+ * })
+ */
+exports.releaseLockStep = (0, workflows_sdk_1.createStep)(exports.releaseLockStepId, async (data, { container, parentStepIdempotencyKey }) => {
+    const keys = Array.isArray(data.key)
+        ? data.key
+        : (0, utils_1.isDefined)(data.key)
+            ? [data.key]
+            : [];
+    if (!keys.length) {
+        return new workflows_sdk_1.StepResponse(true);
+    }
+    const isSubWorkflow = !!parentStepIdempotencyKey;
+    if (isSubWorkflow && !data.executeOnSubWorkflow) {
+        return workflows_sdk_1.StepResponse.skip();
+    }
+    const ownerId = data.ownerId;
+    const locking = container.resolve(utils_1.Modules.LOCKING);
+    const released = await locking.release(keys, {
+        ownerId,
+        provider: data.provider,
+    });
+    return new workflows_sdk_1.StepResponse(released);
+});
+//# sourceMappingURL=release-lock.js.map

package/dist/locking/steps/release-lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-lock.js","sourceRoot":"","sources":["../../../src/locking/steps/release-lock.ts"],"names":[],"mappings":";;;AAAA,oDAA6D;AAC7D,oEAA2E;AAuB9D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;;GAQG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EACH,IAA0B,EAC1B,EAAE,SAAS,EAAE,wBAAwB,EAAE,EACvC,EAAE;IACF,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAClC,CAAC,CAAC,IAAI,CAAC,GAAG;QACV,CAAC,CAAC,IAAA,iBAAS,EAAC,IAAI,CAAC,GAAG,CAAC;YACrB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YACZ,CAAC,CAAC,EAAE,CAAA;IAEN,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,CAAC,wBAAwB,CAAA;IAChD,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,OAAO,4BAAY,CAAC,IAAI,EAAS,CAAA;IACnC,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;IAC5B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;QAC3C,OAAO;QACP,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC,CAAA;IAEF,OAAO,IAAI,4BAAY,CAAC,QAAQ,CAAC,CAAA;AACnC,CAAC,CACF,CAAA"}

package/dist/notification/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./steps";
+//# sourceMappingURL=index.d.ts.map

package/dist/notification/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notification/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}

package/dist/notification/index.js

@@ -0,0 +1,18 @@
+"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("./steps"), exports);
+//# sourceMappingURL=index.js.map

package/dist/notification/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB"}

package/dist/notification/steps/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./send-notifications";
+export * from "./notify-on-failure";
+//# sourceMappingURL=index.d.ts.map

package/dist/notification/steps/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA"}

package/dist/notification/steps/index.js

@@ -0,0 +1,19 @@
+"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("./send-notifications"), exports);
+__exportStar(require("./notify-on-failure"), exports);
+//# sourceMappingURL=index.js.map

package/dist/notification/steps/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/notification/steps/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,sDAAmC"}

package/dist/notification/steps/notify-on-failure.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The notifications to send.
+ */
+export type NotifyOnFailureStepInput = {
+    /**
+     * The address to send the notification to, depending on
+     * the channel. For example, the email address for the email channel.
+     */
+    to: string;
+    /**
+     * The channel to send the notification through. For example, `email`.
+     * A [Notification Module Provider](https://docs.acmekit.com/resources/infrastructure-modules/notification)
+     * must be installed and configured for the specified channel.
+     */
+    channel: string;
+    /**
+     * The ID of the template to use for the notification. This template ID may be defined
+     * in a third-party service used to send the notification.
+     */
+    template: string;
+    /**
+     * The data to use in the notification template. This data may be used to personalize
+     * the notification, such as the user's name or the order number.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The type of trigger that caused the notification to be sent. For example, `order_created`.
+     */
+    trigger_type?: string | null;
+    /**
+     * The ID of the resource that triggered the notification. For example, the ID of the order
+     * that triggered the notification.
+     */
+    resource_id?: string | null;
+    /**
+     * The type of the resource that triggered the notification. For example, `order`.
+     */
+    resource_type?: string | null;
+    /**
+     * The ID of the user receiving the notification.
+     */
+    receiver_id?: string | null;
+    /**
+     * The ID of the original notification if it's being resent.
+     */
+    original_notification_id?: string | null;
+    /**
+     * A key to ensure that the notification is sent only once. If the notification
+     * is sent multiple times, the key ensures that the notification is sent only once.
+     */
+    idempotency_key?: string | null;
+}[];
+export declare const notifyOnFailureStepId = "notify-on-failure";
+/**
+ * This step sends one or more notification when a workflow fails. This
+ * step can be used in the beginning of a workflow so that, when the workflow fails,
+ * the step's compensation function is triggered to send the notification.
+ *
+ * @example
+ * const data = notifyOnFailureStep([{
+ *   to: "example@gmail.com",
+ *   channel: "email",
+ *   template: "order-failed",
+ *   data: {
+ *     order_id: "order_123",
+ *   }
+ * }])
+ */
+export declare const notifyOnFailureStep: import("@acmekit/framework/workflows-sdk").StepFunction<NotifyOnFailureStepInput, undefined>;
+//# sourceMappingURL=notify-on-failure.d.ts.map

package/dist/notification/steps/notify-on-failure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notify-on-failure.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/notify-on-failure.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC,EAAE,CAAA;AAEH,eAAO,MAAM,qBAAqB,sBAAsB,CAAA;AACxD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,8FAgB/B,CAAA"}

package/dist/notification/steps/notify-on-failure.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notifyOnFailureStep = exports.notifyOnFailureStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.notifyOnFailureStepId = "notify-on-failure";
+/**
+ * This step sends one or more notification when a workflow fails. This
+ * step can be used in the beginning of a workflow so that, when the workflow fails,
+ * the step's compensation function is triggered to send the notification.
+ *
+ * @example
+ * const data = notifyOnFailureStep([{
+ *   to: "example@gmail.com",
+ *   channel: "email",
+ *   template: "order-failed",
+ *   data: {
+ *     order_id: "order_123",
+ *   }
+ * }])
+ */
+exports.notifyOnFailureStep = (0, workflows_sdk_1.createStep)(exports.notifyOnFailureStepId, async (data) => {
+    return new workflows_sdk_1.StepResponse(void 0, data);
+}, async (data, { container }) => {
+    if (!data) {
+        return;
+    }
+    const service = container.resolve(utils_1.Modules.NOTIFICATION);
+    await service.createNotifications(data);
+});
+//# sourceMappingURL=notify-on-failure.js.map

package/dist/notification/steps/notify-on-failure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notify-on-failure.js","sourceRoot":"","sources":["../../../src/notification/steps/notify-on-failure.ts"],"names":[],"mappings":";;;AACA,oDAAkD;AAClD,oEAA2E;AAuD9D,QAAA,qBAAqB,GAAG,mBAAmB,CAAA;AACxD;;;;;;;;;;;;;;GAcG;AACU,QAAA,mBAAmB,GAAG,IAAA,0BAAU,EAC3C,6BAAqB,EACrB,KAAK,EAAE,IAA8B,EAAE,EAAE;IACvC,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;AACvC,CAAC,EAED,KAAK,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC5B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAC/B,eAAO,CAAC,YAAY,CACrB,CAAA;IACD,MAAM,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}

package/dist/notification/steps/send-notifications.d.ts

@@ -0,0 +1,74 @@
+import type { Attachment, NotificationContent } from "@acmekit/framework/types";
+/**
+ * The notifications to send.
+ */
+export type SendNotificationsStepInput = {
+    /**
+     * The address to send the notification to, depending on
+     * the channel. For example, the email address for the email channel.
+     */
+    to: string;
+    /**
+     * The address to send the notification from, depending on
+     * the channel. For example, the email address for the email channel.
+     */
+    from?: string | null;
+    /**
+     * The channel to send the notification through. For example, `email`.
+     */
+    channel: string;
+    /**
+     * The ID of the template to use for the notification. This template ID may be defined
+     * in a third-party service used to send the notification.
+     */
+    template?: string | null;
+    /**
+     * The content that gets passed over to the provider.
+     */
+    content?: NotificationContent | null;
+    /**
+     * The data to use in the notification template. This data may be used to personalize
+     * the notification, such as the user's name or the order number.
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * Additional data specific to the provider or channel. For example, cc and bcc for emails.
+     */
+    provider_data?: Record<string, unknown> | null;
+    /**
+     * The type of trigger that caused the notification to be sent. For example, `order_created`.
+     */
+    trigger_type?: string | null;
+    /**
+     * The ID of the resource that triggered the notification. For example, the ID of the order
+     * that triggered the notification.
+     */
+    resource_id?: string | null;
+    /**
+     * The type of the resource that triggered the notification. For example, `order`.
+     */
+    resource_type?: string | null;
+    /**
+     * The ID of the user receiving the notification.
+     */
+    receiver_id?: string | null;
+    /**
+     * The ID of the original notification if it's being resent.
+     */
+    original_notification_id?: string | null;
+    /**
+     * A key to ensure that the notification is sent only once. If the notification
+     * is sent multiple times, the key ensures that the notification is sent only once.
+     */
+    idempotency_key?: string | null;
+    /**
+     * Optional attachments for the notification.
+     */
+    attachments?: Attachment[] | null;
+}[];
+export declare const sendNotificationsStepId = "send-notifications";
+/**
+ * This step sends one or more notifications.
+ */
+export declare const sendNotificationsStep: import("@acmekit/framework/workflows-sdk").StepFunction<SendNotificationsStepInput, import("@acmekit/framework/types").NotificationDTO[]>;
+//# sourceMappingURL=send-notifications.d.ts.map

package/dist/notification/steps/send-notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-notifications.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAEV,mBAAmB,EACpB,MAAM,0BAA0B,CAAA;AAIjC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;IACpC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAC9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;CAClC,EAAE,CAAA;AAEH,eAAO,MAAM,uBAAuB,uBAAuB,CAAA;AAC3D;;GAEG;AACH,eAAO,MAAM,qBAAqB,2IAajC,CAAA"}

package/dist/notification/steps/send-notifications.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendNotificationsStep = exports.sendNotificationsStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.sendNotificationsStepId = "send-notifications";
+/**
+ * This step sends one or more notifications.
+ */
+exports.sendNotificationsStep = (0, workflows_sdk_1.createStep)(exports.sendNotificationsStepId, async (data, { container }) => {
+    const service = container.resolve(utils_1.Modules.NOTIFICATION);
+    const created = await service.createNotifications(data);
+    return new workflows_sdk_1.StepResponse(created, created.map((notification) => notification.id));
+}
+// Most of the notifications are irreversible, so we can't compensate notifications reliably
+);
+//# sourceMappingURL=send-notifications.js.map

package/dist/notification/steps/send-notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-notifications.js","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":";;;AAKA,oDAAkD;AAClD,oEAA2E;AAsE9D,QAAA,uBAAuB,GAAG,oBAAoB,CAAA;AAC3D;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAA,0BAAU,EAC7C,+BAAuB,EACvB,KAAK,EAAE,IAAgC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACxD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAC/B,eAAO,CAAC,YAAY,CACrB,CAAA;IACD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IACvD,OAAO,IAAI,4BAAY,CACrB,OAAO,EACP,OAAO,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAC/C,CAAA;AACH,CAAC;AACD,4FAA4F;CAC7F,CAAA"}

package/dist/order/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./steps";
+export * from "./workflows";
+//# sourceMappingURL=index.d.ts.map

package/dist/order/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/order/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA"}

package/dist/order/index.js

@@ -0,0 +1,19 @@
+"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("./steps"), exports);
+__exportStar(require("./workflows"), exports);
+//# sourceMappingURL=index.js.map

package/dist/order/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/order/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,8CAA2B"}

package/dist/order/steps/add-order-transaction.d.ts

@@ -0,0 +1,15 @@
+import type { CreateOrderTransactionDTO } from "@acmekit/framework/types";
+/**
+ * The transaction(s) to add to the order.
+ */
+export type AddOrderTransactionStepInput = CreateOrderTransactionDTO | CreateOrderTransactionDTO[];
+/**
+ * The added order transaction(s).
+ */
+export type AddOrderTransactionStepOutput = CreateOrderTransactionDTO | CreateOrderTransactionDTO[];
+export declare const addOrderTransactionStepId = "add-order-transaction";
+/**
+ * This step creates order transactions.
+ */
+export declare const addOrderTransactionStep: import("@acmekit/framework/workflows-sdk").StepFunction<AddOrderTransactionStepInput, CreateOrderTransactionDTO | CreateOrderTransactionDTO[] | null>;
+//# sourceMappingURL=add-order-transaction.d.ts.map

package/dist/order/steps/add-order-transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-order-transaction.d.ts","sourceRoot":"","sources":["../../../src/order/steps/add-order-transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAA;AAIzE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,yBAAyB,GACzB,yBAAyB,EAAE,CAAA;AAE/B;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,yBAAyB,GACzB,yBAAyB,EAAE,CAAA;AAE/B,eAAO,MAAM,yBAAyB,0BAA0B,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,uBAAuB,uJAiEnC,CAAA"}

package/dist/order/steps/add-order-transaction.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addOrderTransactionStep = exports.addOrderTransactionStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.addOrderTransactionStepId = "add-order-transaction";
+/**
+ * This step creates order transactions.
+ */
+exports.addOrderTransactionStep = (0, workflows_sdk_1.createStep)(exports.addOrderTransactionStepId, async (data, { container }) => {
+    const service = container.resolve(utils_1.Modules.ORDER);
+    const trxsData = Array.isArray(data) ? data : [data];
+    if (!trxsData.length) {
+        return new workflows_sdk_1.StepResponse(null);
+    }
+    const existingQuery = [];
+    for (const trx of trxsData) {
+        existingQuery.push({
+            order_id: trx.order_id,
+            reference: trx.reference,
+            reference_id: trx.reference_id,
+        });
+    }
+    const existing = await service.listOrderTransactions({
+        $or: existingQuery,
+    }, {
+        select: ["order_id", "reference", "reference_id"],
+    });
+    const existingSet = new Set(existing.map((trx) => `${trx.order_id}-${trx.reference}-${trx.reference_id}`));
+    const selectedData = [];
+    for (const trx of trxsData) {
+        if (!existingSet.has(`${trx.order_id}-${trx.reference}-${trx.reference_id}`)) {
+            selectedData.push(trx);
+        }
+    }
+    if (!selectedData.length) {
+        return new workflows_sdk_1.StepResponse(null);
+    }
+    const created = await service.addOrderTransactions(selectedData);
+    return new workflows_sdk_1.StepResponse((Array.isArray(data)
+        ? created
+        : created[0]), created.map((c) => c.id));
+}, async (id, { container }) => {
+    if (!id?.length) {
+        return;
+    }
+    const service = container.resolve(utils_1.Modules.ORDER);
+    await service.deleteOrderTransactions(id);
+});
+//# sourceMappingURL=add-order-transaction.js.map

package/dist/order/steps/add-order-transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-order-transaction.js","sourceRoot":"","sources":["../../../src/order/steps/add-order-transaction.ts"],"names":[],"mappings":";;;AACA,oDAAkD;AAClD,oEAA2E;AAgB9D,QAAA,yBAAyB,GAAG,uBAAuB,CAAA;AAChE;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAA,0BAAU,EAC/C,iCAAyB,EACzB,KAAK,EAAE,IAAkC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC1D,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,KAAK,CAAC,CAAA;IAEhD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAEpD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,aAAa,GAAU,EAAE,CAAA;IAC/B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,aAAa,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,YAAY,EAAE,GAAG,CAAC,YAAY;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,qBAAqB,CAClD;QACE,GAAG,EAAE,aAAa;KACnB,EACD;QACE,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,cAAc,CAAC;KAClD,CACF,CAAA;IACD,MAAM,WAAW,GAAG,IAAI,GAAG,CACzB,QAAQ,CAAC,GAAG,CACV,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,EAAE,CAChE,CACF,CAAA;IAED,MAAM,YAAY,GAAgC,EAAE,CAAA;IACpD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,IACE,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,EACxE,CAAC;YACD,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;IAEhE,OAAO,IAAI,4BAAY,CACrB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAkC,EAChD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACzB,CAAA;AACH,CAAC,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC1B,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC;QAChB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,KAAK,CAAC,CAAA;IAEhD,MAAM,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}

package/dist/order/steps/archive-orders.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The details of archiving the orders.
+ */
+export type ArchiveOrdersStepInput = {
+    /**
+     * The IDs of the orders to archive.
+     */
+    orderIds: string[];
+};
+export declare const archiveOrdersStepId = "archive-orders";
+/**
+ * This step archives one or more orders.
+ */
+export declare const archiveOrdersStep: import("@acmekit/framework/workflows-sdk").StepFunction<ArchiveOrdersStepInput, import("@acmekit/framework/types").OrderDTO[]>;
+//# sourceMappingURL=archive-orders.d.ts.map

package/dist/order/steps/archive-orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive-orders.d.ts","sourceRoot":"","sources":["../../../src/order/steps/archive-orders.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,eAAO,MAAM,mBAAmB,mBAAmB,CAAA;AACnD;;GAEG;AACH,eAAO,MAAM,iBAAiB,gIAyB7B,CAAA"}