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 13:00:40 +00:00
committed by GitHub
parent eafa3560ae
commit b368251ca3
99 changed files with 1267 additions and 488 deletions
@@ -1,6 +1,7 @@
import { IRegionModuleService } from "@medusajs/types"
import { Modules } from "@medusajs/utils"
import { Module, Modules } from "@medusajs/utils"
import { moduleIntegrationTestRunner } from "medusa-test-utils"
import { RegionModuleService } from "@services"
jest.setTimeout(30000)
@@ -8,6 +9,37 @@ moduleIntegrationTestRunner<IRegionModuleService>({
moduleName: Modules.REGION,
testSuite: ({ service }) => {
describe("Region Module Service", () => {
it(`should export the appropriate linkable configuration`, () => {
const linkable = Module(Modules.REGION, {
service: RegionModuleService,
}).linkable
expect(Object.keys(linkable)).toEqual(["region", "country"])
Object.keys(linkable).forEach((key) => {
delete linkable[key].toJSON
})
expect(linkable).toEqual({
region: {
id: {
linkable: "region_id",
primaryKey: "id",
serviceName: "region",
field: "region",
},
},
country: {
iso_2: {
linkable: "country_iso_2",
primaryKey: "iso_2",
serviceName: "region",
field: "country",
},
},
})
})
it("should create countries on application start", async () => {
const countries = await service.listCountries({}, { take: null })
expect(countries.length).toEqual(250)
+1 -4
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"
}
}
@@ -1,3 +0,0 @@
import { defineJoinerConfig, Modules } from "@medusajs/utils"
export const joinerConfig = defineJoinerConfig(Modules.REGION)
@@ -6,7 +6,6 @@ import {
InferEntityType,
InternalModuleDeclaration,
IRegionModuleService,
ModuleJoinerConfig,
ModulesSdkTypes,
RegionCountryDTO,
RegionDTO,
@@ -28,7 +27,6 @@ import {
} from "@medusajs/utils"
import { Country, Region } from "@models"
import { UpdateRegionInput } from "@types"
import { joinerConfig } from "../joiner-config"
type InjectedDependencies = {
baseRepository: DAL.RepositoryService
@@ -68,10 +66,6 @@ export default class RegionModuleService
this.countryService_ = countryService
}
__joinerConfig(): ModuleJoinerConfig {
return joinerConfig
}
// @ts-expect-error
async createRegions(
data: CreateRegionDTO[],