fix: Corrections to the store region endpoint for v2 (#7152)

packages/medusa/src/api-v2/store/regions/[id]/payment-providers/route.ts

@@ -1,20 +0,0 @@
-import { remoteQueryObjectFromString } from "@medusajs/utils"
-import { MedusaRequest, MedusaResponse } from "../../../../../types/routing"
-
-export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
-  const remoteQuery = req.scope.resolve("remoteQuery")
-
-  const queryObject = remoteQueryObjectFromString({
-    entryPoint: "regions",
-    fields: ["payment_providers.id", "payment_providers.is_enabled"],
-    variables: {
-      id: req.params.id,
-    },
-  })
-
-  const [region] = await remoteQuery(queryObject)
-
-  res.status(200).json({
-    payment_providers: region.payment_providers.filter((pp) => pp.is_enabled),
-  })
-}

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

@@ -1,19 +1,28 @@
-import { remoteQueryObjectFromString } from "@medusajs/utils"
+import {
+  ContainerRegistrationKeys,
+  MedusaError,
+  remoteQueryObjectFromString,
+} from "@medusajs/utils"
 import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
-import { defaultStoreRegionFields } from "../query-config"
 
 export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
-  const remoteQuery = req.scope.resolve("remoteQuery")
-
-  const variables = { id: req.params.id }
-
+  const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
   const queryObject = remoteQueryObjectFromString({
     entryPoint: "region",
-    variables,
-    fields: defaultStoreRegionFields,
+    variables: {
+      filters: { id: req.params.id },
+    },
+    fields: req.remoteQueryConfig.fields,
   })
 
   const [region] = await remoteQuery(queryObject)
 
+  if (!region) {
+    throw new MedusaError(
+      MedusaError.Types.NOT_FOUND,
+      `Region with id: ${req.params.id} was not found`
+    )
+  }
+
   res.status(200).json({ region })
 }

packages/medusa/src/api-v2/store/regions/middlewares.ts

@@ -1,14 +1,14 @@
-import { transformQuery } from "../../../api/middlewares"
 import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import { validateAndTransformQuery } from "../../utils/validate-query"
 import * as QueryConfig from "./query-config"
-import { StoreGetRegionsParams, StoreRegionsRegionParams } from "./validators"
+import { StoreGetRegionParams, StoreGetRegionsParams } from "./validators"
 
 export const storeRegionRoutesMiddlewares: MiddlewareRoute[] = [
   {
     method: ["GET"],
     matcher: "/store/regions",
     middlewares: [
-      transformQuery(
+      validateAndTransformQuery(
         StoreGetRegionsParams,
         QueryConfig.listTransformQueryConfig
       ),
@@ -18,15 +18,10 @@ export const storeRegionRoutesMiddlewares: MiddlewareRoute[] = [
     method: ["GET"],
     matcher: "/store/regions/:id",
     middlewares: [
-      transformQuery(
-        StoreRegionsRegionParams,
+      validateAndTransformQuery(
+        StoreGetRegionParams,
         QueryConfig.retrieveTransformQueryConfig
       ),
     ],
   },
-  {
-    method: ["GET"],
-    matcher: "/store/regions/:id/payment-providers",
-    middlewares: [],
-  },
 ]

packages/medusa/src/api-v2/store/regions/query-config.ts

@@ -6,22 +6,16 @@ export const defaultStoreRegionFields = [
   "updated_at",
   "deleted_at",
   "metadata",
-  "countries.id",
-  "countries.iso_2",
-  "countries.iso_3",
-  "countries.num_code",
-  "countries.name",
-  "currency.code",
-  "currency.symbol",
-  "currency.symbol_native",
-  "currency.name",
+  "*countries",
 ]
 
 export const retrieveTransformQueryConfig = {
+  defaults: defaultStoreRegionFields,
   isList: false,
 }
 
 export const listTransformQueryConfig = {
+  defaults: defaultStoreRegionFields,
   defaultLimit: 20,
   isList: true,
 }

packages/medusa/src/api-v2/store/regions/route.ts

@@ -1,20 +1,27 @@
-import { remoteQueryObjectFromString } from "@medusajs/utils"
+import {
+  ContainerRegistrationKeys,
+  remoteQueryObjectFromString,
+} from "@medusajs/utils"
 import { MedusaRequest, MedusaResponse } from "../../../types/routing"
-import { defaultStoreRegionFields } from "./query-config"
 
 export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
-  const remoteQuery = req.scope.resolve("remoteQuery")
-
-  const variables = { filters: req.filterableFields }
+  const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
 
   const queryObject = remoteQueryObjectFromString({
     entryPoint: "region",
-    variables,
-    fields: defaultStoreRegionFields,
+    variables: {
+      filters: req.filterableFields,
+      ...req.remoteQueryConfig.pagination,
+    },
+    fields: req.remoteQueryConfig.fields,
   })
 
-  // TODO: Add count, offset, limit
-  const regions = await remoteQuery(queryObject)
+  const { rows: regions, metadata } = await remoteQuery(queryObject)
 
-  res.json({ regions })
+  res.json({
+    regions,
+    count: metadata.count,
+    offset: metadata.skip,
+    limit: metadata.take,
+  })
 }

packages/medusa/src/api-v2/store/regions/validators.ts

@@ -1,55 +1,20 @@
-import { OperatorMap } from "@medusajs/types"
-import { Type } from "class-transformer"
-import { IsOptional, IsString, ValidateNested } from "class-validator"
-import { FindParams, extendedFindParamsMixin } from "../../../types/common"
-import { OperatorMapValidator } from "../../../types/validators/operator-map"
+import { createFindParams, createSelectParams } from "../../utils/validators"
+import { z } from "zod"
 
-export class StoreRegionsRegionParams extends FindParams {}
+export type StoreGetRegionParamsType = z.infer<typeof StoreGetRegionParams>
+export const StoreGetRegionParams = createSelectParams()
 
-/**
- * Parameters used to filter and configure the pagination of the retrieved regions.
- */
-export class StoreGetRegionsParams extends extendedFindParamsMixin({
+export type StoreGetRegionsParamsType = z.infer<typeof StoreGetRegionsParams>
+export const StoreGetRegionsParams = createFindParams({
   limit: 50,
   offset: 0,
-}) {
-  /**
-   * Filter by currency code
-   */
-  @IsString({ each: true })
-  @IsOptional()
-  code?: string | string[]
-
-  /**
-   * Filter by region name
-   */
-  @IsString({ each: true })
-  @IsOptional()
-  name?: string | string[]
-
-  /**
-   * Date filters to apply on the regions' `created_at` date.
-   */
-  @IsOptional()
-  @ValidateNested()
-  @Type(() => OperatorMapValidator)
-  created_at?: OperatorMap<string>
-
-  /**
-   * Date filters to apply on the regions' `updated_at` date.
-   */
-  @IsOptional()
-  @ValidateNested()
-  @Type(() => OperatorMapValidator)
-  updated_at?: OperatorMap<string>
-
-  @IsOptional()
-  @ValidateNested({ each: true })
-  @Type(() => StoreGetRegionsParams)
-  $and?: StoreGetRegionsParams[]
-
-  @IsOptional()
-  @ValidateNested({ each: true })
-  @Type(() => StoreGetRegionsParams)
-  $or?: StoreGetRegionsParams[]
-}
+}).merge(
+  z.object({
+    q: z.string().optional(),
+    id: z.union([z.string(), z.array(z.string())]).optional(),
+    code: z.union([z.string(), z.array(z.string())]).optional(),
+    name: z.union([z.string(), z.array(z.string())]).optional(),
+    $and: z.lazy(() => StoreGetRegionsParams.array()).optional(),
+    $or: z.lazy(() => StoreGetRegionsParams.array()).optional(),
+  })
+)