feat: Align the product module HTTP API to follow our conventions (#6759

)

.changeset/calm-spoons-look.md

@@ -0,0 +1,6 @@
+---
+"@medusajs/core-flows": minor
+"@medusajs/medusa": minor
+---
+
+Align the v2 product HTTP endpoints to follow conventions

packages/core-flows/src/product/steps/remove-variant-pricing-link.ts

@@ -1,5 +1,4 @@
 import { Modules } from "@medusajs/modules-sdk"
-import { ILinkModule } from "@medusajs/types"
 import { ContainerRegistrationKeys } from "@medusajs/utils"
 import { StepResponse, createStep } from "@medusajs/workflows-sdk"
 
@@ -11,39 +10,24 @@ export const removeVariantPricingLinkStepId = "remove-variant-pricing-link"
 export const removeVariantPricingLinkStep = createStep(
   removeVariantPricingLinkStepId,
   async (data: StepInput, { container }) => {
-    const remoteLink = container.resolve(ContainerRegistrationKeys.REMOTE_LINK)
-    const linkModule: ILinkModule = remoteLink.getLinkModule(
-      Modules.PRODUCT,
-      "variant_id",
-      Modules.PRICING,
-      "price_set_id"
-    )
-
-    const links = (await linkModule.list(
-      {
-        variant_id: data.variant_ids,
-      },
-      { select: ["id", "variant_id", "price_set_id"] }
-    )) as { id: string; variant_id: string; price_set_id: string }[]
+    if (!data.variant_ids.length) {
+      return
+    }
 
-    await remoteLink.delete(links.map((link) => link.id))
-    return new StepResponse(void 0, links)
+    const remoteLink = container.resolve(ContainerRegistrationKeys.REMOTE_LINK)
+    await remoteLink.delete({
+      [Modules.PRODUCT]: { variant_id: data.variant_ids },
+    })
+    return new StepResponse(void 0, data.variant_ids)
   },
   async (prevData, { container }) => {
     if (!prevData?.length) {
       return
     }
 
     const remoteLink = container.resolve(ContainerRegistrationKeys.REMOTE_LINK)
-    await remoteLink.create(
-      prevData.map((entry) => ({
-        [Modules.PRODUCT]: {
-          variant_id: entry.variant_id,
-        },
-        [Modules.PRICING]: {
-          price_set_id: entry.price_set_id,
-        },
-      }))
-    )
+    await remoteLink.restore({
+      [Modules.PRODUCT]: { variant_id: prevData },
+    })
   }
 )

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

@@ -10,7 +10,6 @@ export const deleteProductVariantsWorkflowId = "delete-product-variants"
 export const deleteProductVariantsWorkflow = createWorkflow(
   deleteProductVariantsWorkflowId,
   (input: WorkflowData<WorkflowInput>): WorkflowData<void> => {
-    // Question: Should we also remove the price set manually, or would that be cascaded?
     removeVariantPricingLinkStep({ variant_ids: input.ids })
     return deleteProductVariantsStep(input.ids)
   }

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

@@ -22,10 +22,7 @@ export const deleteProductsWorkflow = createWorkflow(
         .map((variant) => variant.id)
     })
 
-    // Question: Should we also remove the price set manually, or would that be cascaded?
-    // Question: Since we soft-delete the product, how do we restore the product with the prices and the links?
     removeVariantPricingLinkStep({ variant_ids: variantsToBeDeleted })
-
     return deleteProductsStep(input.ids)
   }
 )

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

@@ -7,9 +7,9 @@ import {
   updateProductOptionsWorkflow,
 } from "@medusajs/core-flows"
 
-import { UpdateProductDTO } from "@medusajs/types"
 import { remoteQueryObjectFromString } from "@medusajs/utils"
 import { UpdateProductOptionDTO } from "../../../../../../../../types/dist"
+import { refetchProduct, remapProduct } from "../../../helpers"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -51,7 +51,12 @@ export const POST = async (
     throw errors[0].error
   }
 
-  res.status(200).json({ product_option: result[0] })
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+  res.status(200).json({ product: remapProduct(product) })
 }
 
 export const DELETE = async (
@@ -71,9 +76,16 @@ export const DELETE = async (
     throw errors[0].error
   }
 
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+
   res.status(200).json({
     id: optionId,
     object: "product_option",
     deleted: true,
+    parent: product,
   })
 }

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

@@ -6,6 +6,7 @@ import {
 import { CreateProductOptionDTO } from "@medusajs/types"
 import { createProductOptionsWorkflow } from "@medusajs/core-flows"
 import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { refetchProduct, remapProduct } from "../../helpers"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -56,5 +57,10 @@ export const POST = async (
     throw errors[0].error
   }
 
-  res.status(200).json({ product_option: result[0] })
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+  res.status(200).json({ product: remapProduct(product) })
 }

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

@@ -9,7 +9,7 @@ import {
 
 import { UpdateProductDTO } from "@medusajs/types"
 import { remoteQueryObjectFromString } from "@medusajs/utils"
-import { remapKeysForProduct, remapProduct } from "../helpers"
+import { refetchProduct, remapKeysForProduct, remapProduct } from "../helpers"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -47,7 +47,12 @@ export const POST = async (
     throw errors[0].error
   }
 
-  res.status(200).json({ product: remapProduct(result[0]) })
+  const product = await refetchProduct(
+    result[0].id,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+  res.status(200).json({ product: remapProduct(product) })
 }
 
 export const DELETE = async (

packages/medusa/src/api-v2/admin/products/[id]/variants/[variant_id]/route.ts

@@ -8,9 +8,13 @@ import {
 } from "@medusajs/core-flows"
 
 import { UpdateProductVariantDTO } from "@medusajs/types"
-import { defaultAdminProductsVariantFields } from "../../../query-config"
 import { remoteQueryObjectFromString } from "@medusajs/utils"
-import { remapKeysForVariant, remapVariant } from "../../../helpers"
+import {
+  refetchProduct,
+  remapKeysForVariant,
+  remapProduct,
+  remapVariant,
+} from "../../../helpers"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -56,7 +60,12 @@ export const POST = async (
     throw errors[0].error
   }
 
-  res.status(200).json({ variant: remapVariant(result[0]) })
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+  res.status(200).json({ product: remapProduct(product) })
 }
 
 export const DELETE = async (
@@ -77,9 +86,16 @@ export const DELETE = async (
     throw errors[0].error
   }
 
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+
   res.status(200).json({
     id: variantId,
     object: "variant",
     deleted: true,
+    parent: product,
   })
 }

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

@@ -7,7 +7,7 @@ import { CreateProductVariantDTO } from "@medusajs/types"
 import { createProductVariantsWorkflow } from "@medusajs/core-flows"
 import { remoteQueryObjectFromString } from "@medusajs/utils"
 import {
-  remapKeysForProduct,
+  refetchProduct,
   remapKeysForVariant,
   remapProduct,
   remapVariant,
@@ -64,15 +64,10 @@ export const POST = async (
     throw errors[0].error
   }
 
-  const remoteQuery = req.scope.resolve("remoteQuery")
-  const queryObject = remoteQueryObjectFromString({
-    entryPoint: "product",
-    variables: {
-      filters: { id: productId },
-    },
-    fields: remapKeysForProduct(req.remoteQueryConfig.fields ?? []),
-  })
-
-  const products = await remoteQuery(queryObject)
-  res.status(200).json({ product: remapProduct(products[0]) })
+  const product = await refetchProduct(
+    productId,
+    req.scope,
+    req.remoteQueryConfig.fields
+  )
+  res.status(200).json({ product: remapProduct(product) })
 }

packages/medusa/src/api-v2/admin/products/helpers.ts

@@ -1,27 +1,34 @@
-import { ProductDTO, ProductVariantDTO } from "@medusajs/types"
+import { MedusaContainer, ProductDTO, ProductVariantDTO } from "@medusajs/types"
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+
+const isPricing = (fieldName: string) =>
+  fieldName.startsWith("variants.prices") ||
+  fieldName.startsWith("*variants.prices") ||
+  fieldName.startsWith("prices") ||
+  fieldName.startsWith("*prices")
 
 // The variant had prices before, but that is not part of the price_set money amounts. Do we remap the request and response or not?
 export const remapKeysForProduct = (selectFields: string[]) => {
   const productFields = selectFields.filter(
-    (fieldName: string) => !fieldName.startsWith("variants.prices")
+    (fieldName: string) => !isPricing(fieldName)
   )
   const pricingFields = selectFields
-    .filter((fieldName: string) => fieldName.startsWith("variants.prices"))
+    .filter((fieldName: string) => isPricing(fieldName))
     .map((fieldName: string) =>
-      fieldName.replace("variants.prices.", "variants.price_set.money_amounts.")
+      fieldName.replace("variants.prices", "variants.price_set.money_amounts")
     )
 
   return [...productFields, ...pricingFields]
 }
 
 export const remapKeysForVariant = (selectFields: string[]) => {
   const variantFields = selectFields.filter(
-    (fieldName: string) => !fieldName.startsWith("prices")
+    (fieldName: string) => !isPricing(fieldName)
   )
   const pricingFields = selectFields
-    .filter((fieldName: string) => fieldName.startsWith("prices"))
+    .filter((fieldName: string) => isPricing(fieldName))
     .map((fieldName: string) =>
-      fieldName.replace("prices.", "price_set.money_amounts.")
+      fieldName.replace("prices", "price_set.money_amounts")
     )
 
   return [...variantFields, ...pricingFields]
@@ -44,3 +51,21 @@ export const remapVariant = (v: ProductVariantDTO) => {
     price_set: undefined,
   }
 }
+
+export const refetchProduct = async (
+  productId: string,
+  scope: MedusaContainer,
+  fields: string[]
+) => {
+  const remoteQuery = scope.resolve("remoteQuery")
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "product",
+    variables: {
+      filters: { id: productId },
+    },
+    fields: remapKeysForProduct(fields ?? []),
+  })
+
+  const products = await remoteQuery(queryObject)
+  return products[0]
+}