koatty_validation 1.2.10 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.3.0](https://github.com/koatty/koatty_validation/compare/v1.2.10...v1.3.0) (2024-01-03)
+
+
+### Features
+
+* 增加@CheckFunc ([d5bdc2d](https://github.com/koatty/koatty_validation/commit/d5bdc2d51cdbf6d558e376bfda51e126158d4e75))
+
+
+### Bug Fixes
+
+* export ValidFuncs ([7d42023](https://github.com/koatty/koatty_validation/commit/7d42023138e9577c9646423c4c38faffba46fb10))
+
 ### [1.2.10](https://github.com/koatty/koatty_validation/compare/v1.2.9...v1.2.10) (2023-12-16)
 
 

package/README.md

@@ -89,6 +89,10 @@ 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

package/dist/README.md

@@ -89,6 +89,10 @@ 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

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-16 14:43:06
+* @Date: 2024-01-03 14:41:03
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -9,6 +9,14 @@ import { CountryCode } from 'libphonenumber-js';
 import { IsIpVersion } from 'class-validator';
 import { ValidationOptions } from 'class-validator';
 
+/**
+ * Use a custom function for validation
+ * @param func
+ * @param validationOptions
+ * @returns
+ */
+export declare function CheckFunc(func: (value: unknown) => boolean, validationOptions?: ValidationOptions): PropertyDecorator;
+
 /**
  * Check the base types.
  *
@@ -126,7 +134,7 @@ export declare function IsCnName(validationOptions?: ValidationOptions): Propert
 export declare function IsDate(validationOptions?: ValidationOptions): PropertyDecorator;
 
 /**
- * Identifies that the field needs to be defined
+ * Alias of Expose
  *
  * @export
  * @returns {PropertyDecorator}
@@ -405,6 +413,103 @@ declare class ValidateClass {
  */
 export declare function Validated(): MethodDecorator;
 
+/**
+ * Validator Functions
+ */
+export declare const ValidFuncs: {
+    /**
+     * Checks value is not empty, undefined, null, '', NaN, [], {} and any empty string(including spaces,
+     * tabs, formfeeds, etc.), returns false
+     */
+    IsNotEmpty: (value: unknown) => boolean;
+    /**
+     * Checks if a given value is a real date.
+     */
+    IsDate: (value: unknown) => boolean;
+    /**
+     * Checks if the string is an email. If given value is not a string, then it returns false.
+     */
+    IsEmail: (value: unknown, options?: IsEmailOptions) => boolean;
+    /**
+     * Checks if the string is an IP (version 4 or 6). If given value is not a string, then it returns false.
+     */
+    IsIP: (value: unknown, version?: any) => boolean;
+    /**
+     * Checks if the string is a valid phone number.
+     * @param value — the potential phone number string to test
+     * @param region 2 characters uppercase country code (e.g. DE, US, CH). If users must enter the intl.
+     * prefix (e.g. +41), then you may pass "ZZ" or null as region.
+     * See [google-libphonenumber, metadata.js:countryCodeToRegionCodeMap on github]
+     * {@link https://github.com/ruimarinho/google-libphonenumber/blob/1e46138878cff479aafe2ce62175c6c49cb58720/src/metadata.js#L33}
+     */
+    IsPhoneNumber: (value: string, region?: CountryCode) => boolean;
+    /**
+     * Checks if the string is an url. If given value is not a string, then it returns false.
+     */
+    IsUrl: (value: string, options?: IsURLOptions) => boolean;
+    /**
+     * check if the string is a hash of type algorithm. Algorithm is one of
+     * ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b']
+     */
+    IsHash: (value: unknown, algorithm: HashAlgorithm) => boolean;
+    /**
+     * Checks if value is a chinese name.
+     */
+    IsCnName: (value: any) => boolean;
+    /**
+     * Checks if value is a idcard number.
+     */
+    IsIdNumber: (value: any) => boolean;
+    /**
+     * Checks if value is a zipCode.
+     */
+    IsZipCode: (value: any) => boolean;
+    /**
+     * Checks if value is a mobile phone number.
+     */
+    IsMobile: (value: any) => boolean;
+    /**
+     * Checks if value is a plateNumber.
+     */
+    IsPlateNumber: (value: any) => boolean;
+    /**
+     * Checks if value matches ("===") the comparison.
+     */
+    Equals: (value: unknown, comparison: unknown) => boolean;
+    /**
+     * Checks if value does not match ("!==") the comparison.
+     */
+    NotEquals: (value: unknown, comparison: unknown) => boolean;
+    /**
+     * Checks if the string contains the seed. If given value is not a string, then it returns false.
+     */
+    Contains: (value: unknown, seed: string) => boolean;
+    /**
+     * Checks if given value is in a array of allowed values.
+     */
+    IsIn: (value: unknown, possibleValues: unknown[]) => boolean;
+    /**
+     * Checks if given value not in a array of allowed values.
+     */
+    IsNotIn: (value: unknown, possibleValues: unknown[]) => boolean;
+    /**
+     * Checks if the first number is greater than or equal to the second.
+     */
+    Gt: (num: unknown, min: number) => boolean;
+    /**
+     * Checks if the first number is less than or equal to the second.
+     */
+    Lt: (num: unknown, max: number) => boolean;
+    /**
+     * Checks if the first number is greater than or equal to the second.
+     */
+    Gte: (num: unknown, min: number) => boolean;
+    /**
+     * Checks if the first number is less than or equal to the second.
+     */
+    Lte: (num: unknown, max: number) => boolean;
+};
+
 export declare type ValidOtpions = {
     message: string;
     value: any;

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-16 14:42:53
+* @Date: 2024-01-03 14:40:53
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -83,7 +83,12 @@ function plainToClass(clazz, data, convert = false) {
 function assignDtoParams(clazz, data, convert = false) {
     const cls = Reflect.construct(clazz, []);
     if (convert) {
-        return convertAssignDtoParams(clazz, cls, data);
+        const metaData = getDtoParamsMeta(clazz, cls);
+        for (const [key, type] of Object.entries(metaData)) {
+            if (key && data[key] !== undefined) {
+                cls[key] = convertParamsType(data[key], type);
+            }
+        }
     }
     else {
         for (const key in cls) {
@@ -92,34 +97,28 @@ function assignDtoParams(clazz, data, convert = false) {
                 cls[key] = data[key];
             }
         }
-        return cls;
     }
+    return cls;
 }
 /**
- * convert type and assign dto params
+ * get class prototype type def.
  * @param clazz
  * @param cls
- * @param data
  * @returns
  */
-function convertAssignDtoParams(clazz, cls, data) {
-    if (Object.prototype.hasOwnProperty.call(cls, "_typeDef")) {
-        for (const key in cls) {
-            if (Object.prototype.hasOwnProperty.call(cls._typeDef, key) &&
-                data[key] !== undefined) {
-                cls[key] = convertParamsType(data[key], cls._typeDef[key]);
-            }
-        }
+function getDtoParamsMeta(clazz, cls) {
+    if (!Object.prototype.hasOwnProperty.call(cls, "_typeDef") &&
+        ("_typeDef" in cls)) {
+        return cls._typeDef;
     }
-    else {
-        const originMap = koatty_container.getOriginMetadata(PARAM_TYPE_KEY, clazz);
-        for (const [key, type] of originMap) {
-            if (key && data[key] !== undefined) {
-                cls[key] = convertParamsType(data[key], type);
-            }
-        }
-    }
-    return cls;
+    const typeDef = koatty_container.getOriginMetadata(PARAM_TYPE_KEY, clazz);
+    Reflect.defineProperty(clazz.prototype, "_typeDef", {
+        enumerable: true,
+        configurable: false,
+        writable: false,
+        value: typeDef
+    });
+    return typeDef;
 }
 /**
  * convertDtoParamsType
@@ -352,7 +351,7 @@ function plateNumber(value) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:47:04
- * @LastEditTime: 2022-08-19 14:21:20
+ * @LastEditTime: 2024-01-03 14:32:49
  */
 // constant
 const PARAM_TYPE_KEY = 'PARAM_TYPE_KEY';
@@ -678,7 +677,7 @@ Object.keys(ValidFuncs).forEach((key) => {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:46:57
- * @LastEditTime: 2023-12-16 14:23:12
+ * @LastEditTime: 2024-01-03 11:30:55
  */
 /**
  * Validation parameter's type and values.
@@ -762,15 +761,11 @@ function Validated() {
  */
 function Expose() {
     return function (object, propertyName) {
-        const types = Reflect.getMetadata("design:type", object, propertyName);
-        if (types) {
-            const originMap = koatty_container.getOriginMetadata(PARAM_TYPE_KEY, object);
-            originMap.set(propertyName, types.name);
-        }
+        setExpose(object, propertyName);
     };
 }
 /**
- * Identifies that the field needs to be defined
+ * Alias of Expose
  *
  * @export
  * @returns {PropertyDecorator}
@@ -1379,7 +1374,33 @@ function IsHash(algorithm, validationOptions) {
         });
     };
 }
+/**
+ * Use a custom function for validation
+ * @param func
+ * @param validationOptions
+ * @returns
+ */
+function CheckFunc(func, validationOptions) {
+    return function (object, propertyName) {
+        setExpose(object, propertyName);
+        classValidator.registerDecorator({
+            name: "vCheckFunc",
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value, args) {
+                    return func(value);
+                },
+                defaultMessage(args) {
+                    return `invalid parameter ($property).`;
+                }
+            }
+        });
+    };
+}
 
+exports.CheckFunc = CheckFunc;
 exports.ClassValidator = ClassValidator;
 exports.Contains = Contains;
 exports.ENABLE_VALIDATED = ENABLE_VALIDATED;
@@ -1411,6 +1432,7 @@ exports.PARAM_CHECK_KEY = PARAM_CHECK_KEY;
 exports.PARAM_RULE_KEY = PARAM_RULE_KEY;
 exports.PARAM_TYPE_KEY = PARAM_TYPE_KEY;
 exports.Valid = Valid;
+exports.ValidFuncs = ValidFuncs;
 exports.Validated = Validated;
 exports.checkParamsType = checkParamsType;
 exports.convertDtoParamsType = convertDtoParamsType;

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-16 14:42:53
+* @Date: 2024-01-03 14:40:53
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -62,7 +62,12 @@ function plainToClass(clazz, data, convert = false) {
 function assignDtoParams(clazz, data, convert = false) {
     const cls = Reflect.construct(clazz, []);
     if (convert) {
-        return convertAssignDtoParams(clazz, cls, data);
+        const metaData = getDtoParamsMeta(clazz, cls);
+        for (const [key, type] of Object.entries(metaData)) {
+            if (key && data[key] !== undefined) {
+                cls[key] = convertParamsType(data[key], type);
+            }
+        }
     }
     else {
         for (const key in cls) {
@@ -71,34 +76,28 @@ function assignDtoParams(clazz, data, convert = false) {
                 cls[key] = data[key];
             }
         }
-        return cls;
     }
+    return cls;
 }
 /**
- * convert type and assign dto params
+ * get class prototype type def.
  * @param clazz
  * @param cls
- * @param data
  * @returns
  */
-function convertAssignDtoParams(clazz, cls, data) {
-    if (Object.prototype.hasOwnProperty.call(cls, "_typeDef")) {
-        for (const key in cls) {
-            if (Object.prototype.hasOwnProperty.call(cls._typeDef, key) &&
-                data[key] !== undefined) {
-                cls[key] = convertParamsType(data[key], cls._typeDef[key]);
-            }
-        }
-    }
-    else {
-        const originMap = getOriginMetadata(PARAM_TYPE_KEY, clazz);
-        for (const [key, type] of originMap) {
-            if (key && data[key] !== undefined) {
-                cls[key] = convertParamsType(data[key], type);
-            }
-        }
+function getDtoParamsMeta(clazz, cls) {
+    if (!Object.prototype.hasOwnProperty.call(cls, "_typeDef") &&
+        ("_typeDef" in cls)) {
+        return cls._typeDef;
     }
-    return cls;
+    const typeDef = getOriginMetadata(PARAM_TYPE_KEY, clazz);
+    Reflect.defineProperty(clazz.prototype, "_typeDef", {
+        enumerable: true,
+        configurable: false,
+        writable: false,
+        value: typeDef
+    });
+    return typeDef;
 }
 /**
  * convertDtoParamsType
@@ -331,7 +330,7 @@ function plateNumber(value) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:47:04
- * @LastEditTime: 2022-08-19 14:21:20
+ * @LastEditTime: 2024-01-03 14:32:49
  */
 // constant
 const PARAM_TYPE_KEY = 'PARAM_TYPE_KEY';
@@ -657,7 +656,7 @@ Object.keys(ValidFuncs).forEach((key) => {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-25 10:46:57
- * @LastEditTime: 2023-12-16 14:23:12
+ * @LastEditTime: 2024-01-03 11:30:55
  */
 /**
  * Validation parameter's type and values.
@@ -741,15 +740,11 @@ function Validated() {
  */
 function Expose() {
     return function (object, propertyName) {
-        const types = Reflect.getMetadata("design:type", object, propertyName);
-        if (types) {
-            const originMap = getOriginMetadata(PARAM_TYPE_KEY, object);
-            originMap.set(propertyName, types.name);
-        }
+        setExpose(object, propertyName);
     };
 }
 /**
- * Identifies that the field needs to be defined
+ * Alias of Expose
  *
  * @export
  * @returns {PropertyDecorator}
@@ -1358,5 +1353,30 @@ function IsHash(algorithm, validationOptions) {
         });
     };
 }
+/**
+ * Use a custom function for validation
+ * @param func
+ * @param validationOptions
+ * @returns
+ */
+function CheckFunc(func, validationOptions) {
+    return function (object, propertyName) {
+        setExpose(object, propertyName);
+        registerDecorator({
+            name: "vCheckFunc",
+            target: object.constructor,
+            propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value, args) {
+                    return func(value);
+                },
+                defaultMessage(args) {
+                    return `invalid parameter ($property).`;
+                }
+            }
+        });
+    };
+}
 
-export { ClassValidator, Contains, ENABLE_VALIDATED, Equals, Expose, FunctionValidator, Gt, Gte, IsCnName, IsDate, IsDefined, IsEmail, IsHash, IsIP, IsIdNumber, IsIn, IsMobile, IsNotEmpty, IsNotIn, IsPhoneNumber, IsPlateNumber, IsUrl, IsZipCode, Length, Lt, Lte, NotEquals, PARAM_CHECK_KEY, PARAM_RULE_KEY, PARAM_TYPE_KEY, Valid, Validated, checkParamsType, convertDtoParamsType, convertParamsType, paramterTypes, plainToClass };
+export { CheckFunc, ClassValidator, Contains, ENABLE_VALIDATED, Equals, Expose, FunctionValidator, Gt, Gte, IsCnName, IsDate, IsDefined, IsEmail, IsHash, IsIP, IsIdNumber, IsIn, IsMobile, IsNotEmpty, IsNotIn, IsPhoneNumber, IsPlateNumber, IsUrl, IsZipCode, Length, Lt, Lte, NotEquals, PARAM_CHECK_KEY, PARAM_RULE_KEY, PARAM_TYPE_KEY, Valid, ValidFuncs, Validated, checkParamsType, convertDtoParamsType, convertParamsType, paramterTypes, plainToClass };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_validation",
-  "version": "1.2.10",
+  "version": "1.3.0",
   "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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_validation",
-  "version": "1.2.10",
+  "version": "1.3.0",
   "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",