Merge pull request #10087 from ZanMinKian/zmj-support_return_type

feat(common): allow to serialize plain object
nestjs · Sep 19, 2022 · 2fb0a1c · 2fb0a1c
2 parents 447e825 + 930161e
commit 2fb0a1c
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/packages/common/serializer/class-serializer.interceptor.ts b/packages/common/serializer/class-serializer.interceptor.ts
@@ -1,3 +1,4 @@
+import { ClassSerializerContextOptions } from './class-serializer.interfaces';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
 import { Inject, Injectable, Optional } from '../decorators/core';
@@ -63,7 +64,7 @@ export class ClassSerializerInterceptor implements NestInterceptor {
    */
   serialize(
     response: PlainLiteralObject | Array<PlainLiteralObject>,
-    options: ClassTransformOptions,
+    options: ClassSerializerContextOptions,
   ): PlainLiteralObject | Array<PlainLiteralObject> {
     if (!isObject(response) || response instanceof StreamableFile) {
       return response;
@@ -76,16 +77,24 @@ export class ClassSerializerInterceptor implements NestInterceptor {
 
   transformToPlain(
     plainOrClass: any,
-    options: ClassTransformOptions,
+    options: ClassSerializerContextOptions,
   ): PlainLiteralObject {
-    return plainOrClass
-      ? classTransformer.classToPlain(plainOrClass, options)
-      : plainOrClass;
+    if (!plainOrClass) {
+      return plainOrClass;
+    }
+    if (!options.type) {
+      return classTransformer.classToPlain(plainOrClass, options);
+    }
+    if (plainOrClass instanceof options.type) {
+      return classTransformer.classToPlain(plainOrClass, options);
+    }
+    const instance = classTransformer.plainToClass(options.type, plainOrClass);
+    return classTransformer.classToPlain(instance, options);
   }
 
   protected getContextOptions(
     context: ExecutionContext,
-  ): ClassTransformOptions | undefined {
+  ): ClassSerializerContextOptions | undefined {
     return this.reflector.getAllAndOverride(CLASS_SERIALIZER_OPTIONS, [
       context.getHandler(),
       context.getClass(),

diff --git a/packages/common/serializer/class-serializer.interfaces.ts b/packages/common/serializer/class-serializer.interfaces.ts
@@ -0,0 +1,6 @@
+import { ClassTransformOptions } from '../interfaces/external/class-transform-options.interface';
+import { Type } from '../interfaces';
+
+export interface ClassSerializerContextOptions extends ClassTransformOptions {
+  type?: Type<any>;
+}
diff --git a/packages/common/serializer/decorators/serialize-options.decorator.ts b/packages/common/serializer/decorators/serialize-options.decorator.ts
@@ -1,6 +1,6 @@
 import { SetMetadata } from '../../decorators';
-import { ClassTransformOptions } from '../../interfaces/external/class-transform-options.interface';
+import { ClassSerializerContextOptions } from '../class-serializer.interfaces';
 import { CLASS_SERIALIZER_OPTIONS } from '../class-serializer.constants';
 
-export const SerializeOptions = (options: ClassTransformOptions) =>
+export const SerializeOptions = (options: ClassSerializerContextOptions) =>
   SetMetadata(CLASS_SERIALIZER_OPTIONS, options);
diff --git a/packages/common/serializer/index.ts b/packages/common/serializer/index.ts
@@ -1,2 +1,3 @@
 export * from './class-serializer.interceptor';
 export * from './decorators';
+export * from './class-serializer.interfaces';