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 { IInventoryService, InventoryItemDTO } from "@medusajs/types"
import { moduleIntegrationTestRunner } from "medusa-test-utils"
import { Modules } from "@medusajs/utils"
import { Module, Modules } from "@medusajs/utils"
import { InventoryModuleService } from "../../src/services"
jest.setTimeout(100000)
@@ -8,6 +9,49 @@ moduleIntegrationTestRunner<IInventoryService>({
moduleName: Modules.INVENTORY,
testSuite: ({ service }) => {
describe("Inventory Module Service", () => {
it(`should export the appropriate linkable configuration`, () => {
const linkable = Module(Modules.INVENTORY, {
service: InventoryModuleService,
}).linkable
expect(Object.keys(linkable)).toEqual([
"inventoryItem",
"inventoryLevel",
"reservationItem",
])
Object.keys(linkable).forEach((key) => {
delete linkable[key].toJSON
})
expect(linkable).toEqual({
inventoryItem: {
id: {
field: "inventoryItem",
linkable: "inventory_item_id",
primaryKey: "id",
serviceName: "inventoryService",
},
},
inventoryLevel: {
id: {
field: "inventoryLevel",
linkable: "inventory_level_id",
primaryKey: "id",
serviceName: "inventoryService",
},
},
reservationItem: {
id: {
field: "reservationItem",
linkable: "reservation_item_id",
primaryKey: "id",
serviceName: "inventoryService",
},
},
})
})
describe("create", () => {
it("should create an inventory item", async () => {
const data = { sku: "test-sku", origin_country: "test-country" }
@@ -1,4 +1,10 @@
module.exports = {
moduleNameMapper: {
"^@models": "<rootDir>/src/models",
"^@services": "<rootDir>/src/services",
"^@repositories": "<rootDir>/src/repositories",
"^@types": "<rootDir>/src/types",
},
transform: {
"^.+\\.[jt]s$": [
"@swc/jest",
+1 -3
View File
@@ -36,9 +36,7 @@
"@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"
},
"scripts": {
"watch": "tsc --build --watch",
+5 -6
View File
@@ -1,7 +1,6 @@
import { ModuleExports } from "@medusajs/types"
import InventoryService from "./services/inventory-module"
import InventoryModuleService from "./services/inventory-module"
import { Module, Modules } from "@medusajs/utils"
const moduleDefinition: ModuleExports = {
service: InventoryService,
}
export default moduleDefinition
export default Module(Modules.INVENTORY, {
service: InventoryModuleService,
})
@@ -9,13 +9,6 @@ export const joinerConfig = defineJoinerConfig(Modules.INVENTORY, {
methodSuffix: "InventoryItems",
},
},
{
name: ["inventory_level", "inventory_levels"],
args: {
entity: "InventoryLevel",
methodSuffix: "InventoryLevels",
},
},
{
name: [
"reservation",