chore: Migrate modules to use the Module util (#7964)

**What**
Apply the `Module` util to each module to handle the export and provide the linkable configuration object.

- Most joiner config that does not have any special config are removed/cleaned up in favor of the autogenerated one or simpler one
- linkable are now available in all modules
- cleaned up the dependencies of the modules

FIXES CORE-2410
This commit is contained in:
Adrien de Peretti
2024-07-05 15:00:40 +02:00
committed by GitHub
parent eafa3560ae
commit b368251ca3
99 changed files with 1267 additions and 488 deletions

View File

@@ -1,11 +1,12 @@
import { IApiKeyModuleService } from "@medusajs/types"
import { ApiKeyType, Modules } from "@medusajs/utils"
import { ApiKeyType, Module, Modules } from "@medusajs/utils"
import crypto from "crypto"
import { moduleIntegrationTestRunner } from "medusa-test-utils"
import {
createPublishableKeyFixture,
createSecretKeyFixture,
} from "../__fixtures__"
import { ApiKeyModuleService } from "@services"
jest.setTimeout(100000)
@@ -39,6 +40,25 @@ moduleIntegrationTestRunner<IApiKeyModuleService>({
jest.restoreAllMocks()
})
it(`should export the appropriate linkable configuration`, () => {
const linkable = Module(Modules.API_KEY, {
service: ApiKeyModuleService,
}).linkable
expect(Object.keys(linkable)).toEqual(["apiKey"])
linkable.apiKey.toJSON = undefined
expect(linkable.apiKey).toEqual({
id: {
linkable: "api_key_id",
primaryKey: "id",
serviceName: "apiKey",
field: "apiKey",
},
})
})
describe("API Key Module Service", () => {
describe("creating a publishable API key", () => {
it("should create it successfully", async function () {

View File

@@ -45,13 +45,10 @@
"typescript": "^5.1.6"
},
"dependencies": {
"@medusajs/modules-sdk": "^1.12.11",
"@medusajs/utils": "^1.11.9",
"@mikro-orm/core": "5.9.7",
"@mikro-orm/migrations": "5.9.7",
"@mikro-orm/postgresql": "5.9.7",
"awilix": "^8.0.0",
"dotenv": "^16.4.5",
"knex": "2.4.2"
"awilix": "^8.0.0"
}
}

View File

@@ -1,5 +1,6 @@
import { ModuleExports } from "@medusajs/types"
import { Module, Modules } from "@medusajs/utils"
import { ApiKeyModuleService } from "@services"
const moduleDefinition: ModuleExports = { service: ApiKeyModuleService }
export default moduleDefinition
export default Module(Modules.API_KEY, {
service: ApiKeyModuleService,
})

View File

@@ -1,3 +0,0 @@
import { defineJoinerConfig, Modules } from "@medusajs/utils"
export const joinerConfig = defineJoinerConfig(Modules.API_KEY)

View File

@@ -8,10 +8,8 @@ import {
FindConfig,
IApiKeyModuleService,
InternalModuleDeclaration,
ModuleJoinerConfig,
ModulesSdkTypes,
} from "@medusajs/types"
import { joinerConfig } from "../joiner-config"
import { ApiKey } from "@models"
import {
CreateApiKeyDTO,
@@ -38,7 +36,7 @@ type InjectedDependencies = {
apiKeyService: ModulesSdkTypes.IMedusaInternalService<any>
}
export default class ApiKeyModuleService
export class ApiKeyModuleService
extends MedusaService<{
ApiKey: { dto: ApiKeyTypes.ApiKeyDTO }
}>({ ApiKey })
@@ -57,9 +55,6 @@ export default class ApiKeyModuleService
this.apiKeyService_ = apiKeyService
}
__joinerConfig(): ModuleJoinerConfig {
return joinerConfig
}
//@ts-expect-error
createApiKeys(
data: ApiKeyTypes.CreateApiKeyDTO[],

View File

@@ -1 +1 @@
export { default as ApiKeyModuleService } from "./api-key-module-service"
export { ApiKeyModuleService } from "./api-key-module-service"