@mikro-orm/nestjs 5.0.1 → 5.1.1

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.

package/mikro-orm.common.d.ts

@@ -1,5 +1,5 @@
-import type { EntityName } from '@mikro-orm/core';
 import { Logger } from '@nestjs/common';
+import type { EntityName } from './typings';
 export declare const MIKRO_ORM_MODULE_OPTIONS: unique symbol;
 export declare const CONTEXT_NAMES: string[];
 export declare const logger: Logger;
@@ -7,5 +7,5 @@ export declare const getMikroORMToken: (name: string) => string;
 export declare const InjectMikroORM: (name: string) => (target: object, key: string | symbol, index?: number | undefined) => void;
 export declare const getEntityManagerToken: (name: string) => string;
 export declare const InjectEntityManager: (name: string) => (target: object, key: string | symbol, index?: number | undefined) => void;
-export declare const getRepositoryToken: <T>(entity: EntityName<T>, name?: string | undefined) => string;
-export declare const InjectRepository: <T>(entity: EntityName<T>, name?: string | undefined) => (target: object, key: string | symbol, index?: number | undefined) => void;
+export declare const getRepositoryToken: <T>(entity: EntityName<T>, name?: string) => string;
+export declare const InjectRepository: <T>(entity: EntityName<T>, name?: string) => (target: object, key: string | symbol, index?: number | undefined) => void;

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

@@ -1,4 +1,5 @@
-import type { AnyEntity, EntityName } from '@mikro-orm/core';
+import type { AnyEntity } from '@mikro-orm/core';
+import type { EntityName } from './typings';
 export declare class MikroOrmEntitiesStorage {
     private static readonly storage;
     static addEntity(entity: EntityName<AnyEntity>, contextName?: string): void;

package/mikro-orm.module.d.ts

@@ -1,6 +1,6 @@
-import type { AnyEntity, EntityName } from '@mikro-orm/core';
+import type { AnyEntity } from '@mikro-orm/core';
 import type { DynamicModule } from '@nestjs/common';
-import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions, MikroOrmMiddlewareModuleOptions, MikroOrmModuleFeatureOptions } from './typings';
+import type { MikroOrmModuleAsyncOptions, MikroOrmModuleSyncOptions, MikroOrmMiddlewareModuleOptions, MikroOrmModuleFeatureOptions, EntityName } from './typings';
 export declare class MikroOrmModule {
     static forRoot(options?: MikroOrmModuleSyncOptions): DynamicModule;
     static forRootAsync(options: MikroOrmModuleAsyncOptions): DynamicModule;

package/mikro-orm.providers.d.ts

@@ -1,6 +1,6 @@
-import type { AnyEntity, EntityName } from '@mikro-orm/core';
+import type { AnyEntity } from '@mikro-orm/core';
 import { EntityManager } from '@mikro-orm/core';
-import type { MikroOrmModuleAsyncOptions } from './typings';
+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;

package/mikro-orm.providers.js

@@ -27,6 +27,14 @@ function createMikroOrmProvider(contextName) {
 }
 exports.createMikroOrmProvider = createMikroOrmProvider;
 function createEntityManagerProvider(scope = common_1.Scope.DEFAULT, entityManager = core_1.EntityManager, contextName) {
+    if (!contextName && entityManager !== core_1.EntityManager) {
+        return {
+            provide: entityManager,
+            scope,
+            useFactory: (em) => em,
+            inject: [core_1.EntityManager], // depend on the EM from core package
+        };
+    }
     return {
         provide: contextName ? (0, mikro_orm_common_1.getEntityManagerToken)(contextName) : entityManager,
         scope,
@@ -39,7 +47,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 || [],
         };
     }
@@ -49,7 +62,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.1",
+  "version": "5.1.1",
   "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.14.0",
-    "@typescript-eslint/parser": "~5.14.0",
+    "@typescript-eslint/eslint-plugin": "~5.33.0",
+    "@typescript-eslint/parser": "~5.33.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.6.2"
+    "typescript": "4.7.4"
   },
   "commitlint": {
     "extends": [

package/typings.d.ts

@@ -1,4 +1,4 @@
-import type { AnyEntity, EntityName, IDatabaseDriver, Options } from '@mikro-orm/core';
+import type { AnyEntity, EntityName as CoreEntityName, EntitySchema, 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 {
@@ -26,7 +26,7 @@ export interface MikroOrmModuleFeatureOptions {
     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 {
 }
@@ -37,4 +37,5 @@ export interface MikroOrmModuleAsyncOptions<D extends IDatabaseDriver = IDatabas
     useFactory?: (...args: any[]) => Promise<Omit<MikroOrmModuleOptions<D>, 'contextName'>> | Omit<MikroOrmModuleOptions<D>, 'contextName'>;
     inject?: any[];
 }
+export declare type EntityName<T extends AnyEntity<T>> = CoreEntityName<T> | EntitySchema<any>;
 export {};