Chore/rm main entity concept (#7709)

**What** Update the `MedusaService` class, factory and types to remove the concept of main modules. The idea being that all method will be explicitly named and suffixes to represent the object you are trying to manipulate. This pr also includes various fixes in different modules Co-authored-by: Stevche Radevski <4820812+sradevski@users.noreply.github.com> Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-06-19 15:02:16 +02:00
parent 2895ccfba8
commit 48963f55ef
533 changed files with 6469 additions and 9769 deletions
--- a/packages/modules/api-key/src/index.ts
+++ b/packages/modules/api-key/src/index.ts
@@ -1,7 +1,5 @@
-import { moduleDefinition } from "./module-definition"
-
-export * from "./types"
-export * from "./models"
-export * from "./services"
+import { ModuleExports } from "@medusajs/types"
+import { ApiKeyModuleService } from "@services"

+const moduleDefinition: ModuleExports = { service: ApiKeyModuleService }
 export default moduleDefinition
--- a/packages/modules/api-key/src/joiner-config.ts
+++ b/packages/modules/api-key/src/joiner-config.ts
@@ -1,31 +1,11 @@
 import { Modules } from "@medusajs/modules-sdk"
-import { ModuleJoinerConfig } from "@medusajs/types"
-import { MapToConfig } from "@medusajs/utils"
-import ApiKey from "./models/api-key"
+import {
+  buildEntitiesNameToLinkableKeysMap,
+  defineJoinerConfig,
+  MapToConfig,
+} from "@medusajs/utils"

-export const LinkableKeys: Record<string, string> = {
-  api_key_id: ApiKey.name,
-}
+export const joinerConfig = defineJoinerConfig(Modules.API_KEY)

-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.API_KEY,
-  primaryKeys: ["id"],
-  linkableKeys: LinkableKeys,
-  alias: [
-    {
-      name: ["api_key", "api_keys"],
-      args: { entity: ApiKey.name },
-    },
-  ],
-} as ModuleJoinerConfig
+export const entityNameToLinkableKeysMap: MapToConfig =
+  buildEntitiesNameToLinkableKeysMap(joinerConfig.linkableKeys)
--- a/packages/modules/api-key/src/module-definition.ts
+++ b/packages/modules/api-key/src/module-definition.ts
@@ -1,8 +0,0 @@
-import { ModuleExports } from "@medusajs/types"
-import { ApiKeyModuleService } from "@services"
-
-const service = ApiKeyModuleService
-
-export const moduleDefinition: ModuleExports = {
-  service,
-}
--- a/packages/modules/api-key/src/repositories/index.ts
+++ b/packages/modules/api-key/src/repositories/index.ts
@@ -1 +0,0 @@
-export { MikroOrmBaseRepository as BaseRepository } from "@medusajs/utils"
--- a/packages/modules/api-key/src/scripts/bin/run-seed.ts
+++ b/packages/modules/api-key/src/scripts/bin/run-seed.ts
@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-
-import { ModulesSdkUtils } from "@medusajs/utils"
-import { Modules } from "@medusajs/modules-sdk"
-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-api-key-seed <filePath>`
-    )
-  }
-
-  const run = ModulesSdkUtils.buildSeedScript({
-    moduleName: Modules.API_KEY,
-    models: Models,
-    pathToMigrations: __dirname + "/../../migrations",
-    seedHandler: async ({ manager, data }) => {
-      // TODO: Add seed logic
-    },
-  })
-  await run({ path })
-})()
--- a/packages/modules/api-key/src/services/api-key-module-service.ts
+++ b/packages/modules/api-key/src/services/api-key-module-service.ts
@@ -27,7 +27,7 @@ import {
  isString,
  MedusaContext,
  MedusaError,
-  ModulesSdkUtils,
+  MedusaService,
  promiseAll,
 } from "@medusajs/utils"

@@ -38,17 +38,14 @@ type InjectedDependencies = {
  apiKeyService: ModulesSdkTypes.IMedusaInternalService<any>
 }

-export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
-  extends ModulesSdkUtils.MedusaService<
-    ApiKeyTypes.ApiKeyDTO,
-    {
-      ApiKey: { dto: ApiKeyTypes.ApiKeyDTO }
-    }
-  >(ApiKey, {}, entityNameToLinkableKeysMap)
+export default class ApiKeyModuleService
+  extends MedusaService<{
+    ApiKey: { dto: ApiKeyTypes.ApiKeyDTO }
+  }>({ ApiKey }, entityNameToLinkableKeysMap)
  implements IApiKeyModuleService
 {
  protected baseRepository_: DAL.RepositoryService
-  protected readonly apiKeyService_: ModulesSdkTypes.IMedusaInternalService<TEntity>
+  protected readonly apiKeyService_: ModulesSdkTypes.IMedusaInternalService<ApiKey>

  constructor(
    { baseRepository, apiKeyService }: InjectedDependencies,
@@ -63,22 +60,22 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  __joinerConfig(): ModuleJoinerConfig {
    return joinerConfig
  }
-
-  create(
+  //@ts-expect-error
+  createApiKeys(
    data: ApiKeyTypes.CreateApiKeyDTO[],
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO[]>
-  create(
+  createApiKeys(
    data: ApiKeyTypes.CreateApiKeyDTO,
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO>

  @InjectManager("baseRepository_")
-  async create(
+  async createApiKeys(
    data: ApiKeyTypes.CreateApiKeyDTO | ApiKeyTypes.CreateApiKeyDTO[],
    @MedusaContext() sharedContext: Context = {}
  ): Promise<ApiKeyTypes.ApiKeyDTO | ApiKeyTypes.ApiKeyDTO[]> {
-    const [createdApiKeys, generatedTokens] = await this.create_(
+    const [createdApiKeys, generatedTokens] = await this.createApiKeys_(
      Array.isArray(data) ? data : [data],
      sharedContext
    )
@@ -102,10 +99,10 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  }

  @InjectTransactionManager("baseRepository_")
-  protected async create_(
+  protected async createApiKeys_(
    data: ApiKeyTypes.CreateApiKeyDTO[],
    @MedusaContext() sharedContext: Context = {}
-  ): Promise<[TEntity[], TokenDTO[]]> {
+  ): Promise<[ApiKey[], TokenDTO[]]> {
    await this.validateCreateApiKeys_(data, sharedContext)

    const normalizedInput: CreateApiKeyDTO[] = []
@@ -135,17 +132,17 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
    return [createdApiKeys, generatedTokens]
  }

-  async upsert(
+  async upsertApiKeys(
    data: ApiKeyTypes.UpsertApiKeyDTO[],
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO[]>
-  async upsert(
+  async upsertApiKeys(
    data: ApiKeyTypes.UpsertApiKeyDTO,
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO>

  @InjectManager("baseRepository_")
-  async upsert(
+  async upsertApiKeys(
    data: ApiKeyTypes.UpsertApiKeyDTO | ApiKeyTypes.UpsertApiKeyDTO[],
    @MedusaContext() sharedContext: Context = {}
  ): Promise<ApiKeyTypes.ApiKeyDTO | ApiKeyTypes.ApiKeyDTO[]> {
@@ -161,7 +158,7 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>

    if (forCreate.length) {
      const op = async () => {
-        const [createdApiKeys, generatedTokens] = await this.create_(
+        const [createdApiKeys, generatedTokens] = await this.createApiKeys_(
          forCreate,
          sharedContext
        )
@@ -188,7 +185,7 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>

    if (forUpdate.length) {
      const op = async () => {
-        const updateResp = await this.update_(forUpdate, sharedContext)
+        const updateResp = await this.updateApiKeys_(forUpdate, sharedContext)
        return await this.baseRepository_.serialize<ApiKeyTypes.ApiKeyDTO[]>(
          updateResp
        )
@@ -201,19 +198,20 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
    return Array.isArray(data) ? result : result[0]
  }

-  async update(
+  //@ts-expect-error
+  async updateApiKeys(
    id: string,
    data: ApiKeyTypes.UpdateApiKeyDTO,
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO>
-  async update(
+  async updateApiKeys(
    selector: FilterableApiKeyProps,
    data: ApiKeyTypes.UpdateApiKeyDTO,
    sharedContext?: Context
  ): Promise<ApiKeyTypes.ApiKeyDTO[]>

  @InjectManager("baseRepository_")
-  async update(
+  async updateApiKeys(
    idOrSelector: string | FilterableApiKeyProps,
    data: ApiKeyTypes.UpdateApiKeyDTO,
    @MedusaContext() sharedContext: Context = {}
@@ -224,7 +222,10 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
      sharedContext
    )

-    const updatedApiKeys = await this.update_(normalizedInput, sharedContext)
+    const updatedApiKeys = await this.updateApiKeys_(
+      normalizedInput,
+      sharedContext
+    )

    const serializedResponse = await this.baseRepository_.serialize<
      ApiKeyTypes.ApiKeyDTO[]
@@ -236,10 +237,10 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  }

  @InjectTransactionManager("baseRepository_")
-  protected async update_(
+  protected async updateApiKeys_(
    normalizedInput: UpdateApiKeyInput[],
    @MedusaContext() sharedContext: Context = {}
-  ): Promise<TEntity[]> {
+  ): Promise<ApiKey[]> {
    const updateRequest = normalizedInput.map((k) => ({
      id: k.id,
      title: k.title,
@@ -253,7 +254,8 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  }

  @InjectManager("baseRepository_")
-  async retrieve(
+  // @ts-expect-error
+  async retrieveApiKey(
    id: string,
    config?: FindConfig<ApiKeyTypes.ApiKeyDTO>,
    sharedContext?: Context
@@ -269,7 +271,8 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  }

  @InjectManager("baseRepository_")
-  async list(
+  //@ts-expect-error
+  async listApiKeys(
    filters?: ApiKeyTypes.FilterableApiKeyProps,
    config?: FindConfig<ApiKeyTypes.ApiKeyDTO>,
    sharedContext?: Context
@@ -289,7 +292,8 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  }

  @InjectManager("baseRepository_")
-  async listAndCount(
+  //@ts-expect-error
+  async listAndCountApiKeys(
    filters?: ApiKeyTypes.FilterableApiKeyProps,
    config?: FindConfig<ApiKeyTypes.ApiKeyDTO>,
    sharedContext?: Context
@@ -347,7 +351,7 @@ export default class ApiKeyModuleService<TEntity extends ApiKey = ApiKey>
  async revoke_(
    normalizedInput: RevokeApiKeyInput[],
    @MedusaContext() sharedContext: Context = {}
-  ): Promise<TEntity[]> {
+  ): Promise<ApiKey[]> {
    await this.validateRevokeApiKeys_(normalizedInput)

    const updateRequest = normalizedInput.map((k) => {
				`@@ -1 +0,0 @@`
				`export { MikroOrmBaseRepository as BaseRepository } from "@medusajs/utils"`