koatty 3.5.11 → 3.5.12-0

package/dist/package.json

@@ -0,0 +1,99 @@
+{
+    "name": "koatty",
+    "version": "3.5.12-0",
+    "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": "./index.js",
+        "import": "./index.mjs"
+    },
+    "typings": "index.d.ts",
+    "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.12",
+        "koatty_core": "^1.4.6",
+        "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.2",
+        "koatty_serve": "^1.4.2",
+        "koatty_trace": "^1.5.0",
+        "reflect-metadata": "^0.1.13",
+        "tslib": "^2.3.1"
+    }
+}

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [koatty](./koatty.md) |  |
+

package/docs/api/koatty.apiinput.code.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md) &gt; [code](./koatty.apiinput.code.md)
+
+## ApiInput.code property
+
+<b>Signature:</b>
+
+```typescript
+code?: number;
+```

package/docs/api/koatty.apiinput.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md) &gt; [data](./koatty.apiinput.data.md)
+
+## ApiInput.data property
+
+<b>Signature:</b>
+
+```typescript
+data?: any;
+```

package/docs/api/koatty.apiinput.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md)
+
+## ApiInput interface
+
+Interface for Api input
+
+<b>Signature:</b>
+
+```typescript
+export interface ApiInput 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [code?](./koatty.apiinput.code.md) | number | <i>(Optional)</i> |
+|  [data?](./koatty.apiinput.data.md) | any | <i>(Optional)</i> |
+|  [message?](./koatty.apiinput.message.md) | string | <i>(Optional)</i> |
+

package/docs/api/koatty.apiinput.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiInput](./koatty.apiinput.md) &gt; [message](./koatty.apiinput.message.md)
+
+## ApiInput.message property
+
+<b>Signature:</b>
+
+```typescript
+message?: string;
+```

package/docs/api/koatty.apioutput.code.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiOutput](./koatty.apioutput.md) &gt; [code](./koatty.apioutput.code.md)
+
+## ApiOutput.code property
+
+<b>Signature:</b>
+
+```typescript
+code: number;
+```

package/docs/api/koatty.apioutput.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiOutput](./koatty.apioutput.md) &gt; [data](./koatty.apioutput.data.md)
+
+## ApiOutput.data property
+
+<b>Signature:</b>
+
+```typescript
+data: any;
+```

package/docs/api/koatty.apioutput.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiOutput](./koatty.apioutput.md)
+
+## ApiOutput interface
+
+Interface for Api output
+
+<b>Signature:</b>
+
+```typescript
+export interface ApiOutput 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [code](./koatty.apioutput.code.md) | number |  |
+|  [data](./koatty.apioutput.data.md) | any |  |
+|  [message](./koatty.apioutput.message.md) | string |  |
+

package/docs/api/koatty.apioutput.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ApiOutput](./koatty.apioutput.md) &gt; [message](./koatty.apioutput.message.md)
+
+## ApiOutput.message property
+
+<b>Signature:</b>
+
+```typescript
+message: string;
+```

package/docs/api/koatty.appreadyhookfunc.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [AppReadyHookFunc](./koatty.appreadyhookfunc.md)
+
+## AppReadyHookFunc type
+
+<b>Signature:</b>
+
+```typescript
+export declare type AppReadyHookFunc = (app: Koatty) => Promise<any>;
+```

package/docs/api/koatty.basecontroller._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [(constructor)](./koatty.basecontroller._constructor_.md)
+
+## BaseController.(constructor)
+
+instance of BaseController.
+
+<b>Signature:</b>
+
+```typescript
+protected constructor(ctx: KoattyContext);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ctx | KoattyContext |  BaseController |
+

package/docs/api/koatty.basecontroller._options.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [\_options](./koatty.basecontroller._options.md)
+
+## BaseController.\_options property
+
+<b>Signature:</b>
+
+```typescript
+protected _options: ObjectDefinitionOptions;
+```

package/docs/api/koatty.basecontroller.app.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [app](./koatty.basecontroller.app.md)
+
+## BaseController.app property
+
+<b>Signature:</b>
+
+```typescript
+app: Koatty;
+```

package/docs/api/koatty.basecontroller.ctx.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [ctx](./koatty.basecontroller.ctx.md)
+
+## BaseController.ctx property
+
+<b>Signature:</b>
+
+```typescript
+readonly ctx: KoattyContext;
+```

package/docs/api/koatty.basecontroller.fail.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [fail](./koatty.basecontroller.fail.md)
+
+## BaseController.fail() method
+
+Response to normalize json format content for fail
+
+<b>Signature:</b>
+
+```typescript
+fail(msg: Error | string | ApiInput, data?: any, code?: number): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  msg | Error \| string \| [ApiInput](./koatty.apiinput.md) |  |
+|  data | any |  |
+|  code | number |  |
+
+<b>Returns:</b>
+
+any
+
+{<!-- -->\*<!-- -->}  BaseController
+

package/docs/api/koatty.basecontroller.init.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [init](./koatty.basecontroller.init.md)
+
+## BaseController.init() method
+
+init
+
+  BaseController
+
+<b>Signature:</b>
+
+```typescript
+protected init(): void;
+```
+<b>Returns:</b>
+
+void
+

package/docs/api/koatty.basecontroller.md

@@ -0,0 +1,39 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md)
+
+## BaseController class
+
+Base controller
+
+  BaseController  {<!-- -->IController<!-- -->}
+
+<b>Signature:</b>
+
+```typescript
+export declare class BaseController implements IController 
+```
+<b>Implements:</b> [IController](./koatty.icontroller.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(ctx)](./koatty.basecontroller._constructor_.md) |  | instance of BaseController. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [\_options](./koatty.basecontroller._options.md) |  | ObjectDefinitionOptions |  |
+|  [app](./koatty.basecontroller.app.md) |  | Koatty |  |
+|  [ctx](./koatty.basecontroller.ctx.md) |  | KoattyContext |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [fail(msg, data, code)](./koatty.basecontroller.fail.md) |  | Response to normalize json format content for fail |
+|  [init()](./koatty.basecontroller.init.md) |  | init  BaseController |
+|  [ok(msg, data, code)](./koatty.basecontroller.ok.md) |  | Response to normalize json format content for success |
+

package/docs/api/koatty.basecontroller.ok.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseController](./koatty.basecontroller.md) &gt; [ok](./koatty.basecontroller.ok.md)
+
+## BaseController.ok() method
+
+Response to normalize json format content for success
+
+<b>Signature:</b>
+
+```typescript
+ok(msg: string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  msg | string \| [ApiInput](./koatty.apiinput.md) | 待处理的message消息 |
+|  data | any | 待处理的数据 |
+|  code | number | 错误码，默认0 |
+
+<b>Returns:</b>
+
+Promise&lt;[ApiOutput](./koatty.apioutput.md)<!-- -->&gt;
+
+{<!-- -->\*<!-- -->}  BaseController
+

package/docs/api/koatty.baseservice._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md) &gt; [(constructor)](./koatty.baseservice._constructor_.md)
+
+## BaseService.(constructor)
+
+instance of Base.
+
+<b>Signature:</b>
+
+```typescript
+protected constructor(...arg: any[]);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  arg | any\[\] |  Base |
+

package/docs/api/koatty.baseservice._options.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md) &gt; [\_options](./koatty.baseservice._options.md)
+
+## BaseService.\_options property
+
+<b>Signature:</b>
+
+```typescript
+protected _options: ObjectDefinitionOptions;
+```

package/docs/api/koatty.baseservice.app.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md) &gt; [app](./koatty.baseservice.app.md)
+
+## BaseService.app property
+
+<b>Signature:</b>
+
+```typescript
+app: Koatty;
+```

package/docs/api/koatty.baseservice.init.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md) &gt; [init](./koatty.baseservice.init.md)
+
+## BaseService.init() method
+
+init
+
+
+<b>Signature:</b>
+
+```typescript
+protected init(...arg: any[]): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  arg | any\[\] |  Base |
+
+<b>Returns:</b>
+
+void
+

package/docs/api/koatty.baseservice.md

@@ -0,0 +1,36 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md)
+
+## BaseService class
+
+Base class
+
+  Base
+
+<b>Signature:</b>
+
+```typescript
+export declare class BaseService implements IService 
+```
+<b>Implements:</b> [IService](./koatty.iservice.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(arg)](./koatty.baseservice._constructor_.md) |  | instance of Base. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [\_options](./koatty.baseservice._options.md) |  | ObjectDefinitionOptions |  |
+|  [app](./koatty.baseservice.app.md) |  | Koatty |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [init(arg)](./koatty.baseservice.init.md) |  | init |
+

package/docs/api/koatty.bindappreadyhook.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BindAppReadyHook](./koatty.bindappreadyhook.md)
+
+## BindAppReadyHook() function
+
+bind AppReadyHookFunc example: export function TestDecorator(): ClassDecorator { return (target: any) =<!-- -->&gt; { BindAppReadyHook((app: Koatty) =<!-- -->&gt; { // todo return Promise.resolve(); }<!-- -->, target) } }
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function BindAppReadyHook(func: AppReadyHookFunc, target: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  func | [AppReadyHookFunc](./koatty.appreadyhookfunc.md) |  |
+|  target | any |  |
+
+<b>Returns:</b>
+
+void
+

package/docs/api/koatty.bootstrap.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Bootstrap](./koatty.bootstrap.md)
+
+## Bootstrap() function
+
+Bootstrap application
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function Bootstrap(bootFunc?: Function): ClassDecorator;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  bootFunc | Function |  |
+
+<b>Returns:</b>
+
+ClassDecorator
+
+{<!-- -->ClassDecorator<!-- -->}
+

package/docs/api/koatty.component.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Component](./koatty.component.md)
+
+## Component() function
+
+Indicates that an decorated class is a "component".
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function Component(identifier?: string): ClassDecorator;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  identifier | string | component name |
+
+<b>Returns:</b>
+
+ClassDecorator
+
+{<!-- -->ClassDecorator<!-- -->}
+

package/docs/api/koatty.componentscan.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ComponentScan](./koatty.componentscan.md)
+
+## ComponentScan() function
+
+Define project scan path
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  scanPath | string \| string\[\] |  |
+
+<b>Returns:</b>
+
+ClassDecorator
+
+{<!-- -->ClassDecorator<!-- -->}
+

package/docs/api/koatty.configurationscan.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [ConfigurationScan](./koatty.configurationscan.md)
+
+## ConfigurationScan() function
+
+Define project configuration scan path
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function ConfigurationScan(scanPath?: string | string[]): ClassDecorator;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  scanPath | string \| string\[\] |  |
+
+<b>Returns:</b>
+
+ClassDecorator
+
+{<!-- -->ClassDecorator<!-- -->}
+