feat(core-flows, medusa): add shipping methods to cart API

integration-tests/modules/__tests__/cart/store/cart.workflows.spec.ts

@@ -1530,7 +1530,7 @@ medusaIntegrationTestRunner({
             expect.objectContaining({
               error: expect.objectContaining({
                 message:
-                  "Shipping Options (Test shipping option) are invalid for cart. Add a valid shipping option or remove existing invalid shipping options before continuing.",
+                  "Shipping Options (Test shipping option) are invalid for cart.",
                 type: "invalid_data",
               }),
             }),

packages/core-flows/src/definition/cart/steps/index.ts

@@ -13,6 +13,7 @@ export * from "./get-shipping-option-price-sets"
 export * from "./get-variant-price-sets"
 export * from "./get-variants"
 export * from "./prepare-adjustments-from-promotion-actions"
+export * from "./refresh-cart-shipping-methods"
 export * from "./remove-line-item-adjustments"
 export * from "./remove-shipping-method-adjustments"
 export * from "./retrieve-cart"

packages/core-flows/src/definition/cart/steps/refresh-cart-shipping-methods.ts

@@ -0,0 +1,89 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { CartDTO, ICartModuleService } from "@medusajs/types"
+import { arrayDifference } from "@medusajs/utils"
+import { createStep, StepResponse } from "@medusajs/workflows-sdk"
+import { IFulfillmentModuleService } from "../../../../../types/dist/fulfillment/service"
+
+interface StepInput {
+  cart: CartDTO
+}
+
+export const refreshCartShippingMethodsStepId = "refresh-cart-shipping-methods"
+export const refreshCartShippingMethodsStep = createStep(
+  refreshCartShippingMethodsStepId,
+  async (data: StepInput, { container }) => {
+    const { cart } = data
+    const { shipping_methods: shippingMethods = [] } = cart
+
+    if (!shippingMethods?.length) {
+      return new StepResponse(void 0)
+    }
+
+    const fulfillmentModule = container.resolve<IFulfillmentModuleService>(
+      ModuleRegistrationName.FULFILLMENT
+    )
+
+    const cartModule = container.resolve<ICartModuleService>(
+      ModuleRegistrationName.CART
+    )
+
+    const shippingMethodsToDelete: string[] = []
+    const shippingOptionIds: string[] = shippingMethods.map(
+      (sm) => sm.shipping_option_id!
+    )
+
+    const shippingOptions = await fulfillmentModule.listShippingOptions(
+      { id: shippingOptionIds },
+      { select: ["id", "name"], take: null }
+    )
+
+    const diff = arrayDifference<string>(
+      shippingOptionIds,
+      shippingOptions.map((o) => o.id)
+    )
+
+    // If any shipping methods are found without shipping_option_id, delete them
+    if (diff.length) {
+      shippingMethodsToDelete.push(...diff)
+    }
+
+    const validShippingOptions =
+      await fulfillmentModule.listShippingOptionsForContext(
+        {
+          id: shippingOptionIds,
+          context: { ...cart },
+          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"] }
+      )
+
+    const invalidOptionIds = arrayDifference(
+      shippingOptionIds,
+      validShippingOptions.map((o) => o.id)
+    )
+
+    if (invalidOptionIds.length) {
+      shippingMethodsToDelete.push(...invalidOptionIds)
+    }
+
+    if (shippingMethodsToDelete.length) {
+      await cartModule.softDeleteShippingMethods(shippingMethodsToDelete)
+    }
+
+    return new StepResponse(void 0, shippingMethodsToDelete)
+  },
+  async (shippingMethodsToRestore, { container }) => {
+    if (shippingMethodsToRestore?.length) {
+      const cartModule = container.resolve<ICartModuleService>(
+        ModuleRegistrationName.CART
+      )
+
+      await cartModule.restoreShippingMethods(shippingMethodsToRestore)
+    }
+  }
+)

packages/core-flows/src/definition/cart/steps/validate-cart-shipping-options.ts

@@ -69,7 +69,7 @@ export const validateCartShippingOptionsStep = createStep(
 
       throw new MedusaError(
         MedusaError.Types.INVALID_DATA,
-        `Shipping Options (${invalidOptionNames}) are invalid for cart. Add a valid shipping option or remove existing invalid shipping options before continuing.`
+        `Shipping Options (${invalidOptionNames}) are invalid for cart.`
       )
     }
 

packages/core-flows/src/definition/cart/workflows/add-to-cart.ts

@@ -14,6 +14,7 @@ import {
   confirmInventoryStep,
   getVariantPriceSetsStep,
   getVariantsStep,
+  refreshCartShippingMethodsStep,
   validateVariantsExistStep,
 } from "../steps"
 import { refreshCartPromotionsStep } from "../steps/refresh-cart-promotions"
@@ -22,6 +23,19 @@ import { prepareConfirmInventoryInput } from "../utils/prepare-confirm-inventory
 import { prepareLineItemData } from "../utils/prepare-line-item-data"
 import { refreshPaymentCollectionForCartStep } from "./refresh-payment-collection"
 
+const cartFields = [
+  "region_id",
+  "currency_code",
+  "region.*",
+  "items.*",
+  "items.tax_lines.*",
+  "shipping_address.*",
+  "shipping_methods.*",
+  "shipping_methods.tax_lines*",
+  "customer.*",
+  "customer.groups.*",
+]
+
 // TODO: The AddToCartWorkflow are missing the following steps:
 // - Refresh/delete shipping methods (fulfillment module)
 
@@ -128,15 +142,17 @@ export const addToCartWorkflow = createWorkflow(
 
     const items = addToCartStep({ items: lineItems })
 
-    updateTaxLinesStep({
-      cart_or_cart_id: input.cart,
-      items,
+    const cart = useRemoteQueryStep({
+      entry_point: "cart",
+      fields: cartFields,
+      variables: { id: input.cart.id },
+      list: false,
     })
 
+    refreshCartShippingMethodsStep({ cart })
+    updateTaxLinesStep({ cart_or_cart_id: cart, items })
     refreshCartPromotionsStep({ id: input.cart.id })
-    refreshPaymentCollectionForCartStep({
-      cart_id: input.cart.id,
-    })
+    refreshPaymentCollectionForCartStep({ cart_id: input.cart.id })
 
     return items
   }

packages/utils/src/common/array-difference.ts

@@ -1,9 +1,9 @@
 type ArrayDifferenceElement = string | number
 
-export function arrayDifference(
-  mainArray: ArrayDifferenceElement[],
-  differingArray: ArrayDifferenceElement[]
-): ArrayDifferenceElement[] {
+export function arrayDifference<TElement = ArrayDifferenceElement>(
+  mainArray: TElement[],
+  differingArray: TElement[]
+): TElement[] {
   const mainArraySet = new Set(mainArray)
   const differingArraySet = new Set(differingArray)