add typescript generic type to functions to ensure type check

CHANGELOG.md

@@ -29,6 +29,7 @@ _This changelog follows the [keep a changelog][keep-a-changelog]_ format to main
 
 ### Changed
 
+- enable `forbidUnknownValues` option by default
 - remove documentation about deprecated schema based validation and added warning
 - update warning message logged about missing decorator metadata
 - update `libphonenumber-js` to `^1.10.14` from `^1.9.43`

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.7.10",
-    "libphonenumber-js": "^1.10.14",
-    "validator": "^13.7.0"
+    "@types/validator": "^13.11.8",
+    "libphonenumber-js": "^1.10.62",
+    "validator": "^13.9.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^23.0.4",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@types/jest": "^29.2.4",
-    "@types/node": "^18.11.12",
-    "@typescript-eslint/eslint-plugin": "^5.46.0",
-    "@typescript-eslint/parser": "^5.46.0",
-    "eslint": "^8.29.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^27.1.6",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.10",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^27.9.0",
     "husky": "^4.3.8",
-    "jest": "^29.3.1",
-    "lint-staged": "^13.1.0",
-    "prettier": "^2.8.1",
-    "reflect-metadata": "0.1.13",
-    "rimraf": "3.0.2",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.2",
+    "prettier": "^2.8.8",
+    "reflect-metadata": "0.2.2",
+    "rimraf": "5.0.5",
     "rollup": "^2.79.1",
     "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
   }
 }

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;
 }
 

src/decorator/common/IsIn.spec.ts

@@ -0,0 +1,17 @@
+import { isIn } from './IsIn';
+
+describe('@IsIn decorator implementation', () => {
+  describe('isIn validator', () => {
+    it('should accept valid values', () => {
+      expect(isIn('A', ['A', 'B'])).toBe(true);
+      expect(isIn('A', ['B', 'C'])).toBe(false);
+      expect(isIn('A', [1, 2])).toBe(false);
+    });
+
+    it('should not accept invalid values', () => {
+      expect(isIn('A', 5 as any)).toBe(false);
+      expect(isIn('A', 'ABC' as any)).toBe(false);
+      expect(isIn('A', false as any)).toBe(false);
+    });
+  });
+});

src/decorator/common/IsIn.ts

@@ -7,7 +7,7 @@ export const IS_IN = 'isIn';
  * Checks if given value is in a array of allowed values.
  */
 export function isIn(value: unknown, possibleValues: readonly unknown[]): boolean {
-  return !Array.isArray(possibleValues) || possibleValues.some(possibleValue => possibleValue === value);
+  return Array.isArray(possibleValues) && possibleValues.some(possibleValue => possibleValue === value);
 }
 
 /**

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: [

src/decorator/date/MaxDate.ts

@@ -11,7 +11,7 @@ export function maxDate(date: unknown, maxDate: Date | (() => Date)): boolean {
 }
 
 /**
- * Checks if the value is a date that's after the specified date.
+ * Checks if the value is a date that's before the specified date.
  */
 export function MaxDate(date: Date | (() => Date), validationOptions?: ValidationOptions): PropertyDecorator {
   return ValidateBy(

src/decorator/object/IsNotEmptyObject.ts

@@ -13,7 +13,7 @@ export function isNotEmptyObject(value: unknown, options?: { nullable?: boolean
     return false;
   }
 
-  if (options?.nullable === true) {
+  if (options?.nullable === false) {
     return !Object.values(value).every(propertyValue => propertyValue === null || propertyValue === undefined);
   }
 

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';
 

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';
 

src/decorator/string/IsBase64.ts

@@ -1,25 +1,30 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
 import isBase64Validator from 'validator/lib/isBase64';
+import * as ValidatorJS from 'validator';
 
 export const IS_BASE64 = 'isBase64';
 
 /**
  * Checks if a string is base64 encoded.
  * If given value is not a string, then it returns false.
  */
-export function isBase64(value: unknown): boolean {
-  return typeof value === 'string' && isBase64Validator(value);
+export function isBase64(value: unknown, options?: ValidatorJS.IsBase64Options): boolean {
+  return typeof value === 'string' && isBase64Validator(value, options);
 }
 
 /**
  * Checks if a string is base64 encoded.
  * If given value is not a string, then it returns false.
  */
-export function IsBase64(validationOptions?: ValidationOptions): PropertyDecorator {
+export function IsBase64(
+  options?: ValidatorJS.IsBase64Options,
+  validationOptions?: ValidationOptions
+): PropertyDecorator {
   return ValidateBy(
     {
       name: IS_BASE64,
+      constraints: [options],
       validator: {
         validate: (value, args): boolean => isBase64(value),
         defaultMessage: buildMessage(eachPrefix => eachPrefix + '$property must be base64 encoded', validationOptions),

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';
 

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';

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';
 

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';
 

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';
 

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';
 

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';
 

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';
 

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';
 

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';
 

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';
 

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';
 

src/decorator/string/IsPhoneNumber.spec.ts

@@ -0,0 +1,43 @@
+import { isPhoneNumber } from './IsPhoneNumber';
+
+describe('@IsPhoneNumber decorator implementation', () => {
+  describe('isPhoneNumber validator', () => {
+    it('should accept valid values', () => {
+      expect(isPhoneNumber('+36 20 111 1111')).toBe(true);
+      expect(isPhoneNumber('+36 20 111 1111', 'HU')).toBe(true);
+      expect(isPhoneNumber('20 111 1111', 'HU')).toBe(true);
+    });
+
+    describe('should not accept invalid values', () => {
+      it('xxx', () => {
+        expect(isPhoneNumber('aaaaa', 'HU')).toBe(false);
+        expect(isPhoneNumber('aaaa')).toBe(false);
+      });
+
+      it('when country code do not match number', () => {
+        // US number with Hungarian locale
+        expect(isPhoneNumber('+1 213 373 4253', 'HU')).toBe(false);
+        // Hungarian number with US locale
+        expect(isPhoneNumber('+36 20 111 1111', 'US')).toBe(false);
+      });
+
+      it('when number is invalid in given locale', () => {
+        expect(isPhoneNumber('+36 00 111 1111', 'HU')).toBe(false);
+      });
+
+      it('when phone number length is incorrect', () => {
+        expect(isPhoneNumber('+36 20 111 111', 'HU')).toBe(false);
+      });
+
+      it('when there are letters after or before the phone number', () => {
+        expect(isPhoneNumber('abc +36 20 111 111', 'HU')).toBe(false);
+        expect(isPhoneNumber('+36 20 111 111 abc', 'HU')).toBe(false);
+      });
+    });
+
+    it('should not accept values with extra whitespace', () => {
+      expect(isPhoneNumber('  +36 20 111 1111', 'HU')).toBe(false);
+      expect(isPhoneNumber('+36 20 111 1111  ', 'HU')).toBe(false);
+    });
+  });
+});

src/decorator/string/IsPhoneNumber.ts

@@ -1,6 +1,6 @@
 import { ValidationOptions } from '../ValidationOptions';
 import { buildMessage, ValidateBy } from '../common/ValidateBy';
-import { parsePhoneNumberFromString, CountryCode } from 'libphonenumber-js';
+import { parsePhoneNumber, CountryCode } from 'libphonenumber-js/max';
 
 export const IS_PHONE_NUMBER = 'isPhoneNumber';
 
@@ -13,12 +13,23 @@ export const IS_PHONE_NUMBER = 'isPhoneNumber';
  * If text doesn't start with the international calling code (e.g. +41), then you must set this parameter.
  */
 export function isPhoneNumber(value: string, region?: CountryCode): boolean {
+  if (typeof value !== 'string' || value.trim() !== value) {
+    return false;
+  }
+
   try {
-    const phoneNum = parsePhoneNumberFromString(value, region);
-    const result = phoneNum?.isValid();
-    return !!result;
+    const phoneNumber = parsePhoneNumber(value, region);
+
+    /**
+     * We fail the validation if the user provided a region code
+     * and it doesn't match with the country code of the parsed number.
+     **/
+    if (region && phoneNumber.country !== region) {
+      return false;
+    }
+
+    return phoneNumber.isValid();
   } catch (error) {
-    // logging?
     return false;
   }
 }

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';
 

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';