Implement route/controller-specific transform options

Author: Aleksi Pekkala

README.md

@@ -42,6 +42,7 @@ You can use routing-controllers with [express.js][1] or [koa.js][2].
       - [Throw HTTP errors](#throw-http-errors)
       - [Enable CORS](#enable-cors)
       - [Default settings](#default-settings)
+      - [Selectively disabling request/response transform](#selectively-disable-requestresponse-transforming)
   * [Using middlewares](#using-middlewares)
     + [Use exist middleware](#use-exist-middleware)
     + [Creating your own express middleware](#creating-your-own-express-middleware)
@@ -509,10 +510,6 @@ If you specify a class type to parameter that is decorated with parameter decora
 routing-controllers will use [class-transformer][4] to create instance of that class type.
 More info about this feature is available [here](#creating-instances-of-classes-from-action-params).
 
-#### Disable response transformation
-
-By default response values are coerced to plain objects with [class-transformer](https://github.com/pleerock/class-transformer). When returning large objects or values with complex serialization logic (e.g. Mongoose documents) you might opt for the default `toJSON` handler instead. To disable response transformation simply pass `useResponseClassTransformer: false` to createExpressServer method.
-
 #### Set custom ContentType
 
 You can specify a custom ContentType header:
@@ -787,6 +784,20 @@ const app = createExpressServer({
 app.listen(3000);
 ```
 
+#### Selectively disable request/response transform
+
+To disable `class-transformer` on a per-controller or per-route basis, use the `transformRequest` and `transformResponse` options on your controller and route decorators:
+
+```typescript
+@Controller("/users", {transformRequest: false, transformResponse: false})
+export class UserController {
+
+    @Get("/", {transformResponse: true}) {
+        // route option overrides controller option
+    }
+}
+```
+
 ## Using middlewares
 
 You can use any exist express / koa middleware, or create your own.
@@ -1175,7 +1186,7 @@ If its a class - then instance of this class will be created.
 This technique works not only with `@Body`, but also with `@Param`, `@QueryParam`, `@BodyParam` and other decorators.
 Learn more about class-transformer and how to handle more complex object constructions [here][4].
 This behaviour is enabled by default.
-If you want to disable it simply pass `classTransformer: false` to createExpressServer method.
+If you want to disable it simply pass `classTransformer: false` to createExpressServer method. Alternatively you can disable transforming for [individual controllers or routes](#selectively-disable-requestresponse-transforming).
 
 ## Auto validating action params
 

src/ActionParameterHandler.ts

@@ -162,6 +162,7 @@ export class ActionParameterHandler<T extends BaseDriver> {
      */
     protected transformValue(value: any, paramMetadata: ParamMetadata): any {
         if (this.driver.useClassTransformer &&
+            paramMetadata.actionMetadata.options.transformRequest !== false &&
             paramMetadata.targetType &&
             paramMetadata.targetType !== Object &&
             !(value instanceof paramMetadata.targetType)) {
@@ -197,4 +198,4 @@ export class ActionParameterHandler<T extends BaseDriver> {
         return value;
     }
 
-}
+}

src/RoutingControllersOptions.ts

@@ -40,12 +40,6 @@ export interface RoutingControllersOptions {
      */
     classTransformer?: boolean;
 
-    /**
-     * Toggles class-transformer serialization for response values.
-     * Overwritten by a negative classTransformer value.
-     */
-    useResponseClassTransformer?: boolean;
-
     /**
      * Global class transformer options passed to class-transformer during classToPlain operation.
      * This operation is being executed when server returns response to user.

src/TransformationOptions.ts

@@ -0,0 +1,14 @@
+/**
+ * Options for toggling class-transformer serialization.
+ */
+export interface TransformationOptions {
+  /**
+   * If set to false, class-transformer won't be used to perform request serialization.
+   */
+  transformRequest?: boolean;
+
+  /**
+   * If set to false, class-transformer won't be used to perform response serialization.
+   */
+  transformResponse?: boolean;
+}

src/decorator-options/ControllerOptions.ts

@@ -0,0 +1,8 @@
+import {TransformationOptions} from "../TransformationOptions";
+
+/**
+ * Extra options that apply to each controller action.
+ */
+export interface ControllerOptions extends TransformationOptions {
+
+}

src/decorator-options/HandlerOptions.ts

@@ -0,0 +1,8 @@
+import {TransformationOptions} from "../TransformationOptions";
+
+/**
+ * Extra handler-specific options.
+ */
+export interface HandlerOptions extends TransformationOptions {
+
+}

src/decorator/Controller.ts

@@ -1,18 +1,21 @@
 import {getMetadataArgsStorage} from "../index";
+import {ControllerOptions} from "../decorator-options/ControllerOptions";
 
 /**
  * Defines a class as a controller.
  * Each decorated controller method is served as a controller action.
  * Controller actions are executed when request come.
  *
  * @param baseRoute Extra path you can apply as a base route to all controller actions
+ * @param options Extra options that apply to all controller actions
  */
-export function Controller(baseRoute?: string): Function {
+export function Controller(baseRoute?: string, options?: ControllerOptions): Function {
     return function (object: Function) {
         getMetadataArgsStorage().controllers.push({
             type: "default",
             target: object,
-            route: baseRoute
+            route: baseRoute,
+            options
         });
     };
-}
+}

src/decorator/Delete.ts

@@ -1,28 +1,30 @@
+import {HandlerOptions} from "../decorator-options/HandlerOptions";
 import {getMetadataArgsStorage} from "../index";
 
 /**
  * Registers a controller method to be executed when DELETE request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Delete(route?: RegExp): Function;
+export function Delete(route?: RegExp, options?: HandlerOptions): Function;
 
 /**
  * Registers a controller method to be executed when DELETE request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Delete(route?: string): Function;
+export function Delete(route?: string, options?: HandlerOptions): Function;
 
 /**
  * Registers a controller method to be executed when DELETE request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Delete(route?: string|RegExp): Function {
+export function Delete(route?: string|RegExp, options?: HandlerOptions): Function {
     return function (object: Object, methodName: string) {
         getMetadataArgsStorage().actions.push({
             type: "delete",
             target: object.constructor,
             method: methodName,
-            route: route
+            route: route,
+            options
         });
     };
 }

src/decorator/Get.ts

@@ -1,28 +1,30 @@
+import {HandlerOptions} from "../decorator-options/HandlerOptions";
 import {getMetadataArgsStorage} from "../index";
 
 /**
  * Registers an action to be executed when GET request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Get(route?: RegExp): Function;
+export function Get(route?: RegExp, options?: HandlerOptions): Function;
 
 /**
  * Registers an action to be executed when GET request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Get(route?: string): Function;
+export function Get(route?: string, options?: HandlerOptions): Function;
 
 /**
  * Registers an action to be executed when GET request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Get(route?: string|RegExp): Function {
+export function Get(route?: string|RegExp, options?: HandlerOptions): Function {
     return function (object: Object, methodName: string) {
         getMetadataArgsStorage().actions.push({
             type: "get",
             target: object.constructor,
             method: methodName,
-            route: route
+            options,
+            route
         });
     };
-}
+}

src/decorator/Head.ts

@@ -1,28 +1,30 @@
+import {HandlerOptions} from "../decorator-options/HandlerOptions";
 import {getMetadataArgsStorage} from "../index";
 
 /**
  * Registers an action to be executed when HEAD request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Head(route?: RegExp): Function;
+export function Head(route?: RegExp, options?: HandlerOptions): Function;
 
 /**
  * Registers an action to be executed when HEAD request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Head(route?: string): Function;
+export function Head(route?: string, options?: HandlerOptions): Function;
 
 /**
  * Registers an action to be executed when HEAD request comes on a given route.
  * Must be applied on a controller action.
  */
-export function Head(route?: string|RegExp): Function {
+export function Head(route?: string|RegExp, options?: HandlerOptions): Function {
     return function (object: Object, methodName: string) {
         getMetadataArgsStorage().actions.push({
             type: "head",
             target: object.constructor,
             method: methodName,
-            route: route
+            options,
+            route
         });
     };
-}
+}