@acmekit/core-flows 2.13.1

package/dist/order/workflows/claim/claim-request-item-return.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orderClaimRequestItemReturnWorkflow = exports.orderClaimRequestItemReturnWorkflowId = exports.orderClaimRequestItemReturnValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const update_order_claims_1 = require("../../steps/claim/update-order-claims");
+const preview_order_change_1 = require("../../steps/preview-order-change");
+const create_returns_1 = require("../../steps/return/create-returns");
+const update_order_changes_1 = require("../../steps/update-order-changes");
+const order_validation_1 = require("../../utils/order-validation");
+const create_order_change_actions_1 = require("../create-order-change-actions");
+const refresh_shipping_1 = require("./refresh-shipping");
+/**
+ * This step validates that items can be requested to return as part of a claim.
+ * If the order, claim, or return is canceled, or the order change is not active, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order, order claim, order return, and order change details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = orderClaimRequestItemReturnValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderClaim: {
+ *     id: "claim_123",
+ *     // other order claim details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other order return details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1
+ *     }
+ *   ]
+ * })
+ */
+exports.orderClaimRequestItemReturnValidationStep = (0, workflows_sdk_1.createStep)("claim-request-item-return-validation", async function ({ order, orderChange, orderReturn, orderClaim, items, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfIsCancelled)(orderClaim, "Claim");
+    (0, order_validation_1.throwIfIsCancelled)(orderReturn, "Return");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    (0, order_validation_1.throwIfItemsDoesNotExistsInOrder)({ order, inputItems: items });
+    (0, order_validation_1.throwIfManagedItemsNotStockedAtReturnLocation)({
+        order,
+        orderReturn,
+        inputItems: items,
+    });
+});
+exports.orderClaimRequestItemReturnWorkflowId = "claim-request-item-return";
+/**
+ * This workflow requests one or more items to be returned as part of a claim. The
+ * items are added to the claim as inbound items. The workflow is used by the
+ * [Add Inbound Items to Claim Admin API Route](https://docs.acmekit.com/api/admin#claims_postclaimsidinbounditems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to request items to be returned
+ * as part of a claim in your custom flows.
+ *
+ * @example
+ * const { result } = await orderClaimRequestItemReturnWorkflow(container)
+ * .run({
+ *   input: {
+ *     claim_id: "claim_123",
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Request one or more items to be returned as part of a claim.
+ */
+exports.orderClaimRequestItemReturnWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.orderClaimRequestItemReturnWorkflowId, function (input) {
+    const orderClaim = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_claim",
+        fields: ["id", "order_id", "return_id", "canceled_at"],
+        variables: { id: input.claim_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "claim-query" });
+    const existingOrderReturn = (0, workflows_sdk_1.when)({ orderClaim }, ({ orderClaim }) => {
+        return orderClaim.return_id;
+    }).then(() => {
+        return (0, common_1.useRemoteQueryStep)({
+            entry_point: "return",
+            fields: ["id", "status", "order_id", "location_id", "canceled_at"],
+            variables: { id: orderClaim.return_id },
+            list: false,
+            throw_if_key_not_found: true,
+        }).config({ name: "return-query" });
+    });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: [
+            "id",
+            "status",
+            "items.*",
+            "items.variant.manage_inventory",
+            "items.variant.inventory_items.inventory_item_id",
+            "items.variant.inventory_items.inventory.location_levels.location_id",
+        ],
+        variables: { id: orderClaim.order_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-query" });
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: ["id", "status", "canceled_at", "confirmed_at", "declined_at"],
+        variables: {
+            filters: {
+                order_id: orderClaim.order_id,
+                claim_id: orderClaim.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({
+        name: "order-change-query",
+    });
+    const pickItemLocationId = (0, workflows_sdk_1.transform)({ order, input }, ({ order, input }) => {
+        if (input.location_id) {
+            return input.location_id;
+        }
+        // pick the first item location
+        const item = order?.items?.find((item) => item.id === input.items[0].id);
+        let locationId;
+        (0, utils_1.deepFlatMap)(item, "variant.inventory_items.inventory.location_levels", ({ location_levels }) => {
+            if (!locationId && (0, utils_1.isDefined)(location_levels?.location_id)) {
+                locationId = location_levels.location_id;
+            }
+        });
+        return locationId;
+    });
+    const createdReturn = (0, workflows_sdk_1.when)({ orderClaim }, ({ orderClaim }) => {
+        return !orderClaim.return_id;
+    }).then(() => {
+        return (0, create_returns_1.createReturnsStep)([
+            {
+                order_id: orderClaim.order_id,
+                claim_id: orderClaim.id,
+                location_id: pickItemLocationId,
+            },
+        ]);
+    });
+    const orderReturn = (0, workflows_sdk_1.transform)({ createdReturn, existingOrderReturn }, ({ createdReturn, existingOrderReturn }) => {
+        return existingOrderReturn ?? createdReturn?.[0];
+    });
+    (0, workflows_sdk_1.when)({ createdReturn }, ({ createdReturn }) => {
+        return !!createdReturn?.length;
+    }).then(() => {
+        (0, update_order_changes_1.updateOrderChangesStep)([
+            {
+                id: orderChange.id,
+                return_id: createdReturn?.[0]?.id,
+            },
+        ]);
+    });
+    (0, exports.orderClaimRequestItemReturnValidationStep)({
+        order,
+        items: input.items,
+        orderClaim,
+        orderReturn,
+        orderChange,
+    });
+    (0, workflows_sdk_1.when)({ orderClaim }, ({ orderClaim }) => {
+        return !orderClaim.return_id;
+    }).then(() => {
+        (0, update_order_claims_1.updateOrderClaimsStep)([
+            {
+                id: orderClaim.id,
+                return: createdReturn?.[0].id,
+            },
+        ]);
+    });
+    const orderChangeActionInput = (0, workflows_sdk_1.transform)({ order, orderChange, orderClaim, orderReturn, items: input.items }, ({ order, orderChange, orderClaim, orderReturn, items }) => {
+        return items.map((item) => ({
+            order_change_id: orderChange.id,
+            order_id: order.id,
+            claim_id: orderClaim.id,
+            return_id: orderReturn.id,
+            version: orderChange.version,
+            action: utils_1.ChangeActionType.RETURN_ITEM,
+            internal_note: item.internal_note,
+            reference: "return",
+            reference_id: orderReturn.id,
+            details: {
+                reference_id: item.id,
+                quantity: item.quantity,
+                reason_id: item.reason_id,
+                metadata: item.metadata,
+            },
+        }));
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: orderChangeActionInput,
+    });
+    const refreshArgs = (0, workflows_sdk_1.transform)({ orderChange, orderClaim }, ({ orderChange, orderClaim }) => {
+        return {
+            order_change_id: orderChange.id,
+            claim_id: orderClaim.id,
+            order_id: orderClaim.order_id,
+        };
+    });
+    refresh_shipping_1.refreshClaimShippingWorkflow.runAsStep({
+        input: refreshArgs,
+    });
+    return new workflows_sdk_1.WorkflowResponse((0, preview_order_change_1.previewOrderChangeStep)(orderClaim.order_id));
+});
+//# sourceMappingURL=claim-request-item-return.js.map

package/dist/order/workflows/claim/claim-request-item-return.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"claim-request-item-return.js","sourceRoot":"","sources":["../../../../src/order/workflows/claim/claim-request-item-return.ts"],"names":[],"mappings":";;;AAQA,oDAKiC;AACjC,oEAOyC;AACzC,4CAAoD;AACpD,+EAA6E;AAC7E,2EAAyE;AACzE,sEAAqE;AACrE,2EAAyE;AACzE,mEAKqC;AACrC,gFAAiF;AACjF,yDAAiE;AA4BjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACU,QAAA,yCAAyC,GAAG,IAAA,0BAAU,EACjE,sCAAsC,EACtC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,EACX,WAAW,EACX,UAAU,EACV,KAAK,GAC0C;IAC/C,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,IAAA,qCAAkB,EAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IACvC,IAAA,qCAAkB,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACzC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;IAC9C,IAAA,mDAAgC,EAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IAC9D,IAAA,gEAA6C,EAAC;QAC5C,KAAK;QACL,WAAW;QACX,UAAU,EAAE,KAAK;KAClB,CAAC,CAAA;AACJ,CAAC,CACF,CAAA;AAEY,QAAA,qCAAqC,GAAG,2BAA2B,CAAA;AAChF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,6CAAqC,EACrC,UACE,KAA2E;IAE3E,MAAM,UAAU,GAAG,IAAA,2BAAkB,EAAC;QACpC,WAAW,EAAE,aAAa;QAC1B,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,CAAC;QACtD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;QACjC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,MAAM,mBAAmB,GAAG,IAAA,oBAAI,EAAC,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;QAClE,OAAO,UAAU,CAAC,SAAS,CAAA;IAC7B,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,OAAO,IAAA,2BAAkB,EAAC;YACxB,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,CAAC;YAClE,SAAS,EAAE,EAAE,EAAE,EAAE,UAAU,CAAC,SAAS,EAAE;YACvC,IAAI,EAAE,KAAK;YACX,sBAAsB,EAAE,IAAI;SAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAc,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,MAAM,KAAK,GAAa,IAAA,2BAAkB,EAAC;QACzC,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE;YACN,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,gCAAgC;YAChC,iDAAiD;YACjD,qEAAqE;SACtE;QACD,SAAS,EAAE,EAAE,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE;QACtC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,MAAM,WAAW,GAAmB,IAAA,2BAAkB,EAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,CAAC;QACtE,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,UAAU,CAAC,QAAQ;gBAC7B,QAAQ,EAAE,UAAU,CAAC,EAAE;gBACvB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;aACjE;SACF;QACD,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,oBAAoB;KAC3B,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAA,yBAAS,EAClC,EAAE,KAAK,EAAE,KAAK,EAAE,EAChB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;QACnB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,WAAW,CAAA;QAC1B,CAAC;QAED,+BAA+B;QAC/B,MAAM,IAAI,GAAG,KAAK,EAAE,KAAK,EAAE,IAAI,CAC7B,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CACjC,CAAA;QAER,IAAI,UAA8B,CAAA;QAClC,IAAA,mBAAW,EACT,IAAI,EACJ,mDAAmD,EACnD,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE;YACtB,IAAI,CAAC,UAAU,IAAI,IAAA,iBAAS,EAAC,eAAe,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC3D,UAAU,GAAG,eAAe,CAAC,WAAW,CAAA;YAC1C,CAAC;QACH,CAAC,CACF,CAAA;QACD,OAAO,UAAU,CAAA;IACnB,CAAC,CACF,CAAA;IAED,MAAM,aAAa,GAAG,IAAA,oBAAI,EAAC,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;QAC5D,OAAO,CAAC,UAAU,CAAC,SAAS,CAAA;IAC9B,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,OAAO,IAAA,kCAAiB,EAAC;YACvB;gBACE,QAAQ,EAAE,UAAU,CAAC,QAAQ;gBAC7B,QAAQ,EAAE,UAAU,CAAC,EAAE;gBACvB,WAAW,EAAE,kBAAkB;aAChC;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,WAAW,GAAc,IAAA,yBAAS,EACtC,EAAE,aAAa,EAAE,mBAAmB,EAAE,EACtC,CAAC,EAAE,aAAa,EAAE,mBAAmB,EAAE,EAAE,EAAE;QACzC,OAAO,mBAAmB,IAAK,aAAa,EAAE,CAAC,CAAC,CAAe,CAAA;IACjE,CAAC,CACF,CAAA;IAED,IAAA,oBAAI,EAAC,EAAE,aAAa,EAAE,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE;QAC5C,OAAO,CAAC,CAAC,aAAa,EAAE,MAAM,CAAA;IAChC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,6CAAsB,EAAC;YACrB;gBACE,EAAE,EAAE,WAAW,CAAC,EAAE;gBAClB,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;aAClC;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,iDAAyC,EAAC;QACxC,KAAK;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,UAAU;QACV,WAAW;QACX,WAAW;KACZ,CAAC,CAAA;IAEF,IAAA,oBAAI,EAAC,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;QACtC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAA;IAC9B,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,2CAAqB,EAAC;YACpB;gBACE,EAAE,EAAE,UAAU,CAAC,EAAE;gBACjB,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAE,CAAC,EAAE;aAC/B;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,yBAAS,EACtC,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EACnE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE;QACzD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,eAAe,EAAE,WAAW,CAAC,EAAE;YAC/B,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,QAAQ,EAAE,UAAU,CAAC,EAAE;YACvB,SAAS,EAAE,WAAW,CAAC,EAAE;YACzB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,wBAAgB,CAAC,WAAW;YACpC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,WAAW,CAAC,EAAE;YAC5B,OAAO,EAAE;gBACP,YAAY,EAAE,IAAI,CAAC,EAAE;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB;SACF,CAAC,CAAC,CAAA;IACL,CAAC,CACF,CAAA;IAED,8DAAgC,CAAC,SAAS,CAAC;QACzC,KAAK,EAAE,sBAAsB;KAC9B,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,IAAA,yBAAS,EAC3B,EAAE,WAAW,EAAE,UAAU,EAAE,EAC3B,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,EAAE;QAC9B,OAAO;YACL,eAAe,EAAE,WAAW,CAAC,EAAE;YAC/B,QAAQ,EAAE,UAAU,CAAC,EAAE;YACvB,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAC9B,CAAA;IACH,CAAC,CACF,CAAA;IAED,+CAA4B,CAAC,SAAS,CAAC;QACrC,KAAK,EAAE,WAAW;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,IAAA,6CAAsB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC1E,CAAC,CACF,CAAA"}

package/dist/order/workflows/claim/confirm-claim-request.d.ts

@@ -0,0 +1,81 @@
+import { OrderChangeDTO, OrderClaimDTO, OrderDTO, OrderPreviewDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate confirming a claim request.
+ */
+export type ConfirmClaimRequestValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order claim's details.
+     */
+    orderClaim: OrderClaimDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+};
+/**
+ * This step validates that a requested claim can be confirmed. If the order or claim is canceled,
+ * or the order change is not active, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order, order claim, and order change details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = confirmClaimRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderClaim: {
+ *     id: "claim_123",
+ *     // other order claim details...
+ *   },
+ * })
+ */
+export declare const confirmClaimRequestValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<ConfirmClaimRequestValidationStepInput, unknown>;
+/**
+ * The details of confirming the claim request.
+ */
+export type ConfirmClaimRequestWorkflowInput = {
+    /**
+     * The ID of the claim to confirm.
+     */
+    claim_id: string;
+    /**
+     * The ID of the user confirming the claim.
+     */
+    confirmed_by?: string;
+};
+export declare const confirmClaimRequestWorkflowId = "confirm-claim-request";
+/**
+ * This workflow confirms a requested claim. It's used by the
+ * [Confirm Claim Request API Route](https://docs.acmekit.com/api/admin#claims_postclaimsidrequest).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to confirm a claim
+ * for an order in your custom flows.
+ *
+ * @example
+ * const { result } = await confirmClaimRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     claim_id: "claim_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Confirm a requested claim.
+ */
+export declare const confirmClaimRequestWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<ConfirmClaimRequestWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=confirm-claim-request.d.ts.map

package/dist/order/workflows/claim/confirm-claim-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm-claim-request.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/claim/confirm-claim-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,cAAc,EACd,aAAa,EAEb,QAAQ,EACR,eAAe,EAEhB,MAAM,0BAA0B,CAAA;AA+CjC;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,UAAU,EAAE,aAAa,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,iCAAiC,0GAW7C,CAAA;AAgJD;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,6BAA6B,0BAA0B,CAAA;AACpE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,2BAA2B,kHAsOvC,CAAA"}

package/dist/order/workflows/claim/confirm-claim-request.js

@@ -0,0 +1,345 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.confirmClaimRequestWorkflow = exports.confirmClaimRequestWorkflowId = exports.confirmClaimRequestValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const reserve_inventory_1 = require("../../../cart/steps/reserve-inventory");
+const prepare_confirm_inventory_input_1 = require("../../../cart/utils/prepare-confirm-inventory-input");
+const common_1 = require("../../../common");
+const create_return_fulfillment_1 = require("../../../fulfillment/workflows/create-return-fulfillment");
+const steps_1 = require("../../steps");
+const create_claim_items_from_actions_1 = require("../../steps/claim/create-claim-items-from-actions");
+const confirm_order_changes_1 = require("../../steps/confirm-order-changes");
+const create_return_items_from_actions_1 = require("../../steps/return/create-return-items-from-actions");
+const order_validation_1 = require("../../utils/order-validation");
+const create_or_update_order_payment_collection_1 = require("../create-or-update-order-payment-collection");
+function getUpdateReturnData({ returnId }) {
+    return (0, workflows_sdk_1.transform)({ returnId }, ({ returnId }) => {
+        return [
+            {
+                id: returnId,
+                status: utils_1.ReturnStatus.REQUESTED,
+                requested_at: new Date(),
+            },
+        ];
+    });
+}
+/**
+ * This step validates that a requested claim can be confirmed. If the order or claim is canceled,
+ * or the order change is not active, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order, order claim, and order change details using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @example
+ * const data = confirmClaimRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderClaim: {
+ *     id: "claim_123",
+ *     // other order claim details...
+ *   },
+ * })
+ */
+exports.confirmClaimRequestValidationStep = (0, workflows_sdk_1.createStep)("validate-confirm-claim-request", async function ({ order, orderChange, orderClaim, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfIsCancelled)(orderClaim, "Claim");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+});
+/**
+ * This step confirms that a requested claim has at least one item to return or send
+ */
+const confirmIfClaimItemsArePresent = (0, workflows_sdk_1.createStep)("confirm-if-items-are-present", async function ({ claimItems, returnItems, }) {
+    if (claimItems.length > 0 || (returnItems && returnItems.length > 0)) {
+        return;
+    }
+    throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Order claim request should have at least 1 item`);
+});
+function prepareFulfillmentData({ order, items, shippingOption, deliveryAddress, isReturn, }) {
+    const orderItemsMap = new Map(order.items.map((i) => [i.id, i]));
+    const fulfillmentItems = items.map((i) => {
+        const orderItem = orderItemsMap.get(i.id) ?? i.item;
+        return {
+            line_item_id: i.item_id,
+            quantity: i.quantity,
+            title: orderItem.variant_title ?? orderItem.title,
+            sku: orderItem.variant_sku || "",
+            barcode: orderItem.variant_barcode || "",
+        };
+    });
+    const locationId = shippingOption.service_zone.fulfillment_set.location?.id;
+    // delivery address is the stock location address
+    const address = deliveryAddress ??
+        shippingOption.service_zone.fulfillment_set.location?.address ??
+        {};
+    delete address.id;
+    return {
+        input: {
+            location_id: locationId,
+            provider_id: shippingOption.provider_id,
+            shipping_option_id: shippingOption.id,
+            items: fulfillmentItems,
+            delivery_address: address,
+            order: order,
+        },
+    };
+}
+function transformActionsToItems({ orderChange }) {
+    const claimItems = [];
+    const returnItems = [];
+    const actions = orderChange.actions ?? [];
+    actions.forEach((item) => {
+        if (item.action === utils_1.ChangeActionType.RETURN_ITEM) {
+            returnItems.push(item);
+        }
+        else if (item.action === utils_1.ChangeActionType.ITEM_ADD ||
+            item.action === utils_1.ChangeActionType.WRITE_OFF_ITEM) {
+            claimItems.push(item);
+        }
+    });
+    return {
+        claimItems: {
+            changes: claimItems,
+            claimId: claimItems?.[0]?.claim_id,
+        },
+        returnItems: {
+            changes: returnItems,
+            returnId: returnItems?.[0]?.return_id,
+        },
+    };
+}
+function extractShippingOption({ orderPreview, orderClaim, returnId }) {
+    if (!orderPreview.shipping_methods?.length) {
+        return;
+    }
+    let returnShippingMethod;
+    let claimShippingMethod;
+    for (const shippingMethod of orderPreview.shipping_methods) {
+        const modifiedShippingMethod_ = shippingMethod;
+        if (!modifiedShippingMethod_.actions) {
+            continue;
+        }
+        for (const action of modifiedShippingMethod_.actions) {
+            if (action.action === utils_1.ChangeActionType.SHIPPING_ADD) {
+                if (!!action.return_id && action.return_id === returnId) {
+                    returnShippingMethod = shippingMethod;
+                }
+                else if (action.claim_id === orderClaim.id) {
+                    claimShippingMethod = shippingMethod;
+                }
+            }
+        }
+    }
+    return {
+        returnShippingMethod,
+        claimShippingMethod,
+    };
+}
+exports.confirmClaimRequestWorkflowId = "confirm-claim-request";
+/**
+ * This workflow confirms a requested claim. It's used by the
+ * [Confirm Claim Request API Route](https://docs.acmekit.com/api/admin#claims_postclaimsidrequest).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to confirm a claim
+ * for an order in your custom flows.
+ *
+ * @example
+ * const { result } = await confirmClaimRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     claim_id: "claim_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Confirm a requested claim.
+ */
+exports.confirmClaimRequestWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.confirmClaimRequestWorkflowId, function (input) {
+    const orderClaim = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_claim",
+        fields: [
+            "id",
+            "status",
+            "order_id",
+            "canceled_at",
+            "additional_items.id",
+        ],
+        variables: { id: input.claim_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: [
+            "id",
+            "version",
+            "canceled_at",
+            "items.*",
+            "items.item.id",
+            "shipping_address.*",
+        ],
+        variables: { id: orderClaim.order_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-query" });
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: [
+            "id",
+            "status",
+            "claim_id",
+            "return_id",
+            "actions.id",
+            "actions.claim_id",
+            "actions.return_id",
+            "actions.action",
+            "actions.details",
+            "actions.reference",
+            "actions.reference_id",
+            "actions.internal_note",
+        ],
+        variables: {
+            filters: {
+                order_id: orderClaim.order_id,
+                claim_id: orderClaim.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    (0, exports.confirmClaimRequestValidationStep)({ order, orderClaim, orderChange });
+    const { claimItems, returnItems } = (0, workflows_sdk_1.transform)({ orderChange }, transformActionsToItems);
+    const orderPreview = (0, steps_1.previewOrderChangeStep)(order.id);
+    const [createdClaimItems, createdReturnItems] = (0, workflows_sdk_1.parallelize)((0, create_claim_items_from_actions_1.createOrderClaimItemsFromActionsStep)(claimItems), (0, create_return_items_from_actions_1.createReturnItemsFromActionsStep)(returnItems));
+    confirmIfClaimItemsArePresent({
+        claimItems: createdClaimItems,
+        returnItems: createdReturnItems,
+    });
+    const returnId = (0, workflows_sdk_1.transform)({ createdReturnItems }, ({ createdReturnItems }) => {
+        return createdReturnItems?.[0]?.return_id;
+    });
+    (0, confirm_order_changes_1.confirmOrderChanges)({
+        changes: [orderChange],
+        orderId: order.id,
+        confirmed_by: input.confirmed_by,
+    });
+    (0, workflows_sdk_1.when)({ returnId }, ({ returnId }) => {
+        return !!returnId;
+    }).then(() => {
+        const updateReturnDate = getUpdateReturnData({ returnId });
+        (0, steps_1.updateReturnsStep)(updateReturnDate);
+    });
+    const { returnShippingMethod, claimShippingMethod } = (0, workflows_sdk_1.transform)({ orderPreview, orderClaim, returnId }, extractShippingOption);
+    (0, workflows_sdk_1.when)({ claimShippingMethod }, ({ claimShippingMethod }) => {
+        return !!claimShippingMethod;
+    }).then(() => {
+        const claim = (0, common_1.useRemoteQueryStep)({
+            entry_point: "order_claim",
+            fields: [
+                "id",
+                "version",
+                "canceled_at",
+                "order.sales_channel_id",
+                "additional_items.quantity",
+                "additional_items.raw_quantity",
+                "additional_items.item.id",
+                "additional_items.item.variant.manage_inventory",
+                "additional_items.item.variant.allow_backorder",
+                "additional_items.item.variant.inventory_items.inventory_item_id",
+                "additional_items.item.variant.inventory_items.required_quantity",
+                "additional_items.item.variant.inventory_items.inventory.location_levels.stock_locations.id",
+                "additional_items.item.variant.inventory_items.inventory.location_levels.stock_locations.name",
+                "additional_items.item.variant.inventory_items.inventory.location_levels.stock_locations.sales_channels.id",
+                "additional_items.item.variant.inventory_items.inventory.location_levels.stock_locations.sales_channels.name",
+            ],
+            variables: { id: input.claim_id },
+            list: false,
+            throw_if_key_not_found: true,
+        }).config({ name: "claim-query" });
+        const { variants, items } = (0, workflows_sdk_1.transform)({ claim }, ({ claim }) => {
+            const allItems = [];
+            const allVariants = [];
+            claim.additional_items.forEach((claimItem) => {
+                const item = claimItem.item;
+                allItems.push({
+                    id: item.id,
+                    variant_id: item.variant_id,
+                    quantity: claimItem.raw_quantity ?? claimItem.quantity,
+                });
+                allVariants.push(item.variant);
+            });
+            return {
+                variants: allVariants,
+                items: allItems,
+            };
+        });
+        const formatedInventoryItems = (0, workflows_sdk_1.transform)({
+            input: {
+                sales_channel_id: claim.order.sales_channel_id,
+                variants,
+                items,
+            },
+        }, prepare_confirm_inventory_input_1.prepareConfirmInventoryInput);
+        (0, reserve_inventory_1.reserveInventoryStep)(formatedInventoryItems);
+    });
+    (0, workflows_sdk_1.when)({ returnShippingMethod, returnId }, ({ returnShippingMethod, returnId }) => {
+        return !!returnShippingMethod && !!returnId;
+    }).then(() => {
+        const returnShippingOption = (0, common_1.useRemoteQueryStep)({
+            entry_point: "shipping_options",
+            fields: [
+                "id",
+                "provider_id",
+                "service_zone.fulfillment_set.location.id",
+                "service_zone.fulfillment_set.location.address.*",
+            ],
+            variables: {
+                id: returnShippingMethod.shipping_option_id,
+            },
+            list: false,
+        }).config({ name: "claim-return-shipping-option" });
+        const fulfillmentData = (0, workflows_sdk_1.transform)({
+            order,
+            items: order.items,
+            shippingOption: returnShippingOption,
+            isReturn: true,
+        }, prepareFulfillmentData);
+        const returnFulfillment = create_return_fulfillment_1.createReturnFulfillmentWorkflow.runAsStep(fulfillmentData);
+        const returnLink = (0, workflows_sdk_1.transform)({ returnId, fulfillment: returnFulfillment }, (data) => {
+            return [
+                {
+                    [utils_1.Modules.ORDER]: { return_id: data.returnId },
+                    [utils_1.Modules.FULFILLMENT]: { fulfillment_id: data.fulfillment.id },
+                },
+            ];
+        });
+        (0, common_1.createRemoteLinkStep)(returnLink).config({
+            name: "claim-return-shipping-fulfillment-link",
+        });
+    });
+    create_or_update_order_payment_collection_1.createOrUpdateOrderPaymentCollectionWorkflow.runAsStep({
+        input: {
+            order_id: order.id,
+        },
+    });
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.OrderWorkflowEvents.CLAIM_CREATED,
+        data: {
+            order_id: order.id,
+            claim_id: orderClaim.id,
+        },
+    });
+    return new workflows_sdk_1.WorkflowResponse(orderPreview);
+});
+//# sourceMappingURL=confirm-claim-request.js.map