@acmekit/core-flows 2.13.1

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

@@ -0,0 +1,99 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow, ReturnDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that a return request can have its items dismissed.
+ */
+export type DismissItemReturnRequestValidationStepInput = {
+    /**
+     * 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 dismiss.
+     */
+    items: OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput["items"];
+};
+/**
+ * This step validates that a return request can have its items dismissed.
+ * If the order or return is canceled, the order change is not active,
+ * or the items do not exist in the return, 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 = dismissItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1,
+ *     }
+ *   ]
+ * })
+ */
+export declare const dismissItemReturnRequestValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<DismissItemReturnRequestValidationStepInput, unknown>;
+/**
+ * The data to dismiss items from a return request.
+ *
+ * @property return_id - The ID of the return to dismiss items from.
+ * @property items - The items to dismiss.
+ */
+export type DismissItemReturnRequestWorkflowInput = OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput;
+export declare const dismissItemReturnRequestWorkflowId = "dismiss-item-return-request";
+/**
+ * This workflow dismisses items from a return request due to them being damaged. It's used
+ * by the [Add Damaged Items Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsiddismissitems).
+ *
+ * A damaged item's quantity is dismissed, meaning it's not returned to the inventory.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you
+ * to dismiss items from a return request in your custom flow.
+ *
+ * @example
+ * const { result } = await dismissItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Dismiss items from a return request.
+ */
+export declare const dismissItemReturnRequestWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=dismiss-item-return-request.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dismiss-item-return-request.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/dismiss-item-return-request.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACV,MAAM,0BAA0B,CAAA;AAkBjC;;GAEG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD;;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,oCAAoC,CAAC,OAAO,CAAC,CAAA;CACnE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,sCAAsC,+GAgBlD,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,oCAAoC,CAAA;AAEtG,eAAO,MAAM,kCAAkC,gCAAgC,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,gCAAgC,oIAmE5C,CAAA"}

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

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dismissItemReturnRequestWorkflow = exports.dismissItemReturnRequestWorkflowId = exports.dismissItemReturnRequestValidationStep = 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 create_order_change_actions_1 = require("../create-order-change-actions");
+/**
+ * This step validates that a return request can have its items dismissed.
+ * If the order or return is canceled, the order change is not active,
+ * or the items do not exist in the return, 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 = dismissItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         // other item details...
+ *       }
+ *     ]
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1,
+ *     }
+ *   ]
+ * })
+ */
+exports.dismissItemReturnRequestValidationStep = (0, workflows_sdk_1.createStep)("dismiss-item-return-request-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.throwIfItemsDoesNotExistsInReturn)({ orderReturn, inputItems: items });
+});
+exports.dismissItemReturnRequestWorkflowId = "dismiss-item-return-request";
+/**
+ * This workflow dismisses items from a return request due to them being damaged. It's used
+ * by the [Add Damaged Items Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsiddismissitems).
+ *
+ * A damaged item's quantity is dismissed, meaning it's not returned to the inventory.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you
+ * to dismiss items from a return request in your custom flow.
+ *
+ * @example
+ * const { result } = await dismissItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Dismiss items from a return request.
+ */
+exports.dismissItemReturnRequestWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.dismissItemReturnRequestWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "return",
+        fields: ["id", "status", "order_id", "canceled_at", "items.*"],
+        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"],
+        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.dismissItemReturnRequestValidationStep)({
+        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.RECEIVE_DAMAGED_RETURN_ITEM,
+            internal_note: item.internal_note,
+            reference: "return",
+            reference_id: orderReturn.id,
+            details: {
+                reference_id: item.id,
+                quantity: item.quantity,
+            },
+        }));
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: orderChangeActionInput,
+    });
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id));
+});
+//# sourceMappingURL=dismiss-item-return-request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dismiss-item-return-request.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/dismiss-item-return-request.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAoD;AACpD,uCAAoD;AACpD,mEAIqC;AACrC,gFAAiF;AAwBjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACU,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,wCAAwC,EACxC,KAAK,WACH,EACE,KAAK,EACL,WAAW,EACX,WAAW,EACX,KAAK,GACuC,EAC9C,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,oDAAiC,EAAC,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;AACvE,CAAC,CACF,CAAA;AAUY,QAAA,kCAAkC,GAAG,6BAA6B,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,gCAAgC,GAAG,IAAA,8BAAc,EAC5D,0CAAkC,EAClC,UACE,KAA0D;IAE1D,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC;QAC9D,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,CAAC;QACvC,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,8CAAsC,EAAC;QACrC,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,2BAA2B;YACpD,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;aACxB;SACF,CAAC,CAAC,CAAA;IACL,CAAC,CACF,CAAA;IAED,8DAAgC,CAAC,SAAS,CAAC;QACzC,KAAK,EAAE,sBAAsB;KAC9B,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/receive-complete-return.d.ts

@@ -0,0 +1,71 @@
+import type { OrderWorkflow } from "@acmekit/framework/types";
+import type { ReturnDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that a return can be received and completed.
+ */
+export type ReceiveCompleteReturnValidationStepInput = {
+    /**
+     * The return's details.
+     */
+    orderReturn: ReturnDTO;
+    /**
+     * The details of receiving and completing the return.
+     */
+    input: OrderWorkflow.ReceiveCompleteOrderReturnWorkflowInput;
+};
+/**
+ * This step validates that a return can be received and completed.
+ * If the return is canceled or the items do not exist in the return, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve a return 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 = receiveCompleteReturnValidationStep({
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ */
+export declare const receiveCompleteReturnValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<ReceiveCompleteReturnValidationStepInput, unknown>;
+export declare const receiveAndCompleteReturnOrderWorkflowId = "receive-return-order";
+/**
+ * This workflow marks a return as received and completes it.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you
+ * to receive and complete a return.
+ *
+ * @example
+ * const { result } = await receiveAndCompleteReturnOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Receive and complete a return.
+ */
+export declare const receiveAndCompleteReturnOrderWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.ReceiveCompleteOrderReturnWorkflowInput, ReturnDTO | undefined, []>;
+//# sourceMappingURL=receive-complete-return.d.ts.map

package/dist/order/workflows/return/receive-complete-return.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receive-complete-return.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/receive-complete-return.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAS7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAOzD;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,WAAW,EAAE,SAAS,CAAA;IACtB;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,uCAAuC,CAAA;CAC7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,mCAAmC,4GAS/C,CAAA;AAED,eAAO,MAAM,uCAAuC,yBAAyB,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,qCAAqC,6IAiBjD,CAAA"}

package/dist/order/workflows/return/receive-complete-return.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.receiveAndCompleteReturnOrderWorkflow = exports.receiveAndCompleteReturnOrderWorkflowId = exports.receiveCompleteReturnValidationStep = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const receive_return_1 = require("../../steps/return/receive-return");
+const order_validation_1 = require("../../utils/order-validation");
+/**
+ * This step validates that a return can be received and completed.
+ * If the return is canceled or the items do not exist in the return, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve a return 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 = receiveCompleteReturnValidationStep({
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ */
+exports.receiveCompleteReturnValidationStep = (0, workflows_sdk_1.createStep)("receive-return-order-validation", async function ({ orderReturn, input }, context) {
+    (0, order_validation_1.throwIfIsCancelled)(orderReturn, "Return");
+    (0, order_validation_1.throwIfItemsDoesNotExistsInReturn)({ orderReturn, inputItems: input.items });
+});
+exports.receiveAndCompleteReturnOrderWorkflowId = "receive-return-order";
+/**
+ * This workflow marks a return as received and completes it.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you
+ * to receive and complete a return.
+ *
+ * @example
+ * const { result } = await receiveAndCompleteReturnOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Receive and complete a return.
+ */
+exports.receiveAndCompleteReturnOrderWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.receiveAndCompleteReturnOrderWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "returns",
+        fields: ["id", "canceled_at", "items.*"],
+        variables: { id: input.return_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    (0, exports.receiveCompleteReturnValidationStep)({ orderReturn, input });
+    return new workflows_sdk_1.WorkflowResponse((0, receive_return_1.receiveReturnStep)(input));
+});
+//# sourceMappingURL=receive-complete-return.js.map

package/dist/order/workflows/return/receive-complete-return.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"receive-complete-return.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/receive-complete-return.ts"],"names":[],"mappings":";;;AACA,oEAKyC;AACzC,4CAAoD;AAGpD,sEAAqE;AACrE,mEAGqC;AAgBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACU,QAAA,mCAAmC,GAAG,IAAA,0BAAU,EAC3D,iCAAiC,EACjC,KAAK,WACH,EAAE,WAAW,EAAE,KAAK,EAA4C,EAChE,OAAO;IAEP,IAAA,qCAAkB,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACzC,IAAA,oDAAiC,EAAC,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;AAC7E,CAAC,CACF,CAAA;AAEY,QAAA,uCAAuC,GAAG,sBAAsB,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,qCAAqC,GAAG,IAAA,8BAAc,EACjE,+CAAuC,EACvC,UACE,KAA0E;IAE1E,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,SAAS;QACtB,MAAM,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,CAAC;QACxC,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE;QAClC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAA;IAEF,IAAA,2CAAmC,EAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAA;IAE3D,OAAO,IAAI,gCAAgB,CAAC,IAAA,kCAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,85 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow, ReturnDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that a return's items can be marked as received.
+ */
+export type ReceiveItemReturnRequestValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: Pick<OrderDTO, "id" | "items">;
+    /**
+     * The return's details.
+     */
+    orderReturn: ReturnDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+    /**
+     * The received items.
+     */
+    items: OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput["items"];
+};
+/**
+ * This step validates that a return's items can be marked as received.
+ * If the order or return is canceled, the order change is not active,
+ * or the items do not exist in the return, 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 = receiveItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order 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 receiveItemReturnRequestValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<ReceiveItemReturnRequestValidationStepInput, unknown>;
+export declare const receiveItemReturnRequestWorkflowId = "receive-item-return-request";
+/**
+ * This workflow marks return items as received. It's used by the
+ * [Add Received Items to Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to mark return items as received
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await receiveItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark return items as received.
+ */
+export declare const receiveItemReturnRequestWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=receive-item-return-request.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"receive-item-return-request.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/receive-item-return-request.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACb,SAAS,EACV,MAAM,0BAA0B,CAAA;AAkBjC;;GAEG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD;;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,oCAAoC,CAAC,OAAO,CAAC,CAAA;CACnE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,sCAAsC,+GAgBlD,CAAA;AAED,eAAO,MAAM,kCAAkC,gCAAgC,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,gCAAgC,oIAmE5C,CAAA"}

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

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.receiveItemReturnRequestWorkflow = exports.receiveItemReturnRequestWorkflowId = exports.receiveItemReturnRequestValidationStep = 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 create_order_change_actions_1 = require("../create-order-change-actions");
+/**
+ * This step validates that a return's items can be marked as received.
+ * If the order or return is canceled, the order change is not active,
+ * or the items do not exist in the return, 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 = receiveItemReturnRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderReturn: {
+ *     id: "return_123",
+ *     // other return details...
+ *   },
+ *   items: [
+ *     {
+ *       id: "orli_123",
+ *       quantity: 1,
+ *     }
+ *   ]
+ * })
+ */
+exports.receiveItemReturnRequestValidationStep = (0, workflows_sdk_1.createStep)("receive-item-return-request-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.throwIfItemsDoesNotExistsInReturn)({ orderReturn, inputItems: items });
+});
+exports.receiveItemReturnRequestWorkflowId = "receive-item-return-request";
+/**
+ * This workflow marks return items as received. It's used by the
+ * [Add Received Items to Return Admin API Route](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to mark return items as received
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await receiveItemReturnRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     return_id: "return_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark return items as received.
+ */
+exports.receiveItemReturnRequestWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.receiveItemReturnRequestWorkflowId, function (input) {
+    const orderReturn = (0, common_1.useRemoteQueryStep)({
+        entry_point: "return",
+        fields: ["id", "status", "order_id", "canceled_at", "items.*"],
+        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"],
+        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.receiveItemReturnRequestValidationStep)({
+        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.RECEIVE_RETURN_ITEM,
+            internal_note: item.internal_note,
+            reference: "return",
+            reference_id: orderReturn.id,
+            details: {
+                reference_id: item.id,
+                quantity: item.quantity,
+            },
+        }));
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: orderChangeActionInput,
+    });
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id));
+});
+//# sourceMappingURL=receive-item-return-request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"receive-item-return-request.js","sourceRoot":"","sources":["../../../../src/order/workflows/return/receive-item-return-request.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAoD;AACpD,uCAAoD;AACpD,mEAIqC;AACrC,gFAAiF;AAwBjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACU,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,wCAAwC,EACxC,KAAK,WACH,EACE,KAAK,EACL,WAAW,EACX,WAAW,EACX,KAAK,GACuC,EAC9C,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,oDAAiC,EAAC,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;AACvE,CAAC,CACF,CAAA;AAEY,QAAA,kCAAkC,GAAG,6BAA6B,CAAA;AAC/E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,gCAAgC,GAAG,IAAA,8BAAc,EAC5D,0CAAkC,EAClC,UACE,KAAuE;IAEvE,MAAM,WAAW,GAAc,IAAA,2BAAkB,EAAC;QAChD,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC;QAC9D,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,CAAC;QACvC,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,8CAAsC,EAAC;QACrC,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,mBAAmB;YAC5C,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;aACxB;SACF,CAAC,CAAC,CAAA;IACL,CAAC,CACF,CAAA;IAED,8DAAgC,CAAC,SAAS,CAAC;QACzC,KAAK,EAAE,sBAAsB;KAC9B,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/refresh-shipping.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The data to validate that items can be added to a return.
+ */
+export type RequestItemReturnValidationStepInput = {
+    /**
+     * The order change's ID.
+     */
+    order_change_id: string;
+    /**
+     * The return's details.
+     */
+    return_id: string;
+    /**
+     * The order's ID.
+     */
+    order_id: string;
+};
+export declare const refreshReturnShippingWorkflowId = "refresh-return-shipping";
+/**
+ * This workflow refreshes the shipping method for a return in case the shipping option is calculated.
+ *
+ * @summary
+ *
+ * Refresh return shipping.
+ */
+export declare const refreshReturnShippingWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<RequestItemReturnValidationStepInput, void, []>;
+//# sourceMappingURL=refresh-shipping.d.ts.map

package/dist/order/workflows/return/refresh-shipping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh-shipping.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/return/refresh-shipping.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,+BAA+B,4BAA4B,CAAA;AACxE;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,2GA0DzC,CAAA"}