@etohq/core-flows 1.4.0 → 1.5.0

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

@@ -0,0 +1,23 @@
+/**
+ * The keys to be locked
+ */
+export interface AcquireLockStepInput {
+    key: string | string[];
+    timeout?: number;
+    retryInterval?: number;
+    ttl?: number;
+    ownerId?: string;
+    provider?: string;
+}
+export declare const acquireLockStepId = "acquire-lock-step";
+/**
+ * This step acquires a lock for a given key.
+ *
+ * @example
+ * const data = acquireLockStep({
+ *   "key": "my-lock-key",
+ *   "ttl": 60
+ * })
+ */
+export declare const acquireLockStep: import("@etohq/framework/workflows-sdk").StepFunction<AcquireLockStepInput, undefined>;
+//# sourceMappingURL=acquire-lock.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"acquire-lock.d.ts","sourceRoot":"","sources":["../../src/locking/acquire-lock.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,wFAuD3B,CAAA"}

package/dist/locking/acquire-lock.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acquireLockStep = exports.acquireLockStepId = void 0;
+const utils_1 = require("@etohq/framework/utils");
+const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
+const promises_1 = require("timers/promises");
+exports.acquireLockStepId = "acquire-lock-step";
+/**
+ * This step acquires a lock for a given key.
+ *
+ * @example
+ * const data = acquireLockStep({
+ *   "key": "my-lock-key",
+ *   "ttl": 60
+ * })
+ */
+exports.acquireLockStep = (0, workflows_sdk_1.createStep)(exports.acquireLockStepId, async (data, { container }) => {
+    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 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/acquire-lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"acquire-lock.js","sourceRoot":"","sources":["../../src/locking/acquire-lock.ts"],"names":[],"mappings":";;;AAAA,kDAA2D;AAC3D,kEAAyE;AACzE,8CAA4C;AAc/B,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;;GAQG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,IAA0B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClD,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,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,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC5B,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/index.d.ts

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

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

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

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("./acquire-lock"), exports);
+__exportStar(require("./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,iDAA8B;AAC9B,iDAA8B"}

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

@@ -0,0 +1,19 @@
+/**
+ * The locked keys to be released
+ */
+export interface ReleaseLockStepInput {
+    key: string | string[];
+    ownerId?: string;
+    provider?: string;
+}
+export declare const releaseLockStepId = "release-lock-step";
+/**
+ * This step releases a lock for a given key.
+ *
+ * @example
+ * const data = releaseLockStep({
+ *   "key": "my-lock-key"
+ * })
+ */
+export declare const releaseLockStep: import("@etohq/framework/workflows-sdk").StepFunction<ReleaseLockStepInput, boolean>;
+//# sourceMappingURL=release-lock.d.ts.map

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

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

package/dist/locking/release-lock.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.releaseLockStep = exports.releaseLockStepId = void 0;
+const utils_1 = require("@etohq/framework/utils");
+const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
+exports.releaseLockStepId = "release-lock-step";
+/**
+ * This step releases a lock for a given key.
+ *
+ * @example
+ * const data = releaseLockStep({
+ *   "key": "my-lock-key"
+ * })
+ */
+exports.releaseLockStep = (0, workflows_sdk_1.createStep)(exports.releaseLockStepId, async (data, { container }) => {
+    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 locking = container.resolve(utils_1.Modules.LOCKING);
+    const released = await locking.release(keys, {
+        ownerId: data.ownerId,
+        provider: data.provider,
+    });
+    return new workflows_sdk_1.StepResponse(released);
+});
+//# sourceMappingURL=release-lock.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"release-lock.js","sourceRoot":"","sources":["../../src/locking/release-lock.ts"],"names":[],"mappings":";;;AAAA,kDAA2D;AAC3D,kEAAyE;AAW5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;GAOG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,IAA0B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClD,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,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,OAAO,CAAC,CAAA;IAClD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;QAC3C,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC,CAAA;IAEF,OAAO,IAAI,4BAAY,CAAC,QAAQ,CAAC,CAAA;AACnC,CAAC,CACF,CAAA"}

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

@@ -1,20 +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.etohq.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 a workflow for its compensation function. When the workflow fails,
- * its compensation function is triggered to send the notification.
+ * 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("@etohq/framework/workflows-sdk").StepFunction<NotifyOnFailureStepInput, undefined>;
 //# sourceMappingURL=notify-on-failure.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"notify-on-failure.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/notify-on-failure.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC,EAAE,CAAA;AAEH,eAAO,MAAM,qBAAqB,sBAAsB,CAAA;AACxD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,4FAgB/B,CAAA"}
+{"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,4FAgB/B,CAAA"}

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

@@ -6,8 +6,18 @@ const workflows_sdk_1 = require("@etohq/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 a workflow for its compensation function. When the workflow fails,
- * its compensation function is triggered to send the notification.
+ * 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);

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

@@ -1 +1 @@
-{"version":3,"file":"notify-on-failure.js","sourceRoot":"","sources":["../../../src/notification/steps/notify-on-failure.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAe5D,QAAA,qBAAqB,GAAG,mBAAmB,CAAA;AACxD;;;;GAIG;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"}
+{"version":3,"file":"notify-on-failure.js","sourceRoot":"","sources":["../../../src/notification/steps/notify-on-failure.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAuD5D,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

@@ -1,13 +1,51 @@
+/**
+ * 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 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;
+    /**
+     * 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 sendNotificationsStepId = "send-notifications";

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

@@ -1 +1 @@
-{"version":3,"file":"send-notifications.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,0BAA0B,GAAG;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC,EAAE,CAAA;AAEH,eAAO,MAAM,uBAAuB,uBAAuB,CAAA;AAC3D;;GAEG;AACH,eAAO,MAAM,qBAAqB,uIAajC,CAAA"}
+{"version":3,"file":"send-notifications.d.ts","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;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,uBAAuB,uBAAuB,CAAA;AAC3D;;GAEG;AACH,eAAO,MAAM,qBAAqB,uIAajC,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"send-notifications.js","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAe5D,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"}
+{"version":3,"file":"send-notifications.js","sourceRoot":"","sources":["../../../src/notification/steps/send-notifications.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAqD5D,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/payment/steps/authorize-payment-session.d.ts

@@ -1,11 +1,27 @@
-import { PaymentDTO } from "@etohq/types";
+import { PaymentDTO } from "@etohq/framework/types";
+/**
+ * The data to authorize the payment session.
+ */
 export type AuthorizePaymentSessionStepInput = {
+    /**
+     * The ID of the payment session to authorize.
+     */
     id: string;
-    context: Record<string, unknown>;
+    /**
+     * The context to authorize the payment session with.
+     * This context is passed to the payment provider associated with the payment session.
+     */
+    context?: Record<string, unknown>;
 };
 export declare const authorizePaymentSessionStepId = "authorize-payment-session-step";
 /**
  * This step authorizes a payment session.
+ *
+ * @example
+ * const data = authorizePaymentSessionStep({
+ *   id: "payses_123",
+ *   context: {}
+ * })
  */
-export declare const authorizePaymentSessionStep: import("@etohq/framework/workflows-sdk").StepFunction<AuthorizePaymentSessionStepInput, PaymentDTO>;
+export declare const authorizePaymentSessionStep: import("@etohq/framework/workflows-sdk").StepFunction<AuthorizePaymentSessionStepInput, PaymentDTO | null>;
 //# sourceMappingURL=authorize-payment-session.d.ts.map

package/dist/payment/steps/authorize-payment-session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authorize-payment-session.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/authorize-payment-session.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EACX,MAAM,cAAc,CAAA;AASrB,MAAM,MAAM,gCAAgC,GAAG;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC,CAAA;AAED,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;GAEG;AACH,eAAO,MAAM,2BAA2B,qGA2EvC,CAAA"}
+{"version":3,"file":"authorize-payment-session.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/authorize-payment-session.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EACX,MAAM,wBAAwB,CAAA;AAS/B;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,eAAO,MAAM,6BAA6B,mCAAmC,CAAA;AAC7E;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,4GA+EvC,CAAA"}

package/dist/payment/steps/authorize-payment-session.js

@@ -6,11 +6,20 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.authorizePaymentSessionStepId = "authorize-payment-session-step";
 /**
  * This step authorizes a payment session.
+ *
+ * @example
+ * const data = authorizePaymentSessionStep({
+ *   id: "payses_123",
+ *   context: {}
+ * })
  */
 exports.authorizePaymentSessionStep = (0, workflows_sdk_1.createStep)(exports.authorizePaymentSessionStepId, async (input, { container }) => {
     let payment;
     const logger = container.resolve(utils_1.ContainerRegistrationKeys.LOGGER);
     const paymentModule = container.resolve(utils_1.Modules.PAYMENT);
+    if (!input.id) {
+        return new workflows_sdk_1.StepResponse(null);
+    }
     try {
         payment = await paymentModule.authorizePaymentSession(input.id, input.context || {});
     }
@@ -30,7 +39,7 @@ exports.authorizePaymentSessionStep = (0, workflows_sdk_1.createStep)(exports.au
     if (paymentSession.status !== utils_1.PaymentSessionStatus.AUTHORIZED || !payment) {
         throw new utils_1.EtoError(utils_1.EtoError.Types.PAYMENT_AUTHORIZATION_ERROR, `Payment authorization failed`);
     }
-    return new workflows_sdk_1.StepResponse(payment);
+    return new workflows_sdk_1.StepResponse(paymentSession.payment);
 }, 
 // If payment or any other part of complete cart fails post payment step, we cancel any payments made
 async (payment, { container }) => {

package/dist/payment/steps/authorize-payment-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"authorize-payment-session.js","sourceRoot":"","sources":["../../../src/payment/steps/authorize-payment-session.ts"],"names":[],"mappings":";;;AAKA,kDAK+B;AAC/B,kEAAyE;AAO5D,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;GAEG;AACU,QAAA,2BAA2B,GAAG,IAAA,0BAAU,EACnD,qCAA6B,EAC7B,KAAK,EAAE,KAAuC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC/D,IAAI,OAA+B,CAAA;IACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,aAAa,CAAC,uBAAuB,CACnD,KAAK,CAAC,EAAE,EACR,KAAK,CAAC,OAAO,IAAI,EAAE,CACpB,CAAA;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CACV,0DAA0D,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,CAC5E,CAAA;IACH,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC,sBAAsB,CAC/D,KAAK,CAAC,EAAE,EACR;QACE,SAAS,EAAE,CAAC,SAAS,EAAE,kBAAkB,CAAC;KAC3C,CACF,CAAA;IAED,uGAAuG;IACvG,oBAAoB;IACpB,IAAI,cAAc,CAAC,MAAM,KAAK,4BAAoB,CAAC,aAAa,EAAE,CAAC;QACjE,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,2BAA2B,EAC1C,0CAA0C,CAC3C,CAAA;IACH,CAAC;IAED,2HAA2H;IAC3H,mHAAmH;IACnH,IAAI,cAAc,CAAC,MAAM,KAAK,4BAAoB,CAAC,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QAC1E,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,2BAA2B,EAC1C,8BAA8B,CAC/B,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AACD,qGAAqG;AACrG,KAAK,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,uFAAuF;IACvF,+DAA+D;IAC/D,IACE,OAAO,CAAC,eAAe;QACvB,OAAO,CAAC,eAAe,CAAC,MAAM,KAAK,4BAAoB,CAAC,aAAa,EACrE,CAAC;QACD,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC/C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CACV,+CAA+C,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CACnE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
+{"version":3,"file":"authorize-payment-session.js","sourceRoot":"","sources":["../../../src/payment/steps/authorize-payment-session.ts"],"names":[],"mappings":";;;AAKA,kDAK+B;AAC/B,kEAAyE;AAiB5D,QAAA,6BAA6B,GAAG,gCAAgC,CAAA;AAC7E;;;;;;;;GAQG;AACU,QAAA,2BAA2B,GAAG,IAAA,0BAAU,EACnD,qCAA6B,EAC7B,KAAK,EAAE,KAAuC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC/D,IAAI,OAA+B,CAAA;IACnC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,IAAI,4BAAY,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,aAAa,CAAC,uBAAuB,CACnD,KAAK,CAAC,EAAE,EACR,KAAK,CAAC,OAAO,IAAI,EAAE,CACpB,CAAA;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CACV,0DAA0D,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,CAC5E,CAAA;IACH,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC,sBAAsB,CAC/D,KAAK,CAAC,EAAE,EACR;QACE,SAAS,EAAE,CAAC,SAAS,EAAE,kBAAkB,CAAC;KAC3C,CACF,CAAA;IAED,uGAAuG;IACvG,oBAAoB;IACpB,IAAI,cAAc,CAAC,MAAM,KAAK,4BAAoB,CAAC,aAAa,EAAE,CAAC;QACjE,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,2BAA2B,EAC1C,0CAA0C,CAC3C,CAAA;IACH,CAAC;IAED,2HAA2H;IAC3H,mHAAmH;IACnH,IAAI,cAAc,CAAC,MAAM,KAAK,4BAAoB,CAAC,UAAU,IAAI,CAAC,OAAO,EAAE,CAAC;QAC1E,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,2BAA2B,EAC1C,8BAA8B,CAC/B,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;AACjD,CAAC;AACD,qGAAqG;AACrG,KAAK,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,uFAAuF;IACvF,+DAA+D;IAC/D,IACE,OAAO,CAAC,eAAe;QACvB,OAAO,CAAC,eAAe,CAAC,MAAM,KAAK,4BAAoB,CAAC,aAAa,EACrE,CAAC;QACD,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC/C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CACV,+CAA+C,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CACnE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}

package/dist/payment/steps/cancel-payment.d.ts

@@ -1,4 +1,10 @@
+/**
+ * The data to cancel one or more payments.
+ */
 export type CancelPaymentStepInput = {
+    /**
+     * The ID(s) of the payment(s) to cancel.
+     */
     paymentIds: string | string[];
 };
 export declare const cancelPaymentStepId = "cancel-payment-step";

package/dist/payment/steps/cancel-payment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cancel-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/cancel-payment.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,mBAAmB,wBAAwB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,iBAAiB,wFA0B7B,CAAA"}
+{"version":3,"file":"cancel-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/cancel-payment.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,mBAAmB,wBAAwB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,iBAAiB,wFA0B7B,CAAA"}

package/dist/payment/steps/cancel-payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"cancel-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/cancel-payment.ts"],"names":[],"mappings":";;;AACA,kDAI+B;AAC/B,kEAA2D;AAM9C,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AACxD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,UAAU;QAClB,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAEtB,MAAM,QAAQ,GAAmB,EAAE,CAAA;IAEnC,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CACX,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1C,MAAM,CAAC,KAAK,CACV,+CAA+C,EAAE,MAAM,CAAC,EAAE,CAC3D,CAAA;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,MAAM,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAA;AAC5B,CAAC,CACF,CAAA"}
+{"version":3,"file":"cancel-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/cancel-payment.ts"],"names":[],"mappings":";;;AACA,kDAI+B;AAC/B,kEAA2D;AAY9C,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AACxD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAC1E,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,UAAU;QAClB,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAEtB,MAAM,QAAQ,GAAmB,EAAE,CAAA;IAEnC,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CACX,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1C,MAAM,CAAC,KAAK,CACV,+CAA+C,EAAE,MAAM,CAAC,EAAE,CAC3D,CAAA;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,MAAM,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAA;AAC5B,CAAC,CACF,CAAA"}

package/dist/payment/steps/capture-payment.d.ts

@@ -1,12 +1,24 @@
-import { BigNumberInput } from "@etohq/types";
+import { BigNumberInput } from "@etohq/framework/types";
+/**
+ * The data to capture a payment.
+ */
 export type CapturePaymentStepInput = {
+    /**
+     * The ID of the payment to capture.
+     */
     payment_id: string;
+    /**
+     * The ID of the user that captured the payment.
+     */
     captured_by?: string;
+    /**
+     * The amount to capture. If not provided, the full payment amount will be captured.
+     */
     amount?: BigNumberInput;
 };
 export declare const capturePaymentStepId = "capture-payment-step";
 /**
  * This step captures a payment.
  */
-export declare const capturePaymentStep: import("@etohq/framework/workflows-sdk").StepFunction<CapturePaymentStepInput, import("@etohq/types").PaymentDTO>;
+export declare const capturePaymentStep: import("@etohq/framework/workflows-sdk").StepFunction<CapturePaymentStepInput, import("@etohq/framework/types").PaymentDTO>;
 //# sourceMappingURL=capture-payment.d.ts.map

package/dist/payment/steps/capture-payment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capture-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/capture-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,cAAc,CAAA;AAIrB,MAAM,MAAM,uBAAuB,GAAG;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,mHAW9B,CAAA"}
+{"version":3,"file":"capture-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/capture-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,wBAAwB,CAAA;AAI/B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,6HAa9B,CAAA"}

package/dist/payment/steps/capture-payment.js

@@ -11,5 +11,8 @@ exports.capturePaymentStep = (0, workflows_sdk_1.createStep)(exports.capturePaym
     const paymentModule = container.resolve(utils_1.Modules.PAYMENT);
     const payment = await paymentModule.capturePayment(input);
     return new workflows_sdk_1.StepResponse(payment);
-});
+}
+// We don't want to compensate a capture automatically as the actual funds have already been taken.
+// The only want to compensate here is to issue a refund, but it's better to leave that as a manual operation for now.
+);
 //# sourceMappingURL=capture-payment.js.map

package/dist/payment/steps/capture-payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"capture-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/capture-payment.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAQ5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA8B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACtD,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAEzD,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,CACF,CAAA"}
+{"version":3,"file":"capture-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/capture-payment.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAoB5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA8B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACtD,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAEzD,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AACD,mGAAmG;AACnG,sHAAsH;CACvH,CAAA"}

package/dist/payment/steps/complete-cart-after-payment.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The data to complete a cart after a payment is captured.
+ */
+export type CompleteCartAfterPaymentStepInput = {
+    /**
+     * The ID of the cart to complete.
+     */
+    cart_id: string;
+};
+export declare const completeCartAfterPaymentStepId = "complete-cart-after-payment-step";
+/**
+ * This step completes a cart after a payment is captured.
+ */
+export declare const completeCartAfterPaymentStep: import("@etohq/framework/workflows-sdk").StepFunction<CompleteCartAfterPaymentStepInput, unknown>;
+//# sourceMappingURL=complete-cart-after-payment.d.ts.map

package/dist/payment/steps/complete-cart-after-payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"complete-cart-after-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/complete-cart-after-payment.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,8BAA8B,qCAAqC,CAAA;AAChF;;GAEG;AACH,eAAO,MAAM,4BAA4B,mGAYxC,CAAA"}

package/dist/payment/steps/complete-cart-after-payment.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.completeCartAfterPaymentStep = exports.completeCartAfterPaymentStepId = void 0;
+const utils_1 = require("@etohq/framework/utils");
+const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
+const complete_cart_1 = require("../../cart/workflows/complete-cart");
+exports.completeCartAfterPaymentStepId = "complete-cart-after-payment-step";
+/**
+ * This step completes a cart after a payment is captured.
+ */
+exports.completeCartAfterPaymentStep = (0, workflows_sdk_1.createStep)(exports.completeCartAfterPaymentStepId, async (input, { container }) => {
+    const workflowEngine = container.resolve(utils_1.Modules.WORKFLOW_ENGINE);
+    await workflowEngine.run(complete_cart_1.completeCartWorkflowId, {
+        input: {
+            id: input.cart_id,
+        },
+        transactionId: input.cart_id,
+    });
+});
+//# sourceMappingURL=complete-cart-after-payment.js.map

package/dist/payment/steps/complete-cart-after-payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complete-cart-after-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/complete-cart-after-payment.ts"],"names":[],"mappings":";;;AAAA,kDAAgD;AAChD,kEAA2D;AAC3D,sEAA2E;AAY9D,QAAA,8BAA8B,GAAG,kCAAkC,CAAA;AAChF;;GAEG;AACU,QAAA,4BAA4B,GAAG,IAAA,0BAAU,EACpD,sCAA8B,EAC9B,KAAK,EAAE,KAAwC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAChE,MAAM,cAAc,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,eAAe,CAAC,CAAA;IAEjE,MAAM,cAAc,CAAC,GAAG,CAAC,sCAAsB,EAAE;QAC/C,KAAK,EAAE;YACL,EAAE,EAAE,KAAK,CAAC,OAAO;SAClB;QACD,aAAa,EAAE,KAAK,CAAC,OAAO;KAC7B,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/payment/steps/refund-payment.d.ts

@@ -1,12 +1,24 @@
-import { BigNumberInput } from "@etohq/types";
+import { BigNumberInput } from "@etohq/framework/types";
+/**
+ * The data to refund a payment.
+ */
 export type RefundPaymentStepInput = {
+    /**
+     * The ID of the payment to refund.
+     */
     payment_id: string;
+    /**
+     * The ID of the user that refunded the payment.
+     */
     created_by?: string;
+    /**
+     * The amount to refund. If not provided, the full refundable amount is refunded.
+     */
     amount?: BigNumberInput;
 };
 export declare const refundPaymentStepId = "refund-payment-step";
 /**
  * This step refunds a payment.
  */
-export declare const refundPaymentStep: import("@etohq/framework/workflows-sdk").StepFunction<RefundPaymentStepInput, import("@etohq/types").PaymentDTO>;
+export declare const refundPaymentStep: import("@etohq/framework/workflows-sdk").StepFunction<RefundPaymentStepInput, import("@etohq/framework/types").PaymentDTO>;
 //# sourceMappingURL=refund-payment.d.ts.map

package/dist/payment/steps/refund-payment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refund-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,cAAc,CAAA;AAIrB,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,wBAAwB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,iBAAiB,kHAW7B,CAAA"}
+{"version":3,"file":"refund-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,wBAAwB,CAAA;AAI/B;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,mBAAmB,wBAAwB,CAAA;AACxD;;GAEG;AACH,eAAO,MAAM,iBAAiB,4HAa7B,CAAA"}

package/dist/payment/steps/refund-payment.js

@@ -11,5 +11,8 @@ exports.refundPaymentStep = (0, workflows_sdk_1.createStep)(exports.refundPaymen
     const paymentModule = container.resolve(utils_1.Modules.PAYMENT);
     const payment = await paymentModule.refundPayment(input);
     return new workflows_sdk_1.StepResponse(payment);
-});
+}
+// We don't want to compensate a refund automatically as the actual funds have already been sent
+// And in most cases we can't simply do another capture/authorization
+);
 //# sourceMappingURL=refund-payment.js.map

package/dist/payment/steps/refund-payment.js.map

@@ -1 +1 @@
-{"version":3,"file":"refund-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAQ5D,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AACxD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAExD,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,CACF,CAAA"}
+{"version":3,"file":"refund-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":";;;AAIA,kDAAgD;AAChD,kEAAyE;AAoB5D,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AACxD;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,0BAAU,EACzC,2BAAmB,EACnB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CACrC,eAAO,CAAC,OAAO,CAChB,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAExD,OAAO,IAAI,4BAAY,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC;AACD,gGAAgG;AAChG,qEAAqE;CACtE,CAAA"}