koatty_validation 1.3.1 → 1.3.4

package/dist/index.mjs

@@ -1,14 +1,14 @@
 /*!
 * @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/
 */
+import { validate, isEmail, isIP, isPhoneNumber, isURL, isHash, equals, notEquals, contains, isIn, isNotIn, registerDecorator, isDate, length } from 'class-validator';
 import * as helper from 'koatty_lib';
-import 'reflect-metadata';
 import { getOriginMetadata, IOCContainer } from 'koatty_container';
-import { validate, isEmail, isIP, isPhoneNumber, isURL, isHash, equals, notEquals, contains, isIn, isNotIn, registerDecorator, isDate, length } from 'class-validator';
+import 'reflect-metadata';
 
 /**
  * @ author: richen
@@ -183,6 +183,7 @@ function convertParamsType(param, type) {
             default: //any
                 return param;
         }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
     }
     catch (err) {
         return param;
@@ -332,7 +333,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';
@@ -391,20 +392,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 validate(obj);
-        }
-        else {
-            errors = await validate(obj, { skipMissingProperties: true });
-        }
+        const obj = data instanceof Clazz ? data : plainToClass(Clazz, data, convert);
+        const errors = convert
+            ? await validate(obj)
+            : await validate(obj, { skipMissingProperties: true });
         if (errors.length > 0) {
             throw new Error(Object.values(errors[0].constraints)[0]);
         }
@@ -577,71 +568,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.isString(options)) {
@@ -658,7 +585,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.
@@ -701,7 +628,7 @@ function Valid(rule, options) {
  * @returns {MethodDecorator}
  */
 function Validated() {
-    return (target, propertyKey, descriptor) => {
+    return (target, propertyKey, _descriptor) => {
         //
         IOCContainer.savePropertyData(PARAM_CHECK_KEY, {
             dtoCheck: 1
@@ -773,10 +700,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).";
                 }
             }
@@ -800,10 +727,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).";
                 }
             }
@@ -827,10 +754,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).";
                 }
             }
@@ -854,10 +781,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).";
                 }
             }
@@ -881,10 +808,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).";
                 }
             }
@@ -907,10 +834,10 @@ function IsNotEmpty(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return !helper.isEmpty(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return "invalid parameter ($property).";
                 }
             }
@@ -934,10 +861,10 @@ function Equals(comparison, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return equals(value, comparison);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be equals ${comparison}.`;
                 }
             }
@@ -961,10 +888,10 @@ function NotEquals(comparison, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return notEquals(value, comparison);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be not equals ${comparison}.`;
                 }
             }
@@ -988,11 +915,11 @@ function Contains(seed, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return contains(value, seed);
                     // return typeof value === "string" && (value.indexOf(seed) > -1);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be contains ${seed}.`;
                 }
             }
@@ -1016,10 +943,10 @@ function IsIn(possibleValues, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isIn(value, possibleValues);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1043,10 +970,10 @@ function IsNotIn(possibleValues, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isNotIn(value, possibleValues);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1069,10 +996,10 @@ function IsDate(validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isDate(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1096,10 +1023,10 @@ function Gt(min, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper.toNumber(value) > min;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1123,10 +1050,10 @@ function Lt(max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper.toNumber(value) < max;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1150,10 +1077,10 @@ function Gte(min, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper.toNumber(value) >= min;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1177,10 +1104,10 @@ function Lte(max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return helper.toNumber(value) <= max;
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1206,10 +1133,10 @@ function Length(min, max, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return length(value, min, max);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1233,10 +1160,10 @@ function IsEmail(options, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isEmail(value);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1260,10 +1187,10 @@ function IsIP(version, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isIP(value, version);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1290,10 +1217,10 @@ function IsPhoneNumber(region, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isPhoneNumber(value, region);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1317,10 +1244,10 @@ function IsUrl(options, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isURL(value, options);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter ($property).`;
                 }
             }
@@ -1345,10 +1272,10 @@ function IsHash(algorithm, validationOptions) {
             propertyName,
             options: validationOptions,
             validator: {
-                validate(value, args) {
+                validate(value, _args) {
                     return isHash(value, algorithm);
                 },
-                defaultMessage(args) {
+                defaultMessage(_args) {
                     return `invalid parameter, ($property) must be is an ${algorithm} Hash string.`;
                 }
             }
@@ -1370,10 +1297,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).`;
                 }
             }

package/dist/package.json

@@ -1,89 +1,91 @@
-{
-  "name": "koatty_validation",
-  "version": "1.3.1",
-  "description": "Validation Util for Koatty and ThinkORM.",
-  "scripts": {
-    "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
-    "build:cp": "node scripts/postBuild && copyfiles package.json LICENSE README.md dist/",
-    "build:js": "del-cli --force dist && npx rollup --bundleConfigAsCjs -c .rollup.config.js",
-    "build:doc": "del-cli --force docs/api && npx api-documenter markdown --input temp --output docs/api",
-    "build:dts": "del-cli --force temp && npx tsc && npx api-extractor run --local --verbose",
-    "eslint": "eslint --ext .ts,.js ./",
-    "lock": "npm i --package-lock-only",
-    "prepublishOnly": "npm test && npm run build && git push --follow-tags origin",
-    "prerelease": "npm test && npm run build",
-    "release": "standard-version",
-    "release:pre": "npm run release -- --prerelease",
-    "release:major": "npm run release -- --release-as major",
-    "release:minor": "npm run release -- --release-as minor",
-    "test": "npm run eslint && jest --passWithNoTests"
-  },
-  "main": "./dist/index.js",
-  "exports": {
-    "require": "./dist/index.js",
-    "import": "./dist/index.mjs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/koatty/koatty_validation.git"
-  },
-  "engines": {
-    "node": ">10.0.0"
-  },
-  "author": {
-    "name": "richenlin",
-    "email": "richenlin@gmail.com"
-  },
-  "license": "BSD-3-Clause",
-  "bugs": {
-    "url": "https://github.com/koatty/koatty_validation/issues"
-  },
-  "homepage": "https://github.com/koatty/koatty_validation",
-  "maintainers": [
-    {
-      "name": "richenlin",
-      "email": "richenlin@gmail.com"
-    }
-  ],
-  "devDependencies": {
-    "@commitlint/cli": "^18.x.x",
-    "@commitlint/config-conventional": "^18.x.x",
-    "@microsoft/api-documenter": "^7.x.x",
-    "@microsoft/api-extractor": "^7.x.x",
-    "@rollup/plugin-json": "^6.x.x",
-    "@types/jest": "^29.x.x",
-    "@types/koa": "^2.x.x",
-    "@types/node": "^20.x.x",
-    "@types/validator": "^13.x.x",
-    "@typescript-eslint/eslint-plugin": "^6.x.x",
-    "@typescript-eslint/parser": "^6.x.x",
-    "conventional-changelog-cli": "^4.x.x",
-    "copyfiles": "^2.x.x",
-    "del-cli": "^5.x.x",
-    "eslint": "^8.x.x",
-    "eslint-plugin-jest": "^27.x.x",
-    "husky": "^4.x.x",
-    "jest": "^29.x.x",
-    "jest-html-reporters": "^3.x.x",
-    "libphonenumber-js": "^1.x.x",
-    "reflect-metadata": "^0.x.x",
-    "rollup": "^4.x.x",
-    "rollup-plugin-typescript2": "^0.x.x",
-    "standard-version": "^9.x.x",
-    "ts-jest": "^29.x.x",
-    "ts-node": "^10.x.x",
-    "tslib": "^2.x.x",
-    "typescript": "^5.x.x"
-  },
-  "dependencies": {
-    "class-validator": "^0.14.0",
-    "koatty_container": "^1.x.x",
-    "koatty_lib": "^1.x.x",
-    "koatty_logger": "^2.x.x"
-  },
-  "peerDependencies": {
-    "koatty_container": "^1.x.x",
-    "koatty_lib": "^1.x.x",
-    "koatty_logger": "^2.x.x"
-  }
-}
+{
+  "name": "koatty_validation",
+  "version": "1.3.4",
+  "description": "Validation Util for Koatty and ThinkORM.",
+  "scripts": {
+    "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
+    "build:cp": "node scripts/postBuild && copyfiles package.json LICENSE README.md dist/",
+    "build:js": "del-cli --force dist && npx rollup --bundleConfigAsCjs -c .rollup.config.js",
+    "build:doc": "del-cli --force docs/api && npx api-documenter markdown --input temp --output docs/api",
+    "build:dts": "del-cli --force temp && npx tsc && npx api-extractor run --local --verbose",
+    "eslint": "eslint --ext .ts,.js ./",
+    "lock": "npm i --package-lock-only",
+    "prepublishOnly": "npm test && npm run build && git push --follow-tags origin",
+    "prerelease": "npm test && npm run build",
+    "release": "standard-version",
+    "release:pre": "npm run release -- --prerelease",
+    "release:major": "npm run release -- --release-as major",
+    "release:minor": "npm run release -- --release-as minor",
+    "test": "npm run eslint && jest --passWithNoTests"
+  },
+  "main": "./dist/index.js",
+  "exports": {
+    "require": "./dist/index.js",
+    "import": "./dist/index.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/koatty/koatty_validation.git"
+  },
+  "engines": {
+    "node": ">10.0.0"
+  },
+  "author": {
+    "name": "richenlin",
+    "email": "richenlin@gmail.com"
+  },
+  "license": "BSD-3-Clause",
+  "bugs": {
+    "url": "https://github.com/koatty/koatty_validation/issues"
+  },
+  "homepage": "https://github.com/koatty/koatty_validation",
+  "maintainers": [
+    {
+      "name": "richenlin",
+      "email": "richenlin@gmail.com"
+    }
+  ],
+  "devDependencies": {
+    "@commitlint/cli": "^19.x.x",
+    "@commitlint/config-conventional": "^19.x.x",
+    "@microsoft/api-documenter": "^7.x.x",
+    "@microsoft/api-extractor": "^7.x.x",
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-json": "^6.x.x",
+    "@types/jest": "^29.x.x",
+    "@types/koa": "^2.x.x",
+    "@types/node": "^22.x.x",
+    "@types/validator": "^13.x.x",
+    "@typescript-eslint/eslint-plugin": "^8.x.x",
+    "@typescript-eslint/parser": "^8.x.x",
+    "conventional-changelog-cli": "^5.x.x",
+    "copyfiles": "^2.x.x",
+    "del-cli": "^6.x.x",
+    "eslint": "^8.57.x",
+    "eslint-plugin-jest": "^28.x.x",
+    "husky": "^4.x.x",
+    "jest": "^29.x.x",
+    "jest-html-reporters": "^3.x.x",
+    "libphonenumber-js": "^1.x.x",
+    "reflect-metadata": "^0.x.x",
+    "rollup": "^4.x.x",
+    "rollup-plugin-typescript2": "^0.x.x",
+    "standard-version": "^9.x.x",
+    "ts-jest": "^29.x.x",
+    "ts-node": "^10.x.x",
+    "tslib": "^2.x.x",
+    "typescript": "^5.x.x"
+  },
+  "dependencies": {
+    "class-validator": "^0.14.1",
+    "koatty_container": "^1.x.x",
+    "koatty_lib": "^1.x.x",
+    "koatty_logger": "^2.x.x",
+    "koatty_validation": "file:"
+  },
+  "peerDependencies": {
+    "koatty_container": "^1.x.x",
+    "koatty_lib": "^1.x.x",
+    "koatty_logger": "^2.x.x"
+  }
+}