koatty_validation 1.0.4 → 1.0.12

package/.eslintrc.js

@@ -22,12 +22,13 @@ module.exports = {
   },
   rules: {
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-require-imports": "off",
+    // "@typescript-eslint/no-require-imports": "off",
     "@typescript-eslint/no-var-requires": "off",
     "@typescript-eslint/member-ordering": "off",
     "@typescript-eslint/consistent-type-assertions": "off",
     "@typescript-eslint/no-param-reassign": "off",
     "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/ban-types": ["error",
       {

package/CHANGELOG.md

@@ -2,8 +2,10 @@
 
 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.0.4](https://github.com/koatty/koatty_validation/compare/v1.0.2...v1.0.4) (2021-07-12)
+### [1.0.12](https://github.com/koatty/koatty_validation/compare/v1.0.10...v1.0.12) (2021-12-21)
 
-### [1.0.2](https://github.com/thinkkoa/koatty_validation/compare/v1.0.1...v1.0.2) (2021-06-28)
+### [1.0.10](https://github.com/koatty/koatty_validation/compare/v1.0.8...v1.0.10) (2021-11-25)
 
-### 1.0.1 (2021-06-22)
+### [1.0.8](https://github.com/koatty/koatty_validation/compare/v1.0.6...v1.0.8) (2021-11-23)
+
+### [1.0.6](https://github.com/koatty/koatty_validation/compare/v1.0.4...v1.0.6) (2021-11-20)

package/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2020, ThinkKoa
+Copyright (c) 2020, Koatty
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/babel.config.js

@@ -1,11 +1,6 @@
 /*
  * @Description  : babel配置
  * @usage        : 用于jest执行用例
- * @Date         : 2020-10-19 23:08:40
- * @Author       : fankerwang<fankerwang@tencent.com>
- * @LastEditors  : fankerwang<fankerwang@tencent.com>
- * @LastEditTime : 2021-05-21 20:27:11
- * @FilePath     : /tkoatty/babel.config.js
  */
 
 module.exports = {

package/dist/decorator.d.ts

@@ -0,0 +1,237 @@
+import { CountryCode } from 'libphonenumber-js';
+import { ValidRules } from "./rule";
+import { IsIpVersion, ValidationOptions } from "class-validator";
+export interface IsEmailOptions {
+    allow_display_name?: boolean;
+    require_display_name?: boolean;
+    allow_utf8_local_part?: boolean;
+    require_tld?: boolean;
+}
+export 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;
+}
+export declare type HashAlgorithm = "md4" | "md5" | "sha1" | "sha256" | "sha384" | "sha512" | "ripemd128" | "ripemd160" | "tiger128" | "tiger160" | "tiger192" | "crc32" | "crc32b";
+/**
+ * Validation parameter's type and values.
+ *
+ * @export
+ * @param {(ValidRules | ValidRules[] | Function)} rule
+ * @param {string} [message]
+ * @returns {ParameterDecorator}
+ */
+export declare function Valid(rule: ValidRules | ValidRules[] | Function, message?: string): ParameterDecorator;
+/**
+ * Validation parameter's type and values from DTO class.
+ *
+ * @export
+ * @returns {MethodDecorator}
+ */
+export declare function Validated(): MethodDecorator;
+/**
+ * Marks property as included in the process of transformation.
+ *
+ * @export
+ * @returns {PropertyDecorator}
+ */
+export declare function Expose(): PropertyDecorator;
+/**
+ * Identifies that the field needs to be defined
+ *
+ * @export
+ * @returns {PropertyDecorator}
+ */
+export declare function IsDefined(): PropertyDecorator;
+/**
+ * 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 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}
+ */
+export declare function IsIn(possibleValues: any[], 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 a given value is a real date.
+ *
+ * @export
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsDate(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 Min(min: 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 Max(max: number, 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 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;
+/**
+ * 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 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 the string is an url.
+ *
+ * @export
+ * @param {IsURLOptions} [options]
+ * @param {ValidationOptions} [validationOptions]
+ * @returns {PropertyDecorator}
+ */
+export declare function IsUrl(options?: IsURLOptions, validationOptions?: ValidationOptions): PropertyDecorator;
+/**
+ * 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;