feat(modules-sdk): Remote Query

packages/cache-inmemory/src/initialize/index.ts

@@ -11,12 +11,12 @@ export const initialize = async (
   options?: InMemoryCacheModuleOptions | ExternalModuleDeclaration
 ): Promise<ICacheService> => {
   const serviceKey = Modules.CACHE
-  const loaded = await MedusaModule.bootstrap(
+  const loaded = await MedusaModule.bootstrap<ICacheService>(
     serviceKey,
     "@medusajs/cache-inmemory",
     options as InternalModuleDeclaration | ExternalModuleDeclaration,
     undefined
   )
 
-  return loaded[serviceKey] as ICacheService
+  return loaded[serviceKey]
 }

packages/cache-inmemory/tsconfig.spec.json

@@ -1,5 +1,5 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["src"],
+  "include": ["src", "integration-tests"],
   "exclude": ["node_modules"]
 }

packages/cache-redis/src/initialize/index.ts

@@ -11,12 +11,12 @@ export const initialize = async (
   options?: RedisCacheModuleOptions | ExternalModuleDeclaration
 ): Promise<ICacheService> => {
   const serviceKey = Modules.CACHE
-  const loaded = await MedusaModule.bootstrap(
+  const loaded = await MedusaModule.bootstrap<ICacheService>(
     serviceKey,
     "@medusajs/cache-redis",
     options as InternalModuleDeclaration | ExternalModuleDeclaration,
     undefined
   )
 
-  return loaded[serviceKey] as ICacheService
+  return loaded[serviceKey]
 }

packages/event-bus-local/src/initialize/index.ts

@@ -3,10 +3,10 @@ import { IEventBusService } from "@medusajs/types"
 
 export const initialize = async (): Promise<IEventBusService> => {
   const serviceKey = Modules.EVENT_BUS
-  const loaded = await MedusaModule.bootstrap(
+  const loaded = await MedusaModule.bootstrap<IEventBusService>(
     serviceKey,
     "@medusajs/event-bus-local"
   )
 
-  return loaded[serviceKey] as IEventBusService
+  return loaded[serviceKey]
 }

packages/event-bus-redis/src/initialize/index.ts

@@ -11,12 +11,12 @@ export const initialize = async (
   options?: EventBusRedisModuleOptions | ExternalModuleDeclaration
 ): Promise<IEventBusService> => {
   const serviceKey = Modules.EVENT_BUS
-  const loaded = await MedusaModule.bootstrap(
+  const loaded = await MedusaModule.bootstrap<IEventBusService>(
     serviceKey,
     "@medusajs/event-bus-redis",
     options as InternalModuleDeclaration | ExternalModuleDeclaration,
     undefined
   )
 
-  return loaded[serviceKey] as IEventBusService
+  return loaded[serviceKey]
 }

packages/inventory/src/initialize/index.ts

@@ -15,13 +15,13 @@ export const initialize = async (
   }
 ): Promise<IInventoryService> => {
   const serviceKey = Modules.INVENTORY
-  const loaded = await MedusaModule.bootstrap(
+  const loaded = await MedusaModule.bootstrap<IInventoryService>(
     serviceKey,
     "@medusajs/inventory",
     options as InternalModuleDeclaration | ExternalModuleDeclaration,
     moduleDefinition,
     injectedDependencies
   )
 
-  return loaded[serviceKey] as IInventoryService
+  return loaded[serviceKey]
 }

packages/inventory/src/joiner-config.ts

@@ -0,0 +1,51 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { JoinerServiceConfig } from "@medusajs/types"
+
+export const joinerConfig: JoinerServiceConfig = {
+  serviceName: Modules.INVENTORY,
+  primaryKeys: ["id"],
+  alias: [
+    {
+      name: "inventory_items",
+    },
+    {
+      name: "inventory",
+    },
+    {
+      name: "inventory_level",
+      args: {
+        methodSuffix: "InventoryLevels",
+      },
+    },
+    {
+      name: "inventory_levels",
+      args: {
+        methodSuffix: "InventoryLevels",
+      },
+    },
+    {
+      name: "reservation_items",
+      args: {
+        methodSuffix: "ReservationItems",
+      },
+    },
+    {
+      name: "reservation_item",
+      args: {
+        methodSuffix: "ReservationItems",
+      },
+    },
+    {
+      name: "reservation",
+      args: {
+        methodSuffix: "ReservationItems",
+      },
+    },
+    {
+      name: "reservations",
+      args: {
+        methodSuffix: "ReservationItems",
+      },
+    },
+  ],
+}

packages/inventory/src/services/inventory.ts

@@ -11,6 +11,7 @@ import {
   IInventoryService,
   InventoryItemDTO,
   InventoryLevelDTO,
+  JoinerServiceConfig,
   MODULE_RESOURCE_TYPE,
   ReservationItemDTO,
   SharedContext,
@@ -23,6 +24,7 @@ import {
   MedusaError,
 } from "@medusajs/utils"
 import { EntityManager } from "typeorm"
+import { joinerConfig } from "../joiner-config"
 import InventoryItemService from "./inventory-item"
 import InventoryLevelService from "./inventory-level"
 import ReservationItemService from "./reservation-item"
@@ -57,6 +59,10 @@ export default class InventoryService implements IInventoryService {
     this.reservationItemService_ = reservationItemService
   }
 
+  __joinerConfig(): JoinerServiceConfig {
+    return joinerConfig
+  }
+
   /**
    * Lists inventory items that match the given selector
    * @param selector - the selector to filter inventory items by
@@ -75,6 +81,13 @@ export default class InventoryService implements IInventoryService {
       context
     )
   }
+  async list(
+    selector: FilterableInventoryItemProps,
+    config: FindConfig<InventoryItemDTO> = { relations: [], skip: 0, take: 10 },
+    context: SharedContext = {}
+  ): Promise<InventoryItemDTO[]> {
+    return await this.inventoryItemService_.list(selector, config, context)
+  }
 
   /**
    * Lists inventory levels that match the given selector

packages/medusa/package.json

@@ -42,7 +42,6 @@
     "test": "jest"
   },
   "peerDependencies": {
-    "@medusajs/types": "^1.8.7",
     "medusa-interfaces": "^1.3.7",
     "typeorm": "^0.3.16"
   },

packages/medusa/src/loaders/__tests__/models.spec.ts

@@ -12,7 +12,7 @@ describe("models loader", () => {
 
   beforeAll(async () => {
     try {
-      models = modelsLoader({
+      models = await modelsLoader({
         container,
         isTest: true,
         coreTestPathGlob: "../models/{product,product-variant}.ts",
@@ -30,9 +30,9 @@ describe("models loader", () => {
   })
 
   it("ensure that the product model is an extended model", () => {
-    const productModel = container.resolve("productModel")
+    const productModel = models.find((model) => model.name === "Product")
 
-    expect(productModel.custom_attribute).toEqual("test")
+    expect(new productModel().custom_attribute).toEqual("test")
   })
 
   it("ensure that the extended product model is registered in db_entities", () => {

packages/medusa/src/loaders/models.ts

@@ -8,7 +8,6 @@ import path from "path"
 import { ClassConstructor, MedusaContainer } from "../types/global"
 import { EntitySchema } from "typeorm"
 import { asClass, asValue } from "awilix"
-import { upperCaseFirst } from "@medusajs/utils"
 
 type ModelLoaderParams = {
   container: MedusaContainer
@@ -63,9 +62,8 @@ export default (
               // If an extension file is found, override it with that instead
               if (mappedExtensionModel) {
                 const coreModel = require(modelPath)
-                const modelName = upperCaseFirst(
+                const modelName =
                   formatRegistrationNameWithoutNamespace(modelPath)
-                )
 
                 coreModel[modelName] = mappedExtensionModel
                 val = mappedExtensionModel

packages/medusa/src/loaders/plugins.ts

@@ -1,19 +1,3 @@
-import { SearchUtils, upperCaseFirst } from "@medusajs/utils"
-import { aliasTo, asFunction, asValue, Lifetime } from "awilix"
-import { Express } from "express"
-import fs from "fs"
-import { sync as existsSync } from "fs-exists-cached"
-import glob from "glob"
-import _ from "lodash"
-import { createRequireFromPath } from "medusa-core-utils"
-import {
-  FileService,
-  FulfillmentService,
-  OauthService,
-} from "medusa-interfaces"
-import { trackInstallation } from "medusa-telemetry"
-import path from "path"
-import { EntitySchema } from "typeorm"
 import {
   AbstractTaxService,
   isBatchJobStrategy,
@@ -23,23 +7,40 @@ import {
   isPriceSelectionStrategy,
   isTaxCalculationStrategy,
 } from "../interfaces"
-import { MiddlewareService } from "../services"
 import {
   ClassConstructor,
   ConfigModule,
   Logger,
   MedusaContainer,
 } from "../types/global"
+import {
+  FileService,
+  FulfillmentService,
+  OauthService,
+} from "medusa-interfaces"
+import { Lifetime, aliasTo, asFunction, asValue } from "awilix"
+import { SearchUtils, upperCaseFirst } from "@medusajs/utils"
 import {
   formatRegistrationName,
   formatRegistrationNameWithoutNamespace,
 } from "../utils/format-registration-name"
-import { getModelExtensionsMap } from "./helpers/get-model-extension-map"
 import {
   registerPaymentProcessorFromClass,
   registerPaymentServiceFromClass,
 } from "./helpers/plugins"
+
+import { EntitySchema } from "typeorm"
+import { Express } from "express"
+import { MiddlewareService } from "../services"
+import _ from "lodash"
+import { createRequireFromPath } from "medusa-core-utils"
+import { sync as existsSync } from "fs-exists-cached"
+import fs from "fs"
+import { getModelExtensionsMap } from "./helpers/get-model-extension-map"
+import glob from "glob"
 import logger from "./logger"
+import path from "path"
+import { trackInstallation } from "medusa-telemetry"
 
 type Options = {
   rootDirectory: string

packages/modules-sdk/package.json

@@ -23,7 +23,8 @@
     "typescript": "^4.4.4"
   },
   "dependencies": {
-    "@medusajs/types": "^1.8.8",
+    "@medusajs/orchestration": "^0.0.2",
+    "@medusajs/types": "^1.8.11",
     "@medusajs/utils": "^1.9.1",
     "awilix": "^8.0.0",
     "resolve-cwd": "^3.0.0"

packages/modules-sdk/src/definitions.ts

@@ -9,7 +9,7 @@ export enum Modules {
   STOCK_LOCATION = "stockLocationService",
   INVENTORY = "inventoryService",
   CACHE = "cacheService",
-  PRODUCT = "productModuleService",
+  PRODUCT = "productService",
 }
 
 export const ModulesDefinition: { [key: string]: ModuleDefinition } = {
@@ -33,6 +33,7 @@ export const ModulesDefinition: { [key: string]: ModuleDefinition } = {
     label: "StockLocationService",
     isRequired: false,
     canOverride: true,
+    isQueryable: true,
     dependencies: ["eventBusService"],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
@@ -46,6 +47,7 @@ export const ModulesDefinition: { [key: string]: ModuleDefinition } = {
     label: "InventoryService",
     isRequired: false,
     canOverride: true,
+    isQueryable: true,
     dependencies: ["eventBusService"],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.INTERNAL,
@@ -66,11 +68,12 @@ export const ModulesDefinition: { [key: string]: ModuleDefinition } = {
   },
   [Modules.PRODUCT]: {
     key: Modules.PRODUCT,
-    registrationName: Modules.PRODUCT,
+    registrationName: "productModuleService",
     defaultPackage: false,
     label: "ProductModuleService",
     isRequired: false,
     canOverride: true,
+    isQueryable: true,
     dependencies: [],
     defaultModuleDeclaration: {
       scope: MODULE_SCOPE.EXTERNAL,

packages/modules-sdk/src/index.ts

@@ -3,3 +3,4 @@ export * from "./definitions"
 export * from "./loaders"
 export * from "./medusa-module"
 export * from "./module-helper"
+export * from "./remote-query"