@acmekit/core-flows 2.13.1

package/dist/order/workflows/return/remove-return-shipping-method.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeReturnShippingMethodWorkflow = exports.removeReturnShippingMethodWorkflowId = exports.removeReturnShippingMethodValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const steps_1 = require("../../steps");
+const delete_order_change_actions_1 = require("../../steps/delete-order-change-actions");
+const preview_order_change_1 = require("../../steps/preview-order-change");
+const order_validation_1 = require("../../utils/order-validation");
+/**
+ * This step validates that a shipping method can be removed from a return.
+ * If the return is canceled, the order change is not active,
+ * the shipping method isn't in the return,
+ * or the action doesn't add a shipping method, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve a 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 = removeReturnShippingMethodValidationStep({
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *   }
+ * })
+ */
+exports.removeReturnShippingMethodValidationStep = (0, workflows_sdk_1.createStep)("validate-remove-return-shipping-method", async function ({ orderChange, orderReturn, input, }) {
+    (0, order_validation_1.throwIfIsCancelled)(orderReturn, "Return");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+    if (!associatedAction) {
+        throw new Error(`No shipping method found for return ${input.return_id} in order change ${orderChange.id}`);
+    }
+    else if (associatedAction.action !== utils_1.ChangeActionType.SHIPPING_ADD) {
+        throw new Error(`Action ${associatedAction.id} is not adding a shipping method`);
+    }
+});
+exports.removeReturnShippingMethodWorkflowId = "remove-return-shipping-method";
+/**
+ * This workflow removes a shipping method from a return. It's used by the
+ * [Remove Shipping Method from Return Admin API Route](https://docs.acmekit.com/api/admin#returns_deletereturnsidshippingmethodaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you
+ * to remove a shipping method from a return in your custom flows.
+ *
+ * @example
+ * const { result } = await removeReturnShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Remove a shipping method from a return.
+ */
+exports.removeReturnShippingMethodWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.removeReturnShippingMethodWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "return",
+        fields: ["id", "status", "order_id", "canceled_at"],
+        variables: { id: input.return_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: ["id", "status", "version", "actions.*"],
+        variables: {
+            filters: {
+                order_id: orderReturn.order_id,
+                return_id: orderReturn.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    (0, exports.removeReturnShippingMethodValidationStep)({
+        orderReturn,
+        orderChange,
+        input,
+    });
+    const dataToRemove = (0, workflows_sdk_1.transform)({ orderChange, input }, ({ orderChange, input }) => {
+        const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+        return {
+            actionId: associatedAction.id,
+            shippingMethodId: associatedAction.reference_id,
+        };
+    });
+    (0, workflows_sdk_1.parallelize)((0, delete_order_change_actions_1.deleteOrderChangeActionsStep)({ ids: [dataToRemove.actionId] }), (0, steps_1.deleteOrderShippingMethods)({ ids: [dataToRemove.shippingMethodId] }));
+    return new workflows_sdk_1.WorkflowResponse((0, preview_order_change_1.previewOrderChangeStep)(orderReturn.order_id));
+});
+//# sourceMappingURL=remove-return-shipping-method.js.map

package/dist/order/workflows/return/remove-return-shipping-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-return-shipping-method.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/remove-return-shipping-method.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAOyC;AACzC,4CAAoD;AACpD,uCAAwD;AACxD,yFAAsF;AACtF,2EAAyE;AACzE,mEAGqC;AAoBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACU,QAAA,wCAAwC,GAAG,IAAA,0BAAU,EAChE,wCAAwC,EACxC,KAAK,WAAW,EACd,WAAW,EACX,WAAW,EACX,KAAK,GACyC;IAC9C,IAAA,qCAAkB,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACzC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;IAE9C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,CAAC,SAAS,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC3F,CAAA;IACH,CAAC;SAAM,IAAI,gBAAgB,CAAC,MAAM,KAAK,wBAAgB,CAAC,YAAY,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CACb,UAAU,gBAAgB,CAAC,EAAE,kCAAkC,CAChE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAEY,QAAA,oCAAoC,GAC/C,+BAA+B,CAAA;AACjC;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,kCAAkC,GAAG,IAAA,8BAAc,EAC9D,4CAAoC,EACpC,UACE,KAA0E;IAE1E,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC;QACnD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE;QAClC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAA;IAEF,MAAM,WAAW,GAAmB,IAAA,2BAAkB,EAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC;QAChD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,SAAS,EAAE,WAAW,CAAC,EAAE;gBACzB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;aACjE;SACF;QACD,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,IAAA,gDAAwC,EAAC;QACvC,WAAW;QACX,WAAW;QACX,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,EAAE,WAAW,EAAE,KAAK,EAAE,EACtB,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE;QACzB,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;QAEzB,OAAO;YACL,QAAQ,EAAE,gBAAgB,CAAC,EAAE;YAC7B,gBAAgB,EAAE,gBAAgB,CAAC,YAAY;SAChD,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAA,2BAAW,EACT,IAAA,0DAA4B,EAAC,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC9D,IAAA,kCAA0B,EAAC,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC,CACrE,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,IAAA,6CAAsB,EAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC3E,CAAC,CACF,CAAA"}

package/dist/order/workflows/return/request-item-return.d.ts

@@ -0,0 +1,91 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow, ReturnDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that items can be added to a return.
+ */
+export type RequestItemReturnValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: Pick<OrderDTO, "id" | "items">;
+    /**
+     * The return's details.
+     */
+    orderReturn: ReturnDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+    /**
+     * The items to be added to the return.
+     */
+    items: OrderWorkflow.RequestItemReturnWorkflowInput["items"];
+};
+/**
+ * This step validates that items can be added to a return.
+ * If the order or return is canceled, the order change is not active,
+ * the items do not exist in the order, or the return reasons are invalid,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = requestItemReturnValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1,
+ *     }
+ *   ]
+ * })
+ */
+export declare const requestItemReturnValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<RequestItemReturnValidationStepInput, unknown>;
+export declare const requestItemReturnWorkflowId = "request-item-return";
+/**
+ * This workflow adds items to a return. It's used by the
+ * [Add Requested Items to Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidrequestitems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to add items to a return
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await requestItemReturnWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Add items to a return.
+ */
+export declare const requestItemReturnWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.RequestItemReturnWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=request-item-return.d.ts.map

package/dist/order/workflows/return/request-item-return.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-item-return.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/request-item-return.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACV,MAAM,0BAA0B,CAAA;AAmBjC;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD;;OAEG;IACH,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,GAAG,OAAO,CAAC,CAAA;IACrC;;OAEG;IACH,WAAW,EAAE,SAAS,CAAA;IACtB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAA;CAC7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,+BAA+B,wGAqB3C,CAAA;AAED,eAAO,MAAM,2BAA2B,wBAAwB,CAAA;AAChE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,yBAAyB,8HAoFrC,CAAA"}

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

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestItemReturnWorkflow = exports.requestItemReturnWorkflowId = exports.requestItemReturnValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const steps_1 = require("../../steps");
+const order_validation_1 = require("../../utils/order-validation");
+const validate_return_reason_1 = require("../../utils/validate-return-reason");
+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 added to a return.
+ * If the order or return is canceled, the order change is not active,
+ * the items do not exist in the order, or the return reasons are invalid,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = requestItemReturnValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1,
+ *     }
+ *   ]
+ * })
+ */
+exports.requestItemReturnValidationStep = (0, workflows_sdk_1.createStep)("request-item-return-validation", async function ({ order, orderChange, orderReturn, items, }, context) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfIsCancelled)(orderReturn, "Return");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    (0, order_validation_1.throwIfItemsDoesNotExistsInOrder)({ order, inputItems: items });
+    await (0, validate_return_reason_1.validateReturnReasons)({ orderId: order.id, inputItems: items }, context);
+});
+exports.requestItemReturnWorkflowId = "request-item-return";
+/**
+ * This workflow adds items to a return. It's used by the
+ * [Add Requested Items to Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidrequestitems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to add items to a return
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await requestItemReturnWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Add items to a return.
+ */
+exports.requestItemReturnWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.requestItemReturnWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "return",
+        fields: ["id", "status", "order_id", "canceled_at"],
+        variables: { id: input.return_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: ["id", "status", "canceled_at", "items.*"],
+        variables: { id: orderReturn.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", "order_id", "return_id"],
+        variables: {
+            filters: {
+                order_id: orderReturn.order_id,
+                return_id: orderReturn.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    (0, exports.requestItemReturnValidationStep)({
+        order,
+        items: input.items,
+        orderReturn,
+        orderChange,
+    });
+    const orderChangeActionInput = (0, workflows_sdk_1.transform)({ order, orderChange, orderReturn, items: input.items }, ({ order, orderChange, orderReturn, items }) => {
+        return items.map((item) => ({
+            order_change_id: orderChange.id,
+            order_id: order.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,
+                reason_id: item.reason_id,
+                quantity: item.quantity,
+                metadata: item.metadata,
+            },
+        }));
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: orderChangeActionInput,
+    });
+    const refreshArgs = (0, workflows_sdk_1.transform)({ orderChange, orderReturn }, ({ orderChange, orderReturn }) => {
+        return {
+            order_change_id: orderChange.id,
+            return_id: orderReturn.id,
+            order_id: orderReturn.order_id,
+        };
+    });
+    refresh_shipping_1.refreshReturnShippingWorkflow.runAsStep({
+        input: refreshArgs,
+    });
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id));
+});
+//# sourceMappingURL=request-item-return.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"request-item-return.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/request-item-return.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAoD;AACpD,uCAAoD;AACpD,mEAIqC;AACrC,+EAA0E;AAC1E,gFAAiF;AACjF,yDAAkE;AAuBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACU,QAAA,+BAA+B,GAAG,IAAA,0BAAU,EACvD,gCAAgC,EAChC,KAAK,WACH,EACE,KAAK,EACL,WAAW,EACX,WAAW,EACX,KAAK,GACgC,EACvC,OAAO;IAEP,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,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;IAE9D,MAAM,IAAA,8CAAqB,EACzB,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EACxC,OAAO,CACR,CAAA;AACH,CAAC,CACF,CAAA;AAEY,QAAA,2BAA2B,GAAG,qBAAqB,CAAA;AAChE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,UACE,KAAiE;IAEjE,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC;QACnD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE;QAClC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAA;IAEF,MAAM,KAAK,GAAa,IAAA,2BAAkB,EAAC;QACzC,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC;QAClD,SAAS,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,QAAQ,EAAE;QACvC,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,UAAU,EAAE,WAAW,CAAC;QACjD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,SAAS,EAAE,WAAW,CAAC,EAAE;gBACzB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;aACjE;SACF;QACD,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,IAAA,uCAA+B,EAAC;QAC9B,KAAK;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,WAAW;QACX,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,yBAAS,EACtC,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EACvD,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7C,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,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,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,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,WAAW,EAAE,EAC5B,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,EAAE;QAC/B,OAAO;YACL,eAAe,EAAE,WAAW,CAAC,EAAE;YAC/B,SAAS,EAAE,WAAW,CAAC,EAAE;YACzB,QAAQ,EAAE,WAAW,CAAC,QAAQ;SAC/B,CAAA;IACH,CAAC,CACF,CAAA;IAED,gDAA6B,CAAC,SAAS,CAAC;QACtC,KAAK,EAAE,WAAW;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,IAAA,8BAAsB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;AAC/D,CAAC,CACF,CAAA"}

package/dist/order/workflows/return/update-receive-item-return-request.d.ts

@@ -0,0 +1,90 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow, ReturnDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that an item can be updated in a return receival request.
+ */
+export type UpdateReceiveItemReturnRequestValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The return's details.
+     */
+    orderReturn: ReturnDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+    /**
+     * The details of the item update.
+     */
+    input: OrderWorkflow.UpdateReceiveItemReturnRequestWorkflowInput;
+};
+/**
+ * This step validates that an item can be updated in a return receival request.
+ * If the order or return is canceled, the order change is not active,
+ * the return request is not found, or the action is not receiving an item return request,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = updateReceiveItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *     data: {
+ *       quantity: 1,
+ *     }
+ *   }
+ * })
+ */
+export declare const updateReceiveItemReturnRequestValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<UpdateReceiveItemReturnRequestValidationStepInput, unknown>;
+export declare const updateReceiveItemReturnRequestWorkflowId = "update-receive-item-return-request";
+/**
+ * This workflow updates an item in a return receival request. It's used by the
+ * [Update a Received Item in a Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitemsaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to update an item in a return receival request
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await updateReceiveItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *     data: {
+ *       quantity: 1,
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update an item in a return receival request.
+ */
+export declare const updateReceiveItemReturnRequestWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.UpdateReceiveItemReturnRequestWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=update-receive-item-return-request.d.ts.map

package/dist/order/workflows/return/update-receive-item-return-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-receive-item-return-request.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/update-receive-item-return-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACV,MAAM,0BAA0B,CAAA;AAmBjC;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,SAAS,CAAA;IACtB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,2CAA2C,CAAA;CACjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,eAAO,MAAM,4CAA4C,qHAkCxD,CAAA;AAED,eAAO,MAAM,wCAAwC,uCACf,CAAA;AACtC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,sCAAsC,2IA+DlD,CAAA"}

package/dist/order/workflows/return/update-receive-item-return-request.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateReceiveItemReturnRequestWorkflow = exports.updateReceiveItemReturnRequestWorkflowId = exports.updateReceiveItemReturnRequestValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const steps_1 = require("../../steps");
+const order_validation_1 = require("../../utils/order-validation");
+/**
+ * This step validates that an item can be updated in a return receival request.
+ * If the order or return is canceled, the order change is not active,
+ * the return request is not found, or the action is not receiving an item return request,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = updateReceiveItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *     data: {
+ *       quantity: 1,
+ *     }
+ *   }
+ * })
+ */
+exports.updateReceiveItemReturnRequestValidationStep = (0, workflows_sdk_1.createStep)("update-receive-item-return-request-validation", async function ({ order, orderChange, orderReturn, input, }, context) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfIsCancelled)(orderReturn, "Return");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+    if (!associatedAction) {
+        throw new Error(`No request return found for return ${input.return_id} in order change ${orderChange.id}`);
+    }
+    else if (![
+        utils_1.ChangeActionType.RECEIVE_RETURN_ITEM,
+        utils_1.ChangeActionType.RECEIVE_DAMAGED_RETURN_ITEM,
+    ].includes(associatedAction.action)) {
+        throw new Error(`Action ${associatedAction.id} is not receiving an item return request`);
+    }
+});
+exports.updateReceiveItemReturnRequestWorkflowId = "update-receive-item-return-request";
+/**
+ * This workflow updates an item in a return receival request. It's used by the
+ * [Update a Received Item in a Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitemsaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to update an item in a return receival request
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await updateReceiveItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     action_id: "orchac_123",
+ *     data: {
+ *       quantity: 1,
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update an item in a return receival request.
+ */
+exports.updateReceiveItemReturnRequestWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateReceiveItemReturnRequestWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "return",
+        fields: ["id", "status", "order_id", "canceled_at"],
+        variables: { id: input.return_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: ["id", "status", "canceled_at", "items.*"],
+        variables: { id: orderReturn.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", "version", "actions.*"],
+        variables: {
+            filters: {
+                order_id: orderReturn.order_id,
+                return_id: orderReturn.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    (0, exports.updateReceiveItemReturnRequestValidationStep)({
+        order,
+        input,
+        orderReturn,
+        orderChange,
+    });
+    const updateData = (0, workflows_sdk_1.transform)({ orderChange, input }, ({ input, orderChange }) => {
+        const originalAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+        const data = input.data;
+        return {
+            id: input.action_id,
+            details: {
+                quantity: data.quantity ?? originalAction.details?.quantity,
+            },
+            internal_note: data.internal_note,
+        };
+    });
+    (0, steps_1.updateOrderChangeActionsStep)([updateData]);
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id));
+});
+//# sourceMappingURL=update-receive-item-return-request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"update-receive-item-return-request.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/update-receive-item-return-request.ts"],"names":[],"mappings":";;;AAQA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAoD;AACpD,uCAGoB;AACpB,mEAGqC;AAwBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACU,QAAA,4CAA4C,GAAG,IAAA,0BAAU,EACpE,+CAA+C,EAC/C,KAAK,WACH,EACE,KAAK,EACL,WAAW,EACX,WAAW,EACX,KAAK,GAC6C,EACpD,OAAO;IAEP,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,IAAA,qCAAkB,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACzC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;IAE9C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,sCAAsC,KAAK,CAAC,SAAS,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC1F,CAAA;IACH,CAAC;SAAM,IACL,CAAC;QACC,wBAAgB,CAAC,mBAAmB;QACpC,wBAAgB,CAAC,2BAA2B;KAC7C,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAA0B,CAAC,EACvD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,UAAU,gBAAgB,CAAC,EAAE,0CAA0C,CACxE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAEY,QAAA,wCAAwC,GACnD,oCAAoC,CAAA;AACtC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,sCAAsC,GAAG,IAAA,8BAAc,EAClE,gDAAwC,EACxC,UACE,KAA8E;IAE9E,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC;QACnD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE;QAClC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAA;IAEF,MAAM,KAAK,GAAa,IAAA,2BAAkB,EAAC;QACzC,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC;QAClD,SAAS,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,QAAQ,EAAE;QACvC,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,SAAS,EAAE,WAAW,CAAC;QAChD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,SAAS,EAAE,WAAW,CAAC,EAAE;gBACzB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;aACjE;SACF;QACD,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,IAAA,oDAA4C,EAAC;QAC3C,KAAK;QACL,KAAK;QACL,WAAW;QACX,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAC1B,EAAE,WAAW,EAAE,KAAK,EAAE,EACtB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;QACzB,MAAM,cAAc,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACrD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;QAEzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;QACvB,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,SAAS;YACnB,OAAO,EAAE;gBACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,cAAc,CAAC,OAAO,EAAE,QAAQ;aAC5D;YACD,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAA;IACH,CAAC,CACF,CAAA;IAED,IAAA,oCAA4B,EAAC,CAAC,UAAU,CAAC,CAAC,CAAA;IAE1C,OAAO,IAAI,gCAAgB,CAAC,IAAA,8BAAsB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;AAC/D,CAAC,CACF,CAAA"}