feat(tax): tax module scaffolding (#6417)

**What**
- Scaffolds the tax module

packages/tax/src/index.ts

@@ -0,0 +1,13 @@
+import { initializeFactory, Modules } from "@medusajs/modules-sdk"
+import { moduleDefinition } from "./module-definition"
+
+export * from "./models"
+export * from "./services"
+
+export const initialize = initializeFactory({
+  moduleName: Modules.TAX,
+  moduleDefinition,
+})
+export const runMigrations = moduleDefinition.runMigrations
+export const revertMigration = moduleDefinition.revertMigration
+export default moduleDefinition

packages/tax/src/joiner-config.ts

@@ -0,0 +1,25 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { ModuleJoinerConfig } from "@medusajs/types"
+import { MapToConfig } from "@medusajs/utils"
+
+export const LinkableKeys: Record<string, string> = {
+  tax_rate_id: "TaxRate",
+}
+
+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.TAX,
+  primaryKeys: ["id"],
+  linkableKeys: LinkableKeys,
+  alias: [],
+} as ModuleJoinerConfig

packages/tax/src/models/index.ts

@@ -0,0 +1 @@
+export { default as TaxRate } from "./tax-rate"

packages/tax/src/models/tax-rate.ts

@@ -0,0 +1,60 @@
+import { DAL } from "@medusajs/types"
+import { generateEntityId } from "@medusajs/utils"
+import {
+  BeforeCreate,
+  Entity,
+  OnInit,
+  OptionalProps,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+
+type OptionalTaxRateProps = DAL.EntityDateColumns
+
+@Entity({ tableName: "tax_rate" })
+export default class TaxRate {
+  [OptionalProps]: OptionalTaxRateProps
+
+  @PrimaryKey({ columnType: "text" })
+  id!: string
+
+  @Property({ columnType: "real", nullable: true })
+  rate: number | null = null
+
+  @Property({ columnType: "text", nullable: true })
+  code: string | null = null
+
+  @Property({ columnType: "text" })
+  name: string
+
+  @Property({ columnType: "jsonb", nullable: true })
+  metadata: Record<string, unknown> | null = null
+
+  @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
+
+  @Property({ columnType: "text", nullable: true })
+  created_by: string | null = null
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "txr")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "txr")
+  }
+}

packages/tax/src/module-definition.ts

@@ -0,0 +1,43 @@
+import { MikroOrmBaseRepository, ModulesSdkUtils } from "@medusajs/utils"
+import { Modules } from "@medusajs/modules-sdk"
+import { ModuleExports } from "@medusajs/types"
+import * as Models from "@models"
+import * as ModuleModels from "@models"
+import * as ModuleServices from "@services"
+import { TaxModuleService } from "@services"
+
+const migrationScriptOptions = {
+  moduleName: Modules.TAX,
+  models: Models,
+  pathToMigrations: __dirname + "/migrations",
+}
+
+const runMigrations = ModulesSdkUtils.buildMigrationScript(
+  migrationScriptOptions
+)
+
+const revertMigration = ModulesSdkUtils.buildRevertMigrationScript(
+  migrationScriptOptions
+)
+
+const containerLoader = ModulesSdkUtils.moduleContainerLoaderFactory({
+  moduleModels: ModuleModels,
+  moduleRepositories: { BaseRepository: MikroOrmBaseRepository },
+  moduleServices: ModuleServices,
+})
+
+const connectionLoader = ModulesSdkUtils.mikroOrmConnectionLoaderFactory({
+  moduleName: Modules.TAX,
+  moduleModels: Object.values(Models),
+  migrationsPath: __dirname + "/migrations",
+})
+
+const service = TaxModuleService
+const loaders = [containerLoader, connectionLoader] as any
+
+export const moduleDefinition: ModuleExports = {
+  service,
+  loaders,
+  revertMigration,
+  runMigrations,
+}

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

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+import { Modules } from "@medusajs/modules-sdk"
+import { ModulesSdkUtils } from "@medusajs/utils"
+import * as Models from "@models"
+import { EOL } from "os"
+
+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-tax-seed <filePath>`
+    )
+  }
+
+  const run = ModulesSdkUtils.buildSeedScript({
+    moduleName: Modules.TAX,
+    models: Models,
+    pathToMigrations: __dirname + "/../../migrations",
+    seedHandler: async ({ manager, data }) => {
+      // TODO: Add seed logic
+    },
+  })
+  await run({ path })
+})()

packages/tax/src/services/__tests__/noop.ts

@@ -0,0 +1,5 @@
+describe("noop", function () {
+  it("should run", function () {
+    expect(true).toBe(true)
+  })
+})

packages/tax/src/services/index.ts

@@ -0,0 +1 @@
+export { default as TaxModuleService } from "./tax-module-service"

packages/tax/src/services/tax-module-service.ts

@@ -0,0 +1,81 @@
+import {
+  Context,
+  DAL,
+  ITaxRateModuleService,
+  InternalModuleDeclaration,
+  ModuleJoinerConfig,
+  ModulesSdkTypes,
+  TaxTypes,
+} from "@medusajs/types"
+import {
+  InjectManager,
+  InjectTransactionManager,
+  MedusaContext,
+  ModulesSdkUtils,
+} from "@medusajs/utils"
+import { TaxRate } from "@models"
+import { entityNameToLinkableKeysMap, joinerConfig } from "../joiner-config"
+
+type InjectedDependencies = {
+  baseRepository: DAL.RepositoryService
+  taxRateService: ModulesSdkTypes.InternalModuleService<any>
+}
+
+export default class TaxModuleService<TTaxRate extends TaxRate = TaxRate>
+  extends ModulesSdkUtils.abstractModuleServiceFactory<
+    InjectedDependencies,
+    TaxTypes.TaxRateDTO,
+    {}
+  >(TaxRate, [], entityNameToLinkableKeysMap)
+  implements ITaxRateModuleService
+{
+  protected baseRepository_: DAL.RepositoryService
+  protected taxRateService_: ModulesSdkTypes.InternalModuleService<TTaxRate>
+
+  constructor(
+    { baseRepository, taxRateService }: InjectedDependencies,
+    protected readonly moduleDeclaration: InternalModuleDeclaration
+  ) {
+    // @ts-ignore
+    super(...arguments)
+
+    this.baseRepository_ = baseRepository
+    this.taxRateService_ = taxRateService
+  }
+
+  __joinerConfig(): ModuleJoinerConfig {
+    return joinerConfig
+  }
+
+  async create(
+    data: TaxTypes.CreateTaxRateDTO[],
+    sharedContext?: Context
+  ): Promise<TaxTypes.TaxRateDTO[]>
+
+  async create(
+    data: TaxTypes.CreateTaxRateDTO,
+    sharedContext?: Context
+  ): Promise<TaxTypes.TaxRateDTO>
+
+  @InjectManager("baseRepository_")
+  async create(
+    data: TaxTypes.CreateTaxRateDTO[] | TaxTypes.CreateTaxRateDTO,
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<TaxTypes.TaxRateDTO[] | TaxTypes.TaxRateDTO> {
+    const input = Array.isArray(data) ? data : [data]
+    const rates = await this.create_(input, sharedContext)
+    const result = await this.baseRepository_.serialize<TaxTypes.TaxRateDTO>(
+      rates,
+      { populate: true }
+    )
+    return Array.isArray(data) ? result : result[0]
+  }
+
+  @InjectTransactionManager("baseRepository_")
+  protected async create_(
+    data: TaxTypes.CreateTaxRateDTO[],
+    @MedusaContext() sharedContext: Context = {}
+  ) {
+    return await this.taxRateService_.create(data, sharedContext)
+  }
+}