Merge pull request #77 from snirs90/feat/transform-plain-to-class

Adding @TransformPlainToClass decorator

Author: cojack

README.md

@@ -634,6 +634,7 @@ The `@Transform` decorator is given more arguments to let you configure how you
 |--------------------|------------------------------------------|---------------------------------------------|
 | `@TransformClassToPlain` | `@TransformClassToPlain({ groups: ["user"] })` | Transform the method return with classToPlain and expose the properties on the class.
 | `@TransformClassToClass` | `@TransformClassToClass({ groups: ["user"] })` | Transform the method return with classToClass and expose the properties on the class.
+| `@TransformPlainToClass` | `@TransformPlainToClass(User, { groups: ["user"] })` | Transform the method return with plainToClass and expose the properties on the class.
 
 The above decorators accept one optional argument:
 ClassTransformOptions - The transform options like groups, version, name

src/decorators.ts

@@ -88,3 +88,21 @@ export function TransformClassToClass(params?: ClassTransformOptions): Function
         };
     };
 }
+
+/**
+ * Return the class instance only with the exposed properties.
+ */
+export function TransformPlainToClass(classType: any, params?: ClassTransformOptions): Function {
+
+    return function (target: Function, propertyKey: string, descriptor: PropertyDescriptor) {
+        const classTransformer: ClassTransformer = new ClassTransformer();
+        const originalMethod = descriptor.value;
+
+        descriptor.value = function(...args: any[]) {
+            const result: any = originalMethod.apply(this, args);
+            const isPromise = !!result && (typeof result === "object" || typeof result === "function") && typeof result.then === "function";
+
+            return isPromise ? result.then((data: any) => classTransformer.plainToClass(classType, data, params)) : classTransformer.plainToClass(classType, result, params);
+        };
+    };
+}

test/functional/transformer-method.spec.ts

@@ -1,6 +1,6 @@
 import "reflect-metadata";
 import {defaultMetadataStorage} from "../../src/storage";
-import {Exclude, Expose, TransformClassToPlain, TransformClassToClass} from "../../src/decorators";
+import { Exclude, Expose, TransformClassToPlain, TransformClassToClass, TransformPlainToClass } from "../../src/decorators";
 import {expect} from "chai";
 
 describe("transformer methods decorator", () => {
@@ -50,6 +50,49 @@ describe("transformer methods decorator", () => {
         expect(result).to.be.instanceof(User);
     });
 
+    it("should expose non configuration properties and return User instance class instead of plain object", () => {
+        defaultMetadataStorage.clear();
+
+        @Exclude()
+        class User {
+
+            id: number;
+
+            @Expose()
+            firstName: string;
+
+            @Expose()
+            lastName: string;
+
+            password: string;
+        }
+
+        class UserController {
+
+            @TransformPlainToClass(User)
+            getUser() {
+                const user: any = {};
+                user.firstName = "Snir";
+                user.lastName = "Segal";
+                user.password = "imnosuperman";
+
+                return user;
+            }
+        }
+
+        const controller = new UserController();
+
+        const result = controller.getUser();
+        expect(result.password).to.be.undefined;
+
+        const user = new User();
+        user.firstName = "Snir";
+        user.lastName = "Segal";
+
+        expect(result).to.be.eql(user);
+        expect(result).to.be.instanceof(User);
+    });
+
     it("should expose non configuration properties", () => {
         defaultMetadataStorage.clear();