@acmekit/core-flows 2.13.1

package/dist/order/workflows/order-edit/order-edit-update-item-quantity.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orderEditUpdateItemQuantityWorkflow = exports.orderEditUpdateItemQuantityWorkflowId = exports.orderEditUpdateItemQuantityValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const locking_1 = require("../../../locking");
+const preview_order_change_1 = require("../../steps/preview-order-change");
+const order_validation_1 = require("../../utils/order-validation");
+const compute_adjustments_for_preview_1 = require("../compute-adjustments-for-preview");
+const create_order_change_actions_1 = require("../create-order-change-actions");
+const fields_1 = require("./utils/fields");
+/**
+ * This step validates that the quantity of an existing item in an order can be updated in an order edit.
+ * If the order is canceled or the order change is not active, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order 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 = orderEditUpdateItemQuantityValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   }
+ * })
+ */
+exports.orderEditUpdateItemQuantityValidationStep = (0, workflows_sdk_1.createStep)("order-edit-update-item-quantity-validation", async function ({ order, orderChange, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+});
+exports.orderEditUpdateItemQuantityWorkflowId = "order-edit-update-item-quantity";
+/**
+ * This workflow updates the quantity of an existing item in an order's edit. It's used by the
+ * [Update Order Item Quantity Admin API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditemsitemitem_id).
+ *
+ * This workflow is different from the `updateOrderEditItemQuantityWorkflow` workflow in that this should be used
+ * when the item to update was part of the original order before the edit. The other workflow is for items
+ * that were added to the order as part of the edit.
+ *
+ * You can also use this workflow to remove an item from an order by setting its quantity to `0`.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to update the quantity of an existing
+ * item in an order's edit in your custom flow.
+ *
+ * @example
+ * const { result } = await orderEditUpdateItemQuantityWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     items: [
+ *       {
+ *         id: "orli_123",
+ *         quantity: 2,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update or remove an existing order item's quantity in the order's edit.
+ */
+exports.orderEditUpdateItemQuantityWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.orderEditUpdateItemQuantityWorkflowId, function (input) {
+    (0, locking_1.acquireLockStep)({
+        key: input.order_id,
+        timeout: 2,
+        ttl: 10,
+    });
+    const orderResult = (0, common_1.useQueryGraphStep)({
+        entity: "order",
+        fields: fields_1.fieldsToRefreshOrderEdit,
+        filters: { id: input.order_id },
+        options: {
+            throwIfKeyNotFound: true,
+        },
+    }).config({ name: "order-query" });
+    const order = (0, workflows_sdk_1.transform)({ orderResult }, ({ orderResult }) => {
+        return orderResult.data[0];
+    });
+    const orderChangeResult = (0, common_1.useQueryGraphStep)({
+        entity: "order_change",
+        fields: ["id", "status", "version", "actions.*", "carry_over_promotions"],
+        filters: {
+            order_id: input.order_id,
+            status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+        },
+    }).config({ name: "order-change-query" });
+    const orderChange = (0, workflows_sdk_1.transform)({ orderChangeResult }, ({ orderChangeResult }) => {
+        return orderChangeResult.data[0];
+    });
+    (0, exports.orderEditUpdateItemQuantityValidationStep)({
+        order,
+        orderChange,
+    });
+    const orderChangeActionInput = (0, workflows_sdk_1.transform)({
+        order,
+        orderChange,
+        items: input.items,
+    }, ({ order, orderChange, items }) => {
+        const itemsUpdates = items.map((item) => {
+            const existing = order?.items?.find((exItem) => exItem.id === item.id);
+            const quantityDiff = new utils_1.BigNumber(utils_1.MathBN.sub(item.quantity, existing.quantity));
+            return {
+                order_change_id: orderChange.id,
+                order_id: order.id,
+                version: orderChange.version,
+                action: utils_1.ChangeActionType.ITEM_UPDATE,
+                internal_note: item.internal_note,
+                details: {
+                    reference_id: item.id,
+                    quantity: item.quantity,
+                    unit_price: item.unit_price,
+                    compare_at_unit_price: item.compare_at_unit_price,
+                    quantity_diff: quantityDiff,
+                },
+            };
+        });
+        return [...itemsUpdates];
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: orderChangeActionInput,
+    });
+    compute_adjustments_for_preview_1.computeAdjustmentsForPreviewWorkflow.runAsStep({
+        input: {
+            order,
+            orderChange,
+        },
+    });
+    const previewOrderChange = (0, preview_order_change_1.previewOrderChangeStep)(input.order_id);
+    (0, locking_1.releaseLockStep)({
+        key: input.order_id,
+    });
+    return new workflows_sdk_1.WorkflowResponse(previewOrderChange);
+});
+//# sourceMappingURL=order-edit-update-item-quantity.js.map

package/dist/order/workflows/order-edit/order-edit-update-item-quantity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-edit-update-item-quantity.js","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/order-edit-update-item-quantity.ts"],"names":[],"mappings":";;;AAMA,oDAKiC;AACjC,oEAMyC;AACzC,4CAAmD;AACnD,8CAAmE;AACnE,2EAAyE;AACzE,mEAGqC;AACrC,wFAAyF;AACzF,gFAAiF;AACjF,2CAAyD;AAgBzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,yCAAyC,GAAG,IAAA,0BAAU,EACjE,4CAA4C,EAC5C,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACoC;IAC/C,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC,CACF,CAAA;AAEY,QAAA,qCAAqC,GAChD,iCAAiC,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,6CAAqC,EACrC,UACE,KAA2E;IAE3E,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;QACnB,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC;QACpC,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,iCAAwB;QAChC,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE;YACP,kBAAkB,EAAE,IAAI;SACzB;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QAC3D,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAiB,EAAC;QAC1C,MAAM,EAAE,cAAc;QACtB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,uBAAuB,CAAC;QACzE,OAAO,EAAE;YACP,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;SACjE;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,MAAM,WAAW,GAAG,IAAA,yBAAS,EAC3B,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACxB,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC,CACF,CAAA;IAED,IAAA,iDAAyC,EAAC;QACxC,KAAK;QACL,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,yBAAS,EACtC;QACE,KAAK;QACL,WAAW;QACX,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,EACD,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE;QAChC,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACtC,MAAM,QAAQ,GAAG,KAAK,EAAE,KAAK,EAAE,IAAI,CACjC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CACjC,CAAA;YAEF,MAAM,YAAY,GAAG,IAAI,iBAAS,CAChC,cAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAC7C,CAAA;YAED,OAAO;gBACL,eAAe,EAAE,WAAW,CAAC,EAAE;gBAC/B,QAAQ,EAAE,KAAK,CAAC,EAAE;gBAClB,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,MAAM,EAAE,wBAAgB,CAAC,WAAW;gBACpC,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,OAAO,EAAE;oBACP,YAAY,EAAE,IAAI,CAAC,EAAE;oBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;oBACjD,aAAa,EAAE,YAAY;iBAC5B;aACF,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,CAAC,GAAG,YAAY,CAAC,CAAA;IAC1B,CAAC,CACF,CAAA;IAED,8DAAgC,CAAC,SAAS,CAAC;QACzC,KAAK,EAAE,sBAAsB;KAC9B,CAAC,CAAA;IAEF,sEAAoC,CAAC,SAAS,CAAC;QAC7C,KAAK,EAAE;YACL,KAAK;YACL,WAAW;SACZ;KACF,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAA,6CAAsB,EAAC,KAAK,CAAC,QAAQ,CAAoB,CAAA;IAEpF,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;KACpB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,kBAAkB,CAAC,CAAA;AACjD,CAAC,CACF,CAAA"}

package/dist/order/workflows/order-edit/remove-order-edit-item-action.d.ts

@@ -0,0 +1,70 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate that an item that was added in an order edit can be removed.
+ */
+export type RemoveOrderEditItemActionValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+    /**
+     * The details of the item to be removed.
+     */
+    input: OrderWorkflow.DeleteOrderEditItemActionWorkflowInput;
+};
+/**
+ * This step validates that an item that was added in the order edit can be removed
+ * from the order edit. If the order is canceled or the order change is not active,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order 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 = removeOrderEditItemActionValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ */
+export declare const removeOrderEditItemActionValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<RemoveOrderEditItemActionValidationStepInput, unknown>;
+export declare const removeItemOrderEditActionWorkflowId = "remove-item-order edit-action";
+/**
+ * This workflow removes an item that was added to an order edit. It's used by the
+ * [Remove Item from Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsiditemsaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to remove an item that was
+ * added to an order edit in your custom flow.
+ *
+ * @example
+ * const { result } = await removeItemOrderEditActionWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Remove an item that was added to an order edit.
+ */
+export declare const removeItemOrderEditActionWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.DeleteOrderEditItemActionWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=remove-order-edit-item-action.d.ts.map

package/dist/order/workflows/order-edit/remove-order-edit-item-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-order-edit-item-action.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/remove-order-edit-item-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACd,MAAM,0BAA0B,CAAA;AAsBjC;;GAEG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,sCAAsC,CAAA;CAC5D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,uCAAuC,gHA4BnD,CAAA;AAED,eAAO,MAAM,mCAAmC,kCACf,CAAA;AACjC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iCAAiC,sIA+D7C,CAAA"}

package/dist/order/workflows/order-edit/remove-order-edit-item-action.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeItemOrderEditActionWorkflow = exports.removeItemOrderEditActionWorkflowId = exports.removeOrderEditItemActionValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const locking_1 = require("../../../locking");
+const steps_1 = require("../../steps");
+const order_validation_1 = require("../../utils/order-validation");
+const compute_adjustments_for_preview_1 = require("../compute-adjustments-for-preview");
+const fields_1 = require("./utils/fields");
+/**
+ * This step validates that an item that was added in the order edit can be removed
+ * from the order edit. If the order is canceled or the order change is not active,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order 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 = removeOrderEditItemActionValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ */
+exports.removeOrderEditItemActionValidationStep = (0, workflows_sdk_1.createStep)("remove-item-order-edit-action-validation", async function ({ order, orderChange, input, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+    if (!associatedAction) {
+        throw new Error(`No item found for order ${input.order_id} in order change ${orderChange.id}`);
+    }
+    else if (![utils_1.ChangeActionType.ITEM_ADD, utils_1.ChangeActionType.ITEM_UPDATE].includes(associatedAction.action)) {
+        throw new Error(`Action ${associatedAction.id} is not adding or updating an item`);
+    }
+});
+exports.removeItemOrderEditActionWorkflowId = "remove-item-order edit-action";
+/**
+ * This workflow removes an item that was added to an order edit. It's used by the
+ * [Remove Item from Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsiditemsaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to remove an item that was
+ * added to an order edit in your custom flow.
+ *
+ * @example
+ * const { result } = await removeItemOrderEditActionWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Remove an item that was added to an order edit.
+ */
+exports.removeItemOrderEditActionWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.removeItemOrderEditActionWorkflowId, function (input) {
+    (0, locking_1.acquireLockStep)({
+        key: input.order_id,
+        timeout: 2,
+        ttl: 10,
+    });
+    const orderResult = (0, common_1.useQueryGraphStep)({
+        entity: "order",
+        fields: fields_1.fieldsToRefreshOrderEdit,
+        filters: { id: input.order_id },
+        options: {
+            throwIfKeyNotFound: true,
+        },
+    }).config({ name: "order-query" });
+    const order = (0, workflows_sdk_1.transform)({ orderResult }, ({ orderResult }) => {
+        return orderResult.data[0];
+    });
+    const orderChangeResult = (0, common_1.useQueryGraphStep)({
+        entity: "order_change",
+        fields: ["id", "status", "version", "actions.*", "carry_over_promotions"],
+        filters: {
+            order_id: input.order_id,
+            status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+        },
+    }).config({ name: "order-change-query" });
+    const orderChange = (0, workflows_sdk_1.transform)({ orderChangeResult }, ({ orderChangeResult }) => {
+        return orderChangeResult.data[0];
+    });
+    (0, exports.removeOrderEditItemActionValidationStep)({
+        order,
+        input,
+        orderChange,
+    });
+    (0, steps_1.deleteOrderChangeActionsStep)({ ids: [input.action_id] });
+    compute_adjustments_for_preview_1.computeAdjustmentsForPreviewWorkflow.runAsStep({
+        input: {
+            order,
+            orderChange,
+        },
+    });
+    const previewOrderChange = (0, steps_1.previewOrderChangeStep)(order.id);
+    (0, locking_1.releaseLockStep)({
+        key: input.order_id,
+    });
+    return new workflows_sdk_1.WorkflowResponse(previewOrderChange);
+});
+//# sourceMappingURL=remove-order-edit-item-action.js.map

package/dist/order/workflows/order-edit/remove-order-edit-item-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-order-edit-item-action.js","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/remove-order-edit-item-action.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAmD;AACnD,8CAAmE;AACnE,uCAGoB;AACpB,mEAGqC;AACrC,wFAAyF;AACzF,2CAAyD;AAoBzD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACU,QAAA,uCAAuC,GAAG,IAAA,0BAAU,EAC/D,0CAA0C,EAC1C,KAAK,WAAW,EACd,KAAK,EACL,WAAW,EACX,KAAK,GACwC;IAC7C,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,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,2BAA2B,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC9E,CAAA;IACH,CAAC;SAAM,IACL,CAAC,CAAC,wBAAgB,CAAC,QAAQ,EAAE,wBAAgB,CAAC,WAAW,CAAC,CAAC,QAAQ,CACjE,gBAAgB,CAAC,MAA0B,CAC5C,EACD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,UAAU,gBAAgB,CAAC,EAAE,oCAAoC,CAClE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAEY,QAAA,mCAAmC,GAC9C,+BAA+B,CAAA;AACjC;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,iCAAiC,GAAG,IAAA,8BAAc,EAC7D,2CAAmC,EACnC,UACE,KAAyE;IAEzE,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;QACnB,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC;QACpC,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,iCAAwB;QAChC,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE;YACP,kBAAkB,EAAE,IAAI;SACzB;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QAC3D,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAiB,EAAC;QAC1C,MAAM,EAAE,cAAc;QACtB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,uBAAuB,CAAC;QACzE,OAAO,EAAE;YACP,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;SACjE;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,MAAM,WAAW,GAAG,IAAA,yBAAS,EAC3B,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACxB,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC,CACF,CAAA;IAED,IAAA,+CAAuC,EAAC;QACtC,KAAK;QACL,KAAK;QACL,WAAW;KACZ,CAAC,CAAA;IAEF,IAAA,oCAA4B,EAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;IAExD,sEAAoC,CAAC,SAAS,CAAC;QAC7C,KAAK,EAAE;YACL,KAAK;YACL,WAAW;SACZ;KACF,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAA,8BAAsB,EAAC,KAAK,CAAC,EAAE,CAAoB,CAAA;IAE9E,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;KACpB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,kBAAkB,CAAC,CAAA;AACjD,CAAC,CACF,CAAA"}

package/dist/order/workflows/order-edit/remove-order-edit-shipping-method.d.ts

@@ -0,0 +1,62 @@
+import { OrderChangeDTO, OrderPreviewDTO, OrderWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate that a shipping method can be removed from an order edit.
+ */
+export type RemoveOrderEditShippingMethodValidationStepInput = {
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+    /**
+     * The details of the shipping method to be removed.
+     */
+    input: Pick<OrderWorkflow.DeleteOrderEditShippingMethodWorkflowInput, "order_id" | "action_id">;
+};
+/**
+ * This step validates that a shipping method can be removed from an order edit.
+ * If the order change is not active, the shipping method isn't in the exchange,
+ * or the action doesn't add a shipping method, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = removeOrderEditShippingMethodValidationStep({
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ */
+export declare const removeOrderEditShippingMethodValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<RemoveOrderEditShippingMethodValidationStepInput, unknown>;
+export declare const removeOrderEditShippingMethodWorkflowId = "remove-order-edit-shipping-method";
+/**
+ * This workflow removes a shipping method of an order edit. It's used by the
+ * [Remove Shipping Method Admin API Route](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsidshippingmethodaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to remove a
+ * shipping method from an order edit in your custom flows.
+ *
+ * @example
+ * const { result } = await removeOrderEditShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Remove a shipping method from an order edit.
+ */
+export declare const removeOrderEditShippingMethodWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.DeleteOrderEditShippingMethodWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=remove-order-edit-shipping-method.d.ts.map

package/dist/order/workflows/order-edit/remove-order-edit-shipping-method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-order-edit-shipping-method.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/remove-order-edit-shipping-method.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EACf,aAAa,EACd,MAAM,0BAA0B,CAAA;AAiBjC;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,IAAI,CACT,aAAa,CAAC,0CAA0C,EACxD,UAAU,GAAG,WAAW,CACzB,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,2CAA2C,oHAsBvD,CAAA;AAED,eAAO,MAAM,uCAAuC,sCACf,CAAA;AACrC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,qCAAqC,0IA2DjD,CAAA"}

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

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeOrderEditShippingMethodWorkflow = exports.removeOrderEditShippingMethodWorkflowId = exports.removeOrderEditShippingMethodValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const locking_1 = require("../../../locking");
+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 an order edit.
+ * If the order change is not active, the shipping method isn't in the exchange,
+ * or the action doesn't add a shipping method, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an 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 = removeOrderEditShippingMethodValidationStep({
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ */
+exports.removeOrderEditShippingMethodValidationStep = (0, workflows_sdk_1.createStep)("validate-remove-order-edit-shipping-method", async function ({ orderChange, input, }) {
+    (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 order ${input.order_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.removeOrderEditShippingMethodWorkflowId = "remove-order-edit-shipping-method";
+/**
+ * This workflow removes a shipping method of an order edit. It's used by the
+ * [Remove Shipping Method Admin API Route](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsidshippingmethodaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to remove a
+ * shipping method from an order edit in your custom flows.
+ *
+ * @example
+ * const { result } = await removeOrderEditShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Remove a shipping method from an order edit.
+ */
+exports.removeOrderEditShippingMethodWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.removeOrderEditShippingMethodWorkflowId, function (input) {
+    (0, locking_1.acquireLockStep)({
+        key: input.order_id,
+        timeout: 2,
+        ttl: 10,
+    });
+    const orderChangeResult = (0, common_1.useQueryGraphStep)({
+        entity: "order_change",
+        fields: ["id", "status", "version", "actions.*"],
+        filters: {
+            order_id: input.order_id,
+            status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+        },
+    }).config({ name: "order-change-query" });
+    const orderChange = (0, workflows_sdk_1.transform)({ orderChangeResult }, ({ orderChangeResult }) => {
+        return orderChangeResult.data[0];
+    });
+    (0, exports.removeOrderEditShippingMethodValidationStep)({
+        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] }));
+    const previewOrderChange = (0, preview_order_change_1.previewOrderChangeStep)(input.order_id);
+    (0, locking_1.releaseLockStep)({
+        key: input.order_id,
+    });
+    return new workflows_sdk_1.WorkflowResponse(previewOrderChange);
+});
+//# sourceMappingURL=remove-order-edit-shipping-method.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remove-order-edit-shipping-method.js","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/remove-order-edit-shipping-method.ts"],"names":[],"mappings":";;;AAMA,oDAA8E;AAC9E,oEAOyC;AACzC,4CAAmD;AACnD,8CAAmE;AACnE,uCAAwD;AACxD,yFAAsF;AACtF,2EAAyE;AACzE,mEAA4E;AAmB5E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,2CAA2C,GAAG,IAAA,0BAAU,EACnE,4CAA4C,EAC5C,KAAK,WAAW,EACd,WAAW,EACX,KAAK,GAC4C;IACjD,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,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CACzF,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,uCAAuC,GAClD,mCAAmC,CAAA;AACrC;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,qCAAqC,GAAG,IAAA,8BAAc,EACjE,+CAAuC,EACvC,UACE,KAA6E;IAE7E,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;QACnB,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAiB,EAAC;QAC1C,MAAM,EAAE,cAAc;QACtB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC;QAChD,OAAO,EAAE;YACP,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,CAAC,yBAAiB,CAAC,OAAO,EAAE,yBAAiB,CAAC,SAAS,CAAC;SACjE;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,MAAM,WAAW,GAAG,IAAA,yBAAS,EAC3B,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACxB,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC,CACF,CAAA;IAED,IAAA,mDAA2C,EAAC;QAC1C,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,MAAM,kBAAkB,GAAG,IAAA,6CAAsB,EAAC,KAAK,CAAC,QAAQ,CAAoB,CAAA;IAEpF,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;KACpB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,kBAAkB,CAAC,CAAA;AACjD,CAAC,CACF,CAAA"}

package/dist/order/workflows/order-edit/request-order-edit.d.ts

@@ -0,0 +1,73 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that an order edit can be requested.
+ */
+export type RequestOrderEditRequestValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+};
+/**
+ * This step validates that a order edit can be requested.
+ * If the order is canceled or the order change is not active, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order 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 = requestOrderEditRequestValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ * })
+ */
+export declare const requestOrderEditRequestValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<RequestOrderEditRequestValidationStepInput, unknown>;
+/**
+ * The data to request an order edit.
+ */
+export type OrderEditRequestWorkflowInput = {
+    /**
+     * The ID of the order to request the edit for.
+     */
+    order_id: string;
+    /**
+     * The ID of the user requesting the edit.
+     */
+    requested_by?: string;
+};
+export declare const requestOrderEditRequestWorkflowId = "order-edit-request";
+/**
+ * This workflow requests a previously created order edit request by {@link beginOrderEditOrderWorkflow}. This workflow is used by
+ * the [Request Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsidrequest).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to request an order edit
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await requestOrderEditRequestWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Request an order edit.
+ */
+export declare const requestOrderEditRequestWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderEditRequestWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=request-order-edit.d.ts.map

package/dist/order/workflows/order-edit/request-order-edit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-order-edit.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/request-order-edit.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EAChB,MAAM,0BAA0B,CAAA;AAwCjC;;GAEG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,qCAAqC,8GASjD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,iCAAiC,uBAAuB,CAAA;AACrE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,+BAA+B,+GAuE3C,CAAA"}