feat: Add currency module and remove currency models from region and pricing modules (#6536)

What:
- Creates a new currency module
- Removes currency model from the pricing module
- Removes currency model from region module

packages/medusa/src/api-v2/admin/currencies/[code]/route.ts

@@ -0,0 +1,18 @@
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
+import { defaultAdminCurrencyFields } from "../query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const variables = { code: req.params.code }
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "currency",
+    variables,
+    fields: defaultAdminCurrencyFields,
+  })
+
+  const [currency] = await remoteQuery(queryObject)
+  res.status(200).json({ currency })
+}

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

@@ -0,0 +1,36 @@
+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 {
+  AdminGetCurrenciesCurrencyParams,
+  AdminGetCurrenciesParams,
+} from "./validators"
+
+export const adminCurrencyRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    method: ["ALL"],
+    matcher: "/admin/currencies*",
+    middlewares: [authenticate("admin", ["bearer", "session", "api-key"])],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/currencies",
+    middlewares: [
+      transformQuery(
+        AdminGetCurrenciesParams,
+        QueryConfig.listTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/currencies/:code",
+    middlewares: [
+      transformQuery(
+        AdminGetCurrenciesCurrencyParams,
+        QueryConfig.retrieveTransformQueryConfig
+      ),
+    ],
+  },
+]

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

@@ -0,0 +1,20 @@
+export const defaultAdminCurrencyRelations = []
+export const allowedAdminCurrencyRelations = []
+export const defaultAdminCurrencyFields = [
+  "code",
+  "name",
+  "symbol",
+  "symbol_native",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultAdminCurrencyFields,
+  defaultRelations: defaultAdminCurrencyRelations,
+  allowedRelations: allowedAdminCurrencyRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  defaultLimit: 50,
+  isList: true,
+}

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

@@ -0,0 +1,27 @@
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../types/routing"
+import { defaultAdminCurrencyFields } from "./query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "currency",
+    variables: {
+      filters: req.filterableFields,
+      order: req.listConfig.order,
+      skip: req.listConfig.skip,
+      take: req.listConfig.take,
+    },
+    fields: defaultAdminCurrencyFields,
+  })
+
+  const { rows: currencies, metadata } = await remoteQuery(queryObject)
+
+  res.json({
+    currencies,
+    count: metadata.count,
+    offset: metadata.skip,
+    limit: metadata.take,
+  })
+}

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

@@ -0,0 +1,30 @@
+import { Type } from "class-transformer"
+import { IsOptional, IsString, ValidateNested } from "class-validator"
+import { FindParams, extendedFindParamsMixin } from "../../../types/common"
+
+export class AdminGetCurrenciesCurrencyParams extends FindParams {}
+/**
+ * Parameters used to filter and configure the pagination of the retrieved currencies.
+ */
+export class AdminGetCurrenciesParams extends extendedFindParamsMixin({
+  limit: 50,
+  offset: 0,
+}) {
+  /**
+   * Search parameter for currencies.
+   */
+  @IsString({ each: true })
+  @IsOptional()
+  code?: string | string[]
+
+  // Additional filters from BaseFilterable
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetCurrenciesParams)
+  $and?: AdminGetCurrenciesParams[]
+
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => AdminGetCurrenciesParams)
+  $or?: AdminGetCurrenciesParams[]
+}

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

@@ -1,5 +1,5 @@
-export const defaultAdminRegionRelations = ["countries", "currency"]
-export const allowedAdminRegionRelations = ["countries", "currency"]
+export const defaultAdminRegionRelations = ["countries"]
+export const allowedAdminRegionRelations = ["countries"]
 export const defaultAdminRegionFields = [
   "id",
   "name",
@@ -13,10 +13,6 @@ export const defaultAdminRegionFields = [
   "countries.iso_3",
   "countries.num_code",
   "countries.name",
-  "currency.code",
-  "currency.symbol",
-  "currency.symbol_native",
-  "currency.name",
 ]
 
 export const retrieveTransformQueryConfig = {

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

@@ -16,6 +16,8 @@ import { storeCartRoutesMiddlewares } from "./store/carts/middlewares"
 import { storeCustomerRoutesMiddlewares } from "./store/customers/middlewares"
 import { storeRegionRoutesMiddlewares } from "./store/regions/middlewares"
 import { hooksRoutesMiddlewares } from "./hooks/middlewares"
+import { adminCurrencyRoutesMiddlewares } from "./admin/currencies/middlewares"
+import { storeCurrencyRoutesMiddlewares } from "./store/currencies/middlewares"
 
 export const config: MiddlewaresConfig = {
   routes: [
@@ -37,5 +39,7 @@ export const config: MiddlewaresConfig = {
     ...adminApiKeyRoutesMiddlewares,
     ...hooksRoutesMiddlewares,
     ...adminStoreRoutesMiddlewares,
+    ...adminCurrencyRoutesMiddlewares,
+    ...storeCurrencyRoutesMiddlewares,
   ],
 }

packages/medusa/src/api-v2/store/currencies/[code]/route.ts

@@ -0,0 +1,18 @@
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
+import { defaultStoreCurrencyFields } from "../query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const variables = { code: req.params.code }
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "currency",
+    variables,
+    fields: defaultStoreCurrencyFields,
+  })
+
+  const [currency] = await remoteQuery(queryObject)
+  res.status(200).json({ currency })
+}

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

@@ -0,0 +1,31 @@
+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 {
+  StoreGetCurrenciesCurrencyParams,
+  StoreGetCurrenciesParams,
+} from "./validators"
+
+export const storeCurrencyRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    method: ["GET"],
+    matcher: "/store/currencies",
+    middlewares: [
+      transformQuery(
+        StoreGetCurrenciesParams,
+        QueryConfig.listTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/store/currencies/:code",
+    middlewares: [
+      transformQuery(
+        StoreGetCurrenciesCurrencyParams,
+        QueryConfig.retrieveTransformQueryConfig
+      ),
+    ],
+  },
+]

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

@@ -0,0 +1,20 @@
+export const defaultStoreCurrencyRelations = []
+export const allowedStoreCurrencyRelations = []
+export const defaultStoreCurrencyFields = [
+  "code",
+  "name",
+  "symbol",
+  "symbol_native",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultStoreCurrencyFields,
+  defaultRelations: defaultStoreCurrencyRelations,
+  allowedRelations: allowedStoreCurrencyRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  defaultLimit: 20,
+  isList: true,
+}

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

@@ -0,0 +1,27 @@
+import { remoteQueryObjectFromString } from "@medusajs/utils"
+import { MedusaRequest, MedusaResponse } from "../../../types/routing"
+import { defaultStoreCurrencyFields } from "./query-config"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const remoteQuery = req.scope.resolve("remoteQuery")
+
+  const queryObject = remoteQueryObjectFromString({
+    entryPoint: "currency",
+    variables: {
+      filters: req.filterableFields,
+      order: req.listConfig.order,
+      skip: req.listConfig.skip,
+      take: req.listConfig.take,
+    },
+    fields: defaultStoreCurrencyFields,
+  })
+
+  const { rows: currencies, metadata } = await remoteQuery(queryObject)
+
+  res.json({
+    currencies,
+    count: metadata.count,
+    offset: metadata.skip,
+    limit: metadata.take,
+  })
+}

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

@@ -0,0 +1,30 @@
+import { Type } from "class-transformer"
+import { IsOptional, IsString, ValidateNested } from "class-validator"
+import { FindParams, extendedFindParamsMixin } from "../../../types/common"
+
+export class StoreGetCurrenciesCurrencyParams extends FindParams {}
+/**
+ * Parameters used to filter and configure the pagination of the retrieved currencies.
+ */
+export class StoreGetCurrenciesParams extends extendedFindParamsMixin({
+  limit: 50,
+  offset: 0,
+}) {
+  /**
+   * Search parameter for currencies.
+   */
+  @IsString({ each: true })
+  @IsOptional()
+  code?: string | string[]
+
+  // Additional filters from BaseFilterable
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => StoreGetCurrenciesParams)
+  $and?: StoreGetCurrenciesParams[]
+
+  @IsOptional()
+  @ValidateNested({ each: true })
+  @Type(() => StoreGetCurrenciesParams)
+  $or?: StoreGetCurrenciesParams[]
+}

packages/medusa/src/scripts/migrate-to-pricing-module.ts

@@ -176,33 +176,6 @@ const migratePriceLists = async (container: AwilixContainer) => {
   }
 }
 
-const ensureCurrencies = async (container: AwilixContainer) => {
-  const currenciesService: CurrencyService =
-    container.resolve("currencyService")
-
-  const pricingModuleService: IPricingModuleService = container.resolve(
-    "pricingModuleService"
-  )
-
-  const [coreCurrencies, totalCurrencies] =
-    await currenciesService.listAndCount({}, {})
-
-  const moduleCurrencies = await pricingModuleService.listCurrencies(
-    {},
-    { take: 100000 }
-  )
-
-  const moduleCurrenciesSet = new Set(moduleCurrencies.map(({ code }) => code))
-
-  const currenciesToCreate = coreCurrencies
-    .filter(({ code }) => {
-      return !moduleCurrenciesSet.has(code)
-    })
-    .map(({ includes_tax, ...currency }) => currency)
-
-  await pricingModuleService.createCurrencies(currenciesToCreate)
-}
-
 const migrate = async function ({ directory }) {
   const app = express()
 
@@ -212,11 +185,6 @@ const migrate = async function ({ directory }) {
     isTest: false,
   })
 
-  Logger.info("-----------------------------------------------")
-  Logger.info("------------- Creating currencies -------------")
-  Logger.info("-----------------------------------------------")
-  await ensureCurrencies(container)
-
   Logger.info("-----------------------------------------------")
   Logger.info("--------- Creating default rule types ---------")
   Logger.info("-----------------------------------------------")