@mikro-orm/nestjs 5.2.2 → 6.0.0

package/mikro-orm-core.module.d.ts

@@ -1,7 +1,6 @@
-import type { DynamicModule, MiddlewareConsumer, OnApplicationShutdown } from '@nestjs/common';
+import { type DynamicModule, type MiddlewareConsumer, type OnApplicationShutdown } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
-import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions } from './typings';
-import { MikroOrmModuleOptions } from './typings';
+import { MikroOrmModuleOptions, type MikroOrmModuleAsyncOptions, type MikroOrmModuleSyncOptions } from './typings';
 export declare class MikroOrmCoreModule implements OnApplicationShutdown {
     private readonly options;
     private readonly moduleRef;

package/mikro-orm-core.module.js

@@ -40,11 +40,11 @@ exports.MikroOrmCoreModule = void 0;
 const core_1 = require("@mikro-orm/core");
 const common_1 = require("@nestjs/common");
 const core_2 = require("@nestjs/core");
-const mikro_orm_common_1 = require("./mikro-orm.common");
-const mikro_orm_providers_1 = require("./mikro-orm.providers");
-const mikro_orm_middleware_1 = require("./mikro-orm.middleware");
 const middleware_helper_1 = require("./middleware.helper");
+const mikro_orm_common_1 = require("./mikro-orm.common");
 const mikro_orm_entities_storage_1 = require("./mikro-orm.entities.storage");
+const mikro_orm_middleware_1 = require("./mikro-orm.middleware");
+const mikro_orm_providers_1 = require("./mikro-orm.providers");
 async function tryRequire(name) {
     try {
         return await Promise.resolve(`${name}`).then(s => __importStar(require(s)));
@@ -53,6 +53,17 @@ async function tryRequire(name) {
         return undefined; // ignore, optional dependency
     }
 }
+// TODO: provide the package name via some platform method, prefer that over the static map when available
+const PACKAGES = {
+    MongoDriver: '@mikro-orm/mongo',
+    MySqlDriver: '@mikro-orm/mysql',
+    MsSqlDriver: '@mikro-orm/mssql',
+    MariaDbDriver: '@mikro-orm/mariadb',
+    PostgreSqlDriver: '@mikro-orm/postgresql',
+    SqliteDriver: '@mikro-orm/sqlite',
+    LibSqlDriver: '@mikro-orm/libsql',
+    BetterSqliteDriver: '@mikro-orm/better-sqlite',
+};
 let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
     constructor(options, moduleRef) {
         this.options = options;
@@ -63,11 +74,34 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
         const knex = await tryRequire('@mikro-orm/knex');
         const mongo = await tryRequire('@mikro-orm/mongodb');
         const em = await this.createEntityManager(options);
+        if (em && !contextName) {
+            const packageName = PACKAGES[em.getDriver().constructor.name];
+            const driverPackage = await tryRequire(packageName);
+            if (driverPackage) {
+                return {
+                    module: MikroOrmCoreModule_1,
+                    providers: [
+                        { provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS, useValue: options || {} },
+                        (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName),
+                        (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName, driverPackage.MikroORM),
+                        (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, core_1.EntityManager),
+                        (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, driverPackage.EntityManager),
+                    ],
+                    exports: [
+                        core_1.MikroORM,
+                        core_1.EntityManager,
+                        driverPackage.EntityManager,
+                        driverPackage.MikroORM,
+                    ],
+                };
+            }
+        }
         return {
             module: MikroOrmCoreModule_1,
             providers: [
                 { provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS, useValue: options || {} },
                 (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName),
+                ...(mongo ? [(0, mikro_orm_providers_1.createMikroOrmProvider)(contextName, mongo.MikroORM)] : []),
                 (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, core_1.EntityManager, contextName),
                 ...(em ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, em.constructor, contextName)] : []),
                 ...(knex ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, knex.EntityManager, contextName)] : []),
@@ -78,7 +112,7 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
                 contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : core_1.EntityManager,
                 ...(em && !contextName ? [em.constructor] : []),
                 ...(knex && !contextName ? [knex.EntityManager] : []),
-                ...(mongo && !contextName ? [mongo.EntityManager] : []),
+                ...(mongo && !contextName ? [mongo.EntityManager, mongo.MikroORM] : []),
             ],
         };
     }
@@ -87,6 +121,30 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
         const knex = await tryRequire('@mikro-orm/knex');
         const mongo = await tryRequire('@mikro-orm/mongodb');
         const em = await this.createEntityManager(options);
+        if (em && !contextName) {
+            const packageName = PACKAGES[em.getDriver().constructor.name];
+            const driverPackage = await tryRequire(packageName);
+            if (driverPackage) {
+                return {
+                    module: MikroOrmCoreModule_1,
+                    imports: options.imports || [],
+                    providers: [
+                        ...(options.providers || []),
+                        ...(0, mikro_orm_providers_1.createAsyncProviders)({ ...options, contextName: options.contextName }),
+                        (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName),
+                        (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName, driverPackage.MikroORM),
+                        (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, core_1.EntityManager),
+                        (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, driverPackage.EntityManager),
+                    ],
+                    exports: [
+                        core_1.MikroORM,
+                        core_1.EntityManager,
+                        driverPackage.EntityManager,
+                        driverPackage.MikroORM,
+                    ],
+                };
+            }
+        }
         return {
             module: MikroOrmCoreModule_1,
             imports: options.imports || [],
@@ -104,7 +162,7 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
                 contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : core_1.EntityManager,
                 ...(em && !contextName ? [em.constructor] : []),
                 ...(knex && !contextName ? [knex.EntityManager] : []),
-                ...(mongo && !contextName ? [mongo.EntityManager] : []),
+                ...(mongo && !contextName ? [mongo.EntityManager, mongo.MikroORM] : []),
             ],
         };
     }
@@ -135,7 +193,7 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
         const orm = this.moduleRef.get(token);
         if (orm) {
             await orm.close();
-            mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.clear(orm.config.get('contextName'));
+            mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.clearLater();
         }
         mikro_orm_common_1.CONTEXT_NAMES.length = 0;
     }

package/mikro-orm-middleware.module.d.ts

@@ -1,6 +1,6 @@
-import type { MiddlewareConsumer } from '@nestjs/common';
-import { MikroOrmMiddlewareModuleOptions } from './typings';
+import { type MiddlewareConsumer } from '@nestjs/common';
 import type { MikroORM } from '@mikro-orm/core';
+import { MikroOrmMiddlewareModuleOptions } from './typings';
 export declare class MikroOrmMiddlewareModule {
     private readonly options;
     constructor(options: MikroOrmMiddlewareModuleOptions);
@@ -13,7 +13,7 @@ export declare class MikroOrmMiddlewareModule {
             inject?: undefined;
         } | {
             provide: string;
-            useFactory: (...args: MikroORM[]) => MikroORM<import("@mikro-orm/core").IDatabaseDriver<import("@mikro-orm/core").Connection>>[];
+            useFactory: (...args: MikroORM[]) => MikroORM<import("@mikro-orm/core").IDatabaseDriver<import("@mikro-orm/core").Connection>, import("@mikro-orm/core").EntityManager<import("@mikro-orm/core").IDatabaseDriver<import("@mikro-orm/core").Connection>>>[];
             inject: string[];
             useValue?: undefined;
         })[];

package/mikro-orm-middleware.module.js

@@ -15,9 +15,9 @@ var MikroOrmMiddlewareModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MikroOrmMiddlewareModule = void 0;
 const common_1 = require("@nestjs/common");
+const middleware_helper_1 = require("./middleware.helper");
 const mikro_orm_common_1 = require("./mikro-orm.common");
 const multiple_mikro_orm_middleware_1 = require("./multiple-mikro-orm.middleware");
-const middleware_helper_1 = require("./middleware.helper");
 let MikroOrmMiddlewareModule = MikroOrmMiddlewareModule_1 = class MikroOrmMiddlewareModule {
     constructor(options) {
         this.options = options;

package/mikro-orm.common.d.ts

@@ -4,8 +4,8 @@ export declare const MIKRO_ORM_MODULE_OPTIONS: unique symbol;
 export declare const CONTEXT_NAMES: string[];
 export declare const logger: Logger;
 export declare const getMikroORMToken: (name: string) => string;
-export declare const InjectMikroORM: (name: string) => (target: object, key: string | symbol | undefined, index?: number | undefined) => void;
+export declare const InjectMikroORM: (name: string) => PropertyDecorator & ParameterDecorator;
 export declare const getEntityManagerToken: (name: string) => string;
-export declare const InjectEntityManager: (name: string) => (target: object, key: string | symbol | undefined, index?: number | undefined) => void;
+export declare const InjectEntityManager: (name: string) => PropertyDecorator & ParameterDecorator;
 export declare const getRepositoryToken: <T extends object>(entity: EntityName<T>, name?: string) => string;
-export declare const InjectRepository: <T extends object>(entity: EntityName<T>, name?: string) => (target: object, key: string | symbol | undefined, index?: number | undefined) => void;
+export declare const InjectRepository: <T extends object>(entity: EntityName<T>, name?: string) => PropertyDecorator & ParameterDecorator;

package/mikro-orm.entities.storage.d.ts

@@ -2,7 +2,14 @@ import type { AnyEntity } from '@mikro-orm/core';
 import type { EntityName } from './typings';
 export declare class MikroOrmEntitiesStorage {
     private static readonly storage;
+    private static shouldClear;
     static addEntity(entity: EntityName<AnyEntity>, contextName?: string): void;
     static getEntities(contextName?: string): never[] | IterableIterator<EntityName<Partial<any>>>;
     static clear(contextName?: string): void;
+    /**
+     * When the `addEntity` is called next, the storage will be cleared automatically before it.
+     * We want to keep the cache, as it's populated on require time, but sometimes (tests) the contexts could be cleared.
+     * This resolves both cases by deferring the `clear` call to the first `addEntity` call.
+     */
+    static clearLater(): void;
 }

package/mikro-orm.entities.storage.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MikroOrmEntitiesStorage = void 0;
 class MikroOrmEntitiesStorage {
     static addEntity(entity, contextName = 'default') {
+        if (this.shouldClear) {
+            this.clear(contextName);
+            this.shouldClear = false;
+        }
         let set = this.storage.get(contextName);
         if (!set) {
             set = new Set();
@@ -16,6 +20,15 @@ class MikroOrmEntitiesStorage {
     static clear(contextName = 'default') {
         this.storage.get(contextName)?.clear();
     }
+    /**
+     * When the `addEntity` is called next, the storage will be cleared automatically before it.
+     * We want to keep the cache, as it's populated on require time, but sometimes (tests) the contexts could be cleared.
+     * This resolves both cases by deferring the `clear` call to the first `addEntity` call.
+     */
+    static clearLater() {
+        this.shouldClear = true;
+    }
 }
 exports.MikroOrmEntitiesStorage = MikroOrmEntitiesStorage;
 MikroOrmEntitiesStorage.storage = new Map();
+MikroOrmEntitiesStorage.shouldClear = false;

package/mikro-orm.middleware.d.ts

@@ -1,5 +1,5 @@
 import { MikroORM } from '@mikro-orm/core';
-import type { NestMiddleware } from '@nestjs/common';
+import { type NestMiddleware } from '@nestjs/common';
 export declare class MikroOrmMiddleware implements NestMiddleware {
     private readonly orm;
     constructor(orm: MikroORM);

package/mikro-orm.module.d.ts

@@ -1,6 +1,6 @@
-import type { AnyEntity } from '@mikro-orm/core';
-import type { DynamicModule } from '@nestjs/common';
-import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions, MikroOrmMiddlewareModuleOptions, MikroOrmModuleFeatureOptions, EntityName } from './typings';
+import { type AnyEntity } from '@mikro-orm/core';
+import { type DynamicModule } from '@nestjs/common';
+import type { EntityName, MikroOrmMiddlewareModuleOptions, MikroOrmModuleAsyncOptions, MikroOrmModuleFeatureOptions, MikroOrmModuleSyncOptions } from './typings';
 export declare class MikroOrmModule {
     /**
      * Clears the entity storage. This is useful for testing purposes, when you want to isolate the tests.

package/mikro-orm.module.js

@@ -10,10 +10,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MikroOrmModule = void 0;
 const core_1 = require("@mikro-orm/core");
 const common_1 = require("@nestjs/common");
-const mikro_orm_providers_1 = require("./mikro-orm.providers");
 const mikro_orm_core_module_1 = require("./mikro-orm-core.module");
 const mikro_orm_middleware_module_1 = require("./mikro-orm-middleware.module");
 const mikro_orm_entities_storage_1 = require("./mikro-orm.entities.storage");
+const mikro_orm_providers_1 = require("./mikro-orm.providers");
 let MikroOrmModule = MikroOrmModule_1 = class MikroOrmModule {
     /**
      * Clears the entity storage. This is useful for testing purposes, when you want to isolate the tests.

package/mikro-orm.providers.d.ts

@@ -1,9 +1,7 @@
-import type { AnyEntity } from '@mikro-orm/core';
-import { EntityManager } from '@mikro-orm/core';
-import type { MikroOrmModuleAsyncOptions, EntityName } from './typings';
-import type { Provider, Type } from '@nestjs/common';
-import { Scope } from '@nestjs/common';
-export declare function createMikroOrmProvider(contextName?: string): Provider;
+import { EntityManager, type AnyEntity } from '@mikro-orm/core';
+import { Scope, type Provider, type Type } from '@nestjs/common';
+import type { EntityName, MikroOrmModuleAsyncOptions } from './typings';
+export declare function createMikroOrmProvider(contextName?: string, type?: Type): Provider;
 export declare function createEntityManagerProvider(scope?: Scope, entityManager?: Type, contextName?: string): Provider<EntityManager>;
 export declare function createMikroOrmAsyncOptionsProvider(options: MikroOrmModuleAsyncOptions): Provider;
 export declare function createAsyncProviders(options: MikroOrmModuleAsyncOptions): Provider[];

package/mikro-orm.providers.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMikroOrmRepositoryProviders = exports.createAsyncProviders = exports.createMikroOrmAsyncOptionsProvider = exports.createEntityManagerProvider = exports.createMikroOrmProvider = void 0;
-const mikro_orm_common_1 = require("./mikro-orm.common");
 const core_1 = require("@mikro-orm/core");
+const mikro_orm_common_1 = require("./mikro-orm.common");
 const common_1 = require("@nestjs/common");
 const mikro_orm_entities_storage_1 = require("./mikro-orm.entities.storage");
-function createMikroOrmProvider(contextName) {
+function createMikroOrmProvider(contextName, type = core_1.MikroORM) {
     return {
-        provide: contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : core_1.MikroORM,
+        provide: contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : type,
         useFactory: async (options) => {
             options = { ...options };
             if (options?.autoLoadEntities) {
@@ -31,7 +31,7 @@ function createEntityManagerProvider(scope = common_1.Scope.DEFAULT, entityManag
         return {
             provide: entityManager,
             scope,
-            useFactory: (em) => em,
+            useFactory: (em) => em, // just a simple alias, unlike `useExisting` from nest, this works with request scopes too
             inject: [core_1.EntityManager], // depend on the EM from core package
         };
     }
@@ -47,8 +47,8 @@ function createMikroOrmAsyncOptionsProvider(options) {
     if (options.useFactory) {
         return {
             provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS,
-            useFactory: (...args) => {
-                const factoryOptions = options.useFactory(...args);
+            useFactory: async (...args) => {
+                const factoryOptions = await options.useFactory(...args);
                 return options.contextName
                     ? { contextName: options.contextName, ...factoryOptions }
                     : factoryOptions;
@@ -86,7 +86,7 @@ function createMikroOrmRepositoryProviders(entities, contextName) {
     const inject = contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : core_1.EntityManager;
     (entities || []).forEach(entity => {
         const meta = metadata.find(meta => meta.class === entity);
-        const repository = (meta?.repository ?? meta?.customRepository);
+        const repository = meta?.repository;
         if (repository) {
             providers.push({
                 provide: repository(),

package/multiple-mikro-orm.middleware.d.ts

@@ -1,5 +1,5 @@
-import type { MikroORM } from '@mikro-orm/core';
-import type { NestMiddleware } from '@nestjs/common';
+import { type MikroORM } from '@mikro-orm/core';
+import { type NestMiddleware } from '@nestjs/common';
 export declare class MultipleMikroOrmMiddleware implements NestMiddleware {
     private readonly orm;
     constructor(orm: MikroORM[]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/nestjs",
-  "version": "5.2.2",
+  "version": "6.0.0",
   "license": "MIT",
   "author": {
     "name": "Martin Adamek",
@@ -40,31 +40,32 @@
     "lint": "eslint src/**/*.ts"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "^5.0.0 || ^6.0.0-dev.0",
-    "@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0",
-    "@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0"
+    "@mikro-orm/core": "^6.0.0",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.7.12",
-    "@mikro-orm/sqlite": "^5.7.12",
-    "@nestjs/common": "^9.4.3",
-    "@nestjs/core": "^9.4.3",
-    "@nestjs/platform-express": "^9.4.3",
-    "@nestjs/testing": "^9.4.3",
-    "@types/jest": "^29.5.2",
-    "@types/node": "^20.3.1",
-    "@types/supertest": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "~5.61.0",
-    "@typescript-eslint/parser": "~5.61.0",
-    "conventional-changelog": "^4.0.0",
-    "conventional-changelog-cli": "^3.0.0",
-    "eslint": "^8.43.0",
-    "jest": "^29.5.0",
+    "@mikro-orm/core": "^6.2.7",
+    "@mikro-orm/sqlite": "^6.2.7",
+    "@nestjs/common": "^10.3.8",
+    "@nestjs/core": "^10.3.8",
+    "@nestjs/platform-express": "^10.3.8",
+    "@nestjs/testing": "^10.3.8",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "~7.9.0",
+    "@typescript-eslint/parser": "~7.9.0",
+    "conventional-changelog": "^6.0.0",
+    "conventional-changelog-cli": "^5.0.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "jest": "^29.7.0",
     "rxjs": "^7.8.1",
-    "supertest": "^6.3.3",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "typescript": "5.2.2"
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "5.4.5"
   },
   "commitlint": {
     "extends": [
@@ -102,7 +103,7 @@
     ]
   },
   "engines": {
-    "node": ">= 14.0.0"
+    "node": ">= 18.12.0"
   },
-  "packageManager": "yarn@3.6.3"
+  "packageManager": "yarn@4.2.2"
 }