koatty_validation 1.2.9 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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)
+
+
+### Bug Fixes
+
+* assign dto property ([2357642](https://github.com/koatty/koatty_validation/commit/2357642f6ac1479c839454d40ec4bd89f3fbd7b2))
+
 ### [1.2.9](https://github.com/koatty/koatty_validation/compare/v1.2.8...v1.2.9) (2023-09-01)
 
 ### [1.2.8](https://github.com/koatty/koatty_validation/compare/v1.2.7...v1.2.8) (2023-02-17)

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-09-01 11:55:18
+* @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;