@acmekit/core-flows 2.13.1

package/dist/cart/steps/upsert-tax-lines-for-items.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertTaxLinesForItemsStep = exports.upsertTaxLinesForItemsStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.upsertTaxLinesForItemsStepId = "set-tax-lines-for-items";
+/**
+ * This step sets the tax lines of shipping methods and line items in a cart.
+ *
+ * :::tip
+ *
+ * You can use the {@link retrieveCartStep} to retrieve a cart's details.
+ *
+ * :::
+ *
+ * @example
+ * const data = upsertTaxLinesForItemsStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart,
+ *   "item_tax_lines": [{
+ *     "rate": 48,
+ *     "code": "CODE123",
+ *     "name": "Tax rate 2",
+ *     "provider_id": "provider_1",
+ *     "line_item_id": "litem_123"
+ *   }],
+ *   "shipping_tax_lines": [{
+ *     "rate": 49,
+ *     "code": "CODE456",
+ *     "name": "Tax rate 1",
+ *     "provider_id": "provider_1",
+ *     "shipping_line_id": "sm_123"
+ *   }]
+ * })
+ */
+exports.upsertTaxLinesForItemsStep = (0, workflows_sdk_1.createStep)(exports.upsertTaxLinesForItemsStepId, async (data, { container }) => {
+    const { cart, item_tax_lines, shipping_tax_lines } = data;
+    const cartService = container.resolve(utils_1.Modules.CART);
+    const [existingShippingMethodTaxLines, existingLineItemTaxLines] = await (0, utils_1.promiseAll)([
+        shipping_tax_lines.length
+            ? cartService.listShippingMethodTaxLines({
+                shipping_method_id: shipping_tax_lines.map((t) => t.shipping_line_id),
+            })
+            : [],
+        item_tax_lines.length
+            ? cartService.listLineItemTaxLines({
+                item_id: item_tax_lines.map((t) => t.line_item_id),
+            })
+            : [],
+    ]);
+    const itemsTaxLinesData = normalizeItemTaxLinesForCart(item_tax_lines, existingLineItemTaxLines);
+    const shippingTaxLinesData = normalizeShippingTaxLinesForCart(shipping_tax_lines, existingShippingMethodTaxLines);
+    await (0, utils_1.promiseAll)([
+        itemsTaxLinesData.length
+            ? cartService.upsertLineItemTaxLines(itemsTaxLinesData)
+            : [],
+        shippingTaxLinesData.length
+            ? cartService.upsertShippingMethodTaxLines(shippingTaxLinesData)
+            : [],
+    ]);
+    return new workflows_sdk_1.StepResponse(null, {
+        cart,
+        existingLineItemTaxLines,
+        existingShippingMethodTaxLines,
+    });
+}, async (revertData, { container }) => {
+    if (!revertData) {
+        return;
+    }
+    const { existingLineItemTaxLines, existingShippingMethodTaxLines } = revertData;
+    const cartService = container.resolve(utils_1.Modules.CART);
+    if (existingLineItemTaxLines) {
+        await cartService.upsertLineItemTaxLines(existingLineItemTaxLines.map((taxLine) => ({
+            description: taxLine.description,
+            tax_rate_id: taxLine.tax_rate_id,
+            code: taxLine.code,
+            rate: taxLine.rate,
+            provider_id: taxLine.provider_id,
+            item_id: taxLine.item_id,
+        })));
+    }
+    await cartService.upsertShippingMethodTaxLines(existingShippingMethodTaxLines.map((taxLine) => ({
+        description: taxLine.description,
+        tax_rate_id: taxLine.tax_rate_id,
+        code: taxLine.code,
+        rate: taxLine.rate,
+        provider_id: taxLine.provider_id,
+        shipping_method_id: taxLine.shipping_method_id,
+    })));
+});
+function normalizeItemTaxLinesForCart(taxLines, existingTaxLines) {
+    return taxLines.map((taxLine) => ({
+        id: existingTaxLines.find((t) => t.item_id === taxLine.line_item_id)?.id,
+        description: taxLine.name,
+        tax_rate_id: taxLine.rate_id,
+        code: taxLine.code,
+        rate: taxLine.rate,
+        provider_id: taxLine.provider_id,
+        item_id: taxLine.line_item_id,
+    }));
+}
+function normalizeShippingTaxLinesForCart(taxLines, existingTaxLines) {
+    return taxLines.map((taxLine) => ({
+        id: existingTaxLines.find((t) => t.shipping_method_id === taxLine.shipping_line_id)?.id,
+        description: taxLine.name,
+        tax_rate_id: taxLine.rate_id,
+        code: taxLine.code,
+        rate: taxLine.rate,
+        provider_id: taxLine.provider_id,
+        shipping_method_id: taxLine.shipping_line_id,
+    }));
+}
+//# sourceMappingURL=upsert-tax-lines-for-items.js.map

package/dist/cart/steps/upsert-tax-lines-for-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsert-tax-lines-for-items.js","sourceRoot":"","sources":["../../../src/cart/steps/upsert-tax-lines-for-items.ts"],"names":[],"mappings":";;;AAUA,oDAA8D;AAC9D,oEAA2E;AAoB9D,QAAA,4BAA4B,GAAG,yBAAyB,CAAA;AACrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,0BAA0B,GAAG,IAAA,0BAAU,EAClD,oCAA4B,EAC5B,KAAK,EAAE,IAAkC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC1D,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;IACzD,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEvE,MAAM,CAAC,8BAA8B,EAAE,wBAAwB,CAAC,GAC9D,MAAM,IAAA,kBAAU,EAAC;QACf,kBAAkB,CAAC,MAAM;YACvB,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC;gBACrC,kBAAkB,EAAE,kBAAkB,CAAC,GAAG,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAC1B;aACF,CAAC;YACJ,CAAC,CAAC,EAAE;QAEN,cAAc,CAAC,MAAM;YACnB,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC;gBAC/B,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;aACnD,CAAC;YACJ,CAAC,CAAC,EAAE;KACP,CAAC,CAAA;IAEJ,MAAM,iBAAiB,GAAG,4BAA4B,CACpD,cAAc,EACd,wBAAwB,CACzB,CAAA;IACD,MAAM,oBAAoB,GAAG,gCAAgC,CAC3D,kBAAkB,EAClB,8BAA8B,CAC/B,CAAA;IAED,MAAM,IAAA,kBAAU,EAAC;QACf,iBAAiB,CAAC,MAAM;YACtB,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,iBAAiB,CAAC;YACvD,CAAC,CAAC,EAAE;QACN,oBAAoB,CAAC,MAAM;YACzB,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,oBAAoB,CAAC;YAChE,CAAC,CAAC,EAAE;KACP,CAAC,CAAA;IAEF,OAAO,IAAI,4BAAY,CAAC,IAAI,EAAE;QAC5B,IAAI;QACJ,wBAAwB;QACxB,8BAA8B;KAC/B,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAM;IACR,CAAC;IAED,MAAM,EAAE,wBAAwB,EAAE,8BAA8B,EAAE,GAChE,UAAU,CAAA;IAEZ,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEvE,IAAI,wBAAwB,EAAE,CAAC;QAC7B,MAAM,WAAW,CAAC,sBAAsB,CACtC,wBAAwB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACzC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAC,CACJ,CAAA;IACH,CAAC;IAED,MAAM,WAAW,CAAC,4BAA4B,CAC5C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;KAC/C,CAAC,CAAC,CACJ,CAAA;AACH,CAAC,CACF,CAAA;AAED,SAAS,4BAA4B,CACnC,QAA0B,EAC1B,gBAAsC;IAEtC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAyC,EAAE,EAAE,CAAC,CAAC;QAClE,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE;QACxE,WAAW,EAAE,OAAO,CAAC,IAAI;QACzB,WAAW,EAAE,OAAO,CAAC,OAAO;QAC5B,IAAI,EAAE,OAAO,CAAC,IAAK;QACnB,IAAI,EAAE,OAAO,CAAC,IAAK;QACnB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,OAAO,EAAE,OAAO,CAAC,YAAY;KAC9B,CAAC,CAAC,CAAA;AACL,CAAC;AAED,SAAS,gCAAgC,CACvC,QAA8B,EAC9B,gBAA4C;IAE5C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA6C,EAAE,EAAE,CAAC,CAAC;QACtE,EAAE,EAAE,gBAAgB,CAAC,IAAI,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,KAAK,OAAO,CAAC,gBAAgB,CACzD,EAAE,EAAE;QACL,WAAW,EAAE,OAAO,CAAC,IAAI;QACzB,WAAW,EAAE,OAAO,CAAC,OAAO;QAC5B,IAAI,EAAE,OAAO,CAAC,IAAK;QACnB,IAAI,EAAE,OAAO,CAAC,IAAK;QACnB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,kBAAkB,EAAE,OAAO,CAAC,gBAAgB;KAC7C,CAAC,CAAC,CAAA;AACL,CAAC"}

package/dist/cart/steps/validate-cart-payments.d.ts

@@ -0,0 +1,30 @@
+import type { CartWorkflowDTO } from "@acmekit/framework/types";
+/**
+ * The cart's details.
+ */
+export interface ValidateCartPaymentsStepInput {
+    /**
+     * The cart to validate payment sessions for.
+     */
+    cart: CartWorkflowDTO;
+}
+export declare const validateCartPaymentsStepId = "validate-cart-payments";
+/**
+ * This step validates a cart's payment sessions. Their status must
+ * be `pending`, `requires_more`, `authorized`, or `captured`. If not valid, the step throws an error.
+ *
+ * :::tip
+ *
+ * You can use the {@link retrieveCartStep} to retrieve a cart's details.
+ *
+ * :::
+ *
+ * @example
+ * const data = validateCartPaymentsStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart
+ * })
+ */
+export declare const validateCartPaymentsStep: import("@acmekit/framework/workflows-sdk").StepFunction<ValidateCartPaymentsStepInput, import("@acmekit/framework/types").PaymentSessionDTO[]>;
+//# sourceMappingURL=validate-cart-payments.d.ts.map

package/dist/cart/steps/validate-cart-payments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart-payments.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart-payments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAS/D;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,eAAe,CAAA;CACtB;AAED,eAAO,MAAM,0BAA0B,2BAA2B,CAAA;AAClE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,gJA2CpC,CAAA"}

package/dist/cart/steps/validate-cart-payments.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCartPaymentsStep = exports.validateCartPaymentsStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateCartPaymentsStepId = "validate-cart-payments";
+/**
+ * This step validates a cart's payment sessions. Their status must
+ * be `pending`, `requires_more`, `authorized`, or `captured`. If not valid, the step throws an error.
+ *
+ * :::tip
+ *
+ * You can use the {@link retrieveCartStep} to retrieve a cart's details.
+ *
+ * :::
+ *
+ * @example
+ * const data = validateCartPaymentsStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart
+ * })
+ */
+exports.validateCartPaymentsStep = (0, workflows_sdk_1.createStep)(exports.validateCartPaymentsStepId, async (data) => {
+    const { cart: { payment_collection: paymentCollection, total, credit_line_total }, } = data;
+    const canSkipPayment = utils_1.MathBN.convert(credit_line_total).gte(0) && utils_1.MathBN.convert(total).lte(0);
+    if (canSkipPayment) {
+        return new workflows_sdk_1.StepResponse([]);
+    }
+    if (!(0, utils_1.isPresent)(paymentCollection)) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Payment collection has not been initiated for cart`);
+    }
+    // We check if any of these payment sessions are present in the cart
+    // If not, we throw an error for the consumer to provide a processable payment session
+    const processablePaymentStatuses = [
+        utils_1.PaymentSessionStatus.PENDING,
+        utils_1.PaymentSessionStatus.REQUIRES_MORE,
+        utils_1.PaymentSessionStatus.AUTHORIZED, // E.g. payment was authorized, but the cart was not completed
+        utils_1.PaymentSessionStatus.CAPTURED, // E.g. payment was captured, but the cart was not completed
+    ];
+    const paymentsToProcess = paymentCollection.payment_sessions?.filter((ps) => processablePaymentStatuses.includes(ps.status));
+    if (!paymentsToProcess?.length) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Payment sessions are required to complete cart`);
+    }
+    return new workflows_sdk_1.StepResponse(paymentsToProcess);
+});
+//# sourceMappingURL=validate-cart-payments.js.map

package/dist/cart/steps/validate-cart-payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart-payments.js","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart-payments.ts"],"names":[],"mappings":";;;AACA,oDAKiC;AACjC,oEAA2E;AAY9D,QAAA,0BAA0B,GAAG,wBAAwB,CAAA;AAClE;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,wBAAwB,GAAG,IAAA,0BAAU,EAChD,kCAA0B,EAC1B,KAAK,EAAE,IAAmC,EAAE,EAAE;IAC5C,MAAM,EACJ,IAAI,EAAE,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAC1E,GAAG,IAAI,CAAA;IAER,MAAM,cAAc,GAClB,cAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,cAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAE1E,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,IAAI,4BAAY,CAAC,EAAE,CAAC,CAAA;IAC7B,CAAC;IAED,IAAI,CAAC,IAAA,iBAAS,EAAC,iBAAiB,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,oDAAoD,CACrD,CAAA;IACH,CAAC;IAED,oEAAoE;IACpE,sFAAsF;IACtF,MAAM,0BAA0B,GAAG;QACjC,4BAAoB,CAAC,OAAO;QAC5B,4BAAoB,CAAC,aAAa;QAClC,4BAAoB,CAAC,UAAU,EAAE,8DAA8D;QAC/F,4BAAoB,CAAC,QAAQ,EAAE,4DAA4D;KAC5F,CAAA;IAED,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAC1E,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,MAA8B,CAAC,CACvE,CAAA;IAED,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,gDAAgD,CACjD,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,iBAAiB,CAAC,CAAA;AAC5C,CAAC,CACF,CAAA"}

package/dist/cart/steps/validate-cart-shipping-options.d.ts

@@ -0,0 +1,50 @@
+import type { CartDTO } from "@acmekit/framework/types";
+/**
+ * The details of the cart and its shipping options context.
+ */
+export interface ValidateCartShippingOptionsStepInput {
+    /**
+     * The cart to validate shipping options for.
+     */
+    cart?: CartDTO;
+    /**
+     * The context to validate the shipping options.
+     */
+    shippingOptionsContext?: {
+        /**
+         * Validate whether the shipping options are enabled in the store.
+         */
+        enabled_in_store?: "true" | "false";
+        /**
+         * Validate whether the shipping options are used for returns.
+         */
+        is_return?: "true" | "false";
+    };
+    /**
+     * The IDs of the shipping options to validate.
+     */
+    option_ids: string[];
+    /**
+     * Pre-fetched shipping options. If provided, validation will be done against these
+     * instead of querying the database.
+     */
+    prefetched_shipping_options?: {
+        id: string;
+    }[];
+}
+export declare const validateCartShippingOptionsStepId = "validate-cart-shipping-options";
+/**
+ * This step validates shipping options to ensure they can be applied on a cart.
+ * If not valid, the step throws an error.
+ *
+ * @example
+ * const data = validateCartShippingOptionsStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart,
+ *   option_ids: ["so_123"],
+ *   shippingOptionsContext: {}
+ * })
+ */
+export declare const validateCartShippingOptionsStep: import("@acmekit/framework/workflows-sdk").StepFunction<ValidateCartShippingOptionsStepInput, undefined>;
+//# sourceMappingURL=validate-cart-shipping-options.d.ts.map

package/dist/cart/steps/validate-cart-shipping-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart-shipping-options.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart-shipping-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAER,MAAM,0BAA0B,CAAA;AAQjC;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,sBAAsB,CAAC,EAAE;QACvB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;QACnC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,2BAA2B,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC/C;AAED,eAAO,MAAM,iCAAiC,mCACZ,CAAA;AAClC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,+BAA+B,0GA2D3C,CAAA"}

package/dist/cart/steps/validate-cart-shipping-options.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCartShippingOptionsStep = exports.validateCartShippingOptionsStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateCartShippingOptionsStepId = "validate-cart-shipping-options";
+/**
+ * This step validates shipping options to ensure they can be applied on a cart.
+ * If not valid, the step throws an error.
+ *
+ * @example
+ * const data = validateCartShippingOptionsStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart,
+ *   option_ids: ["so_123"],
+ *   shippingOptionsContext: {}
+ * })
+ */
+exports.validateCartShippingOptionsStep = (0, workflows_sdk_1.createStep)(exports.validateCartShippingOptionsStepId, async (data, { container }) => {
+    const { option_ids: optionIds = [], cart, shippingOptionsContext, prefetched_shipping_options: prefetchedShippingOptions, } = data;
+    if (!optionIds.length) {
+        return new workflows_sdk_1.StepResponse(void 0);
+    }
+    let validShippingOptionIds;
+    if (!prefetchedShippingOptions) {
+        if (!cart || !shippingOptionsContext) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Cart and shippingOptionsContext need to be defined if prefetchedShippingOptions is not.`);
+        }
+        // Legacy behavior: query the database
+        const fulfillmentModule = container.resolve(utils_1.Modules.FULFILLMENT);
+        const validShippingOptions = await fulfillmentModule.listShippingOptionsForContext({
+            id: optionIds,
+            context: shippingOptionsContext,
+            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,
+            },
+        }, { relations: ["rules"] });
+        validShippingOptionIds = validShippingOptions.map((o) => o.id);
+    }
+    else {
+        validShippingOptionIds = prefetchedShippingOptions.map((o) => o.id);
+    }
+    const invalidOptionIds = (0, utils_1.arrayDifference)(optionIds, validShippingOptionIds);
+    if (invalidOptionIds.length) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Shipping Options are invalid for cart.`);
+    }
+    return new workflows_sdk_1.StepResponse(void 0);
+});
+//# sourceMappingURL=validate-cart-shipping-options.js.map

package/dist/cart/steps/validate-cart-shipping-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart-shipping-options.js","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart-shipping-options.ts"],"names":[],"mappings":";;;AAIA,oDAIiC;AACjC,oEAA2E;AAkC9D,QAAA,iCAAiC,GAC5C,gCAAgC,CAAA;AAClC;;;;;;;;;;;;GAYG;AACU,QAAA,+BAA+B,GAAG,IAAA,0BAAU,EACvD,yCAAiC,EACjC,KAAK,EAAE,IAA0C,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClE,MAAM,EACJ,UAAU,EAAE,SAAS,GAAG,EAAE,EAC1B,IAAI,EACJ,sBAAsB,EACtB,2BAA2B,EAAE,yBAAyB,GACvD,GAAG,IAAI,CAAA;IAER,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,sBAAgC,CAAA;IACpC,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YACrC,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,yFAAyF,CAC1F,CAAA;QACH,CAAC;QAED,sCAAsC;QACtC,MAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,CACzC,eAAO,CAAC,WAAW,CACpB,CAAA;QAED,MAAM,oBAAoB,GACxB,MAAM,iBAAiB,CAAC,6BAA6B,CACnD;YACE,EAAE,EAAE,SAAS;YACb,OAAO,EAAE,sBAAsB;YAC/B,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,EACD,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,CACzB,CAAA;QAEH,sBAAsB,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAChE,CAAC;SAAM,CAAC;QACN,sBAAsB,GAAG,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACrE,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,sBAAsB,CAAC,CAAA;IAE3E,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,wCAAwC,CACzC,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,CACF,CAAA"}

package/dist/cart/steps/validate-cart.d.ts

@@ -0,0 +1,30 @@
+import type { CartDTO, CartWorkflowDTO } from "@acmekit/framework/types";
+/**
+ * The details of the cart to validate.
+ */
+export interface ValidateCartStepInput {
+    /**
+     * The cart to validate.
+     */
+    cart: CartWorkflowDTO | CartDTO;
+}
+export declare const validateCartStepId = "validate-cart";
+/**
+ * This step validates a cart to ensure it exists and is not completed.
+ * If not valid, the step throws an error.
+ *
+ * :::tip
+ *
+ * You can use the {@link retrieveCartStep} to retrieve a cart's details.
+ *
+ * :::
+ *
+ * @example
+ * const data = validateCartStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart,
+ * })
+ */
+export declare const validateCartStep: import("@acmekit/framework/workflows-sdk").StepFunction<ValidateCartStepInput, unknown>;
+//# sourceMappingURL=validate-cart.d.ts.map

package/dist/cart/steps/validate-cart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAIxE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,OAAO,CAAA;CAChC;AAED,eAAO,MAAM,kBAAkB,kBAAkB,CAAA;AACjD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB,yFAY5B,CAAA"}

package/dist/cart/steps/validate-cart.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCartStep = exports.validateCartStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateCartStepId = "validate-cart";
+/**
+ * This step validates a cart to ensure it exists and is not completed.
+ * If not valid, the step throws an error.
+ *
+ * :::tip
+ *
+ * You can use the {@link retrieveCartStep} to retrieve a cart's details.
+ *
+ * :::
+ *
+ * @example
+ * const data = validateCartStep({
+ *   // retrieve the details of the cart from another workflow
+ *   // or in another step using the Cart Module's service
+ *   cart,
+ * })
+ */
+exports.validateCartStep = (0, workflows_sdk_1.createStep)(exports.validateCartStepId, async (data) => {
+    const { cart } = data;
+    if (cart.completed_at) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Cart ${cart.id} is already completed.`);
+    }
+});
+//# sourceMappingURL=validate-cart.js.map

package/dist/cart/steps/validate-cart.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-cart.js","sourceRoot":"","sources":["../../../src/cart/steps/validate-cart.ts"],"names":[],"mappings":";;;AACA,oDAAuD;AACvD,oEAA6D;AAYhD,QAAA,kBAAkB,GAAG,eAAe,CAAA;AACjD;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,gBAAgB,GAAG,IAAA,0BAAU,EACxC,0BAAkB,EAClB,KAAK,EAAE,IAA2B,EAAE,EAAE;IACpC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;IAErB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,QAAQ,IAAI,CAAC,EAAE,wBAAwB,CACxC,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}

package/dist/cart/steps/validate-line-item-prices.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The details of the line items to validate.
+ */
+export interface ValidateLineItemPricesStepInput {
+    /**
+     * The line items to validate.
+     */
+    items: {
+        /**
+         * The price of the line item.
+         */
+        unit_price?: number | null;
+        /**
+         * The title of the line item.
+         */
+        title: string;
+    }[];
+}
+export declare const validateLineItemPricesStepId = "validate-line-item-prices";
+/**
+ * This step validates the specified line item objects to ensure they have prices.
+ * If an item doesn't have a price, the step throws an error.
+ *
+ * @example
+ * const data = validateLineItemPricesStep({
+ *   items: [
+ *     {
+ *       unit_price: 10,
+ *       title: "Shirt"
+ *     },
+ *     {
+ *       title: "Pants"
+ *     }
+ *   ]
+ * })
+ */
+export declare const validateLineItemPricesStep: import("@acmekit/framework/workflows-sdk").StepFunction<ValidateLineItemPricesStepInput, unknown>;
+//# sourceMappingURL=validate-line-item-prices.d.ts.map

package/dist/cart/steps/validate-line-item-prices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-line-item-prices.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-line-item-prices.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC1B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ;AAED,eAAO,MAAM,4BAA4B,8BAA8B,CAAA;AACvE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,0BAA0B,mGAqBtC,CAAA"}

package/dist/cart/steps/validate-line-item-prices.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateLineItemPricesStep = exports.validateLineItemPricesStepId = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateLineItemPricesStepId = "validate-line-item-prices";
+/**
+ * This step validates the specified line item objects to ensure they have prices.
+ * If an item doesn't have a price, the step throws an error.
+ *
+ * @example
+ * const data = validateLineItemPricesStep({
+ *   items: [
+ *     {
+ *       unit_price: 10,
+ *       title: "Shirt"
+ *     },
+ *     {
+ *       title: "Pants"
+ *     }
+ *   ]
+ * })
+ */
+exports.validateLineItemPricesStep = (0, workflows_sdk_1.createStep)(exports.validateLineItemPricesStepId, async (data, { container }) => {
+    if (!data.items?.length) {
+        return;
+    }
+    const priceNotFound = [];
+    for (const item of data.items) {
+        if (!(0, utils_1.isPresent)(item?.unit_price)) {
+            priceNotFound.push(item.title);
+        }
+    }
+    if (priceNotFound.length > 0) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Items ${priceNotFound.join(", ")} do not have a price`);
+    }
+});
+//# sourceMappingURL=validate-line-item-prices.js.map

package/dist/cart/steps/validate-line-item-prices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-line-item-prices.js","sourceRoot":"","sources":["../../../src/cart/steps/validate-line-item-prices.ts"],"names":[],"mappings":";;;AAAA,oDAAkE;AAClE,oEAA6D;AAqBhD,QAAA,4BAA4B,GAAG,2BAA2B,CAAA;AACvE;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,0BAA0B,GAAG,IAAA,0BAAU,EAClD,oCAA4B,EAC5B,KAAK,EAAE,IAAqC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,aAAa,GAAa,EAAE,CAAA;IAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAA,iBAAS,EAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;YACjC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,SAAS,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CACxD,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}

package/dist/cart/steps/validate-sales-channel.d.ts

@@ -0,0 +1,5 @@
+import type { SalesChannelDTO } from "@acmekit/framework/types";
+export declare const validateSalesChannelStep: import("@acmekit/framework/workflows-sdk").StepFunction<{
+    salesChannel: SalesChannelDTO;
+}, undefined>;
+//# sourceMappingURL=validate-sales-channel.d.ts.map

package/dist/cart/steps/validate-sales-channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-sales-channel.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-sales-channel.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE/D,eAAO,MAAM,wBAAwB;kBAEN,eAAe;aAY7C,CAAA"}

package/dist/cart/steps/validate-sales-channel.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSalesChannelStep = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+exports.validateSalesChannelStep = (0, workflows_sdk_1.createStep)("validate-sales-channel", async (data) => {
+    const { salesChannel } = data;
+    if (!salesChannel?.id) {
+        throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, "Sales channel is required when creating a cart. Either provide a sales channel ID or set the default sales channel for the store.");
+    }
+    return new workflows_sdk_1.StepResponse(void 0);
+});
+//# sourceMappingURL=validate-sales-channel.js.map

package/dist/cart/steps/validate-sales-channel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-sales-channel.js","sourceRoot":"","sources":["../../../src/cart/steps/validate-sales-channel.ts"],"names":[],"mappings":";;;AAAA,oDAAuD;AACvD,oEAA2E;AAI9D,QAAA,wBAAwB,GAAG,IAAA,0BAAU,EAChD,wBAAwB,EACxB,KAAK,EAAE,IAAuC,EAAE,EAAE;IAChD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;IAE7B,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,mIAAmI,CACpI,CAAA;IACH,CAAC;IAED,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,CACF,CAAA"}

package/dist/cart/steps/validate-shipping-methods-data.d.ts

@@ -0,0 +1,93 @@
+import { ValidateFulfillmentDataContext } from "@acmekit/framework/types";
+/**
+ * The details of the shipping methods to validate.
+ */
+export type ValidateShippingMethodsDataInput = {
+    /**
+     * The shipping method's ID.
+     */
+    id: string;
+    /**
+     * The fulfillment provider ID that associated with the shipping option
+     * that the method was created from.
+     */
+    provider_id: string;
+    /**
+     * The `data` property of the shipping option that the shipping method was
+     * created from.
+     */
+    option_data: Record<string, unknown>;
+    /**
+     * The `data` property of the shipping method.
+     */
+    method_data: Record<string, unknown>;
+    /**
+     * The context to validate the shipping method.
+     */
+    context: ValidateFulfillmentDataContext;
+}[];
+/**
+ * The validated data of the shipping methods.
+ */
+export type ValidateShippingMethodsDataOutput = void | {
+    [x: string]: Record<string, unknown>;
+}[];
+export declare const validateAndReturnShippingMethodsDataStepId = "validate-and-return-shipping-methods-data";
+/**
+ * This step validates shipping options to ensure they can be applied on a cart.
+ * The step either returns the validated data or void.
+ *
+ * @example
+ * const data = validateAndReturnShippingMethodsDataStep({
+ *   id: "sm_123",
+ *   provider_id: "my_provider",
+ *   option_data: {},
+ *   method_data: {},
+ *   context: {
+ *     id: "cart_123",
+ *     shipping_address: {
+ *       id: "saddr_123",
+ *       first_name: "Jane",
+ *       last_name: "Smith",
+ *       address_1: "456 Elm St",
+ *       city: "Shelbyville",
+ *       country_code: "us",
+ *       postal_code: "67890",
+ *     },
+ *     items: [
+ *       {
+ *         variant: {
+ *           id: "variant_123",
+ *           weight: 1,
+ *           length: 1,
+ *           height: 1,
+ *           width: 1,
+ *           material: "wood",
+ *           product: {
+ *             id: "prod_123"
+ *           }
+ *         }
+ *       }
+ *     ],
+ *     product: {
+ *       id: "prod_123",
+ *       collection_id: "pcol_123",
+ *       categories: [],
+ *       tags: []
+ *     },
+ *     from_location: {
+ *       id: "sloc_123",
+ *       first_name: "John",
+ *       last_name: "Doe",
+ *       address_1: "123 Main St",
+ *       city: "Springfield",
+ *       country_code: "us",
+ *       postal_code: "12345",
+ *     },
+ *   }
+ * })
+ */
+export declare const validateAndReturnShippingMethodsDataStep: import("@acmekit/workflows-sdk").StepFunction<ValidateShippingMethodsDataInput, {
+    [x: string]: Record<string, unknown>;
+}[] | undefined>;
+//# sourceMappingURL=validate-shipping-methods-data.d.ts.map

package/dist/cart/steps/validate-shipping-methods-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-shipping-methods-data.d.ts","sourceRoot":"","sources":["../../../src/cart/steps/validate-shipping-methods-data.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,8BAA8B,EAC/B,MAAM,0BAA0B,CAAA;AAGjC;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC;;OAEG;IACH,OAAO,EAAE,8BAA8B,CAAA;CACxC,EAAE,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACzC,IAAI,GACJ;IACE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC,EAAE,CAAA;AAEP,eAAO,MAAM,0CAA0C,8CACV,CAAA;AAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,eAAO,MAAM,wCAAwC;;gBA8BpD,CAAA"}