feat(core-flows,fulfillment, fulfillment-manual, types): make fulfill…

…ment typings more specific (#10677) **What** - attempt to add more specific type definitions around fulfillment provider APIs --- CLOSES CMRC-814 CLOSES CMRC-816 CLOSES CMRC-817
medusajs · Jan 7, 2025 · 16b0672 · 16b0672
1 parent 333ed53
commit 16b0672
Show file tree

Hide file tree

Showing 12 changed files with 1,358 additions and 68 deletions.
diff --git a/...sts/http/src/utils/providers/fulfillment-manual-calculated/services/manual-fulfillment.ts b/...sts/http/src/utils/providers/fulfillment-manual-calculated/services/manual-fulfillment.ts
@@ -41,14 +41,17 @@ export class ManualFulfillmentService extends AbstractFulfillmentProviderService
 
   async createFulfillment() {
     // No data is being sent anywhere
-    return {}
+    return {
+      data: {},
+      labels: [],
+    }
   }
 
   async cancelFulfillment() {
     return {}
   }
 
   async createReturnFulfillment() {
-    return {}
+    return { data: {}, labels: [] }
   }
 }
diff --git a/packages/core/core-flows/src/cart/steps/validate-shipping-methods-data.ts b/packages/core/core-flows/src/cart/steps/validate-shipping-methods-data.ts
@@ -1,8 +1,7 @@
 import { Modules, promiseAll } from "@medusajs/framework/utils"
 import {
-  CartDTO,
   IFulfillmentModuleService,
-  StockLocationDTO,
+  ValidateFulfillmentDataContext,
 } from "@medusajs/types"
 import { createStep, StepResponse } from "@medusajs/workflows-sdk"
 
@@ -11,7 +10,7 @@ export type ValidateShippingMethodsDataInput = {
   provider_id: string
   option_data: Record<string, unknown>
   method_data: Record<string, unknown>
-  context: CartDTO & { from_location: StockLocationDTO; [k: string]: unknown }
+  context: ValidateFulfillmentDataContext
 }[]
 
 export const validateAndReturnShippingMethodsDataStepId =
@@ -38,7 +37,7 @@ export const validateAndReturnShippingMethodsDataStep = createStep(
           option.provider_id,
           option.option_data,
           option.method_data,
-          option.context
+          option.context as ValidateFulfillmentDataContext
         )
 
         return {

diff --git a/packages/core/types/src/fulfillment/common/cart.ts b/packages/core/types/src/fulfillment/common/cart.ts
@@ -0,0 +1,29 @@
+import { CartDTO } from "../.."
+
+export type CartPropsForFulfillment = {
+  id: CartDTO["id"]
+  shipping_address: CartDTO["shipping_address"]
+  items: CartDTO["items"] & {
+    variant: {
+      id: string
+      weight: number
+      length: number
+      height: number
+      width: number
+      material: string
+      product: {
+        id: string
+      }
+    }
+    product: {
+      id: string
+      collection_id: string
+      categories: {
+        id: string
+      }[]
+      tags: {
+        id: string
+      }[]
+    }
+  }
+}
diff --git a/packages/core/types/src/fulfillment/common/index.ts b/packages/core/types/src/fulfillment/common/index.ts
@@ -10,3 +10,5 @@ export * from "./fulfillment-provider"
 export * from "./fulfillment"
 export * from "./fulfillment-item"
 export * from "./fulfillment-label"
+export * from "./cart"
+export * from "./order"