@acmekit/core-flows 2.13.1

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

@@ -0,0 +1,24 @@
+import { BigNumberInput } from "@acmekit/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("@acmekit/framework/workflows-sdk").StepFunction<RefundPaymentStepInput, import("@acmekit/framework/types").PaymentDTO>;
+//# sourceMappingURL=refund-payment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refund-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEf,MAAM,0BAA0B,CAAA;AAIjC;;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,gIAa7B,CAAA"}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refundPaymentStep = exports.refundPaymentStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.refundPaymentStepId = "refund-payment-step";
+/**
+ * This step refunds a payment.
+ */
+exports.refundPaymentStep = (0, workflows_sdk_1.createStep)(exports.refundPaymentStepId, async (input, { container }) => {
+    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

@@ -0,0 +1 @@
+{"version":3,"file":"refund-payment.js","sourceRoot":"","sources":["../../../src/payment/steps/refund-payment.ts"],"names":[],"mappings":";;;AAIA,oDAAkD;AAClD,oEAA2E;AAoB9D,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"}

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

@@ -0,0 +1,28 @@
+import { BigNumberInput, PaymentDTO } from "@acmekit/framework/types";
+/**
+ * The data to refund one or more payments.
+ */
+export type RefundPaymentsStepInput = {
+    /**
+     * The ID of the payment to refund.
+     */
+    payment_id: string;
+    /**
+     * The amount to refund.
+     */
+    amount: BigNumberInput;
+    /**
+     * The ID of the user that refunded the payment.
+     */
+    created_by?: string;
+    /**
+     * The note to attach to the refund.
+     */
+    note?: string;
+}[];
+export declare const refundPaymentsStepId = "refund-payments-step";
+/**
+ * This step refunds one or more payments.
+ */
+export declare const refundPaymentsStep: import("@acmekit/framework/workflows-sdk").StepFunction<RefundPaymentsStepInput, PaymentDTO[]>;
+//# sourceMappingURL=refund-payments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refund-payments.d.ts","sourceRoot":"","sources":["../../../src/payment/steps/refund-payments.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAGd,UAAU,EACX,MAAM,0BAA0B,CAAA;AASjC;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,EAAE,CAAA;AAEH,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,gGA0B9B,CAAA"}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refundPaymentsStep = exports.refundPaymentsStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.refundPaymentsStepId = "refund-payments-step";
+/**
+ * This step refunds one or more payments.
+ */
+exports.refundPaymentsStep = (0, workflows_sdk_1.createStep)(exports.refundPaymentsStepId, async (input, { container }) => {
+    const logger = container.resolve(utils_1.ContainerRegistrationKeys.LOGGER);
+    const paymentModule = container.resolve(utils_1.Modules.PAYMENT);
+    const promises = [];
+    for (const refundInput of input) {
+        promises.push(paymentModule.refundPayment(refundInput).catch((e) => {
+            logger.error(`Error was thrown trying to cancel payment - ${refundInput.payment_id} - ${e}`);
+        }));
+    }
+    const successfulRefunds = (await (0, utils_1.promiseAll)(promises)).filter((payment) => (0, utils_1.isObject)(payment));
+    return new workflows_sdk_1.StepResponse(successfulRefunds);
+});
+//# sourceMappingURL=refund-payments.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refund-payments.js","sourceRoot":"","sources":["../../../src/payment/steps/refund-payments.ts"],"names":[],"mappings":";;;AAMA,oDAKiC;AACjC,oEAA2E;AAwB9D,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,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,QAAQ,GAAiC,EAAE,CAAA;IAEjD,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE,CAAC;QAChC,QAAQ,CAAC,IAAI,CACX,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACnD,MAAM,CAAC,KAAK,CACV,+CAA+C,WAAW,CAAC,UAAU,MAAM,CAAC,EAAE,CAC/E,CAAA;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CACxE,IAAA,gBAAQ,EAAC,OAAO,CAAC,CAClB,CAAA;IAED,OAAO,IAAI,4BAAY,CAAC,iBAAiB,CAAC,CAAA;AAC5C,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,40 @@
+import type { BigNumberInput, PaymentDTO } from "@acmekit/framework/types";
+/**
+ * The data to capture a payment.
+ */
+export type CapturePaymentWorkflowInput = {
+    /**
+     * 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 capturePaymentWorkflowId = "capture-payment-workflow";
+/**
+ * This workflow captures a payment. It's used by the
+ * [Capture Payment Admin API Route](https://docs.acmekit.com/api/admin#payments_postpaymentsidcapture).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to capture a payment in your custom flows.
+ *
+ * @example
+ * const { result } = await capturePaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_id: "pay_123"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Capture a payment.
+ */
+export declare const capturePaymentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<CapturePaymentWorkflowInput, PaymentDTO, []>;
+//# sourceMappingURL=capture-payment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"capture-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/workflows/capture-payment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAa1E;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;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,wBAAwB,6BAA6B,CAAA;AAClE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,sBAAsB,wGA0ClC,CAAA"}

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

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capturePaymentWorkflow = exports.capturePaymentWorkflowId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const add_order_transaction_1 = require("../../order/steps/add-order-transaction");
+const capture_payment_1 = require("../steps/capture-payment");
+exports.capturePaymentWorkflowId = "capture-payment-workflow";
+/**
+ * This workflow captures a payment. It's used by the
+ * [Capture Payment Admin API Route](https://docs.acmekit.com/api/admin#payments_postpaymentsidcapture).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to capture a payment in your custom flows.
+ *
+ * @example
+ * const { result } = await capturePaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_id: "pay_123"
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Capture a payment.
+ */
+exports.capturePaymentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.capturePaymentWorkflowId, (input) => {
+    const payment = (0, capture_payment_1.capturePaymentStep)(input);
+    const orderPayment = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_payment_collection",
+        fields: ["order.id"],
+        variables: { payment_collection_id: payment.payment_collection_id },
+        list: false,
+    });
+    (0, workflows_sdk_1.when)({ orderPayment }, ({ orderPayment }) => {
+        return !!orderPayment?.order?.id;
+    }).then(() => {
+        const orderTransactionData = (0, workflows_sdk_1.transform)({ input, payment, orderPayment }, ({ input, payment, orderPayment }) => {
+            return payment.captures?.map((capture) => {
+                return {
+                    order_id: orderPayment.order.id,
+                    amount: input.amount ?? capture.raw_amount ?? capture.amount,
+                    currency_code: payment.currency_code,
+                    reference_id: capture.id,
+                    reference: "capture",
+                };
+            });
+        });
+        (0, add_order_transaction_1.addOrderTransactionStep)(orderTransactionData);
+    });
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.PaymentEvents.CAPTURED,
+        data: { id: payment.id },
+    });
+    return new workflows_sdk_1.WorkflowResponse(payment);
+});
+//# sourceMappingURL=capture-payment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"capture-payment.js","sourceRoot":"","sources":["../../../src/payment/workflows/capture-payment.ts"],"names":[],"mappings":";;;AACA,oDAAwD;AACxD,oEAMyC;AACzC,yCAAgE;AAChE,mFAAiF;AACjF,8DAA6D;AAoBhD,QAAA,wBAAwB,GAAG,0BAA0B,CAAA;AAClE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CACE,KAAgD,EAClB,EAAE;IAChC,MAAM,OAAO,GAAG,IAAA,oCAAkB,EAAC,KAAK,CAAC,CAAA;IAEzC,MAAM,YAAY,GAAG,IAAA,2BAAkB,EAAC;QACtC,WAAW,EAAE,0BAA0B;QACvC,MAAM,EAAE,CAAC,UAAU,CAAC;QACpB,SAAS,EAAE,EAAE,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,EAAE;QACnE,IAAI,EAAE,KAAK;KACZ,CAAC,CAAA;IAEF,IAAA,oBAAI,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QAC1C,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,CAAA;IAClC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,MAAM,oBAAoB,GAAG,IAAA,yBAAS,EACpC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,EAChC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE;YACnC,OAAO,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvC,OAAO;oBACL,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE;oBAC/B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,MAAM;oBAC5D,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,YAAY,EAAE,OAAO,CAAC,EAAE;oBACxB,SAAS,EAAE,SAAS;iBACrB,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;QAED,IAAA,+CAAuB,EAAC,oBAAoB,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,qBAAa,CAAC,QAAQ;QACjC,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE;KACzB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/payment/workflows/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./capture-payment";
+export * from "./process-payment";
+export * from "./refund-payment";
+export * from "./refund-payments";
+//# sourceMappingURL=index.d.ts.map

package/dist/payment/workflows/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/payment/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA"}

package/dist/payment/workflows/index.js

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

package/dist/payment/workflows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/payment/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,oDAAiC;AACjC,mDAAgC;AAChC,oDAAiC"}

package/dist/payment/workflows/process-payment.d.ts

@@ -0,0 +1,33 @@
+import type { WebhookActionResult } from "@acmekit/framework/types";
+/**
+ * The data to process a payment from a webhook action.
+ */
+export interface ProcessPaymentWorkflowInput extends WebhookActionResult {
+}
+export declare const processPaymentWorkflowId = "process-payment-workflow";
+/**
+ * This workflow processes a payment to either complete its associated cart,
+ * capture the payment, or authorize the payment session. It's used when a
+ * [Webhook Event is received](https://docs.acmekit.com/resources/commerce-modules/payment/webhook-events).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to process a payment in your custom flows based on a webhook action.
+ *
+ * @example
+ * const { result } = await processPaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     action: "captured",
+ *     data: {
+ *       session_id: "payses_123",
+ *       amount: 10
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Process a payment based on a webhook event.
+ */
+export declare const processPaymentWorkflow: import("@acmekit/workflows-sdk").ReturnWorkflow<ProcessPaymentWorkflowInput, unknown, any[]>;
+//# sourceMappingURL=process-payment.d.ts.map

package/dist/payment/workflows/process-payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/workflows/process-payment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAYnE;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;CAAG;AAE3E,eAAO,MAAM,wBAAwB,6BAA6B,CAAA;AAClE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,sBAAsB,8FA6IlC,CAAA"}

package/dist/payment/workflows/process-payment.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processPaymentWorkflow = exports.processPaymentWorkflowId = void 0;
+const utils_1 = require("@acmekit/utils");
+const workflows_sdk_1 = require("@acmekit/workflows-sdk");
+const common_1 = require("../../common");
+const steps_1 = require("../steps");
+const complete_cart_after_payment_1 = require("../steps/complete-cart-after-payment");
+const capture_payment_1 = require("./capture-payment");
+const locking_1 = require("../../locking");
+const THIRTY_SECONDS = 30;
+const TWO_MINUTES = 60 * 2;
+exports.processPaymentWorkflowId = "process-payment-workflow";
+/**
+ * This workflow processes a payment to either complete its associated cart,
+ * capture the payment, or authorize the payment session. It's used when a
+ * [Webhook Event is received](https://docs.acmekit.com/resources/commerce-modules/payment/webhook-events).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to process a payment in your custom flows based on a webhook action.
+ *
+ * @example
+ * const { result } = await processPaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     action: "captured",
+ *     data: {
+ *       session_id: "payses_123",
+ *       amount: 10
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Process a payment based on a webhook event.
+ */
+exports.processPaymentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.processPaymentWorkflowId, (input) => {
+    const paymentData = (0, common_1.useQueryGraphStep)({
+        entity: "payment",
+        fields: ["id"],
+        filters: { payment_session_id: input.data?.session_id },
+    }).config({
+        name: "payment-query",
+    });
+    const paymentSessionResult = (0, common_1.useQueryGraphStep)({
+        entity: "payment_session",
+        fields: ["payment_collection_id"],
+        filters: { id: input.data?.session_id },
+    }).config({
+        name: "payment-session-query",
+    });
+    const cartPaymentCollection = (0, common_1.useQueryGraphStep)({
+        entity: "cart_payment_collection",
+        fields: ["cart_id"],
+        filters: {
+            payment_collection_id: paymentSessionResult.data[0].payment_collection_id,
+        },
+    }).config({
+        name: "cart-payment-query",
+    });
+    const cartId = (0, workflows_sdk_1.transform)({ cartPaymentCollection }, ({ cartPaymentCollection }) => {
+        return cartPaymentCollection.data[0]?.cart_id;
+    });
+    const { data: order } = (0, common_1.useQueryGraphStep)({
+        entity: "order_cart",
+        fields: ["id"],
+        filters: {
+            cart_id: cartId
+        },
+        options: {
+            isList: false
+        }
+    }).config({
+        name: "cart-order-query",
+    });
+    (0, workflows_sdk_1.when)("lock-cart-when-available", { cartId }, ({ cartId }) => {
+        return !!cartId;
+    }).then(() => {
+        (0, locking_1.acquireLockStep)({
+            key: cartId,
+            timeout: THIRTY_SECONDS,
+            ttl: TWO_MINUTES,
+        });
+    });
+    (0, workflows_sdk_1.when)({ input, paymentData }, ({ input, paymentData }) => {
+        return (input.action === utils_1.PaymentActions.SUCCESSFUL && !!paymentData.data.length);
+    }).then(() => {
+        capture_payment_1.capturePaymentWorkflow
+            .runAsStep({
+            input: {
+                payment_id: paymentData.data[0].id,
+                amount: input.data?.amount,
+            },
+        })
+            .config({
+            name: "capture-payment",
+        });
+    });
+    (0, workflows_sdk_1.when)({ input, paymentData }, ({ input, paymentData }) => {
+        // payment is captured with the provider but we dont't have any payment data which means we didn't call authorize yet - autocapture flow
+        return (input.action === utils_1.PaymentActions.SUCCESSFUL && !paymentData.data.length);
+    }).then(() => {
+        const payment = (0, steps_1.authorizePaymentSessionStep)({
+            id: input.data.session_id,
+            context: {},
+        }).config({
+            name: "authorize-payment-session-autocapture",
+        });
+        capture_payment_1.capturePaymentWorkflow
+            .runAsStep({
+            input: {
+                payment_id: payment.id,
+                amount: input.data?.amount,
+            },
+        })
+            .config({
+            name: "capture-payment-autocapture",
+        });
+    });
+    (0, workflows_sdk_1.when)({ input, cartPaymentCollection }, ({ input, cartPaymentCollection }) => {
+        // Authorize payment session if no Cart is linked to the payment
+        // When associated with a Cart, the complete cart workflow will handle the authorization
+        return (!cartPaymentCollection.data.length &&
+            input.action === utils_1.PaymentActions.AUTHORIZED &&
+            !!input.data?.session_id);
+    }).then(() => {
+        (0, steps_1.authorizePaymentSessionStep)({
+            id: input.data.session_id,
+            context: {},
+        }).config({
+            name: "authorize-payment-session",
+        });
+    });
+    // We release before the completion to prevent dead locks
+    (0, workflows_sdk_1.when)("release-lock-cart-when-available", { cartId }, ({ cartId }) => {
+        return !!cartId;
+    }).then(() => {
+        (0, locking_1.releaseLockStep)({
+            key: cartId,
+        });
+    });
+    (0, workflows_sdk_1.when)({ cartPaymentCollection, order }, ({ cartPaymentCollection, order }) => {
+        return !!cartPaymentCollection.data.length && !order;
+    }).then(() => {
+        (0, complete_cart_after_payment_1.completeCartAfterPaymentStep)({
+            cart_id: cartPaymentCollection.data[0].cart_id,
+        }).config({
+            continueOnPermanentFailure: true, // Continue payment processing even if cart completion fails
+        });
+    });
+});
+//# sourceMappingURL=process-payment.js.map

package/dist/payment/workflows/process-payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-payment.js","sourceRoot":"","sources":["../../../src/payment/workflows/process-payment.ts"],"names":[],"mappings":";;;AACA,0CAA+C;AAC/C,0DAAwE;AACxE,yCAAgD;AAChD,oCAAsD;AACtD,sFAAmF;AACnF,uDAA0D;AAC1D,2CAAgE;AAEhE,MAAM,cAAc,GAAG,EAAE,CAAA;AACzB,MAAM,WAAW,GAAG,EAAE,GAAG,CAAC,CAAA;AAOb,QAAA,wBAAwB,GAAG,0BAA0B,CAAA;AAClE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,sBAAsB,GAAG,IAAA,8BAAc,EAClD,gCAAwB,EACxB,CAAC,KAAkC,EAAE,EAAE;IACrC,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC;QACpC,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,OAAO,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE;KACxD,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,eAAe;KACtB,CAAC,CAAA;IAEF,MAAM,oBAAoB,GAAG,IAAA,0BAAiB,EAAC;QAC7C,MAAM,EAAE,iBAAiB;QACzB,MAAM,EAAE,CAAC,uBAAuB,CAAC;QACjC,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE;KACxC,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,uBAAuB;KAC9B,CAAC,CAAA;IAEF,MAAM,qBAAqB,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE;YACP,qBAAqB,EACnB,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,qBAAqB;SACrD;KACF,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,oBAAoB;KAC3B,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,IAAA,yBAAS,EACtB,EAAE,qBAAqB,EAAE,EACzB,CAAC,EAAE,qBAAqB,EAAE,EAAE,EAAE;QAC5B,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAA;IAC/C,CAAC,CACF,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACtC,MAAM,EAAE,YAAY;QACpB,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,OAAO,EAAE;YACP,OAAO,EAAE,MAAM;SAChB;QACD,OAAO,EAAE;YACL,MAAM,EAAE,KAAK;SAChB;KACF,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,kBAAkB;KACzB,CAAC,CAAA;IAEJ,IAAA,oBAAI,EAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC1D,OAAO,CAAC,CAAC,MAAM,CAAA;IACjB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,yBAAe,EAAC;YACd,GAAG,EAAE,MAAM;YACX,OAAO,EAAE,cAAc;YACvB,GAAG,EAAE,WAAW;SACjB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,oBAAI,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;QACtD,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,sBAAc,CAAC,UAAU,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CACxE,CAAA;IACH,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,wCAAsB;aACnB,SAAS,CAAC;YACT,KAAK,EAAE;gBACL,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM;aAC3B;SACF,CAAC;aACD,MAAM,CAAC;YACN,IAAI,EAAE,iBAAiB;SACxB,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,IAAA,oBAAI,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;QACtD,wIAAwI;QACxI,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,sBAAc,CAAC,UAAU,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CACvE,CAAA;IACH,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,MAAM,OAAO,GAAG,IAAA,mCAA2B,EAAC;YAC1C,EAAE,EAAE,KAAK,CAAC,IAAK,CAAC,UAAU;YAC1B,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC,MAAM,CAAC;YACR,IAAI,EAAE,uCAAuC;SAC9C,CAAC,CAAA;QAEF,wCAAsB;aACnB,SAAS,CAAC;YACT,KAAK,EAAE;gBACL,UAAU,EAAE,OAAO,CAAC,EAAE;gBACtB,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM;aAC3B;SACF,CAAC;aACD,MAAM,CAAC;YACN,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,IAAA,oBAAI,EACF,EAAE,KAAK,EAAE,qBAAqB,EAAE,EAChC,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,EAAE,EAAE;QACnC,gEAAgE;QAChE,wFAAwF;QACxF,OAAO,CACL,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM;YAClC,KAAK,CAAC,MAAM,KAAK,sBAAc,CAAC,UAAU;YAC1C,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CACzB,CAAA;IACH,CAAC,CACF,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,IAAA,mCAA2B,EAAC;YAC1B,EAAE,EAAE,KAAK,CAAC,IAAK,CAAC,UAAU;YAC1B,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC,MAAM,CAAC;YACR,IAAI,EAAE,2BAA2B;SAClC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,yDAAyD;IACzD,IAAA,oBAAI,EAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAClE,OAAO,CAAC,CAAC,MAAM,CAAA;IACjB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,yBAAe,EAAC;YACd,GAAG,EAAE,MAAM;SACZ,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,oBAAI,EAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,EAAE,EAAE;QAC1E,OAAO,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAA;IACtD,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,0DAA4B,EAAC;YAC3B,OAAO,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO;SAC/C,CAAC,CAAC,MAAM,CAAC;YACR,0BAA0B,EAAE,IAAI,EAAE,4DAA4D;SAC/F,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,55 @@
+import { BigNumberInput, PaymentDTO } from "@acmekit/framework/types";
+/**
+ * The data to refund a payment.
+ */
+export type RefundPaymentWorkflowInput = {
+    /**
+     * 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 payment amount will be refunded.
+     */
+    amount?: BigNumberInput;
+    /**
+     * The note to attach to the refund.
+     */
+    note?: string;
+    /**
+     * The ID of the refund reason to attach to the refund.
+     */
+    refund_reason_id?: string;
+};
+/**
+ * This step validates that an order refund credit line can be issued
+ */
+export declare const validateRefundPaymentExceedsCapturedAmountStep: import("@acmekit/framework/workflows-sdk").StepFunction<{
+    payment: PaymentDTO;
+    refundAmount: BigNumberInput;
+}, unknown>;
+export declare const refundPaymentWorkflowId = "refund-payment-workflow";
+/**
+ * This workflow refunds a payment. It's used by the
+ * [Refund Payment Admin API Route](https://docs.acmekit.com/api/admin#payments_postpaymentsidrefund).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to refund a payment in your custom flows.
+ *
+ * @example
+ * const { result } = await refundPaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_id: "payment_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Refund a payment.
+ */
+export declare const refundPaymentWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<RefundPaymentWorkflowInput, any, []>;
+//# sourceMappingURL=refund-payment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refund-payment.d.ts","sourceRoot":"","sources":["../../../src/payment/workflows/refund-payment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAoBrE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,8CAA8C;aAM9C,UAAU;kBACL,cAAc;WA+B/B,CAAA;AAED,eAAO,MAAM,uBAAuB,4BAA4B,CAAA;AAChE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB,gGA4HjC,CAAA"}

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

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refundPaymentWorkflow = exports.refundPaymentWorkflowId = exports.validateRefundPaymentExceedsCapturedAmountStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const add_order_transaction_1 = require("../../order/steps/add-order-transaction");
+const create_order_refund_credit_lines_1 = require("../../order/workflows/payments/create-order-refund-credit-lines");
+const refund_payment_1 = require("../steps/refund-payment");
+/**
+ * This step validates that an order refund credit line can be issued
+ */
+exports.validateRefundPaymentExceedsCapturedAmountStep = (0, workflows_sdk_1.createStep)("validate-refund-payment-exceeds-captured-amount", async function ({ payment, refundAmount, }) {
+    const capturedAmount = (payment.captures || []).reduce((captureAmount, next) => {
+        const amountAsBigNumber = new utils_1.BigNumber(next.raw_amount);
+        return utils_1.MathBN.add(captureAmount, amountAsBigNumber);
+    }, utils_1.MathBN.convert(0));
+    const refundedAmount = (payment.refunds || []).reduce((refundedAmount, next) => {
+        const amountAsBigNumber = new utils_1.BigNumber(next.raw_amount);
+        return utils_1.MathBN.add(refundedAmount, amountAsBigNumber);
+    }, utils_1.MathBN.convert(0));
+    const totalRefundedAmount = utils_1.MathBN.add(refundedAmount, refundAmount);
+    if (utils_1.MathBN.lt(capturedAmount, totalRefundedAmount)) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `You are not allowed to refund more than the captured amount`);
+    }
+});
+exports.refundPaymentWorkflowId = "refund-payment-workflow";
+/**
+ * This workflow refunds a payment. It's used by the
+ * [Refund Payment Admin API Route](https://docs.acmekit.com/api/admin#payments_postpaymentsidrefund).
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you
+ * to refund a payment in your custom flows.
+ *
+ * @example
+ * const { result } = await refundPaymentWorkflow(container)
+ * .run({
+ *   input: {
+ *     payment_id: "payment_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Refund a payment.
+ */
+exports.refundPaymentWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.refundPaymentWorkflowId, (input) => {
+    const payment = (0, common_1.useRemoteQueryStep)({
+        entry_point: "payment",
+        fields: [
+            "id",
+            "payment_collection_id",
+            "currency_code",
+            "amount",
+            "raw_amount",
+            "captures.raw_amount",
+            "refunds.raw_amount",
+        ],
+        variables: { id: input.payment_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    (0, workflows_sdk_1.when)({ input }, ({ input }) => !!input.amount).then(() => (0, exports.validateRefundPaymentExceedsCapturedAmountStep)({
+        payment,
+        refundAmount: input.amount,
+    }));
+    const orderPaymentCollection = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_payment_collection",
+        fields: ["order.id"],
+        variables: { payment_collection_id: payment.payment_collection_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-payment-collection" });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order",
+        fields: ["id", "summary", "total", "currency_code", "region_id"],
+        variables: { id: orderPaymentCollection.order.id },
+        throw_if_key_not_found: true,
+        list: false,
+    }).config({ name: "order" });
+    const refundReason = (0, workflows_sdk_1.when)("fetch-refund-reason", { input }, ({ input }) => !!input.refund_reason_id).then(() => {
+        return (0, common_1.useRemoteQueryStep)({
+            entry_point: "refund_reason",
+            fields: ["id", "label", "code"],
+            variables: { id: input.refund_reason_id },
+            list: false,
+            throw_if_key_not_found: true,
+        }).config({ name: "refund-reason" });
+    });
+    const refundPayment = (0, refund_payment_1.refundPaymentStep)(input);
+    const creditLineAmount = (0, workflows_sdk_1.transform)({ order, payment, input }, ({ order, payment, input }) => {
+        const pendingDifference = order.summary?.raw_pending_difference ??
+            order.summary?.pending_difference ??
+            0;
+        const amountToRefund = input.amount ?? payment.raw_amount ?? payment.amount;
+        if (utils_1.MathBN.lt(pendingDifference, 0)) {
+            const amountOwed = utils_1.MathBN.mult(pendingDifference, -1);
+            return utils_1.MathBN.gt(amountToRefund, amountOwed)
+                ? utils_1.MathBN.sub(amountToRefund, amountOwed)
+                : 0;
+        }
+        return amountToRefund;
+    });
+    (0, workflows_sdk_1.when)({ orderPaymentCollection }, ({ orderPaymentCollection }) => {
+        return !!orderPaymentCollection?.order?.id;
+    }).then(() => {
+        const orderTransactionData = (0, workflows_sdk_1.transform)({ input, refundPayment, orderPaymentCollection, order }, ({ input, refundPayment, orderPaymentCollection, order }) => {
+            return refundPayment.refunds?.map((refund) => {
+                return {
+                    order_id: orderPaymentCollection.order.id,
+                    amount: utils_1.MathBN.mult(input.amount ?? refund.raw_amount ?? refund.amount, -1),
+                    currency_code: refundPayment.currency_code ?? order.currency_code,
+                    reference_id: refund.id,
+                    reference: "refund",
+                };
+            });
+        });
+        (0, add_order_transaction_1.addOrderTransactionStep)(orderTransactionData);
+    });
+    (0, workflows_sdk_1.when)({ creditLineAmount }, ({ creditLineAmount }) => utils_1.MathBN.gt(creditLineAmount, 0)).then(() => {
+        create_order_refund_credit_lines_1.createOrderRefundCreditLinesWorkflow.runAsStep({
+            input: {
+                order_id: order.id,
+                amount: creditLineAmount,
+                reference: refundReason?.label,
+                referenceId: refundReason?.code,
+            },
+        });
+    });
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.PaymentEvents.REFUNDED,
+        data: { id: payment.id },
+    });
+    return new workflows_sdk_1.WorkflowResponse(payment);
+});
+//# sourceMappingURL=refund-payment.js.map