feat(types,modules-sdk): basic module setup for promotions (#5920)

RESOLVES CORE-1580

packages/promotion/src/index.ts

@@ -0,0 +1,7 @@
+import { moduleDefinition } from "./module-definition"
+
+export default moduleDefinition
+
+export * from "./initialize"
+export * from "./loaders"
+export * from "./scripts"

packages/promotion/src/initialize/index.ts

@@ -0,0 +1,27 @@
+import {
+  ExternalModuleDeclaration,
+  InternalModuleDeclaration,
+  MODULE_PACKAGE_NAMES,
+  MedusaModule,
+  Modules,
+} from "@medusajs/modules-sdk"
+import { IPromotionModuleService, ModulesSdkTypes } from "@medusajs/types"
+import { moduleDefinition } from "../module-definition"
+import { InitializeModuleInjectableDependencies } from "../types"
+
+export const initialize = async (
+  options?: ModulesSdkTypes.ModuleBootstrapDeclaration,
+  injectedDependencies?: InitializeModuleInjectableDependencies
+): Promise<IPromotionModuleService> => {
+  const loaded = await MedusaModule.bootstrap<IPromotionModuleService>({
+    moduleKey: Modules.PROMOTION,
+    defaultPath: MODULE_PACKAGE_NAMES[Modules.PROMOTION],
+    declaration: options as
+      | InternalModuleDeclaration
+      | ExternalModuleDeclaration,
+    injectedDependencies,
+    moduleExports: moduleDefinition,
+  })
+
+  return loaded[Modules.PROMOTION]
+}

packages/promotion/src/joiner-config.ts

@@ -0,0 +1,31 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { ModuleJoinerConfig } from "@medusajs/types"
+import { MapToConfig } from "@medusajs/utils"
+import { Promotion } from "@models"
+
+export const LinkableKeys = {
+  promotion_id: Promotion.name,
+}
+
+const entityLinkableKeysMap: MapToConfig = {}
+Object.entries(LinkableKeys).forEach(([key, value]) => {
+  entityLinkableKeysMap[value] ??= []
+  entityLinkableKeysMap[value].push({
+    mapTo: key,
+    valueFrom: key.split("_").pop()!,
+  })
+})
+
+export const entityNameToLinkableKeysMap: MapToConfig = entityLinkableKeysMap
+
+export const joinerConfig: ModuleJoinerConfig = {
+  serviceName: Modules.PROMOTION,
+  primaryKeys: ["id"],
+  linkableKeys: LinkableKeys,
+  alias: {
+    name: ["promotion", "promotions"],
+    args: {
+      entity: Promotion.name,
+    },
+  },
+}

packages/promotion/src/loaders/connection.ts

@@ -0,0 +1,30 @@
+import { InternalModuleDeclaration, LoaderOptions, Modules } from "@medusajs/modules-sdk"
+import { ModulesSdkTypes } from "@medusajs/types"
+import { ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+import * as PromotionModels from "../models"
+
+export default async (
+  {
+    options,
+    container,
+    logger,
+  }: LoaderOptions<
+    | ModulesSdkTypes.ModuleServiceInitializeOptions
+    | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions
+  >,
+  moduleDeclaration?: InternalModuleDeclaration
+): Promise<void> => {
+  const entities = Object.values(PromotionModels) as unknown as EntitySchema[]
+  const pathToMigrations = __dirname + "/../migrations"
+
+  await ModulesSdkUtils.mikroOrmConnectionLoader({
+    moduleName: Modules.PROMOTION,
+    entities,
+    container,
+    options,
+    moduleDeclaration,
+    logger,
+    pathToMigrations,
+  })
+}

packages/promotion/src/loaders/container.ts

@@ -0,0 +1,38 @@
+import * as defaultRepositories from "@repositories"
+
+import { LoaderOptions } from "@medusajs/modules-sdk"
+import { ModulesSdkTypes } from "@medusajs/types"
+import { loadCustomRepositories } from "@medusajs/utils"
+import { asClass } from "awilix"
+
+export default async ({
+  container,
+  options,
+}: LoaderOptions<
+  | ModulesSdkTypes.ModuleServiceInitializeOptions
+  | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions
+>): Promise<void> => {
+  const customRepositories = (
+    options as ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions
+  )?.repositories
+
+  container.register({
+    // promotionService: asClass(defaultServices.PromotionService).singleton(),
+  })
+
+  if (customRepositories) {
+    loadCustomRepositories({
+      defaultRepositories,
+      customRepositories,
+      container,
+    })
+  } else {
+    loadDefaultRepositories({ container })
+  }
+}
+
+function loadDefaultRepositories({ container }) {
+  container.register({
+    baseRepository: asClass(defaultRepositories.BaseRepository).singleton(),
+  })
+}

packages/promotion/src/loaders/index.ts

@@ -0,0 +1,2 @@
+export * from "./connection"
+export * from "./container"

packages/promotion/src/migrations/.snapshot-medusa-promotions.json

@@ -0,0 +1,36 @@
+{
+  "namespaces": [
+    "public"
+  ],
+  "name": "public",
+  "tables": [
+    {
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        }
+      },
+      "name": "promotion",
+      "schema": "public",
+      "indexes": [
+        {
+          "keyName": "promotion_pkey",
+          "columnNames": [
+            "id"
+          ],
+          "composite": false,
+          "primary": true,
+          "unique": true
+        }
+      ],
+      "checks": [],
+      "foreignKeys": {}
+    }
+  ]
+}

packages/promotion/src/migrations/Migration20231218142613.ts

@@ -0,0 +1,9 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20231218142613 extends Migration {
+
+  async up(): Promise<void> {
+    this.addSql('create table "promotion" ("id" text not null, constraint "promotion_pkey" primary key ("id"));');
+  }
+
+}

packages/promotion/src/models/index.ts

@@ -0,0 +1 @@
+export { default as Promotion } from "./promotion"

packages/promotion/src/models/promotion.ts

@@ -0,0 +1,18 @@
+import { generateEntityId } from "@medusajs/utils"
+import { BeforeCreate, Entity, PrimaryKey, OnInit } from "@mikro-orm/core"
+
+@Entity()
+export default class Promotion {
+  @PrimaryKey({ columnType: "text" })
+  id!: string
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "promo")
+  }
+  
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "promo")
+  }
+}

packages/promotion/src/module-definition.ts

@@ -0,0 +1,12 @@
+import { ModuleExports } from "@medusajs/types"
+import { PromotionModuleService } from "@services"
+import loadConnection from "./loaders/connection"
+import loadContainer from "./loaders/container"
+
+const service = PromotionModuleService
+const loaders = [loadContainer, loadConnection] as any
+
+export const moduleDefinition: ModuleExports = {
+  service,
+  loaders,
+}

packages/promotion/src/repositories/index.ts

@@ -0,0 +1 @@
+export { MikroOrmBaseRepository as BaseRepository } from "@medusajs/utils"

packages/promotion/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/promotion/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/promotion/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-promotion-seed <filePath>`
+    )
+  }
+
+  await run({ path })
+})()

packages/promotion/src/scripts/index.ts

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

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

@@ -0,0 +1,43 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+import * as PromotionModels from "@models"
+
+/**
+ * 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(Modules.PROMOTION, options)!
+  const entities = Object.values(PromotionModels) as unknown as EntitySchema[]
+  const pathToMigrations = __dirname + "/../migrations"
+
+  const orm = await DALUtils.mikroOrmCreateConnection(
+    dbData,
+    entities,
+    pathToMigrations
+  )
+
+  try {
+    const migrator = orm.getMigrator()
+    await migrator.down()
+
+    logger?.info("Promotion module migration executed")
+  } catch (error) {
+    logger?.error(`Promotion module migration failed to run - Error: ${error}`)
+  }
+
+  await orm.close()
+}

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

@@ -0,0 +1,55 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+import * as PromotionModels 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(Modules.PROMOTION, options)!
+  const entities = Object.values(PromotionModels) as unknown as EntitySchema[]
+  const pathToMigrations = __dirname + "/../migrations"
+
+  const orm = await DALUtils.mikroOrmCreateConnection(
+    dbData,
+    entities,
+    pathToMigrations
+  )
+
+  try {
+    const migrator = orm.getMigrator()
+
+    const pendingMigrations = await migrator.getPendingMigrations()
+    logger.info(
+      `Running pending migrations: ${JSON.stringify(
+        pendingMigrations,
+        null,
+        2
+      )}`
+    )
+
+    await migrator.up({
+      migrations: pendingMigrations.map((m) => m.name),
+    })
+
+    logger.info("Promotion module migration executed")
+  } catch (error) {
+    logger.error(`Promotion module migration failed to run - Error: ${error}`)
+  }
+
+  await orm.close()
+}

packages/promotion/src/scripts/seed.ts

@@ -0,0 +1,58 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types"
+import { DALUtils, ModulesSdkUtils } from "@medusajs/utils"
+import { EntitySchema } from "@mikro-orm/core"
+import * as PromotionModels 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 { promotionsData } = 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: promotionsData.${EOL}${e}`
+      )
+      throw e
+    }
+  )
+
+  const dbData = ModulesSdkUtils.loadDatabaseConfig(Modules.PROMOTION, options)!
+  const entities = Object.values(PromotionModels) as unknown as EntitySchema[]
+  const pathToMigrations = __dirname + "/../migrations"
+
+  const orm = await DALUtils.mikroOrmCreateConnection(
+    dbData,
+    entities,
+    pathToMigrations
+  )
+
+  const manager = orm.em.fork()
+
+  try {
+    logger.info("Inserting promotions..")
+
+    // TODO: implement promotions seed data
+    // await createPromotions(manager, promotionsData)
+  } catch (e) {
+    logger.error(
+      `Failed to insert the seed data in the PostgreSQL database ${dbData.clientUrl}.${EOL}${e}`
+    )
+  }
+
+  await orm.close(true)
+}

packages/promotion/src/services/__tests__/index.spec.ts

@@ -0,0 +1,5 @@
+describe("Noop test", () => {
+  it("noop check", async () => {
+    expect(true).toBe(true)
+  })
+})

packages/promotion/src/services/index.ts

@@ -0,0 +1 @@
+export { default as PromotionModuleService } from "./promotion-module"

packages/promotion/src/services/promotion-module.ts

@@ -0,0 +1,32 @@
+import {
+  DAL,
+  InternalModuleDeclaration,
+  ModuleJoinerConfig,
+  PromotionTypes,
+} from "@medusajs/types"
+
+import { Promotion } from "@models"
+
+import { joinerConfig } from "../joiner-config"
+
+type InjectedDependencies = {
+  baseRepository: DAL.RepositoryService
+}
+
+export default class PromotionModuleService<
+  TPromotion extends Promotion = Promotion
+> implements PromotionTypes.IPromotionModuleService
+{
+  protected baseRepository_: DAL.RepositoryService
+
+  constructor(
+    { baseRepository }: InjectedDependencies,
+    protected readonly moduleDeclaration: InternalModuleDeclaration
+  ) {
+    this.baseRepository_ = baseRepository
+  }
+
+  __joinerConfig(): ModuleJoinerConfig {
+    return joinerConfig
+  }
+}

packages/promotion/src/types/index.ts

@@ -0,0 +1,5 @@
+import { Logger } from "@medusajs/types"
+
+export type InitializeModuleInjectableDependencies = {
+  logger?: Logger
+}