koatty_validation 1.0.6 → 1.1.0

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

@@ -0,0 +1 @@
+window.jest_html_reporters_callback__({"numFailedTestSuites":0,"numFailedTests":0,"numPassedTestSuites":1,"numPassedTests":1,"numPendingTestSuites":0,"numPendingTests":0,"numRuntimeErrorTestSuites":0,"numTodoTests":0,"numTotalTestSuites":1,"numTotalTests":1,"startTime":1645007506342,"success":false,"testResults":[{"leaks":false,"numFailingTests":0,"numPassingTests":1,"numPendingTests":0,"numTodoTests":0,"perfStats":{"end":1645007508064,"runtime":1655,"slow":false,"start":1645007506409},"skipped":false,"testFilePath":"/Users/richen/Workspace/nodejs/koatty_validation/test/.test.ts","testResults":[{"ancestorTitles":["koatty_validation"],"duration":3,"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":1645007508191,"_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.6",
+    "version": "1.1.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/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA;;;;;GAKG;AACH,gEAAqC;AAErC,+BAAwD;AACxD,uDAAgD;AAEhD,iCAAiC;AACjC,6BAAsJ;AAA7I,kGAAA,WAAW,OAAA;AAAE,sGAAA,eAAe,OAAA;AAAE,wGAAA,iBAAiB,OAAA;AAAE,oGAAA,aAAa,OAAA;AAAE,mGAAA,YAAY,OAAA;AAAE,qGAAA,cAAc,OAAA;AAAE,qGAAA,cAAc,OAAA;AAAE,sGAAA,eAAe,OAAA;AACtI,sDAAuB;AACvB,yCAAyC;AACzC,4CAA4C;AAE5C;;;;;;;GAOG;AACH,SAAgB,KAAK,CAAC,IAA0C,EAAE,OAAgB;IAC9E,IAAI,KAAK,GAAQ,EAAE,CAAC;IACpB,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACvB,KAAK,GAAY,IAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KACrC;SAAM;QACH,KAAK,GAAG,IAAI,CAAC;KAChB;IACD,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,UAAe,EAAE,EAAE;QACzD,WAAW;QACX,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACjF,MAAM,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE9G,+BAAY,CAAC,kBAAkB,CAAC,oBAAc,EAAE;YAC5C,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,KAAK;YACX,OAAO;YACP,KAAK,EAAE,UAAU;YACjB,IAAI;SACP,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5B,CAAC,CAAC;AACN,CAAC;AApBD,sBAoBC;AAED;;;;;GAKG;AACH,SAAgB,SAAS;IACrB,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;QACxE,EAAE;QACF,+BAAY,CAAC,gBAAgB,CAAC,qBAAe,EAAE;YAC3C,QAAQ,EAAE,CAAC;SACd,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAExB,WAAW;QACX,0FAA0F;QAE1F,0DAA0D;QAC1D,iBAAiB;QACjB,oBAAoB;QACpB,kBAAkB;QAClB,sBAAsB;QACtB,qDAAqD;QACrD,gCAAgC;QAChC,4DAA4D;QAC5D,6DAA6D;QAC7D,2GAA2G;QAC3G,0CAA0C;QAC1C,iFAAiF;QACjF,uBAAuB;QACvB,mDAAmD;QACnD,gBAAgB;QAChB,cAAc;QACd,+BAA+B;QAC/B,6CAA6C;QAC7C,YAAY;QACZ,uDAAuD;QACvD,2CAA2C;QAC3C,QAAQ;QACR,KAAK;QACL,qBAAqB;IACzB,CAAC,CAAC;AACN,CAAC;AAnCD,8BAmCC"}

package/dist/lib.d.ts

@@ -1,131 +0,0 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: MIT
- * @ version: 2020-03-20 11:34:38
- */
-import "reflect-metadata";
-export declare const PARAM_TYPE_KEY = "PARAM_TYPE_KEY";
-export declare const PARAM_RULE_KEY = "PARAM_RULE_KEY";
-export declare const PARAM_CHECK_KEY = "PARAM_CHECK_KEY";
-export declare const ENABLE_VALIDATED = "ENABLE_VALIDATED";
-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
-}
-/**
- * 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 recursiveGetMetadata(metadataKey: any, target: any, propertyKey?: string | symbol): any[];
-/**
- * Dynamically add methods for target class types
- *
- * @param {Function} clazz
- * @param {string} protoName
- * @param {Function} func
- */
-export declare function defineNewProperty(clazz: Function, protoName: string, func: Function): void;
-/**
- *
- *
- * @param {(string | symbol)} metadataKey
- * @param {*} target
- * @param {(string | symbol)} [propertyKey]
- * @returns
- */
-export declare function getOriginMetadata(metadataKey: string | symbol, target: any, propertyKey?: string | symbol): any;
-/**
- * Convert parameter's type to defined.
- *
- * @param {*} param
- * @param {string} type
- * @returns
- */
-export declare const convertParamsType: (param: any, type: string) => any;
-/**
- * Check the base types.
- *
- * @param {*} value
- * @param {string} type
- * @returns {*}
- */
-export declare const checkParamsType: (value: any, type: string) => any;
-/**
- *
- *
- * @export
- * @param {*} clazz
- * @param {*} data
- * @param {boolean} [convert=false]
- * @returns
- */
-export declare function plainToClass(clazz: any, data: any, convert?: boolean): any;
-/**
- * Checks if value is a chinese name.
- *
- * @param {string} value
- * @returns {boolean}
- */
-export declare function cnName(value: string): boolean;
-/**
- * Checks if value is a idCard number.
- *
- * @param {string} value
- * @returns
- */
-export declare function idNumber(value: string): boolean;
-/**
- * Checks if value is a mobile phone number.
- *
- * @param {string} value
- * @returns {boolean}
- */
-export declare function mobile(value: string): boolean;
-/**
- * Checks if value is a zipCode.
- *
- * @param {string} value
- * @returns {boolean}
- */
-export declare function zipCode(value: string): boolean;
-/**
- * Checks if value is a plateNumber.
- *
- * @param {string} value
- * @returns {boolean}
- */
-export declare function plateNumber(value: string): boolean;
-interface ParamOptions {
-    index: number;
-    isDto: boolean;
-    type: string;
-    validRules: any[];
-    dtoCheck: boolean;
-}
-/**
- * Check parameters against predefined rules
- *
- * @export
- * @param {*} param
- * @param {number} index
- * @param {ParamOptions} [paramOptions={
- *     validRules: [],
- *     dtoCheck: false
- * }]
- */
-export declare function checkParams(value: any, paramOptions: ParamOptions): Promise<any>;
-export {};