koatty_validation 1.3.1 → 1.3.4

package/dist/README.md

@@ -1,116 +1,116 @@
-# koatty_validation
-Validation Util for Koatty. Based on class-validator, extended parameter type checking and restricted attribute functions.
-
-
-# User Decorators
-
-* @IsDefined
-* @IsCnName
-* @IsIdNumber
-* @IsZipCode
-* @IsMobile
-* @IsPlateNumber
-* @IsEmail
-* @IsIP
-* @IsPhoneNumber
-* @IsUrl
-* @IsHash
-* @IsNotEmpty
-* @Equals
-* @NotEquals
-* @Contains
-* @IsIn
-* @IsNotIn
-* @IsDate
-* @Gt
-* @Gte
-* @Lt
-* @Lte
-  
-* @Valid
-* @Validated
-
-
-
-```js
-
-export class Controller {
-
-    Test(@Valid("IsNotEmpty", "can not be empty!!") id: number){
-        //todo
-    }
-
-    @Validated() // use dto validation
-    TestDto(user: UserDTO) {
-
-    }
-}
-
-export class UserDTO {
-    @IsNotEmpty({ message: "can not be empty!!" })
-    phoneNum: string;
-
-    @IsCnName({ message: "must be cn name"})
-    userName: string;
-}
-
-```
-
-# Validator for manual
-
-## FunctionValidator
-
-* IsCnName
-* IsIdNumber
-* IsZipCode
-* IsMobile
-* IsPlateNumber
-* IsEmail
-* IsIP
-* IsPhoneNumber
-* IsUrl
-* IsHash
-* IsNotEmpty
-* Equals
-* NotEquals
-* Contains
-* IsIn
-* IsNotIn
-* IsDate
-* Gt
-* Gte
-* Lt
-* Lte
-
-exp:
-
-```js
-const str = "";
-// throw Error
-FunctionValidator.IsNotEmpty(str, "cannot be empty");
-FunctionValidator.Contains(str, {message: "must contain s", value: "s"});
-// 
-if (!ValidFuncs.IsNotEmpty(str)) {
-    console.log("empty");
-}
-```
-
-## ClassValidator
-
-exp:
-
-```js
-class SchemaClass {
-    @IsDefined
-    id: number;
-    
-    @IsNotEmpty
-    name: string;
-}
-
-
-ClassValidator.valid(SchemaClass, {name: ''}).catch(err => {
-    console.log(err);
-})
-```
-
+# koatty_validation
+Validation Util for Koatty. Based on class-validator, extended parameter type checking and restricted attribute functions.
+
+
+# User Decorators
+
+* @IsDefined
+* @IsCnName
+* @IsIdNumber
+* @IsZipCode
+* @IsMobile
+* @IsPlateNumber
+* @IsEmail
+* @IsIP
+* @IsPhoneNumber
+* @IsUrl
+* @IsHash
+* @IsNotEmpty
+* @Equals
+* @NotEquals
+* @Contains
+* @IsIn
+* @IsNotIn
+* @IsDate
+* @Gt
+* @Gte
+* @Lt
+* @Lte
+  
+* @Valid
+* @Validated
+
+
+
+```js
+
+export class Controller {
+
+    Test(@Valid("IsNotEmpty", "can not be empty!!") id: number){
+        //todo
+    }
+
+    @Validated() // use dto validation
+    TestDto(user: UserDTO) {
+
+    }
+}
+
+export class UserDTO {
+    @IsNotEmpty({ message: "can not be empty!!" })
+    phoneNum: string;
+
+    @IsCnName({ message: "must be cn name"})
+    userName: string;
+}
+
+```
+
+# Validator for manual
+
+## FunctionValidator
+
+* IsCnName
+* IsIdNumber
+* IsZipCode
+* IsMobile
+* IsPlateNumber
+* IsEmail
+* IsIP
+* IsPhoneNumber
+* IsUrl
+* IsHash
+* IsNotEmpty
+* Equals
+* NotEquals
+* Contains
+* IsIn
+* IsNotIn
+* IsDate
+* Gt
+* Gte
+* Lt
+* Lte
+
+exp:
+
+```js
+const str = "";
+// throw Error
+FunctionValidator.IsNotEmpty(str, "cannot be empty");
+FunctionValidator.Contains(str, {message: "must contain s", value: "s"});
+// 
+if (!ValidFuncs.IsNotEmpty(str)) {
+    console.log("empty");
+}
+```
+
+## ClassValidator
+
+exp:
+
+```js
+class SchemaClass {
+    @IsDefined
+    id: number;
+    
+    @IsNotEmpty
+    name: string;
+}
+
+
+ClassValidator.valid(SchemaClass, {name: ''}).catch(err => {
+    console.log(err);
+})
+```
+

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-08 07:08:42
+* @Date: 2024-10-31 17:03:02
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/

package/dist/index.js

@@ -1,16 +1,16 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-08 07:08:31
+* @Date: 2024-10-31 17:02:42
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
 'use strict';
 
+var classValidator = require('class-validator');
 var helper = require('koatty_lib');
-require('reflect-metadata');
 var koatty_container = require('koatty_container');
-var classValidator = require('class-validator');
+require('reflect-metadata');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -204,6 +204,7 @@ function convertParamsType(param, type) {
             default: //any
                 return param;
         }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
     }
     catch (err) {
         return param;
@@ -353,7 +354,7 @@ function plateNumber(value) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:47:04
- * @LastEditTime: 2024-01-03 14:32:49
+ * @LastEditTime: 2024-10-31 16:57:28
  */
 // constant
 const PARAM_TYPE_KEY = 'PARAM_TYPE_KEY';
@@ -412,20 +413,10 @@ class ValidateClass {
      * @memberof ValidateClass
      */
     async valid(Clazz, data, convert = false) {
-        let obj = {};
-        if (data instanceof Clazz) {
-            obj = data;
-        }
-        else {
-            obj = plainToClass(Clazz, data, convert);
-        }
-        let errors = [];
-        if (convert) {
-            errors = await classValidator.validate(obj);
-        }
-        else {
-            errors = await classValidator.validate(obj, { skipMissingProperties: true });
-        }
+        const obj = data instanceof Clazz ? data : plainToClass(Clazz, data, convert);
+        const errors = convert
+            ? await classValidator.validate(obj)
+            : await classValidator.validate(obj, { skipMissingProperties: true });
         if (errors.length > 0) {
             throw new Error(Object.values(errors[0].constraints)[0]);
         }
@@ -598,71 +589,7 @@ const ValidFuncs = {
  * @param {(string | ValidOtpions)} [options]
  * @returns {*}
  */
-const FunctionValidator = {
-    IsNotEmpty: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsDate: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsEmail: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsIP: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsPhoneNumber: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsUrl: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsHash: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsCnName: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsIdNumber: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsZipCode: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsMobile: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsPlateNumber: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Equals: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    NotEquals: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Contains: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsIn: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    IsNotIn: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Gt: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Lt: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Gte: function (value, options) {
-        throw new Error("Function not implemented.");
-    },
-    Lte: function (value, options) {
-        throw new Error("Function not implemented.");
-    }
-};
+const FunctionValidator = {};
 Object.keys(ValidFuncs).forEach((key) => {
     FunctionValidator[key] = (value, options) => {
         if (helper__namespace.isString(options)) {
@@ -679,7 +606,7 @@ Object.keys(ValidFuncs).forEach((key) => {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:46:57
- * @LastEditTime: 2024-01-03 11:30:55
+ * @LastEditTime: 2024-10-31 16:49:26
  */
 /**
  * Validation parameter's type and values.
@@ -722,7 +649,7 @@ function Valid(rule, options) {
  * @returns {MethodDecorator}
  */
 function Validated() {
-    return (target, propertyKey, descriptor) => {
+    return (target, propertyKey, _descriptor) => {
         //
         koatty_container.IOCContainer.savePropertyData(PARAM_CHECK_KEY, {
             dtoCheck: 1
@@ -794,10 +721,10 @@ function IsCnName(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return cnName(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -821,10 +748,10 @@ function IsIdNumber(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return idNumber(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -848,10 +775,10 @@ function IsZipCode(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return zipCode(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -875,10 +802,10 @@ function IsMobile(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return mobile(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -902,10 +829,10 @@ function IsPlateNumber(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return plateNumber(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -928,10 +855,10 @@ function IsNotEmpty(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return !helper__namespace.isEmpty(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -955,10 +882,10 @@ function Equals(comparison, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.equals(value, comparison);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be equals ${comparison}.`;
                 }
             }
@@ -982,10 +909,10 @@ function NotEquals(comparison, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.notEquals(value, comparison);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be not equals ${comparison}.`;
                 }
             }
@@ -1009,11 +936,11 @@ function Contains(seed, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.contains(value, seed);
                     // return typeof value === "string" && (value.indexOf(seed) > -1);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be contains ${seed}.`;
                 }
             }
@@ -1037,10 +964,10 @@ function IsIn(possibleValues, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isIn(value, possibleValues);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1064,10 +991,10 @@ function IsNotIn(possibleValues, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isNotIn(value, possibleValues);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1090,10 +1017,10 @@ function IsDate(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isDate(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1117,10 +1044,10 @@ function Gt(min, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper__namespace.toNumber(value) > min;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1144,10 +1071,10 @@ function Lt(max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper__namespace.toNumber(value) < max;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1171,10 +1098,10 @@ function Gte(min, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper__namespace.toNumber(value) >= min;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1198,10 +1125,10 @@ function Lte(max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper__namespace.toNumber(value) <= max;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1227,10 +1154,10 @@ function Length(min, max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.length(value, min, max);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1254,10 +1181,10 @@ function IsEmail(options, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isEmail(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1281,10 +1208,10 @@ function IsIP(version, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isIP(value, version);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1311,10 +1238,10 @@ function IsPhoneNumber(region, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isPhoneNumber(value, region);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1338,10 +1265,10 @@ function IsUrl(options, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isURL(value, options);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1366,10 +1293,10 @@ function IsHash(algorithm, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return classValidator.isHash(value, algorithm);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be is an ${algorithm} Hash string.`;
                 }
             }
@@ -1391,10 +1318,10 @@ function CheckFunc(func, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return func(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }