Merge branch 'develop' into feat/add-isiprange-validator

ballinette · web-flow · commit 98713712c879 · 2024-02-27T14:30:34.000+01:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "class-validator",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "description": "Decorator-based property validation for classes.",
   "author": "TypeStack contributors",
   "license": "MIT",
@@ -36,30 +36,30 @@
     "test:ci": "jest --runInBand --no-cache --coverage --verbose"
   },
   "dependencies": {
-    "@types/validator": "^13.9.0",
-    "libphonenumber-js": "^1.10.51",
+    "@types/validator": "^13.11.8",
+    "libphonenumber-js": "^1.10.57",
     "validator": "^13.9.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@types/jest": "^29.5.10",
-    "@types/node": "^20.10.0",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.20",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.54.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jest": "^27.6.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^27.9.0",
     "husky": "^4.3.8",
     "jest": "^29.7.0",
-    "lint-staged": "^15.1.0",
+    "lint-staged": "^15.2.2",
     "prettier": "^2.8.8",
-    "reflect-metadata": "0.1.13",
+    "reflect-metadata": "0.2.1",
     "rimraf": "5.0.5",
     "rollup": "^2.79.1",
     "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.3.2"
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   }
 }
diff --git a/src/decorator/common/IsDefined.ts b/src/decorator/common/IsDefined.ts
@@ -8,7 +8,7 @@ export const IS_DEFINED = ValidationTypes.IS_DEFINED;
 /**
  * Checks if value is defined (!== undefined, !== null).
  */
-export function isDefined(value: any): boolean {
+export function isDefined<T>(value: T | undefined | null): value is T {
   return value !== undefined && value !== null;
 }
 
diff --git a/src/decorator/common/IsOptional.ts b/src/decorator/common/IsOptional.ts
@@ -4,13 +4,16 @@ import { ValidationTypes } from '../../validation/ValidationTypes';
 import { ValidationMetadata } from '../../metadata/ValidationMetadata';
 import { getMetadataStorage } from '../../metadata/MetadataStorage';
 
+export const IS_OPTIONAL = 'isOptional';
+
 /**
  * Checks if value is missing and if so, ignores all validators.
  */
 export function IsOptional(validationOptions?: ValidationOptions): PropertyDecorator {
   return function (object: object, propertyName: string): void {
     const args: ValidationMetadataArgs = {
       type: ValidationTypes.CONDITIONAL_VALIDATION,
+      name: IS_OPTIONAL,
       target: object.constructor,
       propertyName: propertyName,
       constraints: [
diff --git a/src/decorator/string/IsAlpha.ts b/src/decorator/string/IsAlpha.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isAlphaValidator from 'validator/lib/isAlpha';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_ALPHA = 'isAlpha';
 
diff --git a/src/decorator/string/IsAlphanumeric.ts b/src/decorator/string/IsAlphanumeric.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isAlphanumericValidator from 'validator/lib/isAlphanumeric';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_ALPHANUMERIC = 'isAlphanumeric';
 
diff --git a/src/decorator/string/IsBase64.ts b/src/decorator/string/IsBase64.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isBase64Validator from 'validator/lib/isBase64';
-import type ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_BASE64 = 'isBase64';
 
diff --git a/src/decorator/string/IsCurrency.ts b/src/decorator/string/IsCurrency.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isCurrencyValidator from 'validator/lib/isCurrency';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_CURRENCY = 'isCurrency';
 
diff --git a/src/decorator/string/IsDateString.ts b/src/decorator/string/IsDateString.ts
@@ -1,6 +1,6 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 import { isISO8601 } from './IsISO8601';
 
 export const IS_DATE_STRING = 'isDateString';
diff --git a/src/decorator/string/IsDecimal.ts b/src/decorator/string/IsDecimal.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isDecimalValidator from 'validator/lib/isDecimal';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_DECIMAL = 'isDecimal';
 
diff --git a/src/decorator/string/IsEmail.ts b/src/decorator/string/IsEmail.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isEmailValidator from 'validator/lib/isEmail';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_EMAIL = 'isEmail';
 
diff --git a/src/decorator/string/IsFQDN.ts b/src/decorator/string/IsFQDN.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isFqdnValidator from 'validator/lib/isFQDN';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_FQDN = 'isFqdn';
 
diff --git a/src/decorator/string/IsHash.ts b/src/decorator/string/IsHash.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isHashValidator from 'validator/lib/isHash';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_HASH = 'isHash';
 
diff --git a/src/decorator/string/IsISO8601.ts b/src/decorator/string/IsISO8601.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isIso8601Validator from 'validator/lib/isISO8601';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_ISO8601 = 'isIso8601';
 
diff --git a/src/decorator/string/IsISSN.ts b/src/decorator/string/IsISSN.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isISSNValidator from 'validator/lib/isISSN';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_ISSN = 'isISSN';
 
diff --git a/src/decorator/string/IsIdentityCard.ts b/src/decorator/string/IsIdentityCard.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isIdentityCardValidator from 'validator/lib/isIdentityCard';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_IDENTITY_CARD = 'isIdentityCard';
 
diff --git a/src/decorator/string/IsMacAddress.ts b/src/decorator/string/IsMacAddress.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions, isValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isMacAddressValidator from 'validator/lib/isMACAddress';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_MAC_ADDRESS = 'isMacAddress';
 
diff --git a/src/decorator/string/IsMobilePhone.ts b/src/decorator/string/IsMobilePhone.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isMobilePhoneValidator from 'validator/lib/isMobilePhone';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_MOBILE_PHONE = 'isMobilePhone';
 
diff --git a/src/decorator/string/IsNumberString.ts b/src/decorator/string/IsNumberString.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isNumericValidator from 'validator/lib/isNumeric';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_NUMBER_STRING = 'isNumberString';
 
diff --git a/src/decorator/string/IsPostalCode.ts b/src/decorator/string/IsPostalCode.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isPostalCodeValidator from 'validator/lib/isPostalCode';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_POSTAL_CODE = 'isPostalCode';
 
diff --git a/src/decorator/string/IsStrongPassword.ts b/src/decorator/string/IsStrongPassword.ts
@@ -1,4 +1,4 @@
-import validator from 'validator';
+import * as validator from 'validator';
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 
diff --git a/src/decorator/string/IsUUID.ts b/src/decorator/string/IsUUID.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isUuidValidator from 'validator/lib/isUUID';
-import type ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_UUID = 'isUuid';
 
diff --git a/src/decorator/string/IsUrl.ts b/src/decorator/string/IsUrl.ts
@@ -1,7 +1,7 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isUrlValidator from 'validator/lib/isURL';
-import ValidatorJS from 'validator';
+import * as ValidatorJS from 'validator';
 
 export const IS_URL = 'isUrl';
 
diff --git a/src/validation/ValidationExecutor.ts b/src/validation/ValidationExecutor.ts
@@ -67,7 +67,7 @@ export class ValidationExecutor {
     );
     const groupedMetadatas = this.metadataStorage.groupByPropertyName(targetMetadatas);
 
-    if (this.validatorOptions && forbidUnknownValues && !targetMetadatas.length) {
+    if (forbidUnknownValues && !targetMetadatas.length) {
       const validationError = new ValidationError();
 
       if (
diff --git a/src/validation/ValidatorOptions.ts b/src/validation/ValidatorOptions.ts
@@ -75,8 +75,9 @@ export interface ValidatorOptions {
    * Fails validation for objects unknown to class-validator. Defaults to true.
    *
    * For instance, since a plain empty object has no annotations used for validation:
-   * - `validate({})` // passes
+   * - `validate({})` // fails.
    * - `validate({}, { forbidUnknownValues: true })` // fails.
+   * - `validate({}, { forbidUnknownValues: false })` // passes.
    * - `validate(new SomeAnnotatedEmptyClass(), { forbidUnknownValues: true })` // passes.
    */
   forbidUnknownValues?: boolean;
diff --git a/test/functional/validation-functions-and-decorators.spec.ts b/test/functional/validation-functions-and-decorators.spec.ts
@@ -199,7 +199,7 @@ import {
 import { Validator } from '../../src/validation/Validator';
 import { ValidatorOptions } from '../../src/validation/ValidatorOptions';
 import { constraintToString } from '../../src/validation/ValidationUtils';
-import { default as ValidatorJS } from 'validator';
+import * as ValidatorJS from 'validator';
 
 function checkValidValues(
   object: { someProperty: any },
diff --git a/test/functional/validator-options.spec.ts b/test/functional/validator-options.spec.ts
@@ -44,4 +44,43 @@ describe('validator options', () => {
       expect(errors.length).toEqual(0);
     });
   });
+
+  it(`should return error on unknown objects if no options object argument is passed`, () => {
+    const anonymousObject = { badKey: 'This should not pass.' };
+
+    return validator.validate(anonymousObject, undefined).then(errors => {
+      expect(errors.length).toEqual(1);
+      expect(errors[0].target).toEqual(anonymousObject);
+      expect(errors[0].property).toEqual(undefined);
+      expect(errors[0].value).toEqual(undefined);
+      expect(errors[0].children).toBeInstanceOf(Array);
+      expect(errors[0].constraints).toEqual({ unknownValue: 'an unknown value was passed to the validate function' });
+    });
+  });
+
+  it(`should return error on unknown objects if empty options object argument passed`, () => {
+    const anonymousObject = { badKey: 'This should not pass.' };
+
+    return validator.validate(anonymousObject, {}).then(errors => {
+      expect(errors.length).toEqual(1);
+      expect(errors[0].target).toEqual(anonymousObject);
+      expect(errors[0].property).toEqual(undefined);
+      expect(errors[0].value).toEqual(undefined);
+      expect(errors[0].children).toBeInstanceOf(Array);
+      expect(errors[0].constraints).toEqual({ unknownValue: 'an unknown value was passed to the validate function' });
+    });
+  });
+
+  it(`should return error on unknown objects if options object argument passed with forbidUnknownValues undefined`, () => {
+    const anonymousObject = { badKey: 'This should not pass.' };
+
+    return validator.validate(anonymousObject, { forbidUnknownValues: undefined }).then(errors => {
+      expect(errors.length).toEqual(1);
+      expect(errors[0].target).toEqual(anonymousObject);
+      expect(errors[0].property).toEqual(undefined);
+      expect(errors[0].value).toEqual(undefined);
+      expect(errors[0].children).toBeInstanceOf(Array);
+      expect(errors[0].constraints).toEqual({ unknownValue: 'an unknown value was passed to the validate function' });
+    });
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ export const IS_DEFINED = ValidationTypes.IS_DEFINED;`
`8`	`8`	`/**`
`9`	`9`	`* Checks if value is defined (!== undefined, !== null).`
`10`	`10`	`*/`
`11`		`-export function isDefined(value: any): boolean {`
	`11`	`+export function isDefined<T>(value: T \| undefined \| null): value is T {`
`12`	`12`	`return value !== undefined && value !== null;`
`13`	`13`	`}`
`14`	`14`