@acmekit/core-flows 2.13.1

package/dist/cart/workflows/list-shipping-options-for-cart-with-pricing.js

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listShippingOptionsForCartWithPricingWorkflow = exports.listShippingOptionsForCartWithPricingWorkflowId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+const use_remote_query_1 = require("../../common/steps/use-remote-query");
+const fulfillment_1 = require("../../fulfillment");
+const fields_1 = require("../utils/fields");
+const schemas_1 = require("../utils/schemas");
+const get_translated_shipping_option_1 = require("../../common/steps/get-translated-shipping-option");
+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.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.listShippingOptionsForCartWithPricingWorkflowId = "list-shipping-options-for-cart-with-pricing";
+/**
+ * This workflow lists shipping options that can be used during checkout for a cart. It also retrieves the prices
+ * of these shipping options, including calculated prices that may be retrieved from third-party providers.
+ *
+ * This workflow is executed in other cart-related workflows, such as {@link addShippingMethodToCartWorkflow} to retrieve the
+ * price of the shipping method being added to the cart.
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to retrieve the shipping options of a cart and their prices
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await listShippingOptionsForCartWithPricingWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     options: [
+ *       {
+ *         id: "so_123",
+ *         data: {
+ *           carrier_code: "fedex"
+ *         }
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * List a cart's shipping options with prices.
+ *
+ * @property hooks.setShippingOptionsContext - This hook is executed after the cart is retrieved and before the shipping options are queried. You can consume this hook to return any custom context useful for the shipping options retrieval.
+ *
+ * For example, you can consume the hook to add the customer Id to the context:
+ *
+ * ```ts
+ * import { listShippingOptionsForCartWithPricingWorkflow } from "@acmekit/acmekit/core-flows"
+ * import { StepResponse } from "@acmekit/workflows-sdk"
+ *
+ * listShippingOptionsForCartWithPricingWorkflow.hooks.setShippingOptionsContext(
+ *   async ({ cart }, { container }) => {
+ *
+ *     if (cart.customer_id) {
+ *       return new StepResponse({
+ *         customer_id: cart.customer_id,
+ *       })
+ *     }
+ *
+ *     const query = container.resolve("query")
+ *
+ *     const { data: carts } = await query.graph({
+ *       entity: "cart",
+ *       filters: {
+ *         id: cart.id,
+ *       },
+ *       fields: ["customer_id"],
+ *     })
+ *
+ *     return new StepResponse({
+ *       customer_id: carts[0].customer_id,
+ *     })
+ *   }
+ * )
+ * ```
+ *
+ * The `customer_id` property will be added to the context along with other properties such as `is_return` and `enabled_in_store`.
+ *
+ * :::note
+ *
+ * You should also consume the `setShippingOptionsContext` hook in the {@link listShippingOptionsForCartWorkflow} workflow to ensure that the context is consistent when listing shipping options across workflows.
+ *
+ * :::
+ */
+exports.listShippingOptionsForCartWithPricingWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.listShippingOptionsForCartWithPricingWorkflowId, (input) => {
+    const optionIds = (0, workflows_sdk_1.transform)({ input }, ({ input }) => (input.options ?? []).map(({ id }) => id));
+    const cartQuery = (0, common_1.useQueryGraphStep)({
+        entity: "cart",
+        filters: { id: input.cart_id },
+        fields: [
+            ...fields_1.cartFieldsForCalculateShippingOptionsPrices,
+            "sales_channel_id",
+            "currency_code",
+            "region_id",
+            "item_total",
+            "total",
+        ],
+        options: { throwIfKeyNotFound: true },
+    }).config({ name: "get-cart" });
+    const cart = (0, workflows_sdk_1.transform)({ cartQuery }, ({ cartQuery }) => cartQuery.data[0]);
+    (0, common_1.validatePresenceOfStep)({
+        entity: cart,
+        fields: ["sales_channel_id", "region_id", "currency_code"],
+    });
+    const scFulfillmentSetQuery = (0, common_1.useQueryGraphStep)({
+        entity: "sales_channels",
+        filters: { id: cart.sales_channel_id },
+        fields: [
+            "stock_locations.id",
+            "stock_locations.name",
+            "stock_locations.address.*",
+            "stock_locations.fulfillment_sets.id",
+        ],
+        options: {
+            cache: {
+                enable: true,
+            },
+        },
+    }).config({ name: "sales_channels-fulfillment-query" });
+    const scFulfillmentSets = (0, workflows_sdk_1.transform)({ scFulfillmentSetQuery }, ({ scFulfillmentSetQuery }) => scFulfillmentSetQuery.data[0]);
+    const { fulfillmentSetIds, fulfillmentSetLocationMap } = (0, workflows_sdk_1.transform)({ scFulfillmentSets }, ({ scFulfillmentSets }) => {
+        const fulfillmentSetIds = new Set();
+        const fulfillmentSetLocationMap = {};
+        scFulfillmentSets.stock_locations.forEach((stockLocation) => {
+            stockLocation.fulfillment_sets.forEach((fulfillmentSet) => {
+                fulfillmentSetLocationMap[fulfillmentSet.id] = stockLocation;
+                fulfillmentSetIds.add(fulfillmentSet.id);
+            });
+        });
+        return {
+            fulfillmentSetIds: Array.from(fulfillmentSetIds),
+            fulfillmentSetLocationMap,
+        };
+    });
+    const setShippingOptionsContext = (0, workflows_sdk_1.createHook)("setShippingOptionsContext", {
+        cart: cart,
+        fulfillmentSetIds,
+        additional_data: input.additional_data,
+    }, {
+        resultValidator: schemas_1.shippingOptionsContextResult,
+    });
+    const setShippingOptionsContextResult = setShippingOptionsContext.getResult();
+    const commonOptions = (0, workflows_sdk_1.transform)({
+        input,
+        cart,
+        fulfillmentSetIds,
+        optionIds,
+        setShippingOptionsContextResult,
+    }, ({ input, cart, fulfillmentSetIds, optionIds, setShippingOptionsContextResult, }) => ({
+        context: (0, utils_1.QueryContext)({
+            ...(setShippingOptionsContextResult
+                ? setShippingOptionsContextResult
+                : {}),
+            is_return: input.is_return ? "true" : "false",
+            enabled_in_store: !(0, utils_1.isDefined)(input.enabled_in_store)
+                ? "true"
+                : input.enabled_in_store
+                    ? "true"
+                    : "false",
+        }),
+        filters: {
+            id: optionIds.length ? optionIds : undefined,
+            fulfillment_set_id: fulfillmentSetIds,
+            address: {
+                country_code: cart.shipping_address?.country_code,
+                province_code: cart.shipping_address?.province,
+                city: cart.shipping_address?.city,
+                postal_expression: cart.shipping_address?.postal_code,
+            },
+        },
+    }));
+    /**
+     * We need to prefetch exact same SO as in the final result but only to determine pricing calculations first.
+     */
+    const { data: initialOptions } = (0, common_1.useQueryGraphStep)({
+        entity: "shipping_options",
+        fields: ["id", "price_type"],
+        filters: commonOptions.filters,
+        context: commonOptions.context,
+        options: {
+            cache: {
+                enable: true,
+            },
+        },
+    }).config({ name: "shipping-options-price-type-query" });
+    /**
+     * Prepare queries for flat rate and calculated shipping options since price calculations are different for each.
+     */
+    const { flatRateOptionsQuery, calculatedShippingOptionsQuery } = (0, workflows_sdk_1.transform)({
+        cart,
+        initialOptions: initialOptions,
+        commonOptions,
+    }, ({ cart, initialOptions, commonOptions }) => {
+        const flatRateShippingOptionIds = [];
+        const calculatedShippingOptionIds = [];
+        initialOptions.forEach((option) => {
+            if (option.price_type === utils_1.ShippingOptionPriceType.FLAT) {
+                flatRateShippingOptionIds.push(option.id);
+            }
+            else {
+                calculatedShippingOptionIds.push(option.id);
+            }
+        });
+        return {
+            flatRateOptionsQuery: {
+                ...commonOptions,
+                id: flatRateShippingOptionIds,
+                calculated_price: { context: cart },
+            },
+            calculatedShippingOptionsQuery: {
+                ...commonOptions,
+                id: calculatedShippingOptionIds,
+            },
+        };
+    });
+    const [shippingOptionsFlatRate, shippingOptionsCalculated] = (0, workflows_sdk_1.parallelize)((0, use_remote_query_1.useRemoteQueryStep)({
+        entry_point: "shipping_options",
+        fields: [
+            ...COMMON_OPTIONS_FIELDS,
+            "calculated_price.*",
+            "prices.*",
+            "prices.price_rules.*",
+        ],
+        variables: flatRateOptionsQuery,
+    }).config({ name: "shipping-options-query-flat-rate" }), (0, use_remote_query_1.useRemoteQueryStep)({
+        entry_point: "shipping_options",
+        fields: [...COMMON_OPTIONS_FIELDS],
+        variables: calculatedShippingOptionsQuery,
+    }).config({ name: "shipping-options-query-calculated" }));
+    const calculateShippingOptionsPricesData = (0, workflows_sdk_1.transform)({
+        shippingOptionsCalculated,
+        cart,
+        input,
+        fulfillmentSetLocationMap,
+    }, ({ shippingOptionsCalculated, cart, input, fulfillmentSetLocationMap, }) => {
+        const optionDataMap = new Map((input.options ?? []).map(({ id, data }) => [id, data]));
+        return shippingOptionsCalculated.map((so) => ({
+            id: so.id,
+            optionData: so.data,
+            context: {
+                ...cart,
+                from_location: fulfillmentSetLocationMap[so.service_zone.fulfillment_set_id],
+            },
+            data: optionDataMap.get(so.id),
+            provider_id: so.provider_id,
+        }));
+    });
+    const prices = (0, fulfillment_1.calculateShippingOptionsPricesStep)(calculateShippingOptionsPricesData);
+    const shippingOptionsWithPrice = (0, workflows_sdk_1.transform)({
+        shippingOptionsFlatRate,
+        shippingOptionsCalculated,
+        prices,
+        fulfillmentSetLocationMap,
+    }, ({ shippingOptionsFlatRate, shippingOptionsCalculated, prices, fulfillmentSetLocationMap, }) => {
+        return [
+            ...shippingOptionsFlatRate.map((shippingOption) => {
+                const price = shippingOption.calculated_price;
+                return {
+                    ...shippingOption,
+                    amount: price?.calculated_amount,
+                    is_tax_inclusive: !!price?.is_calculated_price_tax_inclusive,
+                };
+            }),
+            ...shippingOptionsCalculated.map((shippingOption, index) => {
+                return {
+                    ...shippingOption,
+                    amount: prices[index]?.calculated_amount,
+                    is_tax_inclusive: prices[index]?.is_calculated_price_tax_inclusive,
+                    calculated_price: prices[index],
+                    stock_location: fulfillmentSetLocationMap[shippingOption.service_zone.fulfillment_set_id],
+                };
+            }),
+        ];
+    });
+    const translatedShippingOptions = (0, get_translated_shipping_option_1.getTranslatedShippingOptionsStep)({
+        shippingOptions: shippingOptionsWithPrice,
+        locale: cart.locale,
+    });
+    return new workflows_sdk_1.WorkflowResponse(translatedShippingOptions, {
+        hooks: [setShippingOptionsContext],
+    });
+});
+//# sourceMappingURL=list-shipping-options-for-cart-with-pricing.js.map

package/dist/cart/workflows/list-shipping-options-for-cart-with-pricing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-shipping-options-for-cart-with-pricing.js","sourceRoot":"","sources":["../../../src/cart/workflows/list-shipping-options-for-cart-with-pricing.ts"],"names":[],"mappings":";;;AAAA,oDAIiC;AACjC,oEAOyC;AAQzC,yCAAwE;AACxE,0EAAwE;AACxE,mDAAsE;AACtE,4CAA6E;AAC7E,8CAA+D;AAC/D,sGAAoG;AAEpG,MAAM,qBAAqB,GAAG;IAC5B,IAAI;IACJ,MAAM;IACN,YAAY;IACZ,iBAAiB;IACjB,iCAAiC;IACjC,mCAAmC;IACnC,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;AAEY,QAAA,+CAA+C,GAC1D,6CAA6C,CAAA;AAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACU,QAAA,6CAA6C,GAAG,IAAA,8BAAc,EACzE,uDAA+C,EAC/C,CACE,KAEC,EACD,EAAE;IACF,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CACnD,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAC1C,CAAA;IAED,MAAM,SAAS,GAAG,IAAA,0BAAiB,EAAC;QAClC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE;QAC9B,MAAM,EAAE;YACN,GAAG,oDAA2C;YAC9C,kBAAkB;YAClB,eAAe;YACf,WAAW;YACX,YAAY;YACZ,OAAO;SACR;QACD,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE;KACtC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAE/B,MAAM,IAAI,GAAG,IAAA,yBAAS,EAAC,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3E,IAAA,+BAAsB,EAAC;QACrB,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,CAAC,kBAAkB,EAAE,WAAW,EAAE,eAAe,CAAC;KAC3D,CAAC,CAAA;IAEF,MAAM,qBAAqB,GAAG,IAAA,0BAAiB,EAAC;QAC9C,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE;QACtC,MAAM,EAAE;YACN,oBAAoB;YACpB,sBAAsB;YACtB,2BAA2B;YAC3B,qCAAqC;SACtC;QACD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,kCAAkC,EAAE,CAAC,CAAA;IAEvD,MAAM,iBAAiB,GAAG,IAAA,yBAAS,EACjC,EAAE,qBAAqB,EAAE,EACzB,CAAC,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAC7D,CAAA;IAED,MAAM,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,GAAG,IAAA,yBAAS,EAChE,EAAE,iBAAiB,EAAE,EACrB,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACxB,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAA;QAC3C,MAAM,yBAAyB,GAAG,EAAE,CAAA;QAEpC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YAC1D,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;gBACxD,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,aAAa,CAAA;gBAC5D,iBAAiB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,OAAO;YACL,iBAAiB,EAAE,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC;YAChD,yBAAyB;SAC1B,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,yBAAyB,GAAG,IAAA,0BAAU,EAC1C,2BAA2B,EAC3B;QACE,IAAI,EAAE,IAAI;QACV,iBAAiB;QACjB,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,EACD;QACE,eAAe,EAAE,sCAA4B;KAC9C,CACF,CAAA;IACD,MAAM,+BAA+B,GACnC,yBAAyB,CAAC,SAAS,EAAE,CAAA;IAEvC,MAAM,aAAa,GAAG,IAAA,yBAAS,EAC7B;QACE,KAAK;QACL,IAAI;QACJ,iBAAiB;QACjB,SAAS;QACT,+BAA+B;KAChC,EACD,CAAC,EACC,KAAK,EACL,IAAI,EACJ,iBAAiB,EACjB,SAAS,EACT,+BAA+B,GAChC,EAAE,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,IAAA,oBAAY,EAAC;YACpB,GAAG,CAAC,+BAA+B;gBACjC,CAAC,CAAC,+BAA+B;gBACjC,CAAC,CAAC,EAAE,CAAC;YACP,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;YAC7C,gBAAgB,EAAE,CAAC,IAAA,iBAAS,EAAC,KAAK,CAAC,gBAAgB,CAAC;gBAClD,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,KAAK,CAAC,gBAAgB;oBACxB,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,OAAO;SACZ,CAAC;QAEF,OAAO,EAAE;YACP,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YAC5C,kBAAkB,EAAE,iBAAiB;YAErC,OAAO,EAAE;gBACP,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY;gBACjD,aAAa,EAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ;gBAC9C,IAAI,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI;gBACjC,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,EAAE,WAAW;aACtD;SACF;KACF,CAAC,CACH,CAAA;IAED;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACjD,MAAM,EAAE,kBAAkB;QAC1B,MAAM,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC;QAC5B,OAAO,EAAE,aAAa,CAAC,OAAO;QAC9B,OAAO,EAAE,aAAa,CAAC,OAA2B;QAClD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,IAAI;aACb;SACF;KACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CAAA;IAExD;;OAEG;IACH,MAAM,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,GAAG,IAAA,yBAAS,EACxE;QACE,IAAI;QACJ,cAAc,EAAE,cAAc;QAC9B,aAAa;KACd,EACD,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,aAAa,EAAE,EAAE,EAAE;QAC1C,MAAM,yBAAyB,GAAa,EAAE,CAAA;QAC9C,MAAM,2BAA2B,GAAa,EAAE,CAAA;QAEhD,cAAc,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAChC,IAAI,MAAM,CAAC,UAAU,KAAK,+BAAuB,CAAC,IAAI,EAAE,CAAC;gBACvD,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC3C,CAAC;iBAAM,CAAC;gBACN,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC7C,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO;YACL,oBAAoB,EAAE;gBACpB,GAAG,aAAa;gBAChB,EAAE,EAAE,yBAAyB;gBAC7B,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;aACpC;YACD,8BAA8B,EAAE;gBAC9B,GAAG,aAAa;gBAChB,EAAE,EAAE,2BAA2B;aAChC;SACF,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,CAAC,uBAAuB,EAAE,yBAAyB,CAAC,GAAG,IAAA,2BAAW,EACtE,IAAA,qCAAkB,EAAC;QACjB,WAAW,EAAE,kBAAkB;QAC/B,MAAM,EAAE;YACN,GAAG,qBAAqB;YACxB,oBAAoB;YACpB,UAAU;YACV,sBAAsB;SACvB;QACD,SAAS,EAAE,oBAAoB;KAChC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,kCAAkC,EAAE,CAAC,EACvD,IAAA,qCAAkB,EAAC;QACjB,WAAW,EAAE,kBAAkB;QAC/B,MAAM,EAAE,CAAC,GAAG,qBAAqB,CAAC;QAClC,SAAS,EAAE,8BAA8B;KAC1C,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CACzD,CAAA;IAED,MAAM,kCAAkC,GAAG,IAAA,yBAAS,EAClD;QACE,yBAAyB;QACzB,IAAI;QACJ,KAAK;QACL,yBAAyB;KAC1B,EACD,CAAC,EACC,yBAAyB,EACzB,IAAI,EACJ,KAAK,EACL,yBAAyB,GAC1B,EAAE,EAAE;QACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAC3B,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CACxD,CAAA;QAED,OAAO,yBAAyB,CAAC,GAAG,CAClC,CAAC,EAAE,EAAE,EAAE,CACL,CAAC;YACC,EAAE,EAAE,EAAE,CAAC,EAAY;YACnB,UAAU,EAAE,EAAE,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,GAAG,IAAI;gBACP,aAAa,EACX,yBAAyB,CAAC,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC;aAChE;YACD,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YAC9B,WAAW,EAAE,EAAE,CAAC,WAAW;SACQ,CAAA,CACxC,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,MAAM,GAAG,IAAA,gDAAkC,EAC/C,kCAAkC,CACnC,CAAA;IAED,MAAM,wBAAwB,GAAG,IAAA,yBAAS,EACxC;QACE,uBAAuB;QACvB,yBAAyB;QACzB,MAAM;QACN,yBAAyB;KAC1B,EACD,CAAC,EACC,uBAAuB,EACvB,yBAAyB,EACzB,MAAM,EACN,yBAAyB,GAC1B,EAAE,EAAE;QACH,OAAO;YACL,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;gBAChD,MAAM,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAA;gBAE7C,OAAO;oBACL,GAAG,cAAc;oBACjB,MAAM,EAAE,KAAK,EAAE,iBAAiB;oBAChC,gBAAgB,EAAE,CAAC,CAAC,KAAK,EAAE,iCAAiC;iBAC7D,CAAA;YACH,CAAC,CAAC;YACF,GAAG,yBAAyB,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE;gBACzD,OAAO;oBACL,GAAG,cAAc;oBACjB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,iBAAiB;oBACxC,gBAAgB,EACd,MAAM,CAAC,KAAK,CAAC,EAAE,iCAAiC;oBAClD,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC;oBAC/B,cAAc,EACZ,yBAAyB,CACvB,cAAc,CAAC,YAAY,CAAC,kBAAkB,CAC/C;iBACJ,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,yBAAyB,GAAG,IAAA,iEAAgC,EAAC;QACjE,eAAe,EAAE,wBAAwB;QACzC,MAAM,EAAE,IAAI,CAAC,MAAM;KACpB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,yBAAkC,EAAE;QAC9D,KAAK,EAAE,CAAC,yBAAyB,CAAU;KAC5C,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/cart/workflows/list-shipping-options-for-cart.d.ts

@@ -0,0 +1,117 @@
+import { WorkflowData } from "@acmekit/framework/workflows-sdk";
+import { AdditionalData, ListShippingOptionsForCartWorkflowInput } from "@acmekit/framework/types";
+export declare const listShippingOptionsForCartWorkflowId = "list-shipping-options-for-cart";
+/**
+ * This workflow lists the shipping options of a cart. It's executed by the
+ * [List Shipping Options Store API Route](https://docs.acmekit.com/api/store#shipping-options_getshippingoptions).
+ *
+ * :::note
+ *
+ * This workflow doesn't retrieve the calculated prices of the shipping options. If you need to retrieve the prices of the shipping options,
+ * use the {@link listShippingOptionsForCartWithPricingWorkflow} workflow.
+ *
+ * :::
+ *
+ * You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around to retrieve the shipping options of a cart
+ * in your custom flows.
+ *
+ * @example
+ * const { result } = await listShippingOptionsForCartWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     option_ids: ["so_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * List a cart's shipping options.
+ *
+ * @property hooks.setPricingContext - This hook is executed before the shipping options are retrieved. You can consume this hook to return any custom context useful for the prices retrieval of shipping options.
+ *
+ * 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 { listShippingOptionsForCartWorkflow } from "@acmekit/acmekit/core-flows";
+ * import { StepResponse } from "@acmekit/workflows-sdk";
+ *
+ * listShippingOptionsForCartWorkflow.hooks.setPricingContext((
+ *   { cart, fulfillmentSetIds, additional_data }, { container }
+ * ) => {
+ *   return new StepResponse({
+ *     location_id: "sloc_123", // Special price for in-store purchases
+ *   });
+ * });
+ * ```
+ *
+ * The shipping options' prices 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.
+ *
+ * :::
+ *
+ * @property hooks.setShippingOptionsContext - This hook is executed after the cart is retrieved and before the shipping options are queried. You can consume this hook to return any custom context useful for the shipping options retrieval.
+ *
+ * For example, you can consume the hook to add the customer Id to the context:
+ *
+ * ```ts
+ * import { listShippingOptionsForCartWithPricingWorkflow } from "@acmekit/acmekit/core-flows"
+ * import { StepResponse } from "@acmekit/workflows-sdk"
+ *
+ * listShippingOptionsForCartWithPricingWorkflow.hooks.setShippingOptionsContext(
+ *   async ({ cart }, { container }) => {
+ *
+ *     if (cart.customer_id) {
+ *       return new StepResponse({
+ *         customer_id: cart.customer_id,
+ *       })
+ *     }
+ *
+ *     const query = container.resolve("query")
+ *
+ *     const { data: carts } = await query.graph({
+ *       entity: "cart",
+ *       filters: {
+ *         id: cart.id,
+ *       },
+ *       fields: ["customer_id"],
+ *     })
+ *
+ *     return new StepResponse({
+ *       customer_id: carts[0].customer_id,
+ *     })
+ *   }
+ * )
+ * ```
+ *
+ * The `customer_id` property will be added to the context along with other properties such as `is_return` and `enabled_in_store`.
+ *
+ * :::note
+ *
+ * You should also consume the `setShippingOptionsContext` hook in the {@link listShippingOptionsForCartWithPricingWorkflow} workflow to ensure that the context is consistent when listing shipping options across workflows.
+ *
+ * :::
+ */
+export declare const listShippingOptionsForCartWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<ListShippingOptionsForCartWorkflowInput & AdditionalData, any[], [import("@acmekit/framework/workflows-sdk").Hook<"setPricingContext", {
+    cart: any;
+    fulfillmentSetIds: (string[] | WorkflowData<string[]>) & string[];
+    additional_data: ((Record<string, unknown> | WorkflowData<Record<string, unknown> | undefined>) & Record<string, unknown>) | undefined;
+}, Record<string, any> | undefined>, import("@acmekit/framework/workflows-sdk").Hook<"setShippingOptionsContext", {
+    cart: any;
+    fulfillmentSetIds: (string[] | WorkflowData<string[]>) & string[];
+    additional_data: ((Record<string, unknown> | WorkflowData<Record<string, unknown> | undefined>) & Record<string, unknown>) | undefined;
+}, Record<string, any> | undefined>]>;
+//# sourceMappingURL=list-shipping-options-for-cart.d.ts.map

package/dist/cart/workflows/list-shipping-options-for-cart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-shipping-options-for-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/list-shipping-options-for-cart.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,YAAY,EAEb,MAAM,kCAAkC,CAAA;AAOzC,OAAO,EACL,cAAc,EACd,uCAAuC,EACxC,MAAM,0BAA0B,CAAA;AAYjC,eAAO,MAAM,oCAAoC,mCACf,CAAA;AAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuGG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;qCA6O9C,CAAA"}