feature: introduce additional_data to the product endpoints (#8405)

packages/core/core-flows/src/product/workflows/create-collections.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -9,8 +9,7 @@ import { createCollectionsStep } from "../steps"
 
 type WorkflowInput = {
   collections: ProductTypes.CreateProductCollectionDTO[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 export const createCollectionsWorkflowId = "create-collections"
 export const createCollectionsWorkflow = createWorkflow(

packages/core/core-flows/src/product/workflows/create-product-options.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -9,8 +9,7 @@ import { createProductOptionsStep } from "../steps"
 
 type WorkflowInput = {
   product_options: ProductTypes.CreateProductOptionDTO[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 export const createProductOptionsWorkflowId = "create-product-options"
 

packages/core/core-flows/src/product/workflows/create-product-tags.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -9,8 +9,7 @@ import { createProductTagsStep } from "../steps"
 
 type WorkflowInput = {
   product_tags: ProductTypes.CreateProductTagDTO[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 export const createProductTagsWorkflowId = "create-product-tags"
 

packages/core/core-flows/src/product/workflows/create-product-types.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -9,8 +9,7 @@ import { createProductTypesStep } from "../steps"
 
 type WorkflowInput = {
   product_types: ProductTypes.CreateProductTypeDTO[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 export const createProductTypesWorkflowId = "create-product-types"
 

packages/core/core-flows/src/product/workflows/create-product-variants.ts

@@ -1,5 +1,10 @@
 import { LinkDefinition } from "@medusajs/modules-sdk"
-import { InventoryTypes, PricingTypes, ProductTypes } from "@medusajs/types"
+import {
+  AdditionalData,
+  InventoryTypes,
+  PricingTypes,
+  ProductTypes,
+} from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -25,8 +30,7 @@ type WorkflowInput = {
       required_quantity?: number
     }[]
   })[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 const buildLink = (
   variant_id: string,

packages/core/core-flows/src/product/workflows/create-products.ts

@@ -1,4 +1,5 @@
 import {
+  AdditionalData,
   CreateProductWorkflowInputDTO,
   PricingTypes,
   ProductTypes,
@@ -17,8 +18,7 @@ import { createProductVariantsWorkflow } from "./create-product-variants"
 
 type WorkflowInput = {
   products: CreateProductWorkflowInputDTO[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 export const createProductsWorkflowId = "create-products"
 

packages/core/core-flows/src/product/workflows/update-collections.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -10,8 +10,7 @@ import { updateCollectionsStep } from "../steps"
 type UpdateCollectionsStepInput = {
   selector: ProductTypes.FilterableProductCollectionProps
   update: ProductTypes.UpdateProductCollectionDTO
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type WorkflowInput = UpdateCollectionsStepInput
 

packages/core/core-flows/src/product/workflows/update-product-options.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -10,8 +10,7 @@ import { updateProductOptionsStep } from "../steps"
 type UpdateProductOptionsStepInput = {
   selector: ProductTypes.FilterableProductOptionProps
   update: ProductTypes.UpdateProductOptionDTO
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type WorkflowInput = UpdateProductOptionsStepInput
 

packages/core/core-flows/src/product/workflows/update-product-tags.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -10,8 +10,7 @@ import { updateProductTagsStep } from "../steps"
 type UpdateProductTagsStepInput = {
   selector: ProductTypes.FilterableProductTypeProps
   update: ProductTypes.UpdateProductTypeDTO
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type WorkflowInput = UpdateProductTagsStepInput
 

packages/core/core-flows/src/product/workflows/update-product-types.ts

@@ -1,4 +1,4 @@
-import { ProductTypes } from "@medusajs/types"
+import { AdditionalData, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -10,8 +10,7 @@ import { updateProductTypesStep } from "../steps"
 type UpdateProductTypesStepInput = {
   selector: ProductTypes.FilterableProductTypeProps
   update: ProductTypes.UpdateProductTypeDTO
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type WorkflowInput = UpdateProductTypesStepInput
 

packages/core/core-flows/src/product/workflows/update-product-variants.ts

@@ -1,4 +1,4 @@
-import { PricingTypes, ProductTypes } from "@medusajs/types"
+import { AdditionalData, PricingTypes, ProductTypes } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
@@ -23,9 +23,7 @@ type UpdateProductVariantsStepInput =
       })[]
     }
 
-type WorkflowInput = UpdateProductVariantsStepInput & {
-  additional_data?: Record<string, unknown>
-}
+type WorkflowInput = UpdateProductVariantsStepInput & AdditionalData
 
 export const updateProductVariantsWorkflowId = "update-product-variants"
 export const updateProductVariantsWorkflow = createWorkflow(

packages/core/core-flows/src/product/workflows/update-products.ts

@@ -1,6 +1,7 @@
 import { updateProductsStep } from "../steps/update-products"
 
 import {
+  AdditionalData,
   CreateMoneyAmountDTO,
   ProductTypes,
   UpdateProductVariantWorkflowInputDTO,
@@ -26,16 +27,14 @@ type UpdateProductsStepInputSelector = {
     sales_channels?: { id: string }[]
     variants?: UpdateProductVariantWorkflowInputDTO[]
   }
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type UpdateProductsStepInputProducts = {
   products: (Omit<ProductTypes.UpsertProductDTO, "variants"> & {
     sales_channels?: { id: string }[]
     variants?: UpdateProductVariantWorkflowInputDTO[]
   })[]
-  additional_data?: Record<string, unknown>
-}
+} & AdditionalData
 
 type UpdateProductsStepInput =
   | UpdateProductsStepInputSelector

packages/core/types/src/http/common/additional_data.ts

@@ -0,0 +1,7 @@
+/**
+ * Represents the additional_data property accepted in HTTP
+ * requests to allow arbitrary values
+ */
+export type AdditionalData = {
+  additional_data?: Record<string, unknown>
+}

packages/core/types/src/http/common/index.ts

@@ -1,2 +1,3 @@
 export * from "./request"
 export * from "./response"
+export * from "./additional_data"

packages/framework/framework/src/http/types.ts

@@ -147,14 +147,12 @@ export interface MedusaRequest<Body = unknown>
    * A generic context object that can be used across the request lifecycle
    */
   context?: Record<string, any>
+
   /**
-   * Custom validators for the request body and query params that will be
-   * merged with the original validator of the route.
+   * Custom validator to validate the `additional_data` property in
+   * requests that allows for additional_data
    */
-  extendedValidators?: {
-    body?: ZodObject<any, any>
-    queryParams?: ZodObject<any, any>
-  }
+  additionalDataValidator?: ZodObject<any, any>
 }
 
 export interface AuthContext {

packages/framework/framework/src/http/utils/define-middlewares.ts

@@ -7,7 +7,7 @@ import {
   MiddlewareVerb,
   ParserConfig,
 } from "../types"
-import { ZodObject } from "zod"
+import zod, { ZodRawShape } from "zod"
 
 /**
  * A helper function to configure the routes by defining custom middleware,
@@ -19,10 +19,7 @@ export function defineMiddlewares<
     method?: MiddlewareVerb | MiddlewareVerb[]
     matcher: string | RegExp
     bodyParser?: ParserConfig
-    extendedValidators?: {
-      body?: ZodObject<any, any>
-      queryParams?: ZodObject<any, any>
-    }
+    additionalDataValidator?: ZodRawShape
     // eslint-disable-next-line space-before-function-paren
     middlewares?: (<Req extends MedusaRequest>(
       req: Req,
@@ -41,17 +38,16 @@ export function defineMiddlewares<
   return {
     errorHandler,
     routes: routes.map((route) => {
-      const { middlewares, extendedValidators, ...rest } = route
+      const { middlewares, additionalDataValidator, ...rest } = route
       const customMiddleware: MedusaRequestHandler[] = []
 
       /**
-       * Define a custom validator when "extendedValidators.body" or
-       * "extendedValidators.queryParams" validation schema is
-       * provided.
+       * Define a custom validator when a zod schema is provided via
+       * "additionalDataValidator" property
        */
-      if (extendedValidators?.body || extendedValidators?.queryParams) {
+      if (additionalDataValidator) {
         customMiddleware.push((req, _, next) => {
-          req.extendedValidators = extendedValidators
+          req.additionalDataValidator = zod.object(additionalDataValidator)
           next()
         })
       }

packages/medusa/src/api/admin/products/[id]/options/[option_id]/route.ts

@@ -8,7 +8,7 @@ import {
 } from "@medusajs/core-flows"
 
 import { remapKeysForProduct, remapProductResponse } from "../../../helpers"
-import { HttpTypes } from "@medusajs/types"
+import { AdditionalData, HttpTypes } from "@medusajs/types"
 import { refetchEntity } from "../../../../../utils/refetch-entity"
 
 export const GET = async (
@@ -28,16 +28,20 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<HttpTypes.AdminUpdateProductOption>,
+  req: AuthenticatedMedusaRequest<
+    HttpTypes.AdminUpdateProductOption & AdditionalData
+  >,
   res: MedusaResponse<HttpTypes.AdminProductResponse>
 ) => {
   const productId = req.params.id
   const optionId = req.params.option_id
+  const { additional_data, ...update } = req.validatedBody
 
   await updateProductOptionsWorkflow(req.scope).run({
     input: {
       selector: { id: optionId, product_id: productId },
-      update: req.validatedBody,
+      update,
+      additional_data,
     },
   })
 

packages/medusa/src/api/admin/products/[id]/options/route.ts

@@ -5,7 +5,7 @@ import {
 
 import { createProductOptionsWorkflow } from "@medusajs/core-flows"
 import { remapKeysForProduct, remapProductResponse } from "../../helpers"
-import { HttpTypes } from "@medusajs/types"
+import { AdditionalData, HttpTypes } from "@medusajs/types"
 import {
   refetchEntities,
   refetchEntity,
@@ -33,18 +33,23 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<HttpTypes.AdminCreateProductOption>,
+  req: AuthenticatedMedusaRequest<
+    HttpTypes.AdminCreateProductOption & AdditionalData
+  >,
   res: MedusaResponse<HttpTypes.AdminProductResponse>
 ) => {
   const productId = req.params.id
+  const { additional_data, ...rest } = req.validatedBody
+
   await createProductOptionsWorkflow(req.scope).run({
     input: {
       product_options: [
         {
-          ...req.validatedBody,
+          ...rest,
           product_id: productId,
         },
       ],
+      additional_data,
     },
   })
 

packages/medusa/src/api/admin/products/[id]/route.ts

@@ -8,7 +8,7 @@ import {
 } from "../../../../types/routing"
 import { remapKeysForProduct, remapProductResponse } from "../helpers"
 import { MedusaError } from "@medusajs/utils"
-import { HttpTypes } from "@medusajs/types"
+import { AdditionalData, HttpTypes } from "@medusajs/types"
 import { refetchEntity } from "../../../utils/refetch-entity"
 
 export const GET = async (
@@ -31,13 +31,18 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<HttpTypes.AdminUpdateProduct>,
+  req: AuthenticatedMedusaRequest<
+    HttpTypes.AdminUpdateProduct & AdditionalData
+  >,
   res: MedusaResponse<HttpTypes.AdminProductResponse>
 ) => {
+  const { additional_data, ...update } = req.validatedBody
+
   const { result } = await updateProductsWorkflow(req.scope).run({
     input: {
       selector: { id: req.params.id },
-      update: req.validatedBody,
+      update,
+      additional_data,
     },
   })