fix: Retrieve ancestors and/or descendants on product categories (#7226)

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

@@ -7,7 +7,7 @@ import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../../../types/routing"
-import { refetchCategory } from "../../helpers"
+import { refetchEntity } from "../../../../utils/refetch-entity"
 
 export const POST = async (
   req: AuthenticatedMedusaRequest<LinkMethodRequest>,
@@ -24,11 +24,11 @@ export const POST = async (
     throw errors[0].error
   }
 
-  const category = await refetchCategory(
-    req.params.id,
+  const category = await refetchEntity(
+    "product_category",
+    id,
     req.scope,
-    req.remoteQueryConfig.fields,
-    req.filterableFields
+    req.remoteQueryConfig.fields
   )
 
   res.status(200).json({ product_category: category })

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

@@ -4,7 +4,7 @@ import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../../types/routing"
-import { refetchCategory } from "../helpers"
+import { refetchEntities } from "../../../utils/refetch-entity"
 import {
   AdminProductCategoryParamsType,
   AdminUpdateProductCategoryType,
@@ -14,11 +14,11 @@ export const GET = async (
   req: AuthenticatedMedusaRequest<AdminProductCategoryParamsType>,
   res: MedusaResponse<AdminProductCategoryResponse>
 ) => {
-  const category = await refetchCategory(
-    req.params.id,
+  const [category] = await refetchEntities(
+    "product_category",
+    { id: req.params.id, ...req.filterableFields },
     req.scope,
-    req.remoteQueryConfig.fields,
-    req.filterableFields
+    req.remoteQueryConfig.fields
   )
 
   res.json({ product_category: category })
@@ -40,11 +40,11 @@ export const POST = async (
     throw errors[0].error
   }
 
-  const category = await refetchCategory(
-    req.params.id,
+  const [category] = await refetchEntities(
+    "product_category",
+    { id, ...req.filterableFields },
     req.scope,
-    req.remoteQueryConfig.fields,
-    req.filterableFields
+    req.remoteQueryConfig.fields
   )
 
   res.status(200).json({ product_category: category })

packages/medusa/src/api-v2/admin/product-categories/helpers.ts

@@ -1,24 +0,0 @@
-import { MedusaContainer } from "@medusajs/types"
-import {
-  ContainerRegistrationKeys,
-  remoteQueryObjectFromString,
-} from "@medusajs/utils"
-
-export const refetchCategory = async (
-  categoryId: string,
-  scope: MedusaContainer,
-  fields: string[],
-  filterableFields: Record<string, any> = {}
-) => {
-  const remoteQuery = scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
-  const queryObject = remoteQueryObjectFromString({
-    entryPoint: "product_category",
-    variables: {
-      filters: { ...filterableFields, id: categoryId },
-    },
-    fields: fields,
-  })
-
-  const categorys = await remoteQuery(queryObject)
-  return categorys[0]
-}

packages/medusa/src/api-v2/admin/product-categories/query-config.ts

@@ -10,17 +10,36 @@ export const defaults = [
   "created_at",
   "updated_at",
   "metadata",
-  "*parent_category",
-  "*category_children",
+  "parent_category",
+  "category_children",
+]
+
+export const allowed = [
+  "id",
+  "name",
+  "description",
+  "handle",
+  "is_active",
+  "is_internal",
+  "rank",
+  "parent_category_id",
+  "created_at",
+  "updated_at",
+  "metadata",
+  "category_children",
+  "parent_category",
+  "products",
 ]
 
 export const retrieveProductCategoryConfig = {
   defaults,
+  allowed,
   isList: false,
 }
 
 export const listProductCategoryConfig = {
   defaults,
+  allowed,
   defaultLimit: 50,
   isList: true,
 }

packages/medusa/src/api-v2/admin/product-categories/route.ts

@@ -3,15 +3,11 @@ import {
   AdminProductCategoryListResponse,
   AdminProductCategoryResponse,
 } from "@medusajs/types"
-import {
-  ContainerRegistrationKeys,
-  remoteQueryObjectFromString,
-} from "@medusajs/utils"
 import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../types/routing"
-import { refetchCategory } from "./helpers"
+import { refetchEntities } from "../../utils/refetch-entity"
 import {
   AdminCreateProductCategoryType,
   AdminProductCategoriesParamsType,
@@ -21,18 +17,13 @@ export const GET = async (
   req: AuthenticatedMedusaRequest<AdminProductCategoriesParamsType>,
   res: MedusaResponse<AdminProductCategoryListResponse>
 ) => {
-  const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
-
-  const queryObject = remoteQueryObjectFromString({
-    entryPoint: "product_category",
-    variables: {
-      filters: req.filterableFields,
-      ...req.remoteQueryConfig.pagination,
-    },
-    fields: req.remoteQueryConfig.fields,
-  })
-
-  const { rows: product_categories, metadata } = await remoteQuery(queryObject)
+  const { rows: product_categories, metadata } = await refetchEntities(
+    "product_category",
+    req.filterableFields,
+    req.scope,
+    req.remoteQueryConfig.fields,
+    req.remoteQueryConfig.pagination
+  )
 
   res.json({
     product_categories,
@@ -57,11 +48,11 @@ export const POST = async (
     throw errors[0].error
   }
 
-  const category = await refetchCategory(
-    result.id,
+  const [category] = await refetchEntities(
+    "product_category",
+    { id: result.id, ...req.filterableFields },
     req.scope,
-    req.remoteQueryConfig.fields,
-    req.filterableFields
+    req.remoteQueryConfig.fields
   )
 
   res.status(200).json({ product_category: category })

packages/medusa/src/api-v2/store/product-categories/[id]/route.ts

@@ -1,21 +1,22 @@
 import { StoreProductCategoryResponse } from "@medusajs/types"
+import { MedusaError } from "@medusajs/utils"
 import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../../types/routing"
-import { refetchCategory } from "../helpers"
+import { refetchEntities } from "../../../utils/refetch-entity"
 import { StoreProductCategoryParamsType } from "../validators"
-import { MedusaError } from "@medusajs/utils"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest<StoreProductCategoryParamsType>,
   res: MedusaResponse<StoreProductCategoryResponse>
 ) => {
-  const category = await refetchCategory(
-    req.params.id,
+  const category = await refetchEntities(
+    "product_category",
+    { id: req.params.id, ...req.filterableFields },
     req.scope,
     req.remoteQueryConfig.fields,
-    req.filterableFields
+    req.remoteQueryConfig.pagination
   )
 
   if (!category) {

packages/medusa/src/api-v2/utils/refetch-entity.ts

@@ -9,7 +9,8 @@ export const refetchEntities = async (
   entryPoint: string,
   idOrFilter: string | object,
   scope: MedusaContainer,
-  fields: string[]
+  fields: string[],
+  pagination: object = {}
 ) => {
   const remoteQuery = scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
   const filters = isString(idOrFilter) ? { id: idOrFilter } : idOrFilter
@@ -23,7 +24,7 @@ export const refetchEntities = async (
     delete filters.context
   }
 
-  let variables = { filters, ...context }
+  let variables = { filters, ...context, ...pagination }
 
   const queryObject = remoteQueryObjectFromString({
     entryPoint,

packages/medusa/src/utils/get-query-config.ts

@@ -4,11 +4,11 @@ import {
   stringToSelectRelationObject,
 } from "@medusajs/utils"
 import { pick } from "lodash"
-import { isDefined, MedusaError } from "medusa-core-utils"
+import { MedusaError, isDefined } from "medusa-core-utils"
 import { BaseEntity } from "../interfaces"
-import { FindConfig, QueryConfig, RequestQueryFields } from "../types/common"
 import { featureFlagRouter } from "../loaders/feature-flags"
 import MedusaV2 from "../loaders/feature-flags/medusa-v2"
+import { FindConfig, QueryConfig, RequestQueryFields } from "../types/common"
 
 export function pickByConfig<TModel extends BaseEntity>(
   obj: TModel | TModel[],