@mikro-orm/nestjs 5.0.0 → 5.1.0

package/README.md

@@ -176,6 +176,29 @@ export class MyService {
 }
 ```
 
+## Serialization caveat
+
+[NestJS built-in serialization](https://docs.nestjs.com/techniques/serialization) relies on [class-transformer](https://github.com/typestack/class-transformer). Since MikroORM wraps every single entity relation in a `Reference` or a `Collection` instance (for type-safety), this will make the built-in `ClassSerializerInterceptor` blind to any wrapped relations. In other words, if you return MikroORM entities from your HTTP or WebSocket handlers, all of their relations will NOT be serialized.
+
+Luckily, MikroORM provides a [serialization API](https://mikro-orm.io/docs/serializing) which can be used in lieu of `ClassSerializerInterceptor`.
+
+```typescript
+@Entity()
+export class Book {
+
+  @Property({ hidden: true })   // --> Equivalent of class-transformer's `@Exclude`
+  hiddenField: number = Date.now();
+  
+  @Property({ persist: false }) // --> Will only exist in memory (and will be serialized). Similar to class-transformer's `@Expose()`
+  count?: number;
+  
+  @ManyToOne({ serializer: value => value.name, serializedName: 'authorName' })   // Equivalent of class-transformer's `@Transform()`
+  author: Author;
+
+}
+
+```
+
 ## Using `AsyncLocalStorage` for request context
 
 > Since v5 AsyncLocalStorage is used inside RequestContext helper so this section is no longer valid.
@@ -269,7 +292,7 @@ the Nest.js DI container.
 `**./author.entity.ts**`
 
 ```ts
-@Entity()
+@Entity({ customRepository: () => AuthorRepository })
 export class Author {
 
   // to allow inference in `em.getRepository()`
@@ -281,7 +304,6 @@ export class Author {
 `**./author.repository.ts**`
 
 ```ts
-@Repository(Author)
 export class AuthorRepository extends EntityRepository<Author> {
 
   // your custom methods...

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/mikro-orm-core.module.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -63,8 +67,8 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
                 { provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS, useValue: options || {} },
                 (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName),
                 (0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, core_1.EntityManager, contextName),
-                ...(knex ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : knex.SqlEntityManager, contextName)] : []),
-                ...(mongo ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : mongo.MongoEntityManager, contextName)] : []),
+                ...(knex ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, knex.SqlEntityManager, contextName)] : []),
+                ...(mongo ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, mongo.MongoEntityManager, contextName)] : []),
             ],
             exports: [
                 contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : core_1.MikroORM,
@@ -86,8 +90,8 @@ let MikroOrmCoreModule = MikroOrmCoreModule_1 = class MikroOrmCoreModule {
                 ...(0, mikro_orm_providers_1.createAsyncProviders)({ ...options, contextName: options.contextName }),
                 (0, mikro_orm_providers_1.createMikroOrmProvider)(contextName),
                 (0, mikro_orm_providers_1.createEntityManagerProvider)(options.scope, core_1.EntityManager, contextName),
-                ...(knex ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : knex.SqlEntityManager, contextName)] : []),
-                ...(mongo ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : mongo.MongoEntityManager, contextName)] : []),
+                ...(knex ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, knex.SqlEntityManager, contextName)] : []),
+                ...(mongo ? [(0, mikro_orm_providers_1.createEntityManagerProvider)(options?.scope, mongo.MongoEntityManager, contextName)] : []),
             ],
             exports: [
                 contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : core_1.MikroORM,

package/mikro-orm.common.d.ts

@@ -1,7 +1,6 @@
-import type { AnyEntity, EntityName } from '@mikro-orm/core';
+import type { EntityName } from '@mikro-orm/core';
 import { Logger } from '@nestjs/common';
 export declare const MIKRO_ORM_MODULE_OPTIONS: unique symbol;
-export declare const REGISTERED_ENTITIES: Set<EntityName<AnyEntity<any>>>;
 export declare const CONTEXT_NAMES: string[];
 export declare const logger: Logger;
 export declare const getMikroORMToken: (name: string) => string;

package/mikro-orm.common.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InjectRepository = exports.getRepositoryToken = exports.InjectEntityManager = exports.getEntityManagerToken = exports.InjectMikroORM = exports.getMikroORMToken = exports.logger = exports.CONTEXT_NAMES = exports.REGISTERED_ENTITIES = exports.MIKRO_ORM_MODULE_OPTIONS = void 0;
+exports.InjectRepository = exports.getRepositoryToken = exports.InjectEntityManager = exports.getEntityManagerToken = exports.InjectMikroORM = exports.getMikroORMToken = exports.logger = exports.CONTEXT_NAMES = exports.MIKRO_ORM_MODULE_OPTIONS = void 0;
 const core_1 = require("@mikro-orm/core");
 const common_1 = require("@nestjs/common");
 exports.MIKRO_ORM_MODULE_OPTIONS = Symbol('mikro-orm-module-options');
-exports.REGISTERED_ENTITIES = new Set();
 exports.CONTEXT_NAMES = [];
 exports.logger = new common_1.Logger(core_1.MikroORM.name);
 const getMikroORMToken = (name) => `${name}_MikroORM`;

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

@@ -0,0 +1,7 @@
+import type { AnyEntity, EntityName } from '@mikro-orm/core';
+export declare class MikroOrmEntitiesStorage {
+    private static readonly storage;
+    static addEntity(entity: EntityName<AnyEntity>, contextName?: string): void;
+    static getEntities(contextName?: string): never[] | IterableIterator<EntityName<AnyEntity<any>>>;
+    static clear(contextName?: string): void;
+}

package/mikro-orm.entities.storage.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MikroOrmEntitiesStorage = void 0;
+class MikroOrmEntitiesStorage {
+    static addEntity(entity, contextName = 'default') {
+        let set = this.storage.get(contextName);
+        if (!set) {
+            set = new Set();
+            this.storage.set(contextName, set);
+        }
+        set.add(entity);
+    }
+    static getEntities(contextName = 'default') {
+        return this.storage.get(contextName)?.values() || [];
+    }
+    static clear(contextName = 'default') {
+        const set = this.storage.get(contextName);
+        if (!set) {
+            return;
+        }
+        set.clear();
+    }
+}
+exports.MikroOrmEntitiesStorage = MikroOrmEntitiesStorage;
+MikroOrmEntitiesStorage.storage = new Map();

package/mikro-orm.module.d.ts

@@ -1,11 +1,9 @@
 import type { AnyEntity, EntityName } from '@mikro-orm/core';
 import type { DynamicModule } from '@nestjs/common';
-import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions, MikroOrmMiddlewareModuleOptions } from './typings';
+import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions, MikroOrmMiddlewareModuleOptions, MikroOrmModuleFeatureOptions } from './typings';
 export declare class MikroOrmModule {
     static forRoot(options?: MikroOrmModuleSyncOptions): DynamicModule;
     static forRootAsync(options: MikroOrmModuleAsyncOptions): DynamicModule;
-    static forFeature(options: EntityName<AnyEntity>[] | {
-        entities?: EntityName<AnyEntity>[];
-    }, contextName?: string): DynamicModule;
+    static forFeature(options: EntityName<AnyEntity>[] | MikroOrmModuleFeatureOptions, contextName?: string): DynamicModule;
     static forMiddleware(options?: MikroOrmMiddlewareModuleOptions): DynamicModule;
 }

package/mikro-orm.module.js

@@ -12,8 +12,8 @@ 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_common_1 = require("./mikro-orm.common");
 const mikro_orm_middleware_module_1 = require("./mikro-orm-middleware.module");
+const mikro_orm_entities_storage_1 = require("./mikro-orm.entities.storage");
 let MikroOrmModule = MikroOrmModule_1 = class MikroOrmModule {
     static forRoot(options) {
         return {
@@ -29,10 +29,11 @@ let MikroOrmModule = MikroOrmModule_1 = class MikroOrmModule {
     }
     static forFeature(options, contextName) {
         const entities = Array.isArray(options) ? options : (options.entities || []);
-        const providers = (0, mikro_orm_providers_1.createMikroOrmRepositoryProviders)(entities, contextName);
+        const name = (Array.isArray(options) || contextName) ? contextName : options.contextName;
+        const providers = (0, mikro_orm_providers_1.createMikroOrmRepositoryProviders)(entities, name);
         for (const e of entities) {
             if (!core_1.Utils.isString(e)) {
-                mikro_orm_common_1.REGISTERED_ENTITIES.add(e);
+                mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.addEntity(e, name);
             }
         }
         return {

package/mikro-orm.providers.d.ts

@@ -1,10 +1,10 @@
 import type { AnyEntity, EntityName } from '@mikro-orm/core';
 import { EntityManager } from '@mikro-orm/core';
 import type { MikroOrmModuleAsyncOptions } from './typings';
-import type { Provider } from '@nestjs/common';
+import type { Provider, Type } from '@nestjs/common';
 import { Scope } from '@nestjs/common';
 export declare function createMikroOrmProvider(contextName?: string): Provider;
-export declare function createEntityManagerProvider(scope?: Scope, entityManager?: any, contextName?: string): Provider<EntityManager>;
+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[];
 export declare function createMikroOrmRepositoryProviders(entities: EntityName<AnyEntity>[], contextName?: string): Provider[];

package/mikro-orm.providers.js

@@ -4,16 +4,17 @@ exports.createMikroOrmRepositoryProviders = exports.createAsyncProviders = expor
 const mikro_orm_common_1 = require("./mikro-orm.common");
 const core_1 = require("@mikro-orm/core");
 const common_1 = require("@nestjs/common");
+const mikro_orm_entities_storage_1 = require("./mikro-orm.entities.storage");
 function createMikroOrmProvider(contextName) {
     return {
         provide: contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : core_1.MikroORM,
         useFactory: async (options) => {
             if (options?.autoLoadEntities) {
-                options.entities = [...(options.entities || []), ...mikro_orm_common_1.REGISTERED_ENTITIES.values()];
-                options.entitiesTs = [...(options.entitiesTs || []), ...mikro_orm_common_1.REGISTERED_ENTITIES.values()];
+                options.entities = [...(options.entities || []), ...mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.getEntities(contextName)];
+                options.entitiesTs = [...(options.entitiesTs || []), ...mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.getEntities(contextName)];
                 delete options.autoLoadEntities;
             }
-            mikro_orm_common_1.REGISTERED_ENTITIES.clear();
+            mikro_orm_entities_storage_1.MikroOrmEntitiesStorage.clear(contextName);
             if (!options || Object.keys(options).length === 0) {
                 const config = await core_1.ConfigurationLoader.getConfiguration();
                 config.set('logger', mikro_orm_common_1.logger.log.bind(mikro_orm_common_1.logger));
@@ -26,14 +27,8 @@ function createMikroOrmProvider(contextName) {
 }
 exports.createMikroOrmProvider = createMikroOrmProvider;
 function createEntityManagerProvider(scope = common_1.Scope.DEFAULT, entityManager = core_1.EntityManager, contextName) {
-    function getProvide() {
-        if (core_1.Utils.isString(entityManager)) {
-            return entityManager;
-        }
-        return contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : entityManager;
-    }
     return {
-        provide: getProvide(),
+        provide: contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : entityManager,
         scope,
         useFactory: (orm) => scope === common_1.Scope.DEFAULT ? orm.em : orm.em.fork(),
         inject: [contextName ? (0, mikro_orm_common_1.getMikroORMToken)(contextName) : core_1.MikroORM],
@@ -44,7 +39,12 @@ function createMikroOrmAsyncOptionsProvider(options) {
     if (options.useFactory) {
         return {
             provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS,
-            useFactory: options.useFactory,
+            useFactory: (...args) => {
+                const factoryOptions = options.useFactory(...args);
+                return options.contextName
+                    ? { contextName: options.contextName, ...factoryOptions }
+                    : factoryOptions;
+            },
             inject: options.inject || [],
         };
     }
@@ -54,7 +54,7 @@ function createMikroOrmAsyncOptionsProvider(options) {
     }
     return {
         provide: mikro_orm_common_1.MIKRO_ORM_MODULE_OPTIONS,
-        useFactory: async (optionsFactory) => await optionsFactory.createMikroOrmOptions(),
+        useFactory: async (optionsFactory) => await optionsFactory.createMikroOrmOptions(options.contextName),
         inject,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/nestjs",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "license": "MIT",
   "author": {
     "name": "Martin Adamek",
@@ -43,8 +43,8 @@
     "@mikro-orm/core": "^5.0.0",
     "@mikro-orm/knex": "^5.0.0",
     "@mikro-orm/mongodb": "^5.0.0",
-    "@nestjs/common": "^8.0.0",
-    "@nestjs/core": "^8.0.0"
+    "@nestjs/common": "^8.0.0 || ^9.0.0",
+    "@nestjs/core": "^8.0.0 || ^9.0.0"
   },
   "peerDependenciesMeta": {
     "@mikro-orm/knex": {
@@ -55,28 +55,28 @@
     }
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.0.3",
-    "@mikro-orm/sqlite": "^5.0.3",
-    "@mikro-orm/mongodb": "^5.0.3",
-    "@mikro-orm/knex": "^5.0.3",
-    "@nestjs/common": "^8.2.6",
-    "@nestjs/core": "^8.2.6",
-    "@nestjs/platform-express": "^8.2.6",
-    "@nestjs/testing": "^8.2.6",
-    "@types/jest": "^27.4.0",
+    "@mikro-orm/core": "^5.2.3",
+    "@mikro-orm/knex": "^5.2.3",
+    "@mikro-orm/mongodb": "^5.2.3",
+    "@mikro-orm/sqlite": "^5.2.3",
+    "@nestjs/common": "^9.0.1",
+    "@nestjs/core": "^9.0.1",
+    "@nestjs/platform-express": "^9.0.1",
+    "@nestjs/testing": "^9.0.1",
+    "@types/jest": "^28.0.0",
     "@types/node": "^17.0.17",
     "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "~5.12.0",
-    "@typescript-eslint/parser": "~5.12.0",
+    "@typescript-eslint/eslint-plugin": "~5.26.0",
+    "@typescript-eslint/parser": "~5.26.0",
     "conventional-changelog": "^3.1.25",
     "conventional-changelog-cli": "^2.2.2",
     "eslint": "^8.9.0",
-    "jest": "^27.5.1",
+    "jest": "^28.0.0",
     "rxjs": "^7.5.4",
     "supertest": "^6.2.2",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^28.0.0",
     "ts-node": "^10.5.0",
-    "typescript": "4.5.5"
+    "typescript": "4.6.4"
   },
   "commitlint": {
     "extends": [

package/typings.d.ts

@@ -1,4 +1,4 @@
-import type { IDatabaseDriver, Options } from '@mikro-orm/core';
+import type { AnyEntity, EntityName, IDatabaseDriver, Options } from '@mikro-orm/core';
 import type { MiddlewareConsumer, ModuleMetadata, Scope, Type } from '@nestjs/common';
 import type { AbstractHttpAdapter } from '@nestjs/core';
 export interface NestMiddlewareConsumer extends MiddlewareConsumer {
@@ -21,8 +21,12 @@ export declare type MikroOrmModuleOptions<D extends IDatabaseDriver = IDatabaseD
     registerRequestContext?: boolean;
     autoLoadEntities?: boolean;
 } & Options<D> & MikroOrmMiddlewareModuleOptions;
+export interface MikroOrmModuleFeatureOptions {
+    entities?: EntityName<AnyEntity>[];
+    contextName?: string;
+}
 export interface MikroOrmOptionsFactory<D extends IDatabaseDriver = IDatabaseDriver> {
-    createMikroOrmOptions(): Promise<MikroOrmModuleOptions<D>> | MikroOrmModuleOptions<D>;
+    createMikroOrmOptions(contextName?: string): Promise<MikroOrmModuleOptions<D>> | MikroOrmModuleOptions<D>;
 }
 export interface MikroOrmModuleSyncOptions extends MikroOrmModuleOptions, MikroOrmNestScopeOptions {
 }
@@ -30,7 +34,7 @@ export interface MikroOrmModuleAsyncOptions<D extends IDatabaseDriver = IDatabas
     contextName?: string;
     useExisting?: Type<MikroOrmOptionsFactory<D>>;
     useClass?: Type<MikroOrmOptionsFactory<D>>;
-    useFactory?: (...args: any[]) => Promise<MikroOrmModuleOptions<D>> | MikroOrmModuleOptions<D>;
+    useFactory?: (...args: any[]) => Promise<Omit<MikroOrmModuleOptions<D>, 'contextName'>> | Omit<MikroOrmModuleOptions<D>, 'contextName'>;
     inject?: any[];
 }
 export {};