koatty_validation 1.0.4 → 1.0.12

package/dist/util.d.ts

@@ -1,101 +1,10 @@
-import { CountryCode } from 'libphonenumber-js';
-import { ValidationOptions, IsIpVersion } from "class-validator";
-interface IsEmailOptions {
-    allow_display_name?: boolean;
-    require_display_name?: boolean;
-    allow_utf8_local_part?: boolean;
-    require_tld?: boolean;
-}
-interface IsURLOptions {
-    protocols?: string[];
-    require_tld?: boolean;
-    require_protocol?: boolean;
-    require_host?: boolean;
-    require_valid_protocol?: boolean;
-    allow_underscores?: boolean;
-    host_whitelist?: (string | RegExp)[];
-    host_blacklist?: (string | RegExp)[];
-    allow_trailing_dot?: boolean;
-    allow_protocol_relative_urls?: boolean;
-    disallow_auth?: boolean;
-}
-declare class ValidateClass {
-    private static instance;
-    private constructor();
-    /**
-     *
-     *
-     * @static
-     * @returns
-     * @memberof ValidateUtil
-     */
-    static getInstance(): ValidateClass;
-    /**
-     * validated data vs dto class
-     *
-     * @param {*} Clazz
-     * @param {*} data
-     * @param {boolean} [convert=false] auto convert parameters type
-     * @returns {Promise<any>}
-     * @memberof ValidateClass
-     */
-    valid(Clazz: any, data: any, convert?: boolean): Promise<any>;
-}
 /**
- * ClassValidator for manual
- */
-export declare const ClassValidator: ValidateClass;
-interface IsEmailOptions {
-    allow_display_name?: boolean;
-    require_display_name?: boolean;
-    allow_utf8_local_part?: boolean;
-    require_tld?: boolean;
-}
-interface IsURLOptions {
-    protocols?: string[];
-    require_tld?: boolean;
-    require_protocol?: boolean;
-    require_host?: boolean;
-    require_valid_protocol?: boolean;
-    allow_underscores?: boolean;
-    host_whitelist?: (string | RegExp)[];
-    host_blacklist?: (string | RegExp)[];
-    allow_trailing_dot?: boolean;
-    allow_protocol_relative_urls?: boolean;
-    disallow_auth?: boolean;
-}
-declare type HashAlgorithm = "md4" | "md5" | "sha1" | "sha256" | "sha384" | "sha512" | "ripemd128" | "ripemd160" | "tiger128" | "tiger160" | "tiger192" | "crc32" | "crc32b";
-/**
- * Validator Functions
- */
-export declare const FunctionValidator: any;
-/**
- * type checked rules
- *
- * @export
- * @type {number}
- */
-export declare type ValidRules = "IsNotEmpty" | "IsDate" | "IsEmail" | "IsIP" | "IsPhoneNumber" | "IsUrl" | "IsHash" | "IsCnName" | "IsIdNumber" | "IsZipCode" | "IsMobile" | "IsPlateNumber";
-/**
- * Use functions or built-in rules for validation.
- *
- * @export
- * @param {string} name
- * @param {*} value
- * @param {string} type
- * @param {(ValidRules | ValidRules[] | Function)} rule
- * @param {string} [message]
- * @param {boolean} [checkType=true]
- * @returns
- */
-export declare function ValidatorFuncs(name: string, value: any, type: string, rule: ValidRules | ValidRules[] | Function, message?: string, checkType?: boolean): any;
-/**
- * append to the target class method to validated parameter.
- *
- * @export
- * @param {*} target
- * @param {string} propertyKey
+ * @ author: richen
+ * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
+ * @ license: MIT
+ * @ version: 2020-03-20 11:34:38
  */
+import "reflect-metadata";
 /**
  * Set property as included in the process of transformation.
  *
@@ -105,201 +14,95 @@ export declare function ValidatorFuncs(name: string, value: any, type: string, r
  */
 export declare function setExpose(object: Object, propertyName: string | symbol): void;
 /**
- * Marks property as included in the process of transformation.
- *
- * @export
- * @returns {PropertyDecorator}
+ * get metadata value of a metadata key on the prototype chain of an object and property
+ * @param metadataKey metadata key
+ * @param target the target of metadataKey
  */
-export declare function Expose(): PropertyDecorator;
+export declare function recursiveGetMetadata(metadataKey: any, target: any, propertyKey?: string | symbol): any[];
 /**
- * Identifies that the field needs to be defined
+ * Dynamically add methods for target class types
  *
- * @export
- * @returns {PropertyDecorator}
- */
-export declare function IsDefined(): PropertyDecorator;
-/**
- * Checks if value is a chinese name.
- *
- * @export
- * @param {string} property
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {Function} clazz
+ * @param {string} protoName
+ * @param {Function} func
  */
-export declare function IsCnName(validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function defineNewProperty(clazz: Function, protoName: string, func: Function): void;
 /**
- * Checks if value is a idCard number(chinese).
  *
- * @export
- * @param {string} property
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsIdNumber(validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if value is a zipCode(chinese).
  *
- * @export
- * @param {string} property
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsZipCode(validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if value is a mobile phone number(chinese).
- *
- * @export
- * @param {string} property
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsMobile(validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if value is a plate number(chinese).
- *
- * @export
- * @param {string} property
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsPlateNumber(validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks value is not empty, undefined, null, '', NaN, [], {} and any empty string(including spaces, tabs, formfeeds, etc.), returns false.
- *
- * @export
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsNotEmpty(validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if value matches ("===") the comparison.
- *
- * @export
- * @param {*} comparison
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function Equals(comparison: any, validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if value does not match ("!==") the comparison.
- *
- * @export
- * @param {*} comparison
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function NotEquals(comparison: any, validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if the string contains the seed.
- *
- * @export
- * @param {string} seed
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function Contains(seed: string, validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if given value is in a array of allowed values.
- *
- * @export
- * @param {any[]} possibleValues
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {(string | symbol)} metadataKey
+ * @param {*} target
+ * @param {(string | symbol)} [propertyKey]
+ * @returns
  */
-export declare function IsIn(possibleValues: any[], validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function getOriginMetadata(metadataKey: string | symbol, target: any, propertyKey?: string | symbol): any;
 /**
- * Checks if given value not in a array of allowed values.
  *
- * @export
- * @param {any[]} possibleValues
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
- */
-export declare function IsNotIn(possibleValues: any[], validationOptions?: ValidationOptions): PropertyDecorator;
-/**
- * Checks if a given value is a real date.
  *
  * @export
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {*} clazz
+ * @param {*} data
+ * @param {boolean} [convert=false]
+ * @returns
  */
-export declare function IsDate(validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function plainToClass(clazz: any, data: any, convert?: boolean): any;
 /**
- * Checks if the first number is greater than or equal to the min value.
+ * convertDtoParamsType
  *
- * @export
- * @param {number} min
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {*} clazz
+ * @param {*} cls
+ * @param {*} data
+ * @returns {*}
  */
-export declare function Min(min: number, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function convertDtoParamsType(clazz: any, cls: any, data: any): any;
 /**
- * Checks if the first number is less than or equal to the max value.
+ * 绑定参数类型转换
  *
- * @export
- * @param {number} max
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {*} param
+ * @param {string} type
+ * @returns {*}
  */
-export declare function Max(max: number, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function convertParamsType(param: any, type: string): any;
 /**
- * Checks if the string's length falls in a range. Note: this function takes into account surrogate pairs.
- * If given value is not a string, then it returns false.
+ * Check the base types.
  *
- * @export
- * @param {number} min
- * @param {number} [max]
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {*} value
+ * @param {string} type
+ * @returns {*}
  */
-export declare function Length(min: number, max?: number, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function checkParamsType(value: any, type: string): any;
 /**
- * Checks if the string is an email. If given value is not a string, then it returns false.
+ * Checks if value is a chinese name.
  *
- * @export
- * @param {IsEmailOptions} [options]
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {string} value
+ * @returns {boolean}
  */
-export declare function IsEmail(options?: IsEmailOptions, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function cnName(value: string): boolean;
 /**
- * Checks if the string is an IP (version 4 or 6). If given value is not a string, then it returns false.
+ * Checks if value is a idCard number.
  *
- * @export
- * @param {number} [version]
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {string} value
+ * @returns
  */
-export declare function IsIP(version?: IsIpVersion, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function idNumber(value: string): boolean;
 /**
- * Checks if the string is a valid phone number.
+ * Checks if value is a mobile phone number.
  *
- * @export
- * @param {string} {string} 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}
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {string} value
+ * @returns {boolean}
  */
-export declare function IsPhoneNumber(region?: CountryCode, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function mobile(value: string): boolean;
 /**
- * Checks if the string is an url.
+ * Checks if value is a zipCode.
  *
- * @export
- * @param {IsURLOptions} [options]
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {string} value
+ * @returns {boolean}
  */
-export declare function IsUrl(options?: IsURLOptions, validationOptions?: ValidationOptions): PropertyDecorator;
+export declare function zipCode(value: string): 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']
+ * Checks if value is a plateNumber.
  *
- * @export
- * @param {HashAlgorithm} algorithm
- * @param {ValidationOptions} [validationOptions]
- * @returns {PropertyDecorator}
+ * @param {string} value
+ * @returns {boolean}
  */
-export declare function IsHash(algorithm: HashAlgorithm, validationOptions?: ValidationOptions): PropertyDecorator;
-export {};
+export declare function plateNumber(value: string): boolean;