feat(medusa): added list price list products endpoint (#6617)

what:

- adds an endpoint to list price list products

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

@@ -3,7 +3,8 @@ import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../../types/routing"
-import { listPriceLists } from "../utils"
+import { listPriceLists } from "../queries"
+import { adminPriceListRemoteQueryFields } from "../query-config"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -12,7 +13,8 @@ export const GET = async (
   const id = req.params.id
   const [[priceList], count] = await listPriceLists({
     container: req.scope,
-    fields: req.retrieveConfig.select!,
+    remoteQueryFields: adminPriceListRemoteQueryFields,
+    apiFields: req.retrieveConfig.select!,
     variables: {
       filters: { id },
       skip: 0,

packages/medusa/src/api-v2/admin/price-lists/middlewares.ts

@@ -1,5 +1,6 @@
 import { transformQuery } from "../../../api/middlewares"
 import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import { authenticate } from "../../../utils/authenticate-middleware"
 import * as QueryConfig from "./query-config"
 import {
   AdminGetPriceListsParams,
@@ -7,6 +8,11 @@ import {
 } from "./validators"
 
 export const adminPriceListsRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    method: ["ALL"],
+    matcher: "/admin/price-lists*",
+    middlewares: [authenticate("admin", ["bearer", "session", "api-key"])],
+  },
   {
     method: ["GET"],
     matcher: "/admin/price-lists",

packages/medusa/src/api-v2/admin/price-lists/queries/list-price-lists.ts

@@ -0,0 +1,90 @@
+import {
+  MedusaContainer,
+  PriceListRuleDTO,
+  PriceSetMoneyAmountDTO,
+  ProductVariantDTO,
+} from "@medusajs/types"
+import {
+  ContainerRegistrationKeys,
+  remoteQueryObjectFromString,
+} from "@medusajs/utils"
+import { cleanResponseData } from "../../../../utils/clean-response-data"
+import { AdminPriceListRemoteQueryDTO } from "../types"
+
+export async function listPriceLists({
+  container,
+  remoteQueryFields,
+  apiFields,
+  variables,
+}: {
+  container: MedusaContainer
+  remoteQueryFields: string[]
+  apiFields: string[]
+  variables: Record<string, any>
+}): Promise<[AdminPriceListRemoteQueryDTO[], number]> {
+  const remoteQuery = container.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "price_list",
+    fields: remoteQueryFields,
+    variables,
+  })
+
+  const { rows: priceLists, metadata } = await remoteQuery(queryObject)
+
+  if (!metadata.count) {
+    return [[], 0]
+  }
+
+  for (const priceList of priceLists) {
+    priceList.rules = buildPriceListRules(priceList.price_list_rules || [])
+    priceList.prices = buildPriceSetPrices(
+      priceList.price_set_money_amounts || []
+    )
+  }
+
+  const sanitizedPriceLists: AdminPriceListRemoteQueryDTO[] = priceLists.map(
+    (priceList) => cleanResponseData(priceList, apiFields)
+  )
+
+  return [sanitizedPriceLists, metadata.count]
+}
+
+function buildPriceListRules(
+  priceListRules: PriceListRuleDTO[]
+): Record<string, string[]> {
+  return priceListRules.reduce((acc, curr) => {
+    const ruleAttribute = curr.rule_type.rule_attribute
+    const ruleValues = curr.price_list_rule_values || []
+
+    if (ruleAttribute) {
+      acc[ruleAttribute] = ruleValues.map((ruleValue) => ruleValue.value)
+    }
+
+    return acc
+  }, {})
+}
+
+function buildPriceSetPrices(
+  priceSetMoneyAmounts: (PriceSetMoneyAmountDTO & {
+    price_set: PriceSetMoneyAmountDTO["price_set"] & {
+      variant?: ProductVariantDTO
+    }
+  })[]
+): Record<string, any>[] {
+  return priceSetMoneyAmounts.map((priceSetMoneyAmount) => {
+    const productVariant = priceSetMoneyAmount.price_set?.variant
+    const rules = priceSetMoneyAmount.price_rules?.reduce((acc, curr) => {
+      if (curr.rule_type.rule_attribute) {
+        acc[curr.rule_type.rule_attribute] = curr.value
+      }
+
+      return acc
+    }, {})
+
+    return {
+      ...priceSetMoneyAmount.money_amount,
+      variant_id: productVariant?.id ?? null,
+      rules,
+    }
+  })
+}

packages/medusa/src/api-v2/admin/price-lists/query-config.ts

@@ -1,53 +1,57 @@
 export enum PriceListRelations {
-  CUSTOMER_GROUPS = "customer_groups",
   PRICES = "prices",
 }
 
-export const priceListRemoteQueryFields = {
-  fields: [
-    "id",
-    "type",
-    "description",
-    "title",
-    "status",
-    "starts_at",
-    "ends_at",
-    "created_at",
-    "updated_at",
-    "deleted_at",
-  ],
-  pricesFields: [
-    "price_set_money_amounts.money_amount.id",
-    "price_set_money_amounts.money_amount.currency_code",
-    "price_set_money_amounts.money_amount.amount",
-    "price_set_money_amounts.money_amount.min_quantity",
-    "price_set_money_amounts.money_amount.max_quantity",
-    "price_set_money_amounts.money_amount.created_at",
-    "price_set_money_amounts.money_amount.deleted_at",
-    "price_set_money_amounts.money_amount.updated_at",
-    "price_set_money_amounts.price_set.variant.id",
-    "price_set_money_amounts.price_rules.value",
-    "price_set_money_amounts.price_rules.rule_type.rule_attribute",
-  ],
-  customerGroupsFields: [
-    "price_list_rules.price_list_rule_values.value",
-    "price_list_rules.rule_type.rule_attribute",
-    "price_set_money_amounts.price_rules.value",
-    "price_set_money_amounts.price_rules.rule_type.rule_attribute",
-  ],
-}
+export const adminPriceListRemoteQueryFields = [
+  "id",
+  "type",
+  "description",
+  "title",
+  "status",
+  "starts_at",
+  "ends_at",
+  "created_at",
+  "updated_at",
+  "deleted_at",
+  "price_set_money_amounts.money_amount.id",
+  "price_set_money_amounts.money_amount.currency_code",
+  "price_set_money_amounts.money_amount.amount",
+  "price_set_money_amounts.money_amount.min_quantity",
+  "price_set_money_amounts.money_amount.max_quantity",
+  "price_set_money_amounts.money_amount.created_at",
+  "price_set_money_amounts.money_amount.deleted_at",
+  "price_set_money_amounts.money_amount.updated_at",
+  "price_set_money_amounts.price_set.variant.id",
+  "price_set_money_amounts.price_rules.value",
+  "price_set_money_amounts.price_rules.rule_type.rule_attribute",
+  "price_list_rules.price_list_rule_values.value",
+  "price_list_rules.rule_type.rule_attribute",
+]
 
 export const defaultAdminPriceListFields = [
-  ...priceListRemoteQueryFields.fields,
-  "name",
+  "id",
+  "type",
+  "description",
+  "title",
+  "status",
+  "starts_at",
+  "ends_at",
+  "rules",
+  "created_at",
+  "updated_at",
+  "prices.amount",
+  "prices.id",
+  "prices.currency_code",
+  "prices.amount",
+  "prices.min_quantity",
+  "prices.max_quantity",
+  "prices.variant_id",
+  "prices.rules",
 ]
 
 export const defaultAdminPriceListRelations = []
 
-export const allowedAdminPriceListRelations = [
-  PriceListRelations.CUSTOMER_GROUPS,
-  PriceListRelations.PRICES,
-]
+export const allowedAdminPriceListRelations = [PriceListRelations.PRICES]
 
 export const adminListTransformQueryConfig = {
   defaultLimit: 50,

packages/medusa/src/api-v2/admin/price-lists/route.ts

@@ -2,7 +2,8 @@ import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../types/routing"
-import { listPriceLists } from "./utils"
+import { listPriceLists } from "./queries"
+import { adminPriceListRemoteQueryFields } from "./query-config"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -11,7 +12,8 @@ export const GET = async (
   const { limit, offset } = req.validatedQuery
   const [priceLists, count] = await listPriceLists({
     container: req.scope,
-    fields: req.listConfig.select!,
+    apiFields: req.listConfig.select!,
+    remoteQueryFields: adminPriceListRemoteQueryFields,
     variables: {
       filters: req.filterableFields,
       order: req.listConfig.order,

packages/medusa/src/api-v2/admin/price-lists/types.ts

@@ -0,0 +1,22 @@
+import { PriceListStatus, PriceListType } from "@medusajs/types"
+
+export type AdminPriceListRemoteQueryDTO = {
+  id: string
+  type?: PriceListType
+  description?: string
+  title?: string
+  status?: PriceListStatus
+  starts_at?: string
+  ends_at?: string
+  created_at?: string
+  updated_at?: string
+  deleted_at?: string
+  prices?: {
+    id: string
+    variant_id: string
+    currency_code?: string
+    amount?: number
+    min_quantity?: number
+    max_quantity?: number
+  }[]
+}

packages/medusa/src/api-v2/admin/price-lists/utils/list-price-lists.ts

@@ -1,123 +0,0 @@
-import { LinkModuleUtils, ModuleRegistrationName } from "@medusajs/modules-sdk"
-import { MedusaContainer, PriceListDTO } from "@medusajs/types"
-import { remoteQueryObjectFromString } from "@medusajs/utils"
-import { cleanResponseData } from "../../../../utils/clean-response-data"
-import { PriceListRelations, priceListRemoteQueryFields } from "../query-config"
-
-enum RuleAttributes {
-  CUSTOMER_GROUP_ID = "customer_group_id",
-  REGION_ID = "region_id",
-}
-
-export async function listPriceLists({
-  container,
-  fields,
-  variables,
-}: {
-  container: MedusaContainer
-  fields: string[]
-  variables: Record<string, any>
-}): Promise<[PriceListDTO[], number]> {
-  const remoteQuery = container.resolve(LinkModuleUtils.REMOTE_QUERY)
-  const customerModule = container.resolve(ModuleRegistrationName.CUSTOMER)
-
-  const remoteQueryFields = fields.filter(
-    (field) =>
-      !field.startsWith(PriceListRelations.CUSTOMER_GROUPS) &&
-      !field.startsWith(PriceListRelations.PRICES)
-  )
-  const customerGroupFields = fields.filter((field) =>
-    field.startsWith(PriceListRelations.CUSTOMER_GROUPS)
-  )
-  const pricesFields = fields.filter((field) =>
-    field.startsWith(PriceListRelations.PRICES)
-  )
-
-  if (customerGroupFields.length) {
-    remoteQueryFields.push(...priceListRemoteQueryFields.customerGroupsFields)
-  }
-
-  if (pricesFields.length) {
-    remoteQueryFields.push(...priceListRemoteQueryFields.pricesFields)
-  }
-
-  const queryObject = remoteQueryObjectFromString({
-    entryPoint: "price_list",
-    fields: remoteQueryFields,
-    variables,
-  })
-
-  const {
-    rows: priceLists,
-    metadata: { count },
-  } = await remoteQuery(queryObject)
-
-  if (!count) {
-    return [[], 0]
-  }
-
-  const customerGroupIds: string[] = customerGroupFields.length
-    ? priceLists
-        .map((priceList) => priceList.price_list_rules)
-        .flat(1)
-        .filter(
-          (rule) =>
-            rule.rule_type?.rule_attribute === RuleAttributes.CUSTOMER_GROUP_ID
-        )
-        .map((rule) => rule.price_list_rule_values.map((plrv) => plrv.value))
-        .flat(1)
-    : []
-
-  const customerGroups = await customerModule.listCustomerGroups(
-    { id: customerGroupIds },
-    {}
-  )
-
-  const customerGroupIdMap = new Map(customerGroups.map((cg) => [cg.id, cg]))
-
-  for (const priceList of priceLists) {
-    const priceSetMoneyAmounts = priceList.price_set_money_amounts || []
-    const priceListRulesData = priceList.price_list_rules || []
-    delete priceList.price_set_money_amounts
-    delete priceList.price_list_rules
-
-    if (pricesFields.length) {
-      priceList.prices = priceSetMoneyAmounts.map((priceSetMoneyAmount) => {
-        const productVariant = priceSetMoneyAmount.price_set.variant
-        const rules = priceSetMoneyAmount.price_rules.reduce((acc, curr) => {
-          acc[curr.rule_type.rule_attribute] = curr.value
-          return acc
-        }, {})
-
-        return {
-          ...priceSetMoneyAmount.money_amount,
-          price_list_id: priceList.id,
-          variant_id: productVariant?.id ?? null,
-          region_id: rules["region_id"] ?? null,
-          rules,
-        }
-      })
-    }
-
-    priceList.name = priceList.title
-    delete priceList.title
-
-    if (customerGroupFields.length) {
-      const customerGroupPriceListRule = priceListRulesData.find(
-        (plr) =>
-          plr.rule_type.rule_attribute === RuleAttributes.CUSTOMER_GROUP_ID
-      )
-
-      priceList.customer_groups =
-        customerGroupPriceListRule?.price_list_rule_values
-          .map((cgr) => customerGroupIdMap.get(cgr.value))
-          .filter(Boolean) || []
-    }
-  }
-
-  const sanitizedPriceLists = priceLists.map((priceList) => {
-    return cleanResponseData(priceList, fields)
-  })
-
-  return [sanitizedPriceLists, count]
-}

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

@@ -1,5 +1,7 @@
+import { transformBody, transformQuery } from "../../../api/middlewares"
+import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import { authenticate } from "../../../utils/authenticate-middleware"
 import * as QueryConfig from "./query-config"
-
 import {
   AdminGetProductsOptionsParams,
   AdminGetProductsParams,
@@ -14,10 +16,6 @@ import {
   AdminPostProductsProductVariantsVariantReq,
   AdminPostProductsReq,
 } from "./validators"
-import { transformBody, transformQuery } from "../../../api/middlewares"
-
-import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
-import { authenticate } from "../../../utils/authenticate-middleware"
 
 export const adminProductRoutesMiddlewares: MiddlewareRoute[] = [
   {
@@ -25,7 +23,6 @@ export const adminProductRoutesMiddlewares: MiddlewareRoute[] = [
     matcher: "/admin/products*",
     middlewares: [authenticate("admin", ["bearer", "session", "api-key"])],
   },
-
   {
     method: ["GET"],
     matcher: "/admin/products",

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

@@ -1,22 +1,59 @@
+import { createProductsWorkflow } from "@medusajs/core-flows"
+import { CreateProductDTO } from "@medusajs/types"
+import {
+  ContainerRegistrationKeys,
+  isString,
+  remoteQueryObjectFromString,
+} from "@medusajs/utils"
 import {
   AuthenticatedMedusaRequest,
   MedusaResponse,
 } from "../../../types/routing"
-
-import { CreateProductDTO } from "@medusajs/types"
-import { createProductsWorkflow } from "@medusajs/core-flows"
-import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { listPriceLists } from "../price-lists/queries"
+import { AdminGetProductsParams } from "./validators"
 
 export const GET = async (
-  req: AuthenticatedMedusaRequest,
+  req: AuthenticatedMedusaRequest<AdminGetProductsParams>,
   res: MedusaResponse
 ) => {
-  const remoteQuery = req.scope.resolve("remoteQuery")
+  const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
+  const filterableFields: AdminGetProductsParams = { ...req.filterableFields }
+  const filterByPriceListIds = filterableFields.price_list_id
+  const priceListVariantIds: string[] = []
+
+  // When filtering by price_list_id, we need use the remote query to get
+  // the variant IDs through the price list price sets.
+  if (Array.isArray(filterByPriceListIds)) {
+    const [priceLists] = await listPriceLists({
+      container: req.scope,
+      remoteQueryFields: ["price_set_money_amounts.price_set.variant.id"],
+      apiFields: ["prices.variant_id"],
+      variables: { filters: { id: filterByPriceListIds }, skip: 0, take: null },
+    })
+
+    priceListVariantIds.push(
+      ...(priceLists
+        .map((priceList) => priceList.prices?.map((price) => price.variant_id))
+        .flat(2)
+        .filter(isString) || [])
+    )
+
+    delete filterableFields.price_list_id
+  }
+
+  if (priceListVariantIds.length) {
+    const existingVariantFilters = filterableFields.variants || {}
+
+    filterableFields.variants = {
+      ...existingVariantFilters,
+      id: priceListVariantIds,
+    }
+  }
 
   const queryObject = remoteQueryObjectFromString({
     entryPoint: "product",
     variables: {
-      filters: req.filterableFields,
+      filters: filterableFields,
       order: req.listConfig.order,
       skip: req.listConfig.skip,
       take: req.listConfig.take,

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

@@ -1,4 +1,5 @@
 import { OperatorMap } from "@medusajs/types"
+import { ProductStatus } from "@medusajs/utils"
 import { Transform, Type } from "class-transformer"
 import {
   IsArray,
@@ -14,7 +15,6 @@ import {
 } from "class-validator"
 import { FindParams, extendedFindParamsMixin } from "../../../types/common"
 import { OperatorMapValidator } from "../../../types/validators/operator-map"
-import { ProductStatus } from "@medusajs/utils"
 import { IsType } from "../../../utils"
 import { optionalBooleanMapper } from "../../../utils/validators/is-boolean"
 
@@ -73,13 +73,12 @@ export class AdminGetProductsParams extends extendedFindParamsMixin({
   @Transform(({ value }) => optionalBooleanMapper.get(value.toLowerCase()))
   is_giftcard?: boolean
 
-  // TODO: Add in next iteration
-  // /**
-  //  * Filter products by their associated price lists' ID.
-  //  */
-  // @IsArray()
-  // @IsOptional()
-  // price_list_id?: string[]
+  /**
+   * Filter products by their associated price lists' ID.
+   */
+  @IsOptional()
+  @IsArray()
+  price_list_id?: string[]
 
   /**
    * Filter products by their associated product collection's ID.
@@ -102,6 +101,11 @@ export class AdminGetProductsParams extends extendedFindParamsMixin({
   @IsOptional()
   type_id?: string[]
 
+  // TODO: Replace this with AdminGetProductVariantsParams when its available
+  @IsOptional()
+  @IsObject()
+  variants?: Record<any, any>
+
   // /**
   //  * Filter products by their associated sales channels' ID.
   //  */