Merge branch 'nestjs:master' into feature/add-more-apiresponse

Author: lit26

lib/type-helpers/partial-type.helper.ts

@@ -1,6 +1,7 @@
 import { Type } from '@nestjs/common';
 import {
   applyIsOptionalDecorator,
+  applyValidateIfDefinedDecorator,
   inheritPropertyInitializers,
   inheritTransformationMetadata,
   inheritValidationMetadata
@@ -15,7 +16,25 @@ import { clonePluginMetadataFactory } from './mapped-types.utils';
 
 const modelPropertiesAccessor = new ModelPropertiesAccessor();
 
-export function PartialType<T>(classRef: Type<T>): Type<Partial<T>> {
+export function PartialType<T>(
+  classRef: Type<T>,
+  /**
+   *  Configuration options.
+   */
+  options: {
+    /**
+     * If true, validations will be ignored on a property if it is either null or undefined. If
+     * false, validations will be ignored only if the property is undefined.
+     * @default true
+     */
+    skipNullProperties?: boolean;
+  } = {}
+): Type<Partial<T>> {
+  const applyPartialDecoratorFn =
+    options.skipNullProperties === false
+      ? applyValidateIfDefinedDecorator
+      : applyIsOptionalDecorator;
+
   const fields = modelPropertiesAccessor.getModelProperties(classRef.prototype);
 
   abstract class PartialTypeClass {
@@ -30,7 +49,7 @@ export function PartialType<T>(classRef: Type<T>): Type<Partial<T>> {
   if (keysWithValidationConstraints) {
     keysWithValidationConstraints
       .filter((key) => !fields.includes(key))
-      .forEach((key) => applyIsOptionalDecorator(PartialTypeClass, key));
+      .forEach((key) => applyPartialDecoratorFn(PartialTypeClass, key));
   }
 
   inheritTransformationMetadata(classRef, PartialTypeClass);
@@ -48,7 +67,7 @@ export function PartialType<T>(classRef: Type<T>): Type<Partial<T>> {
         PartialTypeClass[METADATA_FACTORY_NAME]()
       );
       pluginFields.forEach((key) =>
-        applyIsOptionalDecorator(PartialTypeClass, key)
+        applyPartialDecoratorFn(PartialTypeClass, key)
       );
     }
 
@@ -65,7 +84,7 @@ export function PartialType<T>(classRef: Type<T>): Type<Partial<T>> {
         required: false
       });
       decoratorFactory(PartialTypeClass.prototype, key);
-      applyIsOptionalDecorator(PartialTypeClass, key);
+      applyPartialDecoratorFn(PartialTypeClass, key);
     });
   }
   applyFields(fields);

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/swagger",
-  "version": "7.3.0",
+  "version": "7.3.1",
   "description": "Nest - modern, fast, powerful node.js web framework (@swagger)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -32,32 +32,32 @@
     "swagger-ui-dist": "5.11.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.6.0",
-    "@commitlint/config-angular": "18.6.0",
-    "@fastify/static": "7.0.1",
-    "@nestjs/common": "10.3.2",
-    "@nestjs/core": "10.3.2",
-    "@nestjs/platform-express": "10.3.2",
-    "@nestjs/platform-fastify": "10.3.2",
+    "@commitlint/cli": "19.2.1",
+    "@commitlint/config-angular": "19.1.0",
+    "@fastify/static": "7.0.2",
+    "@nestjs/common": "10.3.7",
+    "@nestjs/core": "10.3.7",
+    "@nestjs/platform-express": "10.3.7",
+    "@nestjs/platform-fastify": "10.3.7",
     "@types/jest": "29.5.12",
     "@types/js-yaml": "4.0.9",
-    "@types/lodash": "4.14.202",
-    "@types/node": "20.11.17",
-    "@typescript-eslint/eslint-plugin": "6.21.0",
-    "@typescript-eslint/parser": "6.21.0",
+    "@types/lodash": "4.17.0",
+    "@types/node": "20.12.3",
+    "@typescript-eslint/eslint-plugin": "7.5.0",
+    "@typescript-eslint/parser": "7.5.0",
     "class-transformer": "0.5.1",
     "class-validator": "0.14.1",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
-    "express": "4.18.2",
-    "husky": "9.0.10",
+    "express": "4.19.2",
+    "husky": "9.0.11",
     "jest": "29.7.0",
     "lint-staged": "15.2.2",
     "openapi-types": "12.1.3",
     "prettier": "2.8.8",
-    "reflect-metadata": "0.2.1",
-    "release-it": "17.0.3",
+    "reflect-metadata": "0.2.2",
+    "release-it": "17.1.1",
     "supertest": "6.3.4",
     "swagger-parser": "10.0.3",
     "ts-jest": "29.1.2",

package.json

@@ -21,9 +21,44 @@ describe('PartialType', () => {
   describe('Validation metadata', () => {
     it('should apply @IsOptional to properties reflected by the plugin', async () => {
       const updateDto = new UpdateUserDto();
+      updateDto.firstName = null;
       const validationErrors = await validate(updateDto);
       expect(validationErrors).toHaveLength(0);
     });
+
+    it('should apply @IsOptional to properties reflected by the plugin if option `skipNullProperties` is true', async () => {
+      class UpdateUserWithNullableDto extends PartialType(CreateUserDto, {
+        skipNullProperties: true
+      }) {}
+      const updateDto = new UpdateUserWithNullableDto();
+      updateDto.firstName = null;
+      const validationErrors = await validate(updateDto);
+      expect(validationErrors).toHaveLength(0);
+    });
+
+    it('should apply @IsOptional to properties reflected by the plugin if option `skipNullProperties` is undefined', async () => {
+      class UpdateUserWithoutNullableDto extends PartialType(
+        CreateUserDto,
+        {}
+      ) {}
+      const updateDto = new UpdateUserWithoutNullableDto();
+      updateDto.firstName = null;
+      const validationErrors = await validate(updateDto);
+      expect(validationErrors).toHaveLength(0);
+    });
+
+    it('should apply @ValidateIf to properties reflected by the plugin if option `skipNullProperties` is false', async () => {
+      class UpdateUserWithoutNullableDto extends PartialType(CreateUserDto, {
+        skipNullProperties: false
+      }) {}
+      const updateDto = new UpdateUserWithoutNullableDto();
+      updateDto.firstName = null;
+      const validationErrors = await validate(updateDto);
+      expect(validationErrors).toHaveLength(1);
+      expect(validationErrors[0].constraints).toEqual({
+        isString: 'firstName must be a string'
+      });
+    });
   });
   describe('OpenAPI metadata', () => {
     it('should return partial class', async () => {