feat(pricing, types, utils, medusa-sdk): Pricing Module Setup + Currency (#4860)

What:

- Setups the skeleton for pricing module
- Creates service/model/repository for currency model
- Setups types
- Setups DB
- Moved some utils to a common place

RESOLVES CORE-1477
RESOLVES CORE-1476

packages/pricing/src/scripts/bin/run-migration-down.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+export default (async () => {
+  const { revertMigration } = await import("../migration-down")
+  const { config } = await import("dotenv")
+  config()
+  await revertMigration()
+})()

packages/pricing/src/scripts/bin/run-migration-up.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+export default (async () => {
+  const { runMigrations } = await import("../migration-up")
+  const { config } = await import("dotenv")
+  config()
+  await runMigrations()
+})()

packages/pricing/src/scripts/bin/run-seed.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import { EOL } from "os"
+import { run } from "../seed"
+
+const args = process.argv
+const path = args.pop() as string
+
+export default (async () => {
+  const { config } = await import("dotenv")
+  config()
+  if (!path) {
+    throw new Error(
+      `filePath is required.${EOL}Example: medusa-pricing-seed <filePath>`
+    )
+  }
+
+  await run({ path })
+})()

packages/pricing/src/scripts/index.ts

@@ -0,0 +1,2 @@
+export * from "./migration-up"
+export * from "./migration-down"

packages/pricing/src/scripts/migration-down.ts

@@ -0,0 +1,39 @@
+import * as PricingModels from "@models"
+
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+
+/**
+ * This script is only valid for mikro orm managers. If a user provide a custom manager
+ * he is in charge of reverting the migrations.
+ * @param options
+ * @param logger
+ * @param moduleDeclaration
+ */
+export async function revertMigration({
+  options,
+  logger,
+}: Pick<
+  LoaderOptions<ModulesSdkTypes.ModuleServiceInitializeOptions>,
+  "options" | "logger"
+> = {}) {
+  logger ??= console as unknown as Logger
+
+  const dbData = ModulesSdkUtils.loadDatabaseConfig("pricing", options)!
+  const entities = Object.values(PricingModels) as unknown as EntitySchema[]
+
+  const orm = await DALUtils.mikroOrmCreateConnection(dbData, entities)
+
+  try {
+    const migrator = orm.getMigrator()
+    await migrator.down()
+
+    logger?.info("Pricing module migration executed")
+  } catch (error) {
+    logger?.error(`Pricing module migration failed to run - Error: ${error}`)
+  }
+
+  await orm.close()
+}

packages/pricing/src/scripts/migration-up.ts

@@ -0,0 +1,43 @@
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+import * as PricingModels from "@models"
+
+/**
+ * This script is only valid for mikro orm managers. If a user provide a custom manager
+ * he is in charge of running the migrations.
+ * @param options
+ * @param logger
+ * @param moduleDeclaration
+ */
+export async function runMigrations({
+  options,
+  logger,
+}: Pick<
+  LoaderOptions<ModulesSdkTypes.ModuleServiceInitializeOptions>,
+  "options" | "logger"
+> = {}) {
+  logger ??= console as unknown as Logger
+
+  const dbData = ModulesSdkUtils.loadDatabaseConfig("pricing", options)!
+  const entities = Object.values(PricingModels) as unknown as EntitySchema[]
+
+  const orm = await DALUtils.mikroOrmCreateConnection(dbData, entities)
+
+  try {
+    const migrator = orm.getMigrator()
+
+    const pendingMigrations = await migrator.getPendingMigrations()
+    logger.info(`Running pending migrations: ${pendingMigrations}`)
+
+    await migrator.up({
+      migrations: pendingMigrations.map((m) => m.name),
+    })
+
+    logger.info("Pricing module migration executed")
+  } catch (error) {
+    logger.error(`Pricing module migration failed to run - Error: ${error}`)
+  }
+
+  await orm.close()
+}

packages/pricing/src/scripts/seed.ts

@@ -0,0 +1,64 @@
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema, RequiredEntityData } from "@mikro-orm/core"
+import { SqlEntityManager } from "@mikro-orm/postgresql"
+import * as PricingModels from "@models"
+import { EOL } from "os"
+import { resolve } from "path"
+
+export async function run({
+  options,
+  logger,
+  path,
+}: Partial<
+  Pick<
+    LoaderOptions<ModulesSdkTypes.ModuleServiceInitializeOptions>,
+    "options" | "logger"
+  >
+> & {
+  path: string
+}) {
+  logger ??= console as unknown as Logger
+
+  logger.info(`Loading seed data from ${path}...`)
+
+  const { currenciesData } = await import(resolve(process.cwd(), path)).catch(
+    (e) => {
+      logger?.error(
+        `Failed to load seed data from ${path}. Please, provide a relative path and check that you export the following currenciesData.${EOL}${e}`
+      )
+      throw e
+    }
+  )
+
+  const dbData = ModulesSdkUtils.loadDatabaseConfig("pricing", options)!
+  const entities = Object.values(PricingModels) as unknown as EntitySchema[]
+
+  const orm = await DALUtils.mikroOrmCreateConnection(dbData, entities)
+  const manager = orm.em.fork()
+
+  try {
+    logger.info("Inserting currencies")
+
+    await createCurrencies(manager, currenciesData)
+  } catch (e) {
+    logger.error(
+      `Failed to insert the seed data in the PostgreSQL database ${dbData.clientUrl}.${EOL}${e}`
+    )
+  }
+
+  await orm.close(true)
+}
+
+async function createCurrencies(
+  manager: SqlEntityManager,
+  data: RequiredEntityData<PricingModels.Currency>[]
+) {
+  const currencies: any[] = data.map((currencyData) => {
+    return manager.create(PricingModels.Currency, currencyData)
+  })
+
+  await manager.persistAndFlush(currencies)
+
+  return currencies
+}