feat: sales channel module (#5923)

packages/sales-channel/src/index.ts

@@ -0,0 +1,27 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { ModulesSdkUtils } from "@medusajs/utils"
+
+import * as SalesChannelModels from "@models"
+
+import { moduleDefinition } from "./module-definition"
+
+export default moduleDefinition
+
+const migrationScriptOptions = {
+  moduleName: Modules.SALES_CHANNEL,
+  models: SalesChannelModels,
+  pathToMigrations: __dirname + "/migrations",
+}
+
+export const runMigrations = ModulesSdkUtils.buildMigrationScript(
+  migrationScriptOptions
+)
+export const revertMigration = ModulesSdkUtils.buildRevertMigrationScript(
+  migrationScriptOptions
+)
+
+export * from "./initialize"
+export * from "./types"
+export * from "./loaders"
+export * from "./models"
+export * from "./services"

packages/sales-channel/src/initialize/index.ts

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

packages/sales-channel/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 { SalesChannel } from "@models"
+
+export const LinkableKeys = {
+  sales_channel_id: SalesChannel.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.SALES_CHANNEL,
+  primaryKeys: ["id"],
+  linkableKeys: LinkableKeys,
+  alias: [
+    {
+      name: ["sales_channel", "sales_channels"],
+      args: { entity: "SalesChannel" },
+    },
+  ],
+} as ModuleJoinerConfig

packages/sales-channel/src/loaders/connection.ts

@@ -0,0 +1,37 @@
+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 SalesChannelModels from "@models"
+
+export default async (
+  {
+    options,
+    container,
+    logger,
+  }: LoaderOptions<
+    | ModulesSdkTypes.ModuleServiceInitializeOptions
+    | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions
+  >,
+  moduleDeclaration?: InternalModuleDeclaration
+): Promise<void> => {
+  const entities = Object.values(
+    SalesChannelModels
+  ) as unknown as EntitySchema[]
+  const pathToMigrations = __dirname + "/../migrations"
+
+  await ModulesSdkUtils.mikroOrmConnectionLoader({
+    moduleName: Modules.SALES_CHANNEL,
+    entities,
+    container,
+    options,
+    moduleDeclaration,
+    logger,
+    pathToMigrations,
+  })
+}

packages/sales-channel/src/loaders/container.ts

@@ -0,0 +1,10 @@
+import { ModulesSdkUtils } from "@medusajs/utils"
+import * as ModuleModels from "@models"
+import * as ModuleRepositories from "@repositories"
+import * as ModuleServices from "@services"
+
+export default ModulesSdkUtils.moduleContainerLoaderFactory({
+  moduleModels: ModuleModels,
+  moduleRepositories: ModuleRepositories,
+  moduleServices: ModuleServices,
+})

packages/sales-channel/src/loaders/index.ts

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

packages/sales-channel/src/migrations/.snapshot-medusa-sales-channel-tst.json

@@ -0,0 +1,105 @@
+{
+  "namespaces": [
+    "public"
+  ],
+  "name": "public",
+  "tables": [
+    {
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "name": {
+          "name": "name",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "description": {
+          "name": "description",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "text"
+        },
+        "is_disabled": {
+          "name": "is_disabled",
+          "type": "boolean",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "default": "false",
+          "mappedType": "boolean"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "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": "sales_channel",
+      "schema": "public",
+      "indexes": [
+        {
+          "columnNames": [
+            "deleted_at"
+          ],
+          "composite": false,
+          "keyName": "IDX_sales_channel_deleted_at",
+          "primary": false,
+          "unique": false
+        },
+        {
+          "keyName": "sales_channel_pkey",
+          "columnNames": [
+            "id"
+          ],
+          "composite": false,
+          "primary": true,
+          "unique": true
+        }
+      ],
+      "checks": [],
+      "foreignKeys": {}
+    }
+  ]
+}

packages/sales-channel/src/migrations/Migration20240115152146.ts

@@ -0,0 +1,12 @@
+import { Migration } from "@mikro-orm/migrations"
+
+export class Migration20240115152146 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(
+      'create table if not exists "sales_channel" ("id" text not null, "name" text not null, "description" text null, "is_disabled" boolean not null default false, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "sales_channel_pkey" primary key ("id"));'
+    )
+    this.addSql(
+      'create index "IDX_sales_channel_deleted_at" on "sales_channel" ("deleted_at");'
+    )
+  }
+}

packages/sales-channel/src/models/index.ts

@@ -0,0 +1 @@
+export { default as SalesChannel } from "./sales-channel"

packages/sales-channel/src/models/sales-channel.ts

@@ -0,0 +1,61 @@
+import { DALUtils, generateEntityId } from "@medusajs/utils"
+
+import {
+  BeforeCreate,
+  Entity,
+  Filter,
+  Index,
+  OptionalProps,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+import { DAL } from "@medusajs/types"
+
+type SalesChannelOptionalProps = "is_disabled" | DAL.EntityDateColumns
+
+@Entity()
+@Filter(DALUtils.mikroOrmSoftDeletableFilterOptions)
+export default class SalesChannel {
+  [OptionalProps]?: SalesChannelOptionalProps
+
+  @PrimaryKey({ columnType: "text" })
+  id!: string
+
+  @Property({ columnType: "text" })
+  name!: string
+
+  @Property({ columnType: "text", nullable: true })
+  description: string | null = null
+
+  @Property({ columnType: "boolean", default: false })
+  is_disabled = false
+
+  @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
+
+  @Index({ name: "IDX_sales_channel_deleted_at" })
+  @Property({ columnType: "timestamptz", nullable: true })
+  deleted_at: Date | null = null
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "sc")
+  }
+
+  @BeforeCreate()
+  onInit() {
+    this.id = generateEntityId(this.id, "sc")
+  }
+}

packages/sales-channel/src/module-definition.ts

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

packages/sales-channel/src/repositories/index.ts

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

packages/sales-channel/src/scripts/bin/run-seed.ts

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+
+import { ModulesSdkUtils } from "@medusajs/utils"
+import { Modules } from "@medusajs/modules-sdk"
+import * as ProductModels from "@models"
+import { createSalesChannels } from "../seed-utils"
+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-product-seed <filePath>`
+    )
+  }
+
+  const run = ModulesSdkUtils.buildSeedScript({
+    moduleName: Modules.PRODUCT,
+    models: ProductModels,
+    pathToMigrations: __dirname + "/../../migrations",
+    seedHandler: async ({ manager, data }) => {
+      const { salesChannelData } = data
+      await createSalesChannels(manager, salesChannelData)
+    },
+  })
+  await run({ path })
+})()

packages/sales-channel/src/scripts/seed-utils.ts

@@ -0,0 +1,16 @@
+import { SalesChannel } from "@models"
+import { RequiredEntityData } from "@mikro-orm/core"
+import { SqlEntityManager } from "@mikro-orm/postgresql"
+
+export async function createSalesChannels(
+  manager: SqlEntityManager,
+  data: RequiredEntityData<SalesChannel>[]
+) {
+  const channels = data.map((channel) => {
+    return manager.create(SalesChannel, channel)
+  })
+
+  await manager.persistAndFlush(channels)
+
+  return channels
+}

packages/sales-channel/src/services/__fixtures__/sales-channel.ts

@@ -0,0 +1,17 @@
+import { SalesChannelService, SalesChannelModuleService } from "@services"
+import { asClass, asValue, createContainer } from "awilix"
+
+export const mockContainer = createContainer()
+
+mockContainer.register({
+  transaction: asValue(async (task) => await task()),
+  salesChannelRepository: asValue({
+    find: jest.fn().mockImplementation(async ({ where: { code } }) => {
+      return [{}]
+    }),
+    findAndCount: jest.fn().mockResolvedValue([[], 0]),
+    getFreshManager: jest.fn().mockResolvedValue({}),
+  }),
+  salesChannelService: asClass(SalesChannelService),
+  salesChannelModuleService: asClass(SalesChannelModuleService),
+})

packages/sales-channel/src/services/__tests__/sales-channle.spec.ts

@@ -0,0 +1,34 @@
+import { mockContainer } from "../__fixtures__/sales-channel"
+
+describe("Sales channel service", function () {
+  beforeEach(function () {
+    jest.clearAllMocks()
+  })
+
+  it("should list sales channels with filters and relations", async function () {
+    const salesChannelRepository = mockContainer.resolve(
+      "salesChannelRepository"
+    )
+    const salesChannelService = mockContainer.resolve("salesChannelService")
+
+    const config = {
+      select: ["id", "name"],
+    }
+
+    await salesChannelService.list({}, config)
+
+    expect(salesChannelRepository.find).toHaveBeenCalledWith(
+      {
+        where: {},
+        options: {
+          fields: ["id", "name"],
+          limit: 15,
+          offset: 0,
+          withDeleted: undefined,
+          populate: [],
+        },
+      },
+      expect.any(Object)
+    )
+  })
+})

packages/sales-channel/src/services/index.ts

@@ -0,0 +1,2 @@
+export { default as SalesChannelService } from "./sales-channel"
+export { default as SalesChannelModuleService } from "./sales-channel-module"

packages/sales-channel/src/services/sales-channel-module.ts

@@ -0,0 +1,247 @@
+import {
+  Context,
+  DAL,
+  FilterableSalesChannelProps,
+  FindConfig,
+  InternalModuleDeclaration,
+  ISalesChannelModuleService,
+  ModuleJoinerConfig,
+  RestoreReturn,
+  SalesChannelDTO,
+  SoftDeleteReturn,
+} from "@medusajs/types"
+import {
+  InjectManager,
+  InjectTransactionManager,
+  mapObjectTo,
+  MedusaContext,
+} from "@medusajs/utils"
+import { CreateSalesChannelDTO, UpdateSalesChannelDTO } from "@medusajs/types"
+
+import { SalesChannel } from "@models"
+
+import SalesChannelService from "./sales-channel"
+import {
+  joinerConfig,
+  entityNameToLinkableKeysMap,
+  LinkableKeys,
+} from "../joiner-config"
+
+type InjectedDependencies = {
+  baseRepository: DAL.RepositoryService
+  salesChannelService: SalesChannelService<any>
+}
+
+export default class SalesChannelModuleService<
+  TEntity extends SalesChannel = SalesChannel
+> implements ISalesChannelModuleService
+{
+  protected baseRepository_: DAL.RepositoryService
+  protected readonly salesChannelService_: SalesChannelService<TEntity>
+
+  constructor(
+    { baseRepository, salesChannelService }: InjectedDependencies,
+    protected readonly moduleDeclaration: InternalModuleDeclaration
+  ) {
+    this.baseRepository_ = baseRepository
+    this.salesChannelService_ = salesChannelService
+  }
+
+  __joinerConfig(): ModuleJoinerConfig {
+    return joinerConfig
+  }
+
+  async create(
+    data: CreateSalesChannelDTO[],
+    sharedContext?: Context
+  ): Promise<SalesChannelDTO[]>
+
+  async create(
+    data: CreateSalesChannelDTO,
+    sharedContext?: Context
+  ): Promise<SalesChannelDTO>
+
+  @InjectTransactionManager("baseRepository_")
+  async create(
+    data: CreateSalesChannelDTO | CreateSalesChannelDTO[],
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<SalesChannelDTO | SalesChannelDTO[]> {
+    const input = Array.isArray(data) ? data : [data]
+
+    const result = await this.salesChannelService_.create(input, sharedContext)
+
+    return await this.baseRepository_.serialize<SalesChannelDTO[]>(
+      Array.isArray(data) ? result : result[0],
+      {
+        populate: true,
+      }
+    )
+  }
+
+  async delete(ids: string[], sharedContext?: Context): Promise<void>
+
+  async delete(id: string, sharedContext?: Context): Promise<void>
+
+  @InjectTransactionManager("baseRepository_")
+  async delete(
+    ids: string | string[],
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<void> {
+    const salesChannelIds = Array.isArray(ids) ? ids : [ids]
+    await this.salesChannelService_.delete(salesChannelIds, sharedContext)
+  }
+
+  @InjectTransactionManager("baseRepository_")
+  protected async softDelete_(
+    salesChannelIds: string[],
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<[TEntity[], Record<string, unknown[]>]> {
+    return await this.salesChannelService_.softDelete(
+      salesChannelIds,
+      sharedContext
+    )
+  }
+
+  @InjectManager("baseRepository_")
+  async softDelete<
+    TReturnableLinkableKeys extends string = Lowercase<
+      keyof typeof LinkableKeys
+    >
+  >(
+    salesChannelIds: string[],
+    { returnLinkableKeys }: SoftDeleteReturn<TReturnableLinkableKeys> = {},
+    sharedContext: Context = {}
+  ): Promise<Record<Lowercase<keyof typeof LinkableKeys>, string[]> | void> {
+    const [_, cascadedEntitiesMap] = await this.softDelete_(
+      salesChannelIds,
+      sharedContext
+    )
+
+    let mappedCascadedEntitiesMap
+    if (returnLinkableKeys) {
+      mappedCascadedEntitiesMap = mapObjectTo<
+        Record<Lowercase<keyof typeof LinkableKeys>, string[]>
+      >(cascadedEntitiesMap, entityNameToLinkableKeysMap, {
+        pick: returnLinkableKeys,
+      })
+    }
+
+    return mappedCascadedEntitiesMap ? mappedCascadedEntitiesMap : void 0
+  }
+
+  @InjectTransactionManager("baseRepository_")
+  async restore_(
+    salesChannelIds: string[],
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<[TEntity[], Record<string, unknown[]>]> {
+    return await this.salesChannelService_.restore(
+      salesChannelIds,
+      sharedContext
+    )
+  }
+
+  @InjectManager("baseRepository_")
+  async restore<
+    TReturnableLinkableKeys extends string = Lowercase<
+      keyof typeof LinkableKeys
+    >
+  >(
+    salesChannelIds: string[],
+    { returnLinkableKeys }: RestoreReturn<TReturnableLinkableKeys> = {},
+    sharedContext: Context = {}
+  ): Promise<Record<Lowercase<keyof typeof LinkableKeys>, string[]> | void> {
+    const [_, cascadedEntitiesMap] = await this.restore_(
+      salesChannelIds,
+      sharedContext
+    )
+
+    let mappedCascadedEntitiesMap
+    if (returnLinkableKeys) {
+      mappedCascadedEntitiesMap = mapObjectTo<
+        Record<Lowercase<keyof typeof LinkableKeys>, string[]>
+      >(cascadedEntitiesMap, entityNameToLinkableKeysMap, {
+        pick: returnLinkableKeys,
+      })
+    }
+
+    return mappedCascadedEntitiesMap ? mappedCascadedEntitiesMap : void 0
+  }
+
+  async update(
+    data: UpdateSalesChannelDTO[],
+    sharedContext?: Context
+  ): Promise<SalesChannelDTO[]>
+
+  async update(
+    data: UpdateSalesChannelDTO,
+    sharedContext?: Context
+  ): Promise<SalesChannelDTO>
+
+  @InjectTransactionManager("baseRepository_")
+  async update(
+    data: UpdateSalesChannelDTO | UpdateSalesChannelDTO[],
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<SalesChannelDTO | SalesChannelDTO[]> {
+    const input = Array.isArray(data) ? data : [data]
+
+    const result = await this.salesChannelService_.update(input, sharedContext)
+
+    return await this.baseRepository_.serialize<SalesChannelDTO[]>(
+      Array.isArray(data) ? result : result[0],
+      {
+        populate: true,
+      }
+    )
+  }
+
+  @InjectManager("baseRepository_")
+  async retrieve(
+    salesChannelId: string,
+    config: FindConfig<SalesChannelDTO> = {},
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<SalesChannelDTO> {
+    const salesChannel = await this.salesChannelService_.retrieve(
+      salesChannelId,
+      config
+    )
+
+    return await this.baseRepository_.serialize<SalesChannelDTO>(salesChannel, {
+      populate: true,
+    })
+  }
+
+  @InjectManager("baseRepository_")
+  async list(
+    filters: {} = {},
+    config: FindConfig<SalesChannelDTO> = {},
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<SalesChannelDTO[]> {
+    const salesChannels = await this.salesChannelService_.list(filters, config)
+
+    return await this.baseRepository_.serialize<SalesChannelDTO[]>(
+      salesChannels,
+      {
+        populate: true,
+      }
+    )
+  }
+
+  @InjectManager("baseRepository_")
+  async listAndCount(
+    filters: FilterableSalesChannelProps = {},
+    config: FindConfig<SalesChannelDTO> = {},
+    @MedusaContext() sharedContext: Context = {}
+  ): Promise<[SalesChannelDTO[], number]> {
+    const [salesChannels, count] = await this.salesChannelService_.listAndCount(
+      filters,
+      config
+    )
+
+    return [
+      await this.baseRepository_.serialize<SalesChannelDTO[]>(salesChannels, {
+        populate: true,
+      }),
+      count,
+    ]
+  }
+}

packages/sales-channel/src/services/sales-channel.ts

@@ -0,0 +1,24 @@
+import { DAL } from "@medusajs/types"
+import { ModulesSdkUtils } from "@medusajs/utils"
+import { CreateSalesChannelDTO, UpdateSalesChannelDTO } from "@medusajs/types"
+
+import { SalesChannel } from "@models"
+
+type InjectedDependencies = {
+  salesChannelRepository: DAL.RepositoryService
+}
+
+export default class SalesChannelService<
+  TEntity extends SalesChannel = SalesChannel
+> extends ModulesSdkUtils.abstractServiceFactory<
+  InjectedDependencies,
+  {
+    create: CreateSalesChannelDTO
+    update: UpdateSalesChannelDTO
+  }
+>(SalesChannel)<TEntity> {
+  constructor(container: InjectedDependencies) {
+    // @ts-ignore
+    super(...arguments)
+  }
+}

packages/sales-channel/src/types/index.ts

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

packages/sales-channel/src/types/repositories.ts

@@ -0,0 +1,15 @@
+import { DAL } from "@medusajs/types"
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+import { SalesChannel } from "@models"
+import { CreateSalesChannelDTO, UpdateSalesChannelDTO } from "@medusajs/types"
+
+export interface ISalesChannelRepository<
+  TEntity extends SalesChannel = SalesChannel
+> extends DAL.RepositoryService<
+    TEntity,
+    {
+      create: CreateSalesChannelDTO
+      update: UpdateSalesChannelDTO
+    }
+  > {}