Merge branch 'FionaLovett-validate-transform' into 5.6.0

Author: kamilmysliwiec

package-lock.json

@@ -5,30 +5,21 @@
   "scripts": {
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "precommit": "lint-staged",
-    "test":
-      "nyc --require ts-node/register mocha packages/**/*.spec.ts --reporter spec --require 'node_modules/reflect-metadata/Reflect.js'",
-    "integration-test":
-      "mocha integration/**/*.spec.ts --reporter spec --require ts-node/register --require 'node_modules/reflect-metadata/Reflect.js'",
-    "lint":
-      "tslint -p tsconfig.json -c tslint.json \"packages/**/*.ts\" -e \"*.spec.ts\"",
-    "format":
-      "prettier **/**/*.ts --ignore-path ./.prettierignore --write && git status",
+    "test": "nyc --require ts-node/register mocha packages/**/*.spec.ts --reporter spec --require 'node_modules/reflect-metadata/Reflect.js'",
+    "integration-test": "mocha integration/**/*.spec.ts --reporter spec --require ts-node/register --require 'node_modules/reflect-metadata/Reflect.js'",
+    "lint": "tslint -p tsconfig.json -c tslint.json \"packages/**/*.ts\" -e \"*.spec.ts\"",
+    "format": "prettier **/**/*.ts --ignore-path ./.prettierignore --write && git status",
     "clean": "gulp clean:bundle",
     "build": "npm run clean && gulp build",
     "prebuild:dev": "rm -rf node_modules/@nestjs",
     "build:dev": "gulp build --dist node_modules/@nestjs && gulp move",
     "postinstall": "opencollective",
     "prerelease": "gulp copy-misc && gulp build --dist node_modules/@nestjs",
-    "publish":
-      "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --force-publish --exact -m \"chore(@nestjs) publish %s release\"",
-    "publish:rc":
-      "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=rc -m \"chore(@nestjs) publish %s release\"",
-    "publish:next":
-      "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=next --skip-git -m \"chore(@nestjs) publish %s release\"",
-    "publish:beta":
-      "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=beta -m \"chore(@nestjs) publish %s release\"",
-    "publish:test":
-      "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --force-publish --npm-tag=test --skip-git -m \"chore(@nestjs) publish %s release\""
+    "publish": "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --force-publish --exact -m \"chore(@nestjs) publish %s release\"",
+    "publish:rc": "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=rc -m \"chore(@nestjs) publish %s release\"",
+    "publish:next": "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=next --skip-git -m \"chore(@nestjs) publish %s release\"",
+    "publish:beta": "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --npm-tag=beta -m \"chore(@nestjs) publish %s release\"",
+    "publish:test": "npm run prerelease && npm run build && ./node_modules/.bin/lerna publish --force-publish --npm-tag=test --skip-git -m \"chore(@nestjs) publish %s release\""
   },
   "engines": {
     "node": ">= 8.9.0"
@@ -141,7 +132,9 @@
     }
   },
   "nyc": {
-    "include": ["packages/**/*.ts"],
+    "include": [
+      "packages/**/*.ts"
+    ],
     "exclude": [
       "node_modules/",
       "packages/**/*.spec.ts",
@@ -161,13 +154,23 @@
       "packages/common/serializer/**/*",
       "packages/common/services/logger.service.ts"
     ],
-    "extension": [".ts"],
-    "require": ["ts-node/register"],
-    "reporter": ["text-summary", "html"],
+    "extension": [
+      ".ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "reporter": [
+      "text-summary",
+      "html"
+    ],
     "sourceMap": true,
     "instrument": true
   },
   "lint-staged": {
-    "packages/**/*.{ts,json}": ["npm run format", "git add"]
+    "packages/**/*.{ts,json}": [
+      "npm run format",
+      "git add"
+    ]
   }
 }

package.json

@@ -6,13 +6,15 @@ import {
   ValidationError,
 } from '../index';
 import { ValidatorOptions } from '../interfaces/external/validator-options.interface';
+import { ClassTransformOptions } from '../interfaces/external/class-transform-options.interface';
 import { PipeTransform } from '../interfaces/features/pipe-transform.interface';
 import { loadPackage } from '../utils/load-package.util';
 import { isNil } from '../utils/shared.utils';
 
 export interface ValidationPipeOptions extends ValidatorOptions {
   transform?: boolean;
   disableErrorMessages?: boolean;
+  transformOptions?: ClassTransformOptions;
   exceptionFactory?: (errors: ValidationError[]) => any;
 }
 
@@ -24,13 +26,20 @@ export class ValidationPipe implements PipeTransform<any> {
   protected isTransformEnabled: boolean;
   protected isDetailedOutputDisabled?: boolean;
   protected validatorOptions: ValidatorOptions;
+  protected transformOptions: ClassTransformOptions;
   protected exceptionFactory: (errors: ValidationError[]) => any;
 
   constructor(@Optional() options?: ValidationPipeOptions) {
     options = options || {};
-    const { transform, disableErrorMessages, ...validatorOptions } = options;
+    const {
+      transform,
+      disableErrorMessages,
+      transformOptions,
+      ...validatorOptions
+    } = options;
     this.isTransformEnabled = !!transform;
     this.validatorOptions = validatorOptions;
+    this.transformOptions = transformOptions;
     this.isDetailedOutputDisabled = disableErrorMessages;
     this.exceptionFactory =
       options.exceptionFactory ||
@@ -52,6 +61,7 @@ export class ValidationPipe implements PipeTransform<any> {
     const entity = classTransformer.plainToClass(
       metatype,
       this.toEmptyIfNil(value),
+      this.transformOptions
     );
     const errors = await classValidator.validate(entity, this.validatorOptions);
     if (errors.length > 0) {
@@ -60,8 +70,8 @@ export class ValidationPipe implements PipeTransform<any> {
     return this.isTransformEnabled
       ? entity
       : Object.keys(this.validatorOptions).length > 0
-      ? classTransformer.classToPlain(entity)
-      : value;
+        ? classTransformer.classToPlain(entity, this.transformOptions)
+        : value;
   }
 
   private toValidate(metadata: ArgumentMetadata): boolean {

packages/common/pipes/validation.pipe.ts

@@ -1,9 +1,26 @@
-import * as sinon from 'sinon';
 import { expect } from 'chai';
+import { Exclude, Expose } from 'class-transformer';
+import { IsOptional, IsString } from 'class-validator';
 import { ArgumentMetadata } from '../../interfaces';
-import { IsString } from 'class-validator';
 import { ValidationPipe } from '../../pipes/validation.pipe';
 
+@Exclude()
+class TestModelInternal {
+  constructor() {}
+  @Expose()
+  @IsString()
+  public prop1: string;
+
+  @Expose()
+  @IsString()
+  public prop2: string;
+
+  @Expose({ groups: ['internal'] })
+  @IsString()
+  @IsOptional()
+  public propInternal: string;
+}
+
 class TestModel {
   constructor() {}
   @IsString() public prop1: string;
@@ -18,6 +35,11 @@ describe('ValidationPipe', () => {
     metatype: TestModel,
     data: '',
   };
+  const transformMetadata: ArgumentMetadata = {
+    type: 'body',
+    metatype: TestModelInternal,
+    data: '',
+  };
 
   describe('transform', () => {
     describe('when validation passes', () => {
@@ -68,8 +90,40 @@ describe('ValidationPipe', () => {
           expect(target.transform(testObj, metadata)).to.eventually.throw;
         });
       });
+      describe('when transformation is internal', () => {
+        it('should return a TestModel with internal property', async () => {
+          target = new ValidationPipe({
+            transform: true,
+            transformOptions: { groups: ['internal'] },
+          });
+          const testObj = {
+            prop1: 'value1',
+            prop2: 'value2',
+            propInternal: 'value3',
+          };
+          expect(
+            await target.transform(testObj, transformMetadata),
+          ).to.have.property('propInternal');
+        });
+      });
+      describe('when transformation is external', () => {
+        it('should return a TestModel without internal property', async () => {
+          target = new ValidationPipe({
+            transform: true,
+            transformOptions: { groups: ['external'] },
+          });
+          const testObj = {
+            prop1: 'value1',
+            prop2: 'value2',
+            propInternal: 'value3',
+          };
+          expect(
+            await target.transform(testObj, transformMetadata),
+          ).to.not.have.property('propInternal');
+        });
+      });
     });
-    describe("when validation doesn't transform", () => {
+    describe('when validation doesn\'t transform', () => {
       describe('when validation strips', () => {
         it('should return a plain object without extra properties', async () => {
           target = new ValidationPipe({ transform: false, whitelist: true });