@mikro-orm/nestjs 5.0.1 → 5.0.2

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.providers.js

@@ -39,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 || [],
         };
     }
@@ -49,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.1",
+  "version": "5.0.2",
   "license": "MIT",
   "author": {
     "name": "Martin Adamek",
@@ -56,27 +56,27 @@
   },
   "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",
+    "@mikro-orm/mongodb": "^5.0.3",
+    "@mikro-orm/sqlite": "^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",
+    "@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.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.6.2"
+    "typescript": "4.6.4"
   },
   "commitlint": {
     "extends": [

package/typings.d.ts

@@ -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 {
 }