feat(utils,currency): Migrate currency to use DML (#7807)

packages/modules/currency/mikro-orm.config.dev.ts

@@ -1,8 +1,7 @@
+import { defineMikroOrmCliConfig } from "@medusajs/utils"
 import * as entities from "./src/models"
 
-module.exports = {
+export default defineMikroOrmCliConfig({
   entities: Object.values(entities),
-  schema: "public",
-  clientUrl: "postgres://postgres@localhost/medusa-currency",
-  type: "postgresql",
-}
+  databaseName: "medusa-currency",
+})

packages/modules/currency/src/joiner-config.ts

@@ -5,7 +5,12 @@ import {
   Modules,
 } from "@medusajs/utils"
 
-export const joinerConfig = defineJoinerConfig(Modules.CURRENCY)
+export const joinerConfig = defineJoinerConfig(Modules.CURRENCY, {
+  primaryKeys: ["code"],
+  linkableKeys: {
+    currency_code: "currency",
+  },
+})
 
 export const entityNameToLinkableKeysMap: MapToConfig =
   buildEntitiesNameToLinkableKeysMap(joinerConfig.linkableKeys)

packages/modules/currency/src/loaders/initial-data.ts

@@ -14,7 +14,7 @@ export default async ({
   const logger =
     container.resolve<Logger>(ContainerRegistrationKeys.LOGGER) ?? console
   const { currencyService_ } = container.resolve<{
-    currencyService_: ModulesSdkTypes.IMedusaInternalService<Currency>
+    currencyService_: ModulesSdkTypes.IMedusaInternalService<typeof Currency>
   }>(ModuleRegistrationName.CURRENCY)
 
   try {

packages/modules/currency/src/migrations/.snapshot-medusa-currency.json

@@ -42,7 +42,7 @@
         },
         "decimal_digits": {
           "name": "decimal_digits",
-          "type": "int",
+          "type": "integer",
           "unsigned": false,
           "autoincrement": false,
           "primary": false,
@@ -90,6 +90,16 @@
           "length": 6,
           "default": "now()",
           "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
         }
       },
       "name": "currency",

packages/modules/currency/src/migrations/Migration20240624082354.ts

@@ -0,0 +1,15 @@
+import { Migration } from "@mikro-orm/migrations"
+
+export class Migration20240624082354 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(
+      'alter table if exists "currency" add column if not exists "deleted_at" timestamptz null;'
+    )
+  }
+
+  async down(): Promise<void> {
+    this.addSql(
+      'alter table if exists "currency" drop column if exists "deleted_at";'
+    )
+  }
+}

packages/modules/currency/src/models/currency.ts

@@ -1,50 +1,10 @@
-import { BigNumberRawValue } from "@medusajs/types"
-import {
-  BigNumber,
-  MikroOrmBigNumberProperty,
-  Searchable,
-} from "@medusajs/utils"
-import { Entity, PrimaryKey, Property } from "@mikro-orm/core"
+import { model } from "@medusajs/utils"
 
-@Entity({ tableName: "currency" })
-class Currency {
-  @Searchable()
-  @PrimaryKey({ columnType: "text" })
-  code!: string
-
-  @Property({ columnType: "text" })
-  symbol: string
-
-  @Property({ columnType: "text" })
-  symbol_native: string
-
-  @Searchable()
-  @Property({ columnType: "text" })
-  name: string
-
-  @Property({ columnType: "int", default: 0 })
-  decimal_digits: number
-
-  @MikroOrmBigNumberProperty({ default: 0 })
-  rounding: BigNumber | number
-
-  @Property({ columnType: "jsonb" })
-  raw_rounding: BigNumberRawValue
-
-  @Property({
-    onCreate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
-  })
-  created_at: Date
-
-  @Property({
-    onCreate: () => new Date(),
-    onUpdate: () => new Date(),
-    columnType: "timestamptz",
-    defaultRaw: "now()",
-  })
-  updated_at: Date
-}
-
-export default Currency
+export default model.define("currency", {
+  code: model.text().primaryKey(),
+  symbol: model.text(),
+  symbol_native: model.text(),
+  name: model.text(),
+  decimal_digits: model.number().default(0),
+  rounding: model.bigNumber().default(0),
+})

packages/modules/currency/src/services/currency-module-service.ts

@@ -11,9 +11,9 @@ import {
   ModulesSdkTypes,
 } from "@medusajs/types"
 
+import { MedusaService } from "@medusajs/utils"
 import { Currency } from "@models"
 import { entityNameToLinkableKeysMap, joinerConfig } from "../joiner-config"
-import { MedusaService } from "@medusajs/utils"
 
 type InjectedDependencies = {
   baseRepository: DAL.RepositoryService
@@ -27,7 +27,9 @@ export default class CurrencyModuleService
   implements ICurrencyModuleService
 {
   protected baseRepository_: DAL.RepositoryService
-  protected readonly currencyService_: ModulesSdkTypes.IMedusaInternalService<Currency>
+  protected readonly currencyService_: ModulesSdkTypes.IMedusaInternalService<
+    typeof Currency
+  >
 
   constructor(
     { baseRepository, currencyService }: InjectedDependencies,