@acmekit/core-flows 2.13.1

package/dist/order/workflows/exchange/update-exchange-shipping-method.js

@@ -0,0 +1,202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateExchangeShippingMethodWorkflow = exports.updateExchangeShippingMethodWorkflowId = exports.updateExchangeShippingMethodValidationStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../../common");
+const steps_1 = require("../../steps");
+const preview_order_change_1 = require("../../steps/preview-order-change");
+const order_validation_1 = require("../../utils/order-validation");
+const prepare_shipping_method_1 = require("../../utils/prepare-shipping-method");
+const schemas_1 = require("../../../cart/utils/schemas");
+/**
+ * This step validates that an exchange's shipping method can be updated.
+ * If the exchange is canceled, the order change is not active, the shipping method
+ * doesn't exist in the exchange, or the action isn't adding a shipping method,
+ * the step will throw an error.
+ *
+ * :::note
+ *
+ * You can retrieve an order exchange 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 = updateExchangeShippingMethodValidationStep({
+ *   orderChange: {
+ *     id: "orch_123",
+ *     // other order change details...
+ *   },
+ *   orderExchange: {
+ *     id: "exchange_123",
+ *     // other order exchange details...
+ *   },
+ *   input: {
+ *     exchange_id: "exchange_123",
+ *     action_id: "orchact_123",
+ *     data: {
+ *       custom_amount: 10,
+ *     }
+ *   }
+ * })
+ */
+exports.updateExchangeShippingMethodValidationStep = (0, workflows_sdk_1.createStep)("validate-update-exchange-shipping-method", async function ({ orderChange, orderExchange, input, }) {
+    (0, order_validation_1.throwIfIsCancelled)(orderExchange, "Exchange");
+    (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 exchange ${input.exchange_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.updateExchangeShippingMethodWorkflowId = "update-exchange-shipping-method";
+/**
+ * This workflow updates an exchange's inbound or outbound shipping method. It's used by the
+ * [Update Inbound Shipping Admin API Route](https://docs.acmekit.com/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
+ * or the [Outbound Inbound Shipping Admin API Route](https://docs.acmekit.com/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to update an exchange's
+ * inbound or outbound shipping method in your custom flow.
+ *
+ * @example
+ * const { result } = await updateExchangeShippingMethodWorkflow(container)
+ * .run({
+ *   input: {
+ *     exchange_id: "exchange_123",
+ *     action_id: "orchact_123",
+ *     data: {
+ *       custom_amount: 10,
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update an exchange's inbound or outbound shipping method.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping method is updated. 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 { updateExchangeShippingMethodWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * updateExchangeShippingMethodWorkflow.hooks.setPricingContext((
+ *   { order_exchange, order_change, 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.updateExchangeShippingMethodWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateExchangeShippingMethodWorkflowId, function (input) {
+    const orderExchange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_exchange",
+        fields: [
+            "id",
+            "status",
+            "order_id",
+            "canceled_at",
+            "order.currency_code",
+        ],
+        variables: { id: input.exchange_id },
+        list: false,
+        throw_if_key_not_found: true,
+    });
+    const orderChange = (0, common_1.useRemoteQueryStep)({
+        entry_point: "order_change",
+        fields: ["id", "status", "version", "actions.*"],
+        variables: {
+            filters: {
+                order_id: orderExchange.order_id,
+                exchange_id: orderExchange.id,
+                status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
+            },
+        },
+        list: false,
+    }).config({ name: "order-change-query" });
+    const setPricingContext = (0, workflows_sdk_1.createHook)("setPricingContext", {
+        order_exchange: orderExchange,
+        order_change: orderChange,
+        additional_data: input.additional_data,
+    }, {
+        resultValidator: schemas_1.pricingContextResult,
+    });
+    const setPricingContextResult = setPricingContext.getResult();
+    const shippingOptions = (0, workflows_sdk_1.when)({ input }, ({ input }) => {
+        return input.data?.custom_amount === null;
+    }).then(() => {
+        const action = (0, workflows_sdk_1.transform)({ orderChange, input, orderExchange }, ({ orderChange, input, orderExchange }) => {
+            const originalAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
+            return {
+                shipping_method_id: originalAction.reference_id,
+                currency_code: orderExchange.order.currency_code,
+            };
+        });
+        const pricingContext = (0, workflows_sdk_1.transform)({ action, setPricingContextResult }, (data) => {
+            return {
+                ...(data.setPricingContextResult
+                    ? data.setPricingContextResult
+                    : {}),
+                currency_code: data.action.currency_code,
+            };
+        });
+        const shippingMethod = (0, common_1.useRemoteQueryStep)({
+            entry_point: "order_shipping_method",
+            fields: ["id", "shipping_option_id"],
+            variables: {
+                id: action.shipping_method_id,
+            },
+            list: false,
+        }).config({ name: "fetch-shipping-method" });
+        return (0, common_1.useRemoteQueryStep)({
+            entry_point: "shipping_option",
+            fields: [
+                "id",
+                "name",
+                "calculated_price.calculated_amount",
+                "calculated_price.is_calculated_price_tax_inclusive",
+            ],
+            variables: {
+                id: shippingMethod.shipping_option_id,
+                calculated_price: {
+                    context: pricingContext,
+                },
+            },
+        }).config({ name: "fetch-shipping-option" });
+    });
+    (0, exports.updateExchangeShippingMethodValidationStep)({
+        orderExchange,
+        orderChange,
+        input,
+    });
+    const updateData = (0, workflows_sdk_1.transform)({ orderChange, input, shippingOptions }, prepare_shipping_method_1.prepareShippingMethodUpdate);
+    (0, workflows_sdk_1.parallelize)((0, steps_1.updateOrderChangeActionsStep)([updateData.action]), (0, steps_1.updateOrderShippingMethodsStep)([updateData.shippingMethod]));
+    return new workflows_sdk_1.WorkflowResponse((0, preview_order_change_1.previewOrderChangeStep)(orderExchange.order_id), {
+        hooks: [setPricingContext],
+    });
+});
+//# sourceMappingURL=update-exchange-shipping-method.js.map

package/dist/order/workflows/exchange/update-exchange-shipping-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-exchange-shipping-method.js","sourceRoot":"","sources":["../../../../src/order/workflows/exchange/update-exchange-shipping-method.ts"],"names":[],"mappings":";;;AAQA,oDAA8E;AAC9E,oEASyC;AACzC,4CAAoD;AACpD,uCAGoB;AACpB,2EAAyE;AACzE,mEAGqC;AACrC,iFAAiF;AACjF,yDAAkE;AAuBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACU,QAAA,0CAA0C,GAAG,IAAA,0BAAU,EAClE,0CAA0C,EAC1C,KAAK,WAAW,EACd,WAAW,EACX,aAAa,EACb,KAAK,GAC2C;IAChD,IAAA,qCAAkB,EAAC,aAAa,EAAE,UAAU,CAAC,CAAA;IAC7C,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,yCAAyC,KAAK,CAAC,WAAW,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC/F,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,sCAAsC,GACjD,iCAAiC,CAAA;AACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACU,QAAA,oCAAoC,GAAG,IAAA,8BAAc,EAChE,8CAAsC,EACtC,UACE,KAEC;IAED,MAAM,aAAa,GAAqB,IAAA,2BAAkB,EAAC;QACzD,WAAW,EAAE,gBAAgB;QAC7B,MAAM,EAAE;YACN,IAAI;YACJ,QAAQ;YACR,UAAU;YACV,aAAa;YACb,qBAAqB;SACtB;QACD,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE;QACpC,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAA;IAEF,MAAM,WAAW,GAAmB,IAAA,2BAAkB,EAAC;QACrD,WAAW,EAAE,cAAc;QAC3B,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC;QAChD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,QAAQ,EAAE,aAAa,CAAC,QAAQ;gBAChC,WAAW,EAAE,aAAa,CAAC,EAAE;gBAC7B,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,iBAAiB,GAAG,IAAA,0BAAU,EAClC,mBAAmB,EACnB;QACE,cAAc,EAAE,aAAa;QAC7B,YAAY,EAAE,WAAW;QACzB,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,eAAe,GAAG,IAAA,oBAAI,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACpD,OAAO,KAAK,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC3C,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,MAAM,MAAM,GAAG,IAAA,yBAAS,EACtB,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,EACrC,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE;YACxC,MAAM,cAAc,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACrD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;YAEzB,OAAO;gBACL,kBAAkB,EAAE,cAAc,CAAC,YAAY;gBAC/C,aAAa,EAAG,aAAqB,CAAC,KAAK,CAAC,aAAa;aAC1D,CAAA;QACH,CAAC,CACF,CAAA;QAED,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,MAAM,EAAE,uBAAuB,EAAE,EACnC,CAAC,IAAI,EAAE,EAAE;YACP,OAAO;gBACL,GAAG,CAAC,IAAI,CAAC,uBAAuB;oBAC9B,CAAC,CAAC,IAAI,CAAC,uBAAuB;oBAC9B,CAAC,CAAC,EAAE,CAAC;gBACP,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;aACzC,CAAA;QACH,CAAC,CACF,CAAA;QAED,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC;YACxC,WAAW,EAAE,uBAAuB;YACpC,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,CAAC;YACpC,SAAS,EAAE;gBACT,EAAE,EAAE,MAAM,CAAC,kBAAkB;aAC9B;YACD,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;QAE5C,OAAO,IAAA,2BAAkB,EAAC;YACxB,WAAW,EAAE,iBAAiB;YAC9B,MAAM,EAAE;gBACN,IAAI;gBACJ,MAAM;gBACN,oCAAoC;gBACpC,oDAAoD;aACrD;YACD,SAAS,EAAE;gBACT,EAAE,EAAE,cAAc,CAAC,kBAAkB;gBACrC,gBAAgB,EAAE;oBAChB,OAAO,EAAE,cAAc;iBACxB;aACF;SACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,IAAA,kDAA0C,EAAC;QACzC,aAAa;QACb,WAAW;QACX,KAAK;KACN,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAC1B,EAAE,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,EACvC,qDAA2B,CAC5B,CAAA;IAED,IAAA,2BAAW,EACT,IAAA,oCAA4B,EAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EACjD,IAAA,sCAA8B,EAAC,CAAC,UAAU,CAAC,cAAe,CAAC,CAAC,CAC7D,CAAA;IAED,OAAO,IAAI,gCAAgB,CACzB,IAAA,6CAAsB,EAAC,aAAa,CAAC,QAAQ,CAAoB,EACjE;QACE,KAAK,EAAE,CAAC,iBAAiB,CAAU;KACpC,CACF,CAAA;AACH,CAAC,CACF,CAAA"}

package/dist/order/workflows/export-orders.d.ts

@@ -0,0 +1,80 @@
+import { FilterableOrderProps } from "@acmekit/framework/types";
+/**
+ * The data to export orders.
+ */
+export type ExportOrdersDTO = {
+    /**
+     * The fields to select. These fields will be passed to
+     * [Query](https://docs.acmekit.com/learn/fundamentals/module-links/query), so you can
+     * pass order properties or any relation names, including custom links.
+     */
+    select: string[];
+    /**
+     * The filters to select which orders to export.
+     */
+    filter?: FilterableOrderProps;
+};
+export declare const exportOrdersWorkflowId = "export-orders";
+/**
+ * This workflow exports orders matching the specified filters. It's used to
+ * export orders to a CSV file.
+ *
+ * :::note
+ *
+ * This workflow doesn't return the exported orders. Instead, it sends a notification to the admin
+ * users that they can download the exported orders.
+ *
+ * :::
+ *
+ * @example
+ * To export all orders:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *   }
+ * })
+ * ```
+ *
+ * To export orders matching a criteria:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *     filter: {
+ *       created_at: {
+ *         $gte: "2024-01-01",
+ *         $lte: "2024-12-31"
+ *       }
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * To export orders within a date range:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *     filter: {
+ *       created_at: {
+ *         $gte: "2024-01-01T00:00:00Z",
+ *         $lte: "2024-01-31T23:59:59Z"
+ *       }
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Export orders with filtering capabilities.
+ */
+export declare const exportOrdersWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<ExportOrdersDTO, unknown, any[]>;
+//# sourceMappingURL=export-orders.d.ts.map

package/dist/order/workflows/export-orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-orders.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/export-orders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAU/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,sBAAsB,kBAAkB,CAAA;AACrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,eAAO,MAAM,oBAAoB,4FAqDhC,CAAA"}

package/dist/order/workflows/export-orders.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportOrdersWorkflow = exports.exportOrdersWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const notification_1 = require("../../notification");
+const steps_1 = require("../steps");
+exports.exportOrdersWorkflowId = "export-orders";
+/**
+ * This workflow exports orders matching the specified filters. It's used to
+ * export orders to a CSV file.
+ *
+ * :::note
+ *
+ * This workflow doesn't return the exported orders. Instead, it sends a notification to the admin
+ * users that they can download the exported orders.
+ *
+ * :::
+ *
+ * @example
+ * To export all orders:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *   }
+ * })
+ * ```
+ *
+ * To export orders matching a criteria:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *     filter: {
+ *       created_at: {
+ *         $gte: "2024-01-01",
+ *         $lte: "2024-12-31"
+ *       }
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * To export orders within a date range:
+ *
+ * ```ts
+ * const { result } = await exportOrdersWorkflow(container)
+ * .run({
+ *   input: {
+ *     select: ["*"],
+ *     filter: {
+ *       created_at: {
+ *         $gte: "2024-01-01T00:00:00Z",
+ *         $lte: "2024-01-31T23:59:59Z"
+ *       }
+ *     }
+ *   }
+ * })
+ * ```
+ *
+ * @summary
+ *
+ * Export orders with filtering capabilities.
+ */
+exports.exportOrdersWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.exportOrdersWorkflowId, (input) => {
+    const file = (0, steps_1.exportOrdersStep)(input).config({
+        async: true,
+        backgroundExecution: true,
+    });
+    const failureNotification = (0, workflows_sdk_1.transform)({ input }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Order export",
+                    description: `Failed to export orders, please try again later.`,
+                },
+            },
+        ];
+    });
+    (0, notification_1.notifyOnFailureStep)(failureNotification);
+    const fileDetails = (0, common_1.useRemoteQueryStep)({
+        fields: ["id", "url"],
+        entry_point: "file",
+        variables: { id: file.id },
+        list: false,
+    });
+    const notifications = (0, workflows_sdk_1.transform)({ fileDetails, file }, (data) => {
+        return [
+            {
+                // We don't need the recipient here for now, but if we want to push feed notifications to a specific user we could add it.
+                to: "",
+                channel: "feed",
+                template: "admin-ui",
+                data: {
+                    title: "Order export",
+                    description: "Order export completed successfully!",
+                    file: {
+                        filename: data.file.filename,
+                        url: data.fileDetails.url,
+                        mimeType: "text/csv",
+                    },
+                },
+            },
+        ];
+    });
+    (0, notification_1.sendNotificationsStep)(notifications);
+});
+//# sourceMappingURL=export-orders.js.map

package/dist/order/workflows/export-orders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-orders.js","sourceRoot":"","sources":["../../../src/order/workflows/export-orders.ts"],"names":[],"mappings":";;;AACA,oEAIyC;AACzC,yCAAiD;AACjD,qDAA+E;AAC/E,oCAA2C;AAkB9B,QAAA,sBAAsB,GAAG,eAAe,CAAA;AACrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACU,QAAA,oBAAoB,GAAG,IAAA,8BAAc,EAChD,8BAAsB,EACtB,CAAC,KAAoC,EAAsB,EAAE;IAC3D,MAAM,IAAI,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC;QAC1C,KAAK,EAAE,IAAI;QACX,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAA;IAEF,MAAM,mBAAmB,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,kDAAkD;iBAChE;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IACF,IAAA,kCAAmB,EAAC,mBAAmB,CAAC,CAAA;IAExC,MAAM,WAAW,GAAG,IAAA,2BAAkB,EAAC;QACrC,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;QACrB,WAAW,EAAE,MAAM;QACnB,SAAS,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;QAC1B,IAAI,EAAE,KAAK;KACZ,CAAC,CAAA;IAEF,MAAM,aAAa,GAAG,IAAA,yBAAS,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAC9D,OAAO;YACL;gBACE,0HAA0H;gBAC1H,EAAE,EAAE,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,UAAU;gBACpB,IAAI,EAAE;oBACJ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,sCAAsC;oBACnD,IAAI,EAAE;wBACJ,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;wBAC5B,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;wBACzB,QAAQ,EAAE,UAAU;qBACrB;iBACF;aACF;SACF,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,oCAAqB,EAAC,aAAa,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/order/workflows/fetch-shipping-option.d.ts

@@ -0,0 +1,159 @@
+import { AdditionalData, BigNumberInput, CalculatedRMAShippingContext, ShippingOptionDTO } from "@acmekit/framework/types";
+import { BigNumber } from "@acmekit/framework/utils";
+/**
+ * The data to create a shipping method for an order edit.
+ */
+export type FetchShippingOptionForOrderWorkflowInput = AdditionalData & {
+    /**
+     * The ID of the shipping option to fetch.
+     */
+    shipping_option_id: string;
+    /**
+     * The custom amount of the shipping option.
+     * If not provided, the shipping option's amount is used.
+     */
+    custom_amount?: BigNumberInput | null;
+    /**
+     * The currency code of the order.
+     */
+    currency_code: string;
+    /**
+     * The ID of the order.
+     */
+    order_id: string;
+    /**
+     * The context of the RMA flow, which can be useful for retrieving the shipping option's price.
+     */
+    context: CalculatedRMAShippingContext;
+};
+/**
+ * The output of the fetch shipping option for order workflow.
+ */
+export type FetchShippingOptionForOrderWorkflowOutput = ShippingOptionDTO & {
+    /**
+     * The shipping option's price.
+     */
+    calculated_price: {
+        /**
+         * The shipping option's price based on its type and provided context.
+         */
+        calculated_amount: BigNumber;
+        /**
+         * Whether the amount includes taxes.
+         */
+        is_calculated_price_tax_inclusive: boolean;
+    };
+};
+export declare const fetchShippingOptionsForOrderWorkflowId = "fetch-shipping-option";
+/**
+ * This workflow fetches a shipping option for an order. It's used in Return Merchandise Authorization (RMA) flows. It's used
+ * by other workflows, such as {@link createClaimShippingMethodWorkflow}.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around fetching
+ * shipping options for an order.
+ *
+ * @example
+ * const { result } = await fetchShippingOptionForOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     shipping_option_id: "so_123",
+ *     currency_code: "usd",
+ *     order_id: "order_123",
+ *     context: {
+ *       return_id: "ret_123",
+ *       return_items: [
+ *         {
+ *           id: "orli_123",
+ *           quantity: 1,
+ *         }
+ *       ]
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Fetch a shipping option for an order.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping option is fetched. You can consume this hook to set the pricing context for the shipping option. This is useful when you have custom pricing rules that depend on the context of the order.
+ *
+ * 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 { fetchShippingOptionForOrderWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * fetchShippingOptionForOrderWorkflow.hooks.setPricingContext((
+ *   { shipping_option_id, currency_code, order_id, context, additional_data }, { container }
+ * ) => {
+ *   return new StepResponse({
+ *     location_id: "sloc_123", // Special price for in-store purchases
+ *   });
+ * });
+ * ```
+ *
+ * The shipping option's price 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.
+ *
+ * :::
+ *
+ * @privateRemarks
+ * There can be 3 cases:
+ * 1. The shipping option is a flat rate shipping option.
+ *    In this case, pricing calculation context is not used.
+ * 2. The shipping option is a calculated shipping option.
+ *    In this case, calculate shipping price method from the provider is called.
+ * 3. The shipping option is a custom shipping option. -- TODO
+ *    In this case, we don't need to do caluclations above and just return the shipping option with the custom amount.
+ */
+export declare const fetchShippingOptionForOrderWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<AdditionalData & {
+    /**
+     * The ID of the shipping option to fetch.
+     */
+    shipping_option_id: string;
+    /**
+     * The custom amount of the shipping option.
+     * If not provided, the shipping option's amount is used.
+     */
+    custom_amount?: BigNumberInput | null;
+    /**
+     * The currency code of the order.
+     */
+    currency_code: string;
+    /**
+     * The ID of the order.
+     */
+    order_id: string;
+    /**
+     * The context of the RMA flow, which can be useful for retrieving the shipping option's price.
+     */
+    context: CalculatedRMAShippingContext;
+}, ShippingOptionDTO & {
+    /**
+     * The shipping option's price.
+     */
+    calculated_price: {
+        /**
+         * The shipping option's price based on its type and provided context.
+         */
+        calculated_amount: BigNumber;
+        /**
+         * Whether the amount includes taxes.
+         */
+        is_calculated_price_tax_inclusive: boolean;
+    };
+}, [import("@acmekit/framework/workflows-sdk").Hook<"setPricingContext", FetchShippingOptionForOrderWorkflowInput, Record<string, any> | undefined>]>;
+//# sourceMappingURL=fetch-shipping-option.d.ts.map

package/dist/order/workflows/fetch-shipping-option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-shipping-option.d.ts","sourceRoot":"","sources":["../../../src/order/workflows/fetch-shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,cAAc,EACd,4BAA4B,EAE5B,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AAQjC,OAAO,EAAE,SAAS,EAA2B,MAAM,0BAA0B,CAAA;AA+B7E;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG,cAAc,GAAG;IACtE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAA;CACtC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,GAAG;IAC1E;;OAEG;IACH,gBAAgB,EAAE;QAChB;;WAEG;QACH,iBAAiB,EAAE,SAAS,CAAA;QAC5B;;WAEG;QACH,iCAAiC,EAAE,OAAO,CAAA;KAC3C,CAAA;CACF,CAAA;AAED,eAAO,MAAM,sCAAsC,0BAA0B,CAAA;AAC7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,eAAO,MAAM,mCAAmC;IArH9C;;OAEG;wBACiB,MAAM;IAC1B;;;OAGG;oBACa,cAAc,GAAG,IAAI;IACrC;;OAEG;mBACY,MAAM;IACrB;;OAEG;cACO,MAAM;IAChB;;OAEG;aACM,4BAA4B;;IAOrC;;OAEG;sBACe;QAChB;;WAEG;QACH,iBAAiB,EAAE,SAAS,CAAA;QAC5B;;WAEG;QACH,iCAAiC,EAAE,OAAO,CAAA;KAC3C;qJAgNF,CAAA"}