koatty_validation 1.4.0 → 1.6.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.6.0](https://github.com/koatty/koatty_validation/compare/v1.5.0...v1.6.0) (2025-10-22)
+
+
+### Features
+
+* improve validation with instance conversion and caching ([9865b93](https://github.com/koatty/koatty_validation/commit/9865b93e469a7df16fe67e0b85dab3191437b0a8))
+
+## [1.5.0](https://github.com/koatty/koatty_validation/compare/v1.4.0...v1.5.0) (2025-10-22)
+
+
+### Features
+
+* comprehensive code optimization and enhancements ([f7ac738](https://github.com/koatty/koatty_validation/commit/f7ac7381a75a12365aee2a83530a12044c5e1d44))
+
 ## [1.4.0](https://github.com/koatty/koatty_validation/compare/v1.3.2...v1.4.0) (2025-06-10)
 
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-06-10 23:32:33
+* @Date: 2025-10-23 01:25:11
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -212,15 +212,32 @@ export declare function Expose(): PropertyDecorator;
 
 /**
  * Use functions or built-in rules for validation.
+ * Throws error if validation fails.
  *
  * @export
- * @param {ValidRules} rule
- * @param {unknown} value
- * @param {(string | ValidOtpions)} [options]
- * @returns {*}
  */
 export declare const FunctionValidator: {
-    [key in ValidRules]: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsNotEmpty: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsDate: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsEmail: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsIP: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsPhoneNumber: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsUrl: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsHash: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsCnName: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsIdNumber: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsZipCode: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsMobile: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsPlateNumber: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Equals: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly NotEquals: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Contains: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsIn: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly IsNotIn: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Gt: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Lt: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Gte: (value: unknown, options?: string | ValidOtpions) => void;
+    readonly Lte: (value: unknown, options?: string | ValidOtpions) => void;
 };
 
 /**
@@ -232,6 +249,10 @@ export declare function getAllCacheStats(): {
         max: number;
         calculatedSize: number;
         keyCount: number;
+        hits: number;
+        misses: number;
+        hitRate: number;
+        totalRequests: number;
     };
     regex: {
         size: number;
@@ -388,6 +409,11 @@ export declare const PARAM_CHECK_KEY = "PARAM_CHECK_KEY";
 
 export declare const PARAM_RULE_KEY = "PARAM_RULE_KEY";
 
+/**
+ * 参数类型键常量
+ */
+export declare const PARAM_TYPE_KEY = "PARAM_TYPE_KEY";
+
 /**
  * paramterTypes
  *
@@ -539,6 +565,7 @@ declare class ValidateClass {
 
 /**
  * 方法验证装饰器
+ * 自动验证方法参数中的 DTO 对象
  */
 export declare function Validated(): MethodDecorator;
 
@@ -582,6 +609,10 @@ declare class ValidationCache {
         max: number;
         calculatedSize: number;
         keyCount: number;
+        hits: number;
+        misses: number;
+        hitRate: number;
+        totalRequests: number;
     };
     /**
      * 设置缓存TTL
@@ -619,7 +650,7 @@ export declare const ValidFuncs: {
     /**
      * Checks if a given value is a real date.
      */
-    IsDate: (value: unknown) => value is Date;
+    IsDate: (value: unknown) => boolean;
     /**
      * Checks if the string is an email. If given value is not a string, then it returns false.
      */
@@ -636,11 +667,11 @@ export declare const ValidFuncs: {
      * 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;
+    IsPhoneNumber: (value: unknown, 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;
+    IsUrl: (value: unknown, 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']
@@ -649,23 +680,23 @@ export declare const ValidFuncs: {
     /**
      * Checks if value is a chinese name.
      */
-    IsCnName: (value: any) => boolean;
+    IsCnName: (value: unknown) => boolean;
     /**
      * Checks if value is a idcard number.
      */
-    IsIdNumber: (value: any) => boolean;
+    IsIdNumber: (value: unknown) => boolean;
     /**
      * Checks if value is a zipCode.
      */
-    IsZipCode: (value: any) => boolean;
+    IsZipCode: (value: unknown) => boolean;
     /**
      * Checks if value is a mobile phone number.
      */
-    IsMobile: (value: any) => boolean;
+    IsMobile: (value: unknown) => boolean;
     /**
      * Checks if value is a plateNumber.
      */
-    IsPlateNumber: (value: any) => boolean;
+    IsPlateNumber: (value: unknown) => boolean;
     /**
      * Checks if value matches ("===") the comparison.
      */
@@ -689,19 +720,19 @@ export declare const ValidFuncs: {
     /**
      * Checks if the first number is greater than or equal to the second.
      */
-    Gt: (num: unknown, min: number) => boolean;
+    Gt: (value: unknown, min: number) => boolean;
     /**
      * Checks if the first number is less than or equal to the second.
      */
-    Lt: (num: unknown, max: number) => boolean;
+    Lt: (value: unknown, max: number) => boolean;
     /**
      * Checks if the first number is greater than or equal to the second.
      */
-    Gte: (num: unknown, min: number) => boolean;
+    Gte: (value: unknown, min: number) => boolean;
     /**
      * Checks if the first number is less than or equal to the second.
      */
-    Lte: (num: unknown, max: number) => boolean;
+    Lte: (value: unknown, max: number) => boolean;
 };
 
 /**