@acmekit/core-flows 2.13.1

package/dist/order/workflows/mark-payment-collection-as-paid.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markPaymentCollectionAsPaid = exports.markPaymentCollectionAsPaidId = exports.throwUnlessPaymentCollectionNotPaid = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const payment_1 = require("../../payment");
+const payment_collection_1 = require("../../payment-collection");
+/**
+ * This step validates that the payment collection is not paid. If not valid,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve a payment collection's 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 = throwUnlessPaymentCollectionNotPaid({
+ *   paymentCollection: {
+ *     id: "paycol_123",
+ *     // other payment details...
+ *   }
+ * })
+ */
+exports.throwUnlessPaymentCollectionNotPaid = (0, workflows_sdk_1.createStep)("validate-existing-payment-collection", ({ paymentCollection }) => {
+    if (paymentCollection.status !== "not_paid") {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.NOT_ALLOWED, `Can only mark 'not_paid' payment collection as paid`);
+    }
+});
+const systemPaymentProviderId = "pp_system_default";
+exports.markPaymentCollectionAsPaidId = "mark-payment-collection-as-paid";
+/**
+ * This workflow marks a payment collection for an order as paid. It's used by the
+ * [Mark Payment Collection as Paid Admin API Route](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * marking a payment collection for an order as paid.
+ *
+ * @example
+ * const { result } = await markPaymentCollectionAsPaid(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *     payment_collection_id: "paycol_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Mark a payment collection for an order as paid.
+ */
+exports.markPaymentCollectionAsPaid = (0, workflows_sdk_1.createWorkflow)(exports.markPaymentCollectionAsPaidId, (input) => {
+    const { data: paymentCollection } = (0, common_1.useQueryGraphStep)({
+        entity: "payment_collection",
+        filters: { id: input.payment_collection_id },
+        fields: ["id", "status", "amount"],
+        options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "get-payment-collection" });
+    (0, exports.throwUnlessPaymentCollectionNotPaid)({ paymentCollection });
+    const paymentSession = payment_collection_1.createPaymentSessionsWorkflow.runAsStep({
+        input: {
+            payment_collection_id: paymentCollection.id,
+            provider_id: systemPaymentProviderId,
+            data: {},
+            context: {},
+        },
+    });
+    const payment = (0, payment_1.authorizePaymentSessionStep)({
+        id: paymentSession.id,
+    });
+    payment_1.capturePaymentWorkflow.runAsStep({
+        input: {
+            payment_id: payment.id,
+            captured_by: input.captured_by,
+            amount: paymentCollection.amount,
+        },
+    });
+    return new workflows_sdk_1.WorkflowResponse(payment);
+});
+//# sourceMappingURL=mark-payment-collection-as-paid.js.map

package/dist/order/workflows/mark-payment-collection-as-paid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mark-payment-collection-as-paid.js","sourceRoot":"","sources":["../../../src/order/workflows/mark-payment-collection-as-paid.ts"],"names":[],"mappings":";;;AACA,oDAAuD;AACvD,oEAKyC;AACzC,yCAAgD;AAChD,2CAGsB;AACtB,iEAAwE;AAYxE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,mCAAmC,GAAG,IAAA,0BAAU,EAC3D,sCAAsC,EACtC,CAAC,EAAE,iBAAiB,EAA6C,EAAE,EAAE;IACnE,IAAI,iBAAiB,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,WAAW,EAC9B,qDAAqD,CACtD,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAoBD,MAAM,uBAAuB,GAAG,mBAAmB,CAAA;AACtC,QAAA,6BAA6B,GAAG,iCAAiC,CAAA;AAC9E;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,2BAA2B,GAAG,IAAA,8BAAc,EACvD,qCAA6B,EAC7B,CAAC,KAAqD,EAAE,EAAE;IACxD,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACpD,MAAM,EAAE,oBAAoB;QAC5B,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,qBAAqB,EAAE;QAC5C,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC;QAClC,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE7C,IAAA,2CAAmC,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAE1D,MAAM,cAAc,GAAG,kDAA6B,CAAC,SAAS,CAAC;QAC7D,KAAK,EAAE;YACL,qBAAqB,EAAE,iBAAiB,CAAC,EAAE;YAC3C,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,EAAE;SACZ;KACF,CAAC,CAAA;IAEF,MAAM,OAAO,GAAG,IAAA,qCAA2B,EAAC;QAC1C,EAAE,EAAE,cAAc,CAAC,EAAE;KACtB,CAAC,CAAA;IAEF,gCAAsB,CAAC,SAAS,CAAC;QAC/B,KAAK,EAAE;YACL,UAAU,EAAE,OAAO,CAAC,EAAE;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,MAAM,EAAE,iBAAiB,CAAC,MAAM;SACjC;KACF,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,OAAO,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/order/workflows/maybe-refresh-shipping-methods.d.ts

@@ -0,0 +1,55 @@
+import { CalculatedRMAShippingContext } from "@acmekit/framework/types";
+/**
+ * The data to create a shipping method for an order edit.
+ */
+export type MaybeRefreshShippingMethodsWorkflowInput = {
+    /**
+     * The ID of the shipping method to refresh.
+     */
+    shipping_method_id: string;
+    /**
+     * The ID of the order.
+     */
+    order_id: string;
+    /**
+     * The ID of the ADD SHIPPING action to update.
+     */
+    action_id: string;
+    /**
+     * Data to pass for the shipping calculation.
+     */
+    context: CalculatedRMAShippingContext;
+};
+export declare const maybeRefreshShippingMethodsWorkflowId = "maybe-refresh-shipping-methods";
+/**
+ * This workflows refreshes shipping method prices of an order and its changes. It's used in Return Merchandise Authorization (RMA) flows. It's used
+ * by other workflows, such as {@link refreshExchangeShippingWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * refreshing shipping methods in your custom flows.
+ *
+ * @example
+ * const { result } = await maybeRefreshShippingMethodsWorkflow(container)
+ * .run({
+ *   input: {
+ *     shipping_method_id: "shipping_method_123",
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *     context: {
+ *       return_id: "ret_123",
+ *       return_items: [
+ *         {
+ *            id: "orli_123",
+ *            quantity: 1,
+ *         }
+ *       ]
+ *     }
+ *  }
+ * })
+ *
+ * @summary
+ *
+ * Refreshes the shipping method prices of an order and its changes.
+ */
+export declare const maybeRefreshShippingMethodsWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<MaybeRefreshShippingMethodsWorkflowInput, void, []>;
+//# sourceMappingURL=maybe-refresh-shipping-methods.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"maybe-refresh-shipping-methods.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/maybe-refresh-shipping-methods.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,4BAA4B,EAE7B,MAAM,0BAA0B,CAAA;AA0CjC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAA;CACtC,CAAA;AAED,eAAO,MAAM,qCAAqC,mCAChB,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,mCAAmC,+GAwG/C,CAAA"}

package/dist/order/workflows/maybe-refresh-shipping-methods.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maybeRefreshShippingMethodsWorkflow = exports.maybeRefreshShippingMethodsWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const utils_1 = require("@acmekit/framework/utils");
+const steps_1 = require("../../fulfillment/steps");
+const steps_2 = require("../steps");
+const common_1 = require("../../common");
+const COMMON_OPTIONS_FIELDS = [
+    "id",
+    "name",
+    "price_type",
+    "service_zone_id",
+    "service_zone.fulfillment_set_id",
+    "service_zone.fulfillment_set.type",
+    "service_zone.fulfillment_set.location.*",
+    "service_zone.fulfillment_set.location.address.*",
+    "shipping_profile_id",
+    "provider_id",
+    "data",
+    "type.id",
+    "type.label",
+    "type.description",
+    "type.code",
+    "provider.id",
+    "provider.is_enabled",
+    "rules.attribute",
+    "rules.value",
+    "rules.operator",
+];
+exports.maybeRefreshShippingMethodsWorkflowId = "maybe-refresh-shipping-methods";
+/**
+ * This workflows refreshes shipping method prices of an order and its changes. It's used in Return Merchandise Authorization (RMA) flows. It's used
+ * by other workflows, such as {@link refreshExchangeShippingWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around
+ * refreshing shipping methods in your custom flows.
+ *
+ * @example
+ * const { result } = await maybeRefreshShippingMethodsWorkflow(container)
+ * .run({
+ *   input: {
+ *     shipping_method_id: "shipping_method_123",
+ *     order_id: "order_123",
+ *     action_id: "orchact_123",
+ *     context: {
+ *       return_id: "ret_123",
+ *       return_items: [
+ *         {
+ *            id: "orli_123",
+ *            quantity: 1,
+ *         }
+ *       ]
+ *     }
+ *  }
+ * })
+ *
+ * @summary
+ *
+ * Refreshes the shipping method prices of an order and its changes.
+ */
+exports.maybeRefreshShippingMethodsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.maybeRefreshShippingMethodsWorkflowId, function (input) {
+    const shippingMethodQuery = (0, common_1.useQueryGraphStep)({
+        entity: "order_shipping_method",
+        fields: ["id", "shipping_option_id"],
+        filters: {
+            id: input.shipping_method_id,
+        },
+    }).config({ name: "fetch-shipping-method" });
+    const shippingMethod = (0, workflows_sdk_1.transform)(shippingMethodQuery, ({ data }) => data[0]);
+    const shippingOptionQuery = (0, common_1.useQueryGraphStep)({
+        entity: "shipping_option",
+        fields: [...COMMON_OPTIONS_FIELDS],
+        filters: { id: shippingMethod.shipping_option_id },
+        options: {
+            cache: {
+                enable: true,
+            },
+        },
+    }).config({ name: "calculated-option" });
+    const shippingOption = (0, workflows_sdk_1.transform)(shippingOptionQuery, ({ data }) => data[0]);
+    const isCalculatedPriceShippingOption = (0, workflows_sdk_1.transform)(shippingOption, (option) => option?.price_type === utils_1.ShippingOptionPriceType.CALCULATED);
+    (0, workflows_sdk_1.when)({ isCalculatedPriceShippingOption, shippingOption }, ({ isCalculatedPriceShippingOption, shippingOption }) => isCalculatedPriceShippingOption).then(() => {
+        const orderQuery = (0, common_1.useQueryGraphStep)({
+            entity: "order",
+            fields: ["id", "shipping_address", "items.*", "items.variant.*"],
+            filters: { id: input.order_id },
+            options: { throwIfKeyNotFound: true },
+        }).config({ name: "order-query" });
+        const order = (0, workflows_sdk_1.transform)(orderQuery, (data) => data[0]);
+        const calculateShippingOptionsPricesData = (0, workflows_sdk_1.transform)({
+            shippingOption,
+            order,
+            input,
+        }, ({ shippingOption, order, input }) => {
+            return [
+                {
+                    id: shippingOption.id,
+                    optionData: shippingOption.data,
+                    context: {
+                        ...order,
+                        ...input.context,
+                        from_location: shippingOption.service_zone.fulfillment_set.location,
+                    },
+                    // data: {}, // TODO: add data
+                    provider_id: shippingOption.provider_id,
+                },
+            ];
+        });
+        const prices = (0, steps_1.calculateShippingOptionsPricesStep)(calculateShippingOptionsPricesData);
+        const updateData = (0, workflows_sdk_1.transform)({
+            shippingOption,
+            prices,
+            input,
+        }, ({ prices, input }) => {
+            return [
+                {
+                    id: input.action_id,
+                    amount: prices[0].calculated_amount,
+                },
+                {
+                    id: input.shipping_method_id,
+                    amount: prices[0].calculated_amount,
+                    is_custom_amount: false,
+                },
+            ];
+        });
+        (0, workflows_sdk_1.parallelize)((0, steps_2.updateOrderChangeActionsStep)([updateData[0]]), (0, steps_2.updateOrderShippingMethodsStep)([updateData[1]]));
+    });
+    return new workflows_sdk_1.WorkflowResponse(void 0);
+});
+//# sourceMappingURL=maybe-refresh-shipping-methods.js.map

package/dist/order/workflows/maybe-refresh-shipping-methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maybe-refresh-shipping-methods.js","sourceRoot":"","sources":["../../../src/order/workflows/maybe-refresh-shipping-methods.ts"],"names":[],"mappings":";;;AAIA,oEAMyC;AACzC,oDAAkE;AAClE,mDAA4E;AAC5E,oCAGiB;AACjB,yCAAgD;AAEhD,MAAM,qBAAqB,GAAG;IAC5B,IAAI;IACJ,MAAM;IACN,YAAY;IACZ,iBAAiB;IACjB,iCAAiC;IACjC,mCAAmC;IACnC,yCAAyC;IACzC,iDAAiD;IACjD,qBAAqB;IACrB,aAAa;IACb,MAAM;IAEN,SAAS;IACT,YAAY;IACZ,kBAAkB;IAClB,WAAW;IAEX,aAAa;IACb,qBAAqB;IAErB,iBAAiB;IACjB,aAAa;IACb,gBAAgB;CACjB,CAAA;AAwBY,QAAA,qCAAqC,GAChD,gCAAgC,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,mCAAmC,GAAG,IAAA,8BAAc,EAC/D,6CAAqC,EACrC,UACE,KAA+C;IAE/C,MAAM,mBAAmB,GAAG,IAAA,0BAAiB,EAAC;QAC5C,MAAM,EAAE,uBAAuB;QAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,CAAC;QACpC,OAAO,EAAE;YACP,EAAE,EAAE,KAAK,CAAC,kBAAkB;SAC7B;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAE5C,MAAM,cAAc,GAAG,IAAA,yBAAS,EAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5E,MAAM,mBAAmB,GAAG,IAAA,0BAAiB,EAAC;QAC5C,MAAM,EAAE,iBAAiB;QACzB,MAAM,EAAE,CAAC,GAAG,qBAAqB,CAAC;QAClC,OAAO,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,kBAAkB,EAAE;QAClD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAA;IAExC,MAAM,cAAc,GAAG,IAAA,yBAAS,EAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5E,MAAM,+BAA+B,GAAG,IAAA,yBAAS,EAC/C,cAAc,EACd,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,+BAAuB,CAAC,UAAU,CACtE,CAAA;IAED,IAAA,oBAAI,EACF,EAAE,+BAA+B,EAAE,cAAc,EAAE,EACnD,CAAC,EAAE,+BAA+B,EAAE,cAAc,EAAE,EAAE,EAAE,CACtD,+BAA+B,CAClC,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC;YACnC,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,iBAAiB,CAAC;YAChE,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE;YAC/B,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE;SACtC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;QAElC,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAEtD,MAAM,kCAAkC,GAAG,IAAA,yBAAS,EAClD;YACE,cAAc;YACd,KAAK;YACL,KAAK;SACN,EACD,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;YACnC,OAAO;gBACL;oBACE,EAAE,EAAE,cAAc,CAAC,EAAY;oBAC/B,UAAU,EAAE,cAAc,CAAC,IAAI;oBAC/B,OAAO,EAAE;wBACP,GAAG,KAAK;wBACR,GAAG,KAAK,CAAC,OAAO;wBAChB,aAAa,EACX,cAAc,CAAC,YAAY,CAAC,eAAe,CAAC,QAAQ;qBACvD;oBACD,8BAA8B;oBAC9B,WAAW,EAAE,cAAc,CAAC,WAAW;iBACL;aACrC,CAAA;QACH,CAAC,CACF,CAAA;QAED,MAAM,MAAM,GAAG,IAAA,0CAAkC,EAC/C,kCAAkC,CACnC,CAAA;QAED,MAAM,UAAU,GAAG,IAAA,yBAAS,EAC1B;YACE,cAAc;YACd,MAAM;YACN,KAAK;SACN,EACD,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;YACpB,OAAO;gBACL;oBACE,EAAE,EAAE,KAAK,CAAC,SAAS;oBACnB,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB;iBACpC;gBACD;oBACE,EAAE,EAAE,KAAK,CAAC,kBAAkB;oBAC5B,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB;oBACnC,gBAAgB,EAAE,KAAK;iBACxB;aACF,CAAA;QACH,CAAC,CACF,CAAA;QAED,IAAA,2BAAW,EACT,IAAA,oCAA4B,EAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAC7C,IAAA,sCAA8B,EAAC,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC,CACjD,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

package/dist/order/workflows/on-carry-promotions-flag-set.d.ts

@@ -0,0 +1,79 @@
+import { OrderChangeDTO, OrderDTO, PromotionDTO } from "@acmekit/framework/types";
+/**
+ * The data to set the carry over promotions flag for an order change.
+ */
+export type OnCarryPromotionsFlagSetWorkflowInput = {
+    /**
+     * The order change's ID.
+     */
+    order_change_id: string;
+    /**
+     * Whether to carry over promotions to outbound exchange items.
+     */
+    carry_over_promotions: boolean;
+};
+/**
+ * This step validates that the order change is an exchange and validates that
+ * the promotion allocation is valid for carrying over promotions.
+ *
+ * :::note
+ *
+ * You can retrieve details of the order and order change using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @since 2.12.0
+ *
+ * @example
+ * const data = validateCarryPromotionsFlagStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_change_id: "orch_123",
+ *     carry_over_promotions: true,
+ *   }
+ * })
+ */
+export declare const validateCarryPromotionsFlagStep: import("@acmekit/framework/workflows-sdk").StepFunction<{
+    orderChange: OrderChangeDTO;
+    order: OrderDTO & {
+        promotions?: PromotionDTO[];
+    };
+    input: OnCarryPromotionsFlagSetWorkflowInput;
+}, unknown>;
+export declare const onCarryPromotionsFlagSetId = "on-carry-promotions-flag-set";
+/**
+ * This workflow toggles whether promotions are carried over to outbound items of an exchange.
+ * It validates that the order change is an exchange and that it's active. It also validates that the promotion allocation
+ * is valid for carrying over promotions. Finally, it computes adjustments for the order change
+ * and either applies or removes promotion adjustments based on whether promotions are to be carried over.
+ *
+ * This workflow is used by other workflows, such as the {@link updateOrderChangeWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * set the carry over promotions flag for an order change in your custom flows.
+ *
+ * @since 2.12.0
+ *
+ * @example
+ * const { result } = await onCarryPromotionsFlagSet(container)
+ * .run({
+ *   input: {
+ *     order_change_id: "orch_123",
+ *     carry_over_promotions: true,
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Toggle carrying over promotions to outbound exchange items.
+ */
+export declare const onCarryPromotionsFlagSet: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OnCarryPromotionsFlagSetWorkflowInput, void, []>;
+//# sourceMappingURL=on-carry-promotions-flag-set.d.ts.map

package/dist/order/workflows/on-carry-promotions-flag-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-carry-promotions-flag-set.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/on-carry-promotions-flag-set.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,YAAY,EACb,MAAM,0BAA0B,CAAA;AAkBjC;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,+BAA+B;iBAO3B,cAAc;WACpB,QAAQ,GAAG;QAAE,UAAU,CAAC,EAAE,YAAY,EAAE,CAAA;KAAE;WAC1C,qCAAqC;WAgE/C,CAAA;AAED,eAAO,MAAM,0BAA0B,iCAAiC,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,wBAAwB,4GAiEpC,CAAA"}

package/dist/order/workflows/on-carry-promotions-flag-set.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onCarryPromotionsFlagSet = exports.onCarryPromotionsFlagSetId = exports.validateCarryPromotionsFlagStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const order_validation_1 = require("../utils/order-validation");
+const compute_adjustments_for_preview_1 = require("./compute-adjustments-for-preview");
+const fields_1 = require("./order-edit/utils/fields");
+/**
+ * This step validates that the order change is an exchange and validates that
+ * the promotion allocation is valid for carrying over promotions.
+ *
+ * :::note
+ *
+ * You can retrieve details of the order and order change using [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query),
+ * or [useQueryGraphStep](https://docs.acmekit.com/resources/references/acmekit-workflows/steps/useQueryGraphStep).
+ *
+ * :::
+ *
+ * @since 2.12.0
+ *
+ * @example
+ * const data = validateCarryPromotionsFlagStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   },
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   input: {
+ *     order_change_id: "orch_123",
+ *     carry_over_promotions: true,
+ *   }
+ * })
+ */
+exports.validateCarryPromotionsFlagStep = (0, workflows_sdk_1.createStep)("validate-carry-promotions-flag", async function ({ orderChange, order, input, }) {
+    // Validate order change is active
+    (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
+    // we don't need to validate promotion since we will be resetting the adjustments
+    if (!input.carry_over_promotions) {
+        return;
+    }
+    // Validate promotion allocation if promotions exist
+    if (order.promotions && order.promotions.length > 0) {
+        const invalidPromotions = [];
+        for (const promotion of order.promotions) {
+            const applicationMethod = promotion.application_method;
+            if (!applicationMethod) {
+                continue;
+            }
+            const allocation = applicationMethod.allocation;
+            const type = applicationMethod.type;
+            if (allocation !== utils_1.ApplicationMethodAllocation.ACROSS &&
+                allocation !== utils_1.ApplicationMethodAllocation.EACH) {
+                throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Promotion ${promotion.code || promotion.id} has invalid allocation. Only promotions with EACH or ACROSS allocation can be carried over to outbound exchange items.`);
+            }
+            // For fixed promotions, allocation must be EACH
+            if (type === "fixed" &&
+                allocation !== utils_1.ApplicationMethodAllocation.EACH) {
+                invalidPromotions.push(promotion.code || promotion.id);
+            }
+            // For percentage promotions, allocation must be EACH or ACROSS
+            if (type === "percentage" &&
+                allocation !== utils_1.ApplicationMethodAllocation.EACH &&
+                allocation !== utils_1.ApplicationMethodAllocation.ACROSS) {
+                invalidPromotions.push(promotion.code || promotion.id);
+            }
+        }
+        if (invalidPromotions.length > 0) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Promotions with codes ${invalidPromotions.join(", ")} have invalid allocation. Fixed promotions must have EACH allocation, and percentage promotions must have EACH or ACROSS allocation.`);
+        }
+    }
+});
+exports.onCarryPromotionsFlagSetId = "on-carry-promotions-flag-set";
+/**
+ * This workflow toggles whether promotions are carried over to outbound items of an exchange.
+ * It validates that the order change is an exchange and that it's active. It also validates that the promotion allocation
+ * is valid for carrying over promotions. Finally, it computes adjustments for the order change
+ * and either applies or removes promotion adjustments based on whether promotions are to be carried over.
+ *
+ * This workflow is used by other workflows, such as the {@link updateOrderChangeWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * set the carry over promotions flag for an order change in your custom flows.
+ *
+ * @since 2.12.0
+ *
+ * @example
+ * const { result } = await onCarryPromotionsFlagSet(container)
+ * .run({
+ *   input: {
+ *     order_change_id: "orch_123",
+ *     carry_over_promotions: true,
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Toggle carrying over promotions to outbound exchange items.
+ */
+exports.onCarryPromotionsFlagSet = (0, workflows_sdk_1.createWorkflow)(exports.onCarryPromotionsFlagSetId, function (input) {
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: [
+            "id",
+            "status",
+            "version",
+            "exchange_id",
+            "claim_id",
+            "return_id",
+            "order_id",
+            "canceled_at",
+            "confirmed_at",
+            "declined_at",
+            "carry_over_promotions",
+        ],
+        variables: {
+            filters: {
+                id: input.order_change_id,
+            },
+        },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-change-query" });
+    const order = (0, common_1.useRemoteQueryStep)({
+        entry_point: "orders",
+        fields: [
+            ...fields_1.fieldsToComputeAdjustmentsForPreview,
+            "promotions.application_method.*",
+        ],
+        variables: {
+            id: orderChange.order_id,
+        },
+        list: false,
+        throw_if_key_not_found: true,
+    }).config({ name: "order-query" });
+    (0, exports.validateCarryPromotionsFlagStep)({
+        orderChange,
+        order,
+        input,
+    });
+    const orderWithPromotions = (0, workflows_sdk_1.transform)({ order }, ({ order }) => {
+        return {
+            ...order,
+            promotions: order.promotions ?? [],
+        };
+    });
+    compute_adjustments_for_preview_1.computeAdjustmentsForPreviewWorkflow.runAsStep({
+        input: {
+            orderChange,
+            order: orderWithPromotions,
+        },
+    });
+    return new workflows_sdk_1.WorkflowResponse(void 0);
+});
+//# sourceMappingURL=on-carry-promotions-flag-set.js.map

package/dist/order/workflows/on-carry-promotions-flag-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-carry-promotions-flag-set.js","sourceRoot":"","sources":["../../../src/order/workflows/on-carry-promotions-flag-set.ts"],"names":[],"mappings":";;;AAKA,oDAGiC;AACjC,oEAMyC;AACzC,yCAAiD;AACjD,gEAAyE;AAEzE,uFAAwF;AACxF,sDAAgF;AAgBhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACU,QAAA,+BAA+B,GAAG,IAAA,0BAAU,EACvD,gCAAgC,EAChC,KAAK,WAAW,EACd,WAAW,EACX,KAAK,EACL,KAAK,GAKN;IACC,kCAAkC;IAClC,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;IAE9C,iFAAiF;IACjF,IAAI,CAAC,KAAK,CAAC,qBAAqB,EAAE,CAAC;QACjC,OAAM;IACR,CAAC;IAED,oDAAoD;IACpD,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpD,MAAM,iBAAiB,GAAa,EAAE,CAAA;QAEtC,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACzC,MAAM,iBAAiB,GAAI,SAAiB,CAAC,kBAAkB,CAAA;YAE/D,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,SAAQ;YACV,CAAC;YAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,UAAU,CAAA;YAC/C,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAA;YAEnC,IACE,UAAU,KAAK,mCAA2B,CAAC,MAAM;gBACjD,UAAU,KAAK,mCAA2B,CAAC,IAAI,EAC/C,CAAC;gBACD,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,aACE,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,EAC9B,yHAAyH,CAC1H,CAAA;YACH,CAAC;YAED,gDAAgD;YAChD,IACE,IAAI,KAAK,OAAO;gBAChB,UAAU,KAAK,mCAA2B,CAAC,IAAI,EAC/C,CAAC;gBACD,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,EAAE,CAAC,CAAA;YACxD,CAAC;YAED,+DAA+D;YAC/D,IACE,IAAI,KAAK,YAAY;gBACrB,UAAU,KAAK,mCAA2B,CAAC,IAAI;gBAC/C,UAAU,KAAK,mCAA2B,CAAC,MAAM,EACjD,CAAC;gBACD,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,EAAE,CAAC,CAAA;YACxD,CAAC;QACH,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,yBAAyB,iBAAiB,CAAC,IAAI,CAC7C,IAAI,CACL,sIAAsI,CACxI,CAAA;QACH,CAAC;IACH,CAAC;AACH,CAAC,CACF,CAAA;AAEY,QAAA,0BAA0B,GAAG,8BAA8B,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,wBAAwB,GAAG,IAAA,8BAAc,EACpD,kCAA0B,EAC1B,UACE,KAA0D;IAE1D,MAAM,WAAW,GAAmB,IAAA,2BAAkB,EAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,MAAM,EAAE;YACN,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,aAAa;YACb,UAAU;YACV,WAAW;YACX,UAAU;YACV,aAAa;YACb,cAAc;YACd,aAAa;YACb,uBAAuB;SACxB;QACD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,EAAE,EAAE,KAAK,CAAC,eAAe;aAC1B;SACF;QACD,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAEzC,MAAM,KAAK,GACT,IAAA,2BAAkB,EAAC;QACjB,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE;YACN,GAAG,6CAAoC;YACvC,iCAAiC;SAClC;QACD,SAAS,EAAE;YACT,EAAE,EAAE,WAAW,CAAC,QAAQ;SACzB;QACD,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;IAEpC,IAAA,uCAA+B,EAAC;QAC9B,WAAW;QACX,KAAK;QACL,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7D,OAAO;YACL,GAAG,KAAK;YACR,UAAU,EAAG,KAAa,CAAC,UAAU,IAAI,EAAE;SACC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,sEAAoC,CAAC,SAAS,CAAC;QAC7C,KAAK,EAAE;YACL,WAAW;YACX,KAAK,EAAE,mBAAmB;SAC3B;KACF,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,55 @@
+import { OrderChangeDTO, OrderDTO, OrderWorkflow } from "@acmekit/framework/types";
+/**
+ * The data to validate that an order-edit can be requested for an order.
+ */
+export type BeginOrderEditValidationStepInput = {
+    /**
+     * The order's details.
+     */
+    order: OrderDTO;
+};
+/**
+ * This step validates that an order-edit can be requested for an order.
+ * If the order is canceled, the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order's 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 = beginOrderEditValidationStep({
+ *   order: {
+ *     id: "order_123",
+ *     // other order details...
+ *   }
+ * })
+ */
+export declare const beginOrderEditValidationStep: import("@acmekit/framework/workflows-sdk").StepFunction<BeginOrderEditValidationStepInput, unknown>;
+export declare const beginOrderEditOrderWorkflowId = "begin-order-edit-order";
+/**
+ * This workflow creates an order edit request. It' used by the
+ * [Create Order Edit Admin API Route](https://docs.acmekit.com/api/admin#order-edits_postorderedits).
+ *
+ * To request the order edit, use the {@link requestOrderEditRequestWorkflow}. The order edit is then only applied after the
+ * order edit is confirmed using the {@link confirmOrderEditRequestWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to create an order edit
+ * for an order in your custom flows.
+ *
+ * @example
+ * const { result } = await beginOrderEditOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_id: "order_123",
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Create an order edit request.
+ */
+export declare const beginOrderEditOrderWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.BeginorderEditWorkflowInput, OrderChangeDTO, []>;
+//# sourceMappingURL=begin-order-edit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"begin-order-edit.d.ts","sourceRoot":"","sources":["../../../../src/order/workflows/order-edit/begin-order-edit.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EACR,aAAa,EACd,MAAM,0BAA0B,CAAA;AAcjC;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,4BAA4B,qGAKxC,CAAA;AAED,eAAO,MAAM,6BAA6B,2BAA2B,CAAA;AACrE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,2BAA2B,0HA4CvC,CAAA"}