koatty_validation 1.0.10 → 1.2.0

package/jest-html-reporters-attach/result.js

@@ -0,0 +1 @@
+window.jest_html_reporters_callback__({"numFailedTestSuites":0,"numFailedTests":0,"numPassedTestSuites":1,"numPassedTests":2,"numPendingTestSuites":0,"numPendingTests":0,"numRuntimeErrorTestSuites":0,"numTodoTests":0,"numTotalTestSuites":1,"numTotalTests":2,"startTime":1645754279274,"success":false,"testResults":[{"leaks":false,"numFailingTests":0,"numPassingTests":2,"numPendingTests":0,"numTodoTests":0,"perfStats":{"end":1645754280984,"runtime":1640,"slow":false,"start":1645754279344},"skipped":false,"testFilePath":"/Users/richen/Workspace/nodejs/koatty_validation/test/.test.ts","testResults":[{"ancestorTitles":["koatty_validation"],"duration":1,"failureDetails":[],"failureMessages":[],"fullName":"koatty_validation FunctionValidator","invocations":1,"location":null,"numPassingAsserts":0,"status":"passed","title":"FunctionValidator"},{"ancestorTitles":["koatty_validation"],"duration":2,"failureDetails":[],"failureMessages":[],"fullName":"koatty_validation ClassValidator","invocations":1,"location":null,"numPassingAsserts":0,"status":"passed","title":"ClassValidator"}],"failureMessage":null}],"wasInterrupted":false,"config":{"bail":0,"changedFilesWithAncestor":false,"collectCoverage":true,"collectCoverageFrom":[],"coverageDirectory":"coverage","coverageProvider":"babel","coverageReporters":["html","lcov","json","text","clover","text-summary"],"detectLeaks":false,"detectOpenHandles":false,"errorOnDeprecated":false,"expand":false,"findRelatedTests":false,"forceExit":false,"json":false,"lastCommit":false,"listTests":false,"logHeapUsage":false,"maxConcurrency":5,"maxWorkers":7,"noStackTrace":false,"nonFlagArgs":[],"notify":false,"notifyMode":"failure-change","onlyChanged":false,"onlyFailures":false,"passWithNoTests":true,"projects":[],"reporters":[["default",{}],["/Users/richen/Workspace/nodejs/koatty_validation/node_modules/jest-html-reporters/index.js",{}]],"rootDir":"/Users/richen/Workspace/nodejs/koatty_validation","runTestsByPath":false,"skipFilter":false,"testFailureExitCode":1,"testPathPattern":"","testSequencer":"/Users/richen/Workspace/nodejs/koatty_validation/node_modules/@jest/test-sequencer/build/index.js","updateSnapshot":"new","useStderr":false,"verbose":true,"watch":false,"watchAll":false,"watchman":true},"endTime":1645754281125,"_reporterOptions":{"publicPath":"/Users/richen/Workspace/nodejs/koatty_validation","filename":"jest_html_reporters.html","expand":false,"pageTitle":"","hideIcon":false,"testCommand":"npx jest","openReport":false,"failureMessageOnly":false,"enableMergeData":false,"dataMergeLevel":1},"attachInfos":{}})

package/package.json

@@ -1,27 +1,34 @@
 {
     "name": "koatty_validation",
-    "version": "1.0.10",
+    "version": "1.2.0",
     "description": "Validation Util for Koatty and ThinkORM.",
     "scripts": {
-        "build": "del-cli --force dist && tsc",
+        "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
+        "build:cp": "node scripts/postBuild && copyfiles package.json LICENSE README.md dist/",
+        "build:js": "del-cli --force dist && npx rollup -c",
+        "build:doc": "del-cli --force docs/api && npx api-documenter markdown --input temp --output docs/api",
+        "build:dts": "del-cli --force temp && npx tsc && npx api-extractor run --local --verbose",
         "eslint": "eslint --ext .ts,.js ./",
         "prepublishOnly": "npm test && npm run build",
-        "release": "npm run prepublishOnly && standard-version",
+        "prerelease": "npm test && npm run build",
+        "release": "standard-version",
+        "release:pre": "npm run release -- --prerelease",
+        "release:major": "npm run release -- --release-as major",
+        "release:minor": "npm run release -- --release-as minor",
         "pub": "git push --follow-tags origin && npm publish",
         "test": "npm run eslint && jest --passWithNoTests",
         "test:cov": "jest --collectCoverage --detectOpenHandles",
         "version": "conventional-changelog -p angular -i CHANGELOG.md -s"
     },
     "main": "./dist/index.js",
+    "exports": {
+        "require": "./dist/index.js",
+        "import": "./dist/index.mjs"
+    },
     "repository": {
         "type": "git",
         "url": "git+https://github.com/koatty/koatty_validation.git"
     },
-    "keywords": [
-        "validation",
-        "koatty",
-        "thinkKoa"
-    ],
     "engines": {
         "node": ">10.0.0"
     },
@@ -41,25 +48,27 @@
         }
     ],
     "devDependencies": {
-        "@babel/core": "^7.x.x",
-        "@babel/plugin-proposal-decorators": "^7.x.x",
-        "@babel/preset-env": "^7.x.x",
-        "@babel/preset-typescript": "^7.x.x",
-        "@commitlint/cli": "^12.x.x",
-        "@commitlint/config-conventional": "^15.x.x",
+        "@microsoft/api-documenter": "^7.x.x",
+        "@microsoft/api-extractor": "^7.x.x",
+        "@rollup/plugin-json": "^4.x.x",
         "@types/jest": "^27.x.x",
         "@types/koa": "^2.x.x",
         "@types/node": "^16.x.x",
-        "@types/validator": "^13.7.0",
+        "@types/validator": "^13.x.x",
         "@typescript-eslint/eslint-plugin": "^5.x.x",
         "@typescript-eslint/parser": "^5.x.x",
+        "commitlint": "^15.x.x",
+        "commitlint-config-gitmoji": "^2.x.x",
         "conventional-changelog-cli": "^2.x.x",
+        "copyfiles": "^2.x.x",
         "del-cli": "^4.x.x",
         "eslint": "^8.x.x",
         "eslint-plugin-jest": "^25.x.x",
         "husky": "^7.x.x",
         "jest": "^27.x.x",
         "jest-html-reporters": "^2.x.x",
+        "rollup": "^2.x.x",
+        "rollup-plugin-typescript2": "^0.x.x",
         "standard-version": "^9.x.x",
         "ts-jest": "^27.x.x",
         "ts-node": "^10.x.x",
@@ -73,9 +82,9 @@
         "reflect-metadata": "^0.1.13",
         "tslib": "^2.3.1"
     },
-    "husky": {
-        "hooks": {
-            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-        }
+    "peerDependencies": {
+        "koatty_container": "^1.x.x",
+        "koatty_lib": "^1.x.x",
+        "koatty_logger": "^1.x.x"
     }
 }

package/.eslintignore

@@ -1,9 +0,0 @@
-node_modules
-.eslintrc.js
-**/package-lock.json
-**/yarn.lock
-**/*.config.js
-dist
-coverage
-test
-demo

package/.eslintrc.js

@@ -1,43 +0,0 @@
-/**
- * 
- */
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  extends: [
-    'plugin:@typescript-eslint/recommended', // 使用@typescript-eslint/eslint-plugin的推荐规则
-    'plugin:jest/recommended',
-  ],
-  plugins: [
-    '@typescript-eslint',
-    'jest',
-  ],
-  parserOptions: {
-    project: './tsconfig.json',
-  },
-  env: {
-    node: true,
-    mongo: true,
-    jest: true,
-  },
-  rules: {
-    "@typescript-eslint/no-explicit-any": "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",
-      {
-        "types": {
-          "Object": false,
-          "Function": false,
-        },
-        "extendDefaults": true
-      }
-    ],
-  },
-};

package/babel.config.js

@@ -1,21 +0,0 @@
-/*
- * @Description  : babel配置
- * @usage        : 用于jest执行用例
- */
-
-module.exports = {
-  presets: [
-    [
-      '@babel/preset-env',
-      {
-        targets: {
-          node: 'current',
-        },
-      },
-    ],
-    '@babel/preset-typescript',
-  ],
-  plugins: [
-    ['@babel/plugin-proposal-decorators', { 'legacy': true }]
-  ],
-};

package/commitlint.config.js

@@ -1,14 +0,0 @@
-/*
- * 
- */
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore']],
-    'type-empty': [2, 'never'],
-    'scope-enum': [0], // 不校验scope类型
-    'scope-empty': [0], // 不校验scope是否设置
-    'subject-case': [0], // 不校验描述的字符格式
-    'subject-min-length': [2, 'always', 5], // 描述至少5个字符
-  },
-};

package/dist/decorator.d.ts

@@ -1,237 +0,0 @@
-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;