koatty_validation 1.0.10 → 1.2.0

package/dist/index.d.ts

@@ -1,9 +1,422 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: MIT
- * @ version: 2020-03-20 11:31:09
- */
-export * from "./rule";
-export * from "./decorator";
-export { checkParamsType, convertParamsType, convertDtoParamsType, plainToClass } from "./util";
+/*!
+* @Author: richen
+* @Date: 2022-02-25 09:58:15
+* @License: BSD (3-Clause)
+* @Copyright (c) - <richenlin(at)gmail.com>
+* @HomePage: https://koatty.org/
+*/
+import { CountryCode } from 'libphonenumber-js';
+import { IsIpVersion } from 'class-validator';
+import { ValidationOptions } from 'class-validator';
+
+/**
+ * Check the base types.
+ *
+ * @param {*} value
+ * @param {string} type
+ * @returns {*}
+ */
+export declare function checkParamsType(value: any, type: string): any;
+
+/**
+ * ClassValidator for manual
+ */
+export declare const ClassValidator: ValidateClass;
+
+/**
+ * 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;
+
+/**
+ * convertDtoParamsType
+ *
+ * @param {*} clazz
+ * @param {*} cls
+ * @param {*} data
+ * @returns {*}
+ */
+export declare function convertDtoParamsType(clazz: any, cls: any, data: any): any;
+
+/**
+ * 绑定参数类型转换
+ *
+ * @param {*} param
+ * @param {string} type
+ * @returns {*}
+ */
+export declare function convertParamsType(param: any, type: string): any;
+
+export declare const ENABLE_VALIDATED = "ENABLE_VALIDATED";
+
+/**
+ * Checks if value matches ("===") the comparison.
+ *
+ * @export
+ * @param {*} comparison
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Equals(comparison: any, validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Marks property as included in the process of transformation.
+ *
+ * @export
+ * @returns {PropertyDecorator}
+ */
+export declare function Expose(): PropertyDecorator;
+
+/**
+ * Use functions or built-in rules for validation.
+ *
+ * @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;
+};
+
+/**
+ * Checks if the first number is greater than or equal to the min value.
+ *
+ * @export
+ * @param {number} min
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Gt(min: number, validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Checks if the first number is greater than or equal to the min value.
+ *
+ * @export
+ * @param {number} min
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Gte(min: number, validationOptions?: ValidationOptions): PropertyDecorator;
+
+export declare type HashAlgorithm = "md4" | "md5" | "sha1" | "sha256" | "sha384" | "sha512" | "ripemd128" | "ripemd160" | "tiger128" | "tiger160" | "tiger192" | "crc32" | "crc32b";
+
+/**
+ * Checks if value is a chinese name.
+ *
+ * @export
+ * @param {string} property
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsCnName(validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Checks if a given value is a real date.
+ *
+ * @export
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsDate(validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Identifies that the field needs to be defined
+ *
+ * @export
+ * @returns {PropertyDecorator}
+ */
+export declare function IsDefined(): PropertyDecorator;
+
+/**
+ * Checks if the string is an email. If given value is not a string, then it returns false.
+ *
+ * @export
+ * @param {IsEmailOptions} [options]
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsEmail(options?: IsEmailOptions, validationOptions?: ValidationOptions): PropertyDecorator;
+
+export declare interface IsEmailOptions {
+    allow_display_name?: boolean;
+    require_display_name?: boolean;
+    allow_utf8_local_part?: boolean;
+    require_tld?: 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']
+ *
+ * @export
+ * @param {HashAlgorithm} algorithm
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsHash(algorithm: HashAlgorithm, validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * 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 given value is in a array of allowed values.
+ *
+ * @export
+ * @param {any[]} possibleValues
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsIn(possibleValues: any[], validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Checks if the string is an IP (version 4 or 6). If given value is not a string, then it returns false.
+ *
+ * @export
+ * @param {number} [version]
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsIP(version?: IsIpVersion, 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 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 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 the string is a valid 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}
+ */
+export declare function IsPhoneNumber(region?: CountryCode, 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 if the string is an url.
+ *
+ * @export
+ * @param {IsURLOptions} [options]
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsUrl(options?: IsURLOptions, validationOptions?: ValidationOptions): PropertyDecorator;
+
+export declare 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;
+}
+
+/**
+ * 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 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.
+ *
+ * @export
+ * @param {number} min
+ * @param {number} [max]
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Length(min: number, max?: number, validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Checks if the first number is less than or equal to the max value.
+ *
+ * @export
+ * @param {number} max
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Lt(max: number, validationOptions?: ValidationOptions): PropertyDecorator;
+
+/**
+ * Checks if the first number is less than or equal to the max value.
+ *
+ * @export
+ * @param {number} max
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function Lte(max: number, 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;
+
+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
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum paramterTypes {
+    "Number" = 0,
+    "number" = 1,
+    "String" = 2,
+    "string" = 3,
+    "Boolean" = 4,
+    "boolean" = 5,
+    "Array" = 6,
+    "array" = 7,
+    "Tuple" = 8,
+    "tuple" = 9,
+    "Object" = 10,
+    "object" = 11,
+    "Enum" = 12,
+    "enum" = 13,
+    "Bigint" = 14,
+    "bigint" = 15,
+    "Null" = 16,
+    "null" = 17,
+    "Undefined" = 18,
+    "undefined" = 19
+}
+
+/**
+ *
+ *
+ * @export
+ * @param {*} clazz
+ * @param {*} data
+ * @param {boolean} [convert=false]
+ * @returns
+ */
+export declare function plainToClass(clazz: any, data: any, convert?: boolean): any;
+
+/**
+ * Validation parameter's type and values.
+ *
+ * @export
+ * @param {(ValidRules | ValidRules[] | Function)} rule
+ * @param {*} [options] If the options type is a string, the value is the error message of the validation rule.
+ * Some validation rules require additional parameters, ext: @Valid("Gte", {message:"Requires value greater than or equal to 100", value: 100})
+ * @returns {*}  {ParameterDecorator}
+ */
+export declare function Valid(rule: ValidRules | ValidRules[] | Function, options?: string | ValidOtpions): ParameterDecorator;
+
+declare class ValidateClass {
+    /**
+     *
+     *
+     * @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>;
+}
+
+/**
+ * Validation parameter's type and values from DTO class.
+ *
+ * @export
+ * @returns {MethodDecorator}
+ */
+export declare function Validated(): MethodDecorator;
+
+export declare type ValidOtpions = {
+    message: string;
+    value: any;
+};
+
+/**
+ * type checked rules
+ *
+ * @export
+ * @type {number}
+ */
+export declare type ValidRules = "IsNotEmpty" | "IsDate" | "IsEmail" | "IsIP" | "IsPhoneNumber" | "IsUrl" | "IsHash" | "IsCnName" | "IsIdNumber" | "IsZipCode" | "IsMobile" | "IsPlateNumber" | "Equals" | "NotEquals" | "Contains" | "IsIn" | "IsNotIn" | "Gt" | "Lt" | "Gte" | "Lte";
+
+export { }