koatty 3.5.11 → 3.5.12-3

package/dist/package.json

@@ -0,0 +1,98 @@
+{
+    "name": "koatty",
+    "version": "3.5.12-3",
+    "description": "Koa2 + Typescript = koatty. Use Typescript's decorator implement auto injection.",
+    "scripts": {
+        "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",
+        "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"
+    },
+    "directories": {
+        "doc": "docs"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/thinkkoa/koatty.git"
+    },
+    "engines": {
+        "node": ">12.0.0"
+    },
+    "author": {
+        "name": "richenlin",
+        "email": "richenlin@gmail.com"
+    },
+    "license": "BSD-3-Clause",
+    "bugs": {
+        "url": "https://github.com/thinkkoa/koatty/issues"
+    },
+    "homepage": "https://github.com/thinkkoa/koatty",
+    "maintainers": [
+        {
+            "name": "richenlin",
+            "email": "richenlin@gmail.com"
+        }
+    ],
+    "devDependencies": {
+        "@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/koa__router": "^8.x.x",
+        "@types/node": "^16.x.x",
+        "@types/uuid": "^8.x.x",
+        "@types/ws": "^8.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",
+        "typescript": "^4.x.x"
+    },
+    "dependencies": {
+        "koa": "^2.13.4",
+        "koatty_config": "^1.0.6",
+        "koatty_container": "^1.6.16",
+        "koatty_core": "^1.4.14",
+        "koatty_exception": "^1.0.6",
+        "koatty_lib": "^1.2.8",
+        "koatty_loader": "^1.0.2",
+        "koatty_logger": "^1.3.12",
+        "koatty_payload": "^1.3.10",
+        "koatty_router": "^1.6.4",
+        "koatty_serve": "^1.4.4",
+        "koatty_trace": "^1.5.2",
+        "reflect-metadata": "^0.1.13",
+        "tslib": "^2.3.1"
+    }
+}

package/package.json

@@ -1,33 +1,37 @@
 {
     "name": "koatty",
-    "version": "3.5.11",
+    "version": "3.5.12-3",
     "description": "Koa2 + Typescript = koatty. Use Typescript's decorator implement auto injection.",
     "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"
+    },
+    "directories": {
+        "doc": "docs"
+    },
     "repository": {
         "type": "git",
         "url": "git+https://github.com/thinkkoa/koatty.git"
     },
-    "keywords": [
-        "web",
-        "typescript",
-        "framework",
-        "mvc",
-        "koa2",
-        "restful",
-        "agile",
-        "koatty",
-        "thinkkoa"
-    ],
     "engines": {
         "node": ">12.0.0"
     },
@@ -47,27 +51,29 @@
         }
     ],
     "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/koa__router": "^8.0.9",
+        "@types/koa__router": "^8.x.x",
         "@types/node": "^16.x.x",
-        "@types/uuid": "^8.3.3",
-        "@types/ws": "^8.2.0",
+        "@types/uuid": "^8.x.x",
+        "@types/ws": "^8.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",
@@ -76,22 +82,17 @@
     "dependencies": {
         "koa": "^2.13.4",
         "koatty_config": "^1.0.6",
-        "koatty_container": "^1.6.10",
-        "koatty_core": "^1.3.38",
+        "koatty_container": "^1.6.16",
+        "koatty_core": "^1.4.14",
         "koatty_exception": "^1.0.6",
         "koatty_lib": "^1.2.8",
         "koatty_loader": "^1.0.2",
-        "koatty_logger": "^1.2.12",
+        "koatty_logger": "^1.3.12",
         "koatty_payload": "^1.3.10",
-        "koatty_router": "^1.5.14",
-        "koatty_serve": "^1.3.10",
-        "koatty_trace": "^1.4.30",
+        "koatty_router": "^1.6.4",
+        "koatty_serve": "^1.4.4",
+        "koatty_trace": "^1.5.2",
         "reflect-metadata": "^0.1.13",
         "tslib": "^2.3.1"
-    },
-    "husky": {
-        "hooks": {
-            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-        }
     }
-}
+}

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/config/config.d.ts

@@ -1,18 +0,0 @@
-declare const _default: {
-    app_port: number;
-    app_host: string;
-    protocol: string;
-    open_trace: boolean;
-    http_timeout: number;
-    key_file: string;
-    crt_file: string;
-    encoding: string;
-    logs_path: string;
-};
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-01-19 15:41:30
- */
-export default _default;

package/dist/config/config.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-01-19 15:41:30
- */
-exports.default = {
-    /*app config*/
-    app_port: 3000,
-    app_host: "",
-    protocol: "http",
-    open_trace: false,
-    http_timeout: 10,
-    key_file: "",
-    crt_file: "",
-    encoding: "utf-8",
-    // logs_level: "DEBUG", // Level log is printed to the console, "DEBUG" | "INFO" | "WARN" | "ERROR"
-    // logs_console: true, // Whether to console logs
-    // logs_write: false, // Whether to store logs
-    // logs_write_level: "WARN", // Level log is printed to the file, "DEBUG" | "INFO" | "WARN" | "ERROR"
-    logs_path: process.env.ROOT_PATH + "/logs", // Log file directory
-};
-//# sourceMappingURL=config.js.map

package/dist/config/config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,kBAAe;IACX,cAAc;IACd,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,MAAM;IAChB,UAAU,EAAE,KAAK;IACjB,YAAY,EAAE,EAAE;IAChB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,OAAO;IAEjB,mGAAmG;IACnG,iDAAiD;IACjD,8CAA8C;IAC9C,qGAAqG;IACrG,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,qBAAqB;CAEpE,CAAC"}

package/dist/config/middleware.d.ts

@@ -1,28 +0,0 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-04-30 14:52:34
- */
-declare const _default: {
-    list: any[];
-    config: {
-        TraceMiddleware: {
-            HeaderName: string;
-        };
-        PayloadMiddleware: {
-            extTypes: {
-                json: string[];
-                form: string[];
-                text: string[];
-                multipart: string[];
-                xml: string[];
-            };
-            limit: string;
-            encoding: string;
-            multiples: boolean;
-            keepExtensions: boolean;
-        };
-    };
-};
-export default _default;

package/dist/config/middleware.js

@@ -1,32 +0,0 @@
-"use strict";
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-04-30 14:52:34
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    // List of loaded middleware(except for the middleware loaded by default), 
-    // executed in the order of elements
-    list: [],
-    config: {
-        "TraceMiddleware": {
-            HeaderName: 'X-Request-Id',
-        },
-        "PayloadMiddleware": {
-            "extTypes": {
-                "json": ['application/json'],
-                "form": ['application/x-www-form-urlencoded'],
-                "text": ['text/plain'],
-                "multipart": ['multipart/form-data'],
-                "xml": ['text/xml']
-            },
-            "limit": '20mb',
-            "encoding": 'utf-8',
-            "multiples": true,
-            "keepExtensions": true
-        },
-    }
-};
-//# sourceMappingURL=middleware.js.map

package/dist/config/middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/config/middleware.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,kBAAe;IACX,2EAA2E;IAC3E,oCAAoC;IACpC,IAAI,EAAE,EAAE;IACR,MAAM,EAAE;QACJ,iBAAiB,EAAE;YACf,UAAU,EAAE,cAAc;SAC7B;QACD,mBAAmB,EAAE;YACjB,UAAU,EAAE;gBACR,MAAM,EAAE,CAAC,kBAAkB,CAAC;gBAC5B,MAAM,EAAE,CAAC,mCAAmC,CAAC;gBAC7C,MAAM,EAAE,CAAC,YAAY,CAAC;gBACtB,WAAW,EAAE,CAAC,qBAAqB,CAAC;gBACpC,KAAK,EAAE,CAAC,UAAU,CAAC;aACtB;YACD,OAAO,EAAE,MAAM;YACf,UAAU,EAAE,OAAO;YACnB,WAAW,EAAE,IAAI;YACjB,gBAAgB,EAAE,IAAI;SACzB;KACJ;CACJ,CAAC"}

package/dist/config/plugin.d.ts

@@ -1,11 +0,0 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-04-30 14:52:34
- */
-declare const _default: {
-    list: any[];
-    config: {};
-};
-export default _default;

package/dist/config/plugin.js

@@ -1,15 +0,0 @@
-"use strict";
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-04-30 14:52:34
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    // List of loaded plugins, executed in the order of elements
-    list: [],
-    config: { // plugin configuration
-    }
-};
-//# sourceMappingURL=plugin.js.map

package/dist/config/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/config/plugin.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,kBAAe;IACX,4DAA4D;IAC5D,IAAI,EAAE,EAAE;IACR,MAAM,EAAE,EAAE,uBAAuB;KAEhC;CACJ,CAAC"}

package/dist/config/router.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {};
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2019-11-01 18:37:35
- */
-export default _default;

package/dist/config/router.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2019-11-01 18:37:35
- */
-exports.default = {
-// prefix: string;
-/**
- * Methods which should be supported by the router.
- */
-// methods?: string[];
-// routerPath?: string;
-/**
- * Whether or not routing should be case-sensitive.
- */
-// sensitive?: boolean;
-/**
- * Whether or not routes should matched strictly.
- *
- * If strict matching is enabled, the trailing slash is taken into
- * account when matching routes.
- */
-// strict?: boolean;
-/**
- *  Other extended configuration
- */
-// ext?: any;
-};
-//# sourceMappingURL=router.js.map

package/dist/config/router.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"router.js","sourceRoot":"","sources":["../../src/config/router.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,kBAAe;AACX,kBAAkB;AAElB;;GAEG;AACH,sBAAsB;AAEtB,uBAAuB;AAEvB;;GAEG;AACH,uBAAuB;AAEvB;;;;;GAKG;AACH,oBAAoB;AAEpB;;GAEG;AACH,aAAa;CAChB,CAAC"}

package/dist/controller/BaseController.d.ts

@@ -1,60 +0,0 @@
-import { Koatty, KoattyContext } from 'koatty_core';
-import { ObjectDefinitionOptions } from "koatty_container";
-import { ApiInput, ApiOutput, IController } from '../core/Component';
-/**
- * Base controller
- *
- * @export
- * @class BaseController
- * @implements {IController}
- */
-export declare class BaseController implements IController {
-    app: Koatty;
-    ctx: KoattyContext;
-    protected _options: ObjectDefinitionOptions;
-    /**
-     * instance of BaseController.
-     * @param {Koatty} app
-     * @param {KoattyContext} ctx
-     * @memberof BaseController
-     */
-    protected constructor(ctx: KoattyContext);
-    /**
-     * init
-     *
-     * @protected
-     * @memberof BaseController
-     */
-    protected init(): void;
-    /**
-     * Format api interface data format
-     *
-     * @private
-     * @param {Error | string | ApiInput} msg   待处理的接口数据信息｜接口msg
-     * @param {*} data    待返回的数据
-     * @param {number} defaultCode   默认错误码
-     * @returns {ApiOutput}   格式化之后的接口数据
-     * @memberof BaseController
-     */
-    protected formatApiData(msg: any, data: any, defaultCode: number): ApiOutput;
-    /**
-     * Response to normalize json format content for success
-     *
-     * @param {(string | ApiInput)} msg   待处理的message消息
-     * @param {*} [data]    待处理的数据
-     * @param {number} [code=200]    错误码，默认0
-     * @returns {Promise<ApiOutput>}
-     * @memberof BaseController
-     */
-    ok(msg: string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
-    /**
-     * Response to normalize json format content for fail
-     *
-     * @param {(string | ApiInput)} msg
-     * @param {*} [data]
-     * @param {number} [code=1]
-     * @returns {Promise<ApiOutput>}
-     * @memberof BaseController
-     */
-    fail(msg: Error | string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
-}