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
@@ -0,0 +1,63 @@
import { moduleIntegrationTestRunner } from "medusa-test-utils"
import { IPricingModuleService } from "@medusajs/types"
import { Module, Modules } from "@medusajs/utils"
import { PricingModuleService } from "@services"
moduleIntegrationTestRunner<IPricingModuleService>({
moduleName: Modules.PRICING,
testSuite: () => {
describe("PricingModule Service - Calculate Price", () => {
it(`should export the appropriate linkable configuration`, () => {
const linkable = Module(Modules.PRICING, {
service: PricingModuleService,
}).linkable
expect(Object.keys(linkable)).toEqual([
"priceSet",
"priceList",
"price",
"pricePreference",
])
Object.keys(linkable).forEach((key) => {
delete linkable[key].toJSON
})
expect(linkable).toEqual({
priceSet: {
id: {
linkable: "price_set_id",
primaryKey: "id",
serviceName: "pricingService",
field: "priceSet",
},
},
priceList: {
id: {
linkable: "price_list_id",
primaryKey: "id",
serviceName: "pricingService",
field: "priceList",
},
},
price: {
id: {
linkable: "price_id",
primaryKey: "id",
serviceName: "pricingService",
field: "price",
},
},
pricePreference: {
id: {
linkable: "price_preference_id",
primaryKey: "id",
serviceName: "pricingService",
field: "pricePreference",
},
},
})
})
})
},
})
+2 -5
View File
@@ -34,6 +34,7 @@
"orm:cache:clear": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm cache:clear"
},
"devDependencies": {
"@medusajs/types": "^1.11.16",
"@mikro-orm/cli": "5.9.7",
"cross-env": "^5.2.1",
"jest": "^29.7.0",
@@ -45,14 +46,10 @@
"typescript": "^5.1.6"
},
"dependencies": {
"@medusajs/modules-sdk": "^1.12.11",
"@medusajs/types": "^1.11.16",
"@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"
}
}
+4 -8
View File
@@ -1,12 +1,8 @@
import { ModuleExports } from "@medusajs/types"
import { Module, Modules } from "@medusajs/utils"
import { PricingModuleService } from "@services"
const service = PricingModuleService
export const moduleDefinition: ModuleExports = {
service,
}
export default moduleDefinition
export default Module(Modules.PRICING, {
service: PricingModuleService,
})
export * from "./types"
@@ -3,10 +3,4 @@ import { Price, PriceList, PricePreference, PriceSet } from "@models"
export const joinerConfig = defineJoinerConfig(Modules.PRICING, {
models: [PriceSet, PriceList, Price, PricePreference],
linkableKeys: {
price_set_id: PriceSet.name,
price_list_id: PriceList.name,
price_id: Price.name,
price_preference_id: PricePreference.name,
},
})