@acmekit/core-flows 2.13.1

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

@@ -0,0 +1,118 @@
+import { AdditionalData, BigNumberInput, OrderChangeDTO, OrderDTO, OrderPreviewDTO } from "@acmekit/framework/types";
+/**
+ * The data to validate that a shipping method can be created for an order edit.
+ */
+export type CreateOrderEditShippingMethodValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+};
+/**
+ * This step validates that a shipping method can be created for 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 = createOrderEditShippingMethodValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   }
+ * })
+ */
+export declare const createOrderEditShippingMethodValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<CreateOrderEditShippingMethodValidationStepInput, unknown>;
+/**
+ * The data to create a shipping method for an order edit.
+ */
+export type CreateOrderEditShippingMethodWorkflowInput = {
+    /**
+     * The ID of the order to create the shipping method for.
+     */
+    order_id: string;
+    /**
+     * The ID of the shipping option to create the shipping method from.
+     */
+    shipping_option_id: string;
+    /**
+     * The custom amount to create the shipping method with.
+     * If not provided, the shipping option's amount is used.
+     */
+    custom_amount?: BigNumberInput | null;
+};
+export declare const createOrderEditShippingMethodWorkflowId = "create-order-edit-shipping-method";
+/**
+ * This workflow creates a shipping method for an order edit. It's used by the
+ * [Add Shipping Method API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsidshippingmethod).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
+ * for an order edit in your in your own custom flows.
+ *
+ * @example
+ * const { result } = await createOrderEditShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     shipping_option_id: "so_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create a shipping method for an order edit.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping method is created. You can consume this hook to return any custom context useful for the prices retrieval of the shipping method's option.
+ *
+ * For example, assuming you have the following custom pricing rule:
+ *
+ * ```json
+ * {
+ *   "attribute": "location_id",
+ *   "operator": "eq",
+ *   "value": "sloc_123",
+ * }
+ * ```
+ *
+ * You can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:
+ *
+ * ```ts
+ * import { createOrderEditShippingMethodWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * createOrderEditShippingMethodWorkflow.hooks.setPricingContext((
+ *   { order, shipping_option_id, additional_data }, { container }
+ * ) => {
+ *   return new StepResponse({
+ *     location_id: "sloc_123", // Special price for in-store purchases
+ *   });
+ * });
+ * ```
+ *
+ * The price of the shipping method's option will now be retrieved using the context you return.
+ *
+ * :::note
+ *
+ * Learn more about prices calculation context in the [Prices Calculation](https://docs.acmekit.com/resources/commerce-modules/pricing/price-calculation) documentation.
+ *
+ * :::
+ */
+export declare const createOrderEditShippingMethodWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<CreateOrderEditShippingMethodWorkflowInput & AdditionalData, OrderPreviewDTO, [import("@acmekit/framework/workflows-sdk").Hook<"setPricingContext", {
+    order: OrderDTO;
+    shipping_option_id: string;
+    additional_data: Record<string, unknown> | undefined;
+}, Record<string, any> | undefined>]>;
+//# sourceMappingURL=create-order-edit-shipping-method.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-order-edit-shipping-method.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/create-order-edit-shipping-method.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,QAAQ,EACR,eAAe,EAChB,MAAM,0BAA0B,CAAA;AAuBjC;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,2CAA2C,oHASvD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;CACtC,CAAA;AAED,eAAO,MAAM,uCAAuC,sCACf,CAAA;AACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,eAAO,MAAM,qCAAqC;;;;qCAoJjD,CAAA"}

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

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOrderEditShippingMethodWorkflow = exports.createOrderEditShippingMethodWorkflowId = exports.createOrderEditShippingMethodValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const schemas_1 = require("../../../cart/utils/schemas");
+const common_1 = require("../../../common");
+const locking_1 = require("../../../locking");
+const steps_1 = require("../../steps");
+const create_order_shipping_methods_1 = require("../../steps/create-order-shipping-methods");
+const order_validation_1 = require("../../utils/order-validation");
+const prepare_shipping_method_1 = require("../../utils/prepare-shipping-method");
+const create_order_change_actions_1 = require("../create-order-change-actions");
+const update_tax_lines_1 = require("../update-tax-lines");
+const get_translated_shipping_option_1 = require("../../../common/steps/get-translated-shipping-option");
+/**
+ * This step validates that a shipping method can be created for 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 = createOrderEditShippingMethodValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   }
+ * })
+ */
+exports.createOrderEditShippingMethodValidationStep = (0, workflows_sdk_1.createStep)("validate-create-order-edit-shipping-method", async function ({ order, orderChange, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+});
+exports.createOrderEditShippingMethodWorkflowId = "create-order-edit-shipping-method";
+/**
+ * This workflow creates a shipping method for an order edit. It's used by the
+ * [Add Shipping Method API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsidshippingmethod).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
+ * for an order edit in your in your own custom flows.
+ *
+ * @example
+ * const { result } = await createOrderEditShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     shipping_option_id: "so_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create a shipping method for an order edit.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping method is created. You can consume this hook to return any custom context useful for the prices retrieval of the shipping method's option.
+ *
+ * For example, assuming you have the following custom pricing rule:
+ *
+ * ```json
+ * {
+ *   "attribute": "location_id",
+ *   "operator": "eq",
+ *   "value": "sloc_123",
+ * }
+ * ```
+ *
+ * You can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:
+ *
+ * ```ts
+ * import { createOrderEditShippingMethodWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * createOrderEditShippingMethodWorkflow.hooks.setPricingContext((
+ *   { order, shipping_option_id, additional_data }, { container }
+ * ) => {
+ *   return new StepResponse({
+ *     location_id: "sloc_123", // Special price for in-store purchases
+ *   });
+ * });
+ * ```
+ *
+ * The price of the shipping method's option will now be retrieved using the context you return.
+ *
+ * :::note
+ *
+ * Learn more about prices calculation context in the [Prices Calculation](https://docs.acmekit.com/resources/commerce-modules/pricing/price-calculation) documentation.
+ *
+ * :::
+ */
+exports.createOrderEditShippingMethodWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createOrderEditShippingMethodWorkflowId, function (input) {
+    (0, locking_1.acquireLockStep)({
+        key: input.order_id,
+        timeout: 2,
+        ttl: 10,
+    });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: ["id", "status", "currency_code", "canceled_at", "locale"],
+        variables: { id: input.order_id },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-query" });
+    const setPricingContext = (0, workflows_sdk_1.createHook)("setPricingContext", {
+        order,
+        shipping_option_id: input.shipping_option_id,
+        additional_data: input.additional_data,
+    }, {
+        resultValidator: schemas_1.pricingContextResult,
+    });
+    const setPricingContextResult = setPricingContext.getResult();
+    const pricingContext = (0, workflows_sdk_1.transform)({ order, setPricingContextResult }, (data) => {
+        return {
+            ...(data.setPricingContextResult ? data.setPricingContextResult : {}),
+            currency_code: data.order.currency_code,
+        };
+    });
+    const shippingOptions = (0, common_1.useRemoteQueryStep)({
+        entry_point: "shipping_option",
+        fields: [
+            "id",
+            "name",
+            "calculated_price.calculated_amount",
+            "calculated_price.is_calculated_price_tax_inclusive",
+        ],
+        variables: {
+            id: input.shipping_option_id,
+            calculated_price: {
+                context: pricingContext,
+            },
+        },
+    }).config({ name: "fetch-shipping-option" });
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: ["id", "status", "version"],
+        variables: {
+            filters: {
+                order_id: input.order_id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    const translatedShippingOptions = (0, get_translated_shipping_option_1.getTranslatedShippingOptionsStep)({
+        shippingOptions: shippingOptions,
+        locale: order.locale,
+    });
+    const shippingMethodInput = (0, workflows_sdk_1.transform)({
+        relatedEntity: { order_id: order.id },
+        shippingOptions: translatedShippingOptions,
+        customPrice: input.custom_amount,
+        orderChange,
+        input,
+    }, (0, prepare_shipping_method_1.prepareShippingMethod)());
+    const createdMethods = (0, create_order_shipping_methods_1.createOrderShippingMethods)({
+        shipping_methods: [shippingMethodInput],
+    });
+    const shippingMethodIds = (0, workflows_sdk_1.transform)(createdMethods, (createdMethods) => {
+        return createdMethods.map((item) => item.id);
+    });
+    update_tax_lines_1.updateOrderTaxLinesWorkflow.runAsStep({
+        input: {
+            order_id: order.id,
+            shipping_method_ids: shippingMethodIds,
+        },
+    });
+    const orderChangeActionInput = (0, workflows_sdk_1.transform)({
+        order,
+        shippingOptions,
+        createdMethods,
+        customPrice: input.custom_amount,
+        orderChange,
+    }, ({ shippingOptions, order, createdMethods, customPrice, orderChange, }) => {
+        const shippingOption = shippingOptions[0];
+        const createdMethod = createdMethods[0];
+        const methodPrice = customPrice ?? shippingOption.calculated_price.calculated_amount;
+        return {
+            action: utils_1.ChangeActionType.SHIPPING_ADD,
+            reference: "order_shipping_method",
+            order_change_id: orderChange.id,
+            reference_id: createdMethod.id,
+            amount: methodPrice,
+            order_id: order.id,
+        };
+    });
+    create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
+        input: [orderChangeActionInput],
+    });
+    const previewOrderChange = (0, steps_1.previewOrderChangeStep)(order.id);
+    (0, locking_1.releaseLockStep)({
+        key: input.order_id,
+    });
+    return new workflows_sdk_1.WorkflowResponse(previewOrderChange, {
+        hooks: [setPricingContext],
+    });
+});
+//# sourceMappingURL=create-order-edit-shipping-method.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-order-edit-shipping-method.js","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/create-order-edit-shipping-method.ts"],"names":[],"mappings":";;;AAOA,oDAA8E;AAC9E,oEAMyC;AACzC,yDAAkE;AAClE,4CAAoD;AACpD,8CAAmE;AACnE,uCAAoD;AACpD,6FAAsF;AACtF,mEAGqC;AACrC,iFAA2E;AAC3E,gFAAiF;AACjF,0DAAiE;AACjE,yGAAuG;AAgBvG;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,2CAA2C,GAAG,IAAA,0BAAU,EACnE,4CAA4C,EAC5C,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACsC;IACjD,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC,CACF,CAAA;AAqBY,QAAA,uCAAuC,GAClD,mCAAmC,CAAA;AACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACU,QAAA,qCAAqC,GAAG,IAAA,8BAAc,EACjE,+CAAuC,EACvC,UACE,KAAkE;IAElE,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;QACnB,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,KAAK,GAAa,IAAA,2BAAkB,EAAC;QACzC,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,EAAE,QAAQ,CAAC;QAClE,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;QACjC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAElC,MAAM,iBAAiB,GAAG,IAAA,0BAAU,EAClC,mBAAmB,EACnB;QACE,KAAK;QACL,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;QAC5C,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,EACD;QACE,eAAe,EAAE,8BAAoB;KACtC,CACF,CAAA;IACD,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAA;IAE7D,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,KAAK,EAAE,uBAAuB,EAAE,EAClC,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;SACxC,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,eAAe,GAAG,IAAA,2BAAkB,EAAC;QACzC,WAAW,EAAE,iBAAiB;QAC9B,MAAM,EAAE;YACN,IAAI;YACJ,MAAM;YACN,oCAAoC;YACpC,oDAAoD;SACrD;QACD,SAAS,EAAE;YACT,EAAE,EAAE,KAAK,CAAC,kBAAkB;YAC5B,gBAAgB,EAAE;gBAChB,OAAO,EAAE,cAAc;aACxB;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAE5C,MAAM,WAAW,GAAmB,IAAA,2BAAkB,EAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC;QACnC,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,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,MAAM,yBAAyB,GAAG,IAAA,iEAAgC,EAAC;QACjE,eAAe,EAAE,eAAe;QAChC,MAAM,EAAE,KAAK,CAAC,MAAO;KACtB,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EACnC;QACE,aAAa,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE;QACrC,eAAe,EAAE,yBAAyB;QAC1C,WAAW,EAAE,KAAK,CAAC,aAAa;QAChC,WAAW;QACX,KAAK;KACN,EACD,IAAA,+CAAqB,GAAE,CACxB,CAAA;IAED,MAAM,cAAc,GAAG,IAAA,0DAA0B,EAAC;QAChD,gBAAgB,EAAE,CAAC,mBAAmB,CAAC;KACxC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,yBAAS,EAAC,cAAc,EAAE,CAAC,cAAc,EAAE,EAAE;QACrE,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,8CAA2B,CAAC,SAAS,CAAC;QACpC,KAAK,EAAE;YACL,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,mBAAmB,EAAE,iBAAiB;SACvC;KACF,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,yBAAS,EACtC;QACE,KAAK;QACL,eAAe;QACf,cAAc;QACd,WAAW,EAAE,KAAK,CAAC,aAAa;QAChC,WAAW;KACZ,EACD,CAAC,EACC,eAAe,EACf,KAAK,EACL,cAAc,EACd,WAAW,EACX,WAAW,GACZ,EAAE,EAAE;QACH,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QACzC,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;QACvC,MAAM,WAAW,GACf,WAAW,IAAI,cAAc,CAAC,gBAAgB,CAAC,iBAAiB,CAAA;QAElE,OAAO;YACL,MAAM,EAAE,wBAAgB,CAAC,YAAY;YACrC,SAAS,EAAE,uBAAuB;YAClC,eAAe,EAAE,WAAW,CAAC,EAAE;YAC/B,YAAY,EAAE,aAAa,CAAC,EAAE;YAC9B,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,KAAK,CAAC,EAAE;SACnB,CAAA;IACH,CAAC,CACF,CAAA;IAED,8DAAgC,CAAC,SAAS,CAAC;QACzC,KAAK,EAAE,CAAC,sBAAsB,CAAC;KAChC,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAA,8BAAsB,EAC/C,KAAK,CAAC,EAAE,CACU,CAAA;IAEpB,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,QAAQ;KACpB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,kBAAkB,EAAE;QAC9C,KAAK,EAAE,CAAC,iBAAiB,CAAU;KACpC,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/order/workflows/order-edit/order-edit-add-new-item.d.ts

@@ -0,0 +1,66 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate that new items can be added to an order edit.
+ */
+export type OrderEditAddNewItemValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+};
+/**
+ * This step validates that new items can be added to 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 = orderEditAddNewItemValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   }
+ * })
+ */
+export declare const orderEditAddNewItemValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<OrderEditAddNewItemValidationStepInput, unknown>;
+export declare const orderEditAddNewItemWorkflowId = "order-edit-add-new-item";
+/**
+ * This workflow adds new items to an order edit. It's used by the
+ * [Add Items to Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to add new items to an order edit
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await orderEditAddNewItemWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     items: [
+ *       {
+ *         variant_id: "variant_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Add new items to an order edit.
+ */
+export declare const orderEditAddNewItemWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.OrderEditAddNewItemWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=order-edit-add-new-item.d.ts.map

package/dist/order/workflows/order-edit/order-edit-add-new-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-edit-add-new-item.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/order-edit-add-new-item.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACd,MAAM,0BAA0B,CAAA;AAsBjC;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,iCAAiC,0GAS7C,CAAA;AAED,eAAO,MAAM,6BAA6B,4BAA4B,CAAA;AACtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,2BAA2B,gIA+GvC,CAAA"}

package/dist/order/workflows/order-edit/order-edit-add-new-item.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orderEditAddNewItemWorkflow = exports.orderEditAddNewItemWorkflowId = exports.orderEditAddNewItemValidationStep = 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 add_line_items_1 = require("../add-line-items");
+const compute_adjustments_for_preview_1 = require("../compute-adjustments-for-preview");
+const create_order_change_actions_1 = require("../create-order-change-actions");
+const update_tax_lines_1 = require("../update-tax-lines");
+const fields_1 = require("./utils/fields");
+/**
+ * This step validates that new items can be added to 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 = orderEditAddNewItemValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   }
+ * })
+ */
+exports.orderEditAddNewItemValidationStep = (0, workflows_sdk_1.createStep)("order-edit-add-new-item-validation", async function ({ order, orderChange, }) {
+    (0, order_validation_1.throwIfIsCancelled)(order, "Order");
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+});
+exports.orderEditAddNewItemWorkflowId = "order-edit-add-new-item";
+/**
+ * This workflow adds new items to an order edit. It's used by the
+ * [Add Items to Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditems).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to add new items to an order edit
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await orderEditAddNewItemWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     items: [
+ *       {
+ *         variant_id: "variant_123",
+ *         quantity: 1,
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Add new items to an order edit.
+ */
+exports.orderEditAddNewItemWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.orderEditAddNewItemWorkflowId, 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.orderEditAddNewItemValidationStep)({
+        order,
+        orderChange,
+    });
+    const lineItems = add_line_items_1.addOrderLineItemsWorkflow.runAsStep({
+        input: {
+            order_id: order.id,
+            items: input.items,
+        },
+    });
+    const lineItemIds = (0, workflows_sdk_1.transform)(lineItems, (lineItems) => {
+        return lineItems.map((item) => item.id);
+    });
+    update_tax_lines_1.updateOrderTaxLinesWorkflow.runAsStep({
+        input: {
+            order_id: order.id,
+            item_ids: lineItemIds,
+        },
+    });
+    const orderChangeActionInput = (0, workflows_sdk_1.transform)({
+        order,
+        orderChange,
+        items: input.items,
+        lineItems,
+    }, ({ order, orderChange, items, lineItems }) => {
+        return items.map((item, index) => ({
+            order_change_id: orderChange.id,
+            order_id: order.id,
+            version: orderChange.version,
+            action: utils_1.ChangeActionType.ITEM_ADD,
+            internal_note: item.internal_note,
+            details: {
+                reference_id: lineItems[index].id,
+                quantity: item.quantity,
+                unit_price: item.unit_price ?? lineItems[index].unit_price,
+                compare_at_unit_price: item.compare_at_unit_price ??
+                    lineItems[index].compare_at_unit_price,
+                metadata: item.metadata,
+            },
+        }));
+    });
+    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-add-new-item.js.map

package/dist/order/workflows/order-edit/order-edit-add-new-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-edit-add-new-item.js","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/order-edit-add-new-item.ts"],"names":[],"mappings":";;;AAMA,oDAA8E;AAC9E,oEAMyC;AACzC,4CAAmD;AACnD,8CAAmE;AACnE,2EAAyE;AACzE,mEAGqC;AACrC,sDAA6D;AAC7D,wFAAyF;AACzF,gFAAiF;AACjF,0DAAiE;AACjE,2CAAyD;AAgBzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,iCAAiC,GAAG,IAAA,0BAAU,EACzD,oCAAoC,EACpC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GAC4B;IACvC,IAAA,qCAAkB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC,CACF,CAAA;AAEY,QAAA,6BAA6B,GAAG,yBAAyB,CAAA;AACtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,UACE,KAAmE;IAEnE,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,yCAAiC,EAAC;QAChC,KAAK;QACL,WAAW;KACZ,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,0CAAyB,CAAC,SAAS,CAAC;QACpD,KAAK,EAAE;YACL,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB;KACF,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,IAAA,yBAAS,EAAC,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;QACrD,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACzC,CAAC,CAAC,CAAA;IAEF,8CAA2B,CAAC,SAAS,CAAC;QACpC,KAAK,EAAE;YACL,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,QAAQ,EAAE,WAAW;SACtB;KACF,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,IAAA,yBAAS,EACtC;QACE,KAAK;QACL,WAAW;QACX,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,SAAS;KACV,EACD,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;QAC3C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACjC,eAAe,EAAE,WAAW,CAAC,EAAE;YAC/B,QAAQ,EAAE,KAAK,CAAC,EAAE;YAClB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,wBAAgB,CAAC,QAAQ;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE;gBACP,YAAY,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE;gBACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,UAAU;gBAC1D,qBAAqB,EACnB,IAAI,CAAC,qBAAqB;oBAC1B,SAAS,CAAC,KAAK,CAAC,CAAC,qBAAqB;gBACxC,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,sEAAoC,CAAC,SAAS,CAAC;QAC7C,KAAK,EAAE;YACL,KAAK;YACL,WAAW;SACZ;KACF,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,IAAA,6CAAsB,EAC/C,KAAK,CAAC,QAAQ,CACI,CAAA;IAEpB,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/order-edit-update-item-quantity.d.ts

@@ -0,0 +1,72 @@
+import { OrderChangeDTO, OrderDTO, OrderPreviewDTO, OrderWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate that the quantity of an existing item in an order can be updated in an order edit.
+ */
+export type OrderEditUpdateItemQuantityValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+    /**
+     * The order change's details.
+     */
+    orderChange: OrderChangeDTO;
+};
+/**
+ * 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...
+ *   }
+ * })
+ */
+export declare const orderEditUpdateItemQuantityValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<OrderEditUpdateItemQuantityValidationStepInput, unknown>;
+export declare const 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.
+ */
+export declare const orderEditUpdateItemQuantityWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.OrderEditUpdateItemQuantityWorkflowInput, OrderPreviewDTO, []>;
+//# sourceMappingURL=order-edit-update-item-quantity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order-edit-update-item-quantity.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/order-edit-update-item-quantity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,eAAe,EACf,aAAa,EACd,MAAM,0BAA0B,CAAA;AAyBjC;;GAEG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,yCAAyC,kHASrD,CAAA;AAED,eAAO,MAAM,qCAAqC,oCACf,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,mCAAmC,wIAoG/C,CAAA"}