koatty 3.5.10 → 3.5.12-2

package/CHANGELOG.md

@@ -2,41 +2,8 @@
 
 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.
 
-### [3.5.10](https://github.com/thinkkoa/koatty/compare/v3.4.12...v3.5.10) (2021-12-01)
+### [3.5.12-2](https://github.com/thinkkoa/koatty/compare/v3.5.12-1...v3.5.12-2) (2021-12-21)
 
-### [3.4.12](https://github.com/thinkkoa/koatty/compare/v3.4.8...v3.4.12) (2021-11-26)
+### [3.5.12-1](https://github.com/thinkkoa/koatty/compare/v3.5.12-0...v3.5.12-1) (2021-12-21)
 
-### [3.4.8](https://github.com/thinkkoa/koatty/compare/v3.4.4...v3.4.8) (2021-11-25)
-
-### [3.4.6](https://github.com/thinkkoa/koatty/compare/v3.4.4...v3.4.6) (2021-11-25)
-
-### [3.4.4](https://github.com/thinkkoa/koatty/compare/v3.4.2...v3.4.4) (2021-11-20)
-
-### [3.4.2](https://github.com/thinkkoa/koatty/compare/v3.3.6...v3.4.2) (2021-11-19)
-
-### [3.3.6](https://github.com/thinkkoa/koatty/compare/v3.2.12...v3.3.6) (2021-07-13)
-
-### [3.3.4](https://github.com/thinkkoa/koatty/compare/v3.3.3...v3.3.4) (2021-07-07)
-
-### [3.3.3](https://github.com/thinkkoa/koatty/compare/v3.3.2...v3.3.3) (2021-07-06)
-
-### [3.3.2](https://github.com/thinkkoa/koatty/compare/v3.3.0...v3.3.2) (2021-07-01)
-
-### [3.3.0](https://github.com/thinkkoa/koatty/compare/v3.2.12...v3.3.0) (2021-06-24)
-### [3.2.12](https://github.com/thinkkoa/koatty/compare/v3.2.11...v3.2.12) (2021-06-24)
-
-### [3.2.11](https://github.com/thinkkoa/koatty/compare/v3.2.10...v3.2.11) (2021-06-24)
-
-### [3.2.10](https://github.com/thinkkoa/koatty/compare/v3.2.8...v3.2.10) (2021-06-23)
-
-
-### Bug Fixes
-
-* eslint ([2297a9d](https://github.com/thinkkoa/koatty/commit/2297a9dc054e911f31dbe5d8802d982077316df7))
-
-### 3.2.8 (2021-06-21)
-
-
-### Bug Fixes
-
-* --story=[#4](https://github.com/thinkkoa/koatty/issues/4) [bug] RequestMapping内的装饰器用法范围模糊 ([93f7abd](https://github.com/thinkkoa/koatty/commit/93f7abd776bc14449e762c163a1194c6608e1cd3))
+### [3.5.12-0](https://github.com/thinkkoa/koatty/compare/v3.5.10...v3.5.12-0) (2021-12-21)

package/README.md

@@ -1,6 +1,6 @@
 # koatty
 
-Koa2 + Typescript = koatty. 
+Koa2 + Typescript + IOC = koatty. 
 
 Use Typescript's decorator implement IOC and AOP.
 
@@ -11,13 +11,13 @@ Use Typescript's decorator implement IOC and AOP.
 * HTTP、HTTPS、HTTP2 .
 * gRPC  server. 
 * WebSocket server. (unstable)
+* Support loading environment configuration, support parsing command line parameters (process. argv) and environment variables (process.env)
 
 
 ## Documentation
 
-[koatty_doc_CN](https://koatty.github.io/koatty_doc/) （In progress💪）
+[koatty_doc_CN](https://koatty.org/) （In progress💪）
 
-[koatty_doc_EN] come soon...
 
 ## Installation
 
@@ -60,14 +60,11 @@ koatty middleware test
 ```
 ### 4.Create a Model（Optional）
 
-Supports [thinkorm](https://github.com/thinkkoa/thinkorm) and [typeorm](https://github.com/typeorm/typeorm). Please expand other ORM by yourself.
+Supports [typeorm](https://github.com/typeorm/typeorm). Please expand other ORM by yourself.
 
 ```shell
-//thinkorm
-koatty middleware test
-
 //typeorm
-koatty middleware -o typeorm test
+koatty middleware test
 
 ```
 
@@ -148,4 +145,3 @@ Check out the [quick start example][quick-example].
 
 
 
-

package/dist/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Koatty
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/README.md

@@ -0,0 +1,147 @@
+# koatty
+
+Koa2 + Typescript + IOC = koatty. 
+
+Use Typescript's decorator implement IOC and AOP.
+
+[![Version npm](https://img.shields.io/npm/v/koatty.svg?style=flat-square)](https://www.npmjs.com/package/koatty)[![npm Downloads](https://img.shields.io/npm/dm/koatty.svg?style=flat-square)](https://npmcharts.com/compare/koatty?minimal=true)
+
+## New features 
+
+* HTTP、HTTPS、HTTP2 .
+* gRPC  server. 
+* WebSocket server. (unstable)
+* Support loading environment configuration, support parsing command line parameters (process. argv) and environment variables (process.env)
+
+
+## Documentation
+
+[koatty_doc_CN](https://koatty.org/) （In progress💪）
+
+
+## Installation
+
+```shell
+npm i -g koatty_cli
+```
+
+## Quick Start
+
+### 1.Create Project
+
+```shell
+koatty new projectName
+
+cd ./projectName
+
+yarn install
+
+npm start
+```
+
+### 2.Create a Controller
+```shell
+koatty controller test
+
+```
+
+### 3.Create a Service
+
+```shell
+koatty service test
+
+```
+
+### 3.Create a Middleware （Optional）
+
+```shell
+koatty middleware test
+
+```
+### 4.Create a Model（Optional）
+
+Supports [typeorm](https://github.com/typeorm/typeorm). Please expand other ORM by yourself.
+
+```shell
+//typeorm
+koatty middleware test
+
+```
+
+### 5.Create a DTOClass （Optional）
+
+```shell
+koatty dto test
+
+```
+
+### 6.Define TestController
+
+```javascript
+import { Controller, BaseController, Autowired, GetMapping, RequestBody, PathVariable, PostMapping, RequestMapping, RequestMethod, Valid } from "koatty";
+import { TestDTO } from "../model/dto/TestDTO";
+import { TestService } from "../service/TestService";
+import { App } from "../App";
+
+@Controller()
+export class IndexController extends BaseController {
+    app: App;
+
+    @Autowired()
+    private testService: TestService;
+
+    init() {
+        this.cache = {};
+    }
+
+    @RequestMapping("/:name", RequestMethod.ALL)
+    async default(@PathVariable("name") @Valid("IsNotEmpty") name: string) {
+        const info = await this.testService.sayHello(name).catch((err: any) => this.fail(err.message));
+        return info;
+    }
+
+    @PostMapping("/test")
+    @Validated() //need DTOClass
+    test(@RequestParam() params: TestDTO) {
+        return this.ok("test", params);
+    }
+}
+```
+
+## How to debug
+
+if you use vscode , edit the `.vscode/launch.json` , like this: 
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "TS Program",
+            "args": [
+                "${workspaceRoot}/src/App.ts" 
+            ],
+            "runtimeArgs": [
+                "--nolazy",
+                "-r",
+                "ts-node/register"
+            ],
+            "sourceMaps": true,
+            "cwd": "${workspaceRoot}",
+            "protocol": "inspector",
+            "internalConsoleOptions": "neverOpen"
+        }
+    ]
+}
+```
+Select `TS Program` to debug run. Try to call `http://localhost:3000/` .
+
+## Example
+
+Check out the [quick start example][quick-example].
+
+[quick-example]: https://github.com/thinkkoa/koatty_demo/
+
+
+

package/dist/index.d.ts

@@ -1,19 +1,363 @@
-/**
- * @ author: richen
- * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
- * @ license: BSD (3-Clause)
- * @ version: 2020-05-18 10:43:05
- */
-export * from "./controller/BaseController";
-export * from "./controller/HttpController";
-export * from "./core/Bootstrap";
-export * from "./core/Component";
-export * from "./service/BaseService";
-export * from "koatty_core";
-export * from "koatty_container";
-export * from "koatty_exception";
-export * from "koatty_router";
-export * from "koatty_serve";
-export * from "koatty_trace";
-export { Helper } from "./util/Helper";
-export { Logger } from "./util/Logger";
+/*!
+* @Author: richen
+* @Date: 2021-12-21 12:43:54
+* @License: BSD (3-Clause)
+* @Copyright (c) - <richenlin(at)gmail.com>
+* @HomePage: https://koatty.org/
+*/
+import { Helper } from 'koatty_lib';
+import Koa from 'koa';
+import { Koatty } from 'koatty_core';
+import { KoattyContext } from 'koatty_core';
+import { Logger as Logger_2 } from 'koatty_logger';
+import { ObjectDefinitionOptions } from 'koatty_container';
+
+/**
+ * Interface for Api input
+ */
+export declare interface ApiInput {
+    code?: number;
+    message?: string;
+    data?: any;
+}
+
+/**
+ * Interface for Api output
+ */
+export declare interface ApiOutput {
+    code: number;
+    message: string;
+    data: any;
+}
+
+export declare type AppReadyHookFunc = (app: Koatty) => Promise<any>;
+
+/**
+ * Base controller
+ *
+ * @export
+ * @class BaseController
+ * @implements {IController}
+ */
+export declare class BaseController implements IController {
+    app: Koatty;
+    readonly ctx: KoattyContext;
+    /**
+     * instance of BaseController.
+     * @param {Koatty} app
+     * @param {KoattyContext} ctx
+     * @memberof BaseController
+     */
+    /**
+     * init
+     *
+     * @protected
+     * @memberof BaseController
+     */
+    /**
+     * Response to normalize json format content for success
+     *
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @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 {*}
+     * @memberof BaseController
+     */
+    fail(msg: Error | string | ApiInput, data?: any, code?: number): any;
+}
+
+/**
+ * Base class
+ *
+ * @export
+ * @class Base
+ */
+export declare class BaseService implements IService {
+    app: Koatty;
+    /**
+     * instance of Base.
+     * @param {...any[]} arg
+     * @memberof Base
+     */
+    /**
+     * init
+     *
+     * @protected
+     * @param {...any[]} arg
+     * @memberof Base
+     */
+}
+
+/**
+ * bind AppReadyHookFunc
+ * example:
+ * export function TestDecorator(): ClassDecorator {
+ *  return (target: any) => {
+ *   BindAppReadyHook((app: Koatty) => {
+ *      // todo
+ *      return Promise.resolve();
+ *   }, target)
+ *  }
+ * }
+ *
+ * @export
+ * @param {AppReadyHookFunc} func
+ * @param {*} target
+ */
+export declare function BindAppReadyHook(func: AppReadyHookFunc, target: any): void;
+
+/**
+ * Bootstrap application
+ *
+ * @export
+ * @param {Function} [bootFunc]
+ * @returns {ClassDecorator}
+ */
+export declare function Bootstrap(bootFunc?: Function): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "component".
+ *
+ * @export
+ * @param {string} [identifier] component name
+ * @returns {ClassDecorator}
+ */
+export declare function Component(identifier?: string): ClassDecorator;
+
+/**
+ * Define project scan path
+ *
+ * @export
+ * @param {(string | string[])} [scanPath]
+ * @returns {ClassDecorator}
+ */
+export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
+
+/**
+ * Define project configuration scan path
+ *
+ * @export
+ * @param {(string | string[])} [scanPath]
+ * @returns {ClassDecorator}
+ */
+export declare function ConfigurationScan(scanPath?: string | string[]): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "controller".
+ *
+ * @export
+ * @param {string} [path] controller router path
+ * @returns {ClassDecorator}
+ */
+export declare function Controller(path?: string): ClassDecorator;
+
+export { Helper }
+
+/**
+ * HTTP controller
+ *
+ * @export
+ * @class HttpController
+ * @implements {IController}
+ */
+export declare class HttpController extends BaseController {
+    /**
+     * Whether it is a GET request
+     *
+     * @public
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isGet(): boolean;
+    /**
+     * Whether it is a POST request
+     *
+     * @public
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isPost(): boolean;
+    /**
+     * Determines whether the METHOD request is specified
+     *
+     * @public
+     * @param {string} method
+     * @returns {boolean}
+     * @memberof HttpController
+     */
+    isMethod(method: string): boolean;
+    /**
+     * Get/Set headers.
+     *
+     * @public
+     * @param {string} [name]
+     * @param {*} [value]
+     * @returns {*}
+     * @memberof HttpController
+     */
+    header(name?: string, value?: any): any;
+    /**
+     * Get POST/GET parameters, the POST value is priority.
+     *
+     * @param {string} [name]
+     * @returns
+     * @memberof HttpController
+     */
+    param(name?: string): any;
+    /**
+     * Set response content-type
+     *
+     * @public
+     * @param {string} contentType
+     * @param {(string | boolean)} [encoding]
+     * @returns {string}
+     * @memberof HttpController
+     */
+    type(contentType: string, encoding?: string | boolean): string;
+    /**
+     * set cache-control and expires header
+     *
+     * @public
+     * @param {number} [timeout=30]
+     * @returns {void}
+     * @memberof HttpController
+     */
+    expires(timeout?: number): void;
+    /**
+     * Url redirect
+     *
+     * @param {string} urls
+     * @param {string} [alt]
+     * @returns {void}
+     * @memberof HttpController
+     */
+    redirect(urls: string, alt?: string): void;
+    /**
+     * Block access
+     *
+     * @param {number} [code=403]
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    deny(code?: number): Promise<any>;
+    /**
+     * Set response Body content
+     *
+     * @param {*} data
+     * @param {string} [contentType]
+     * @param {string} [encoding]
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    body(data: any, contentType?: string, encoding?: string): Promise<any>;
+    /**
+     * Respond to json formatted content
+     *
+     * @param {*} data
+     * @returns {Promise<any>}
+     * @memberof HttpController
+     */
+    json(data: any): Promise<any>;
+    /**
+     * Response to normalize json format content for success
+     *
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @memberof HttpController
+     */
+    ok(msg: string | ApiInput, data?: any, code?: number): Promise<any>;
+    /**
+     * Response to normalize json format content for fail
+     *
+     * @param {(string | ApiInput)} msg
+     * @param {*} [data]
+     * @param {number} [code=1]
+     * @returns {*}
+     * @memberof HttpController
+     */
+    fail(msg: Error | string | ApiInput, data?: any, code?: number): Promise<any>;
+}
+
+/**
+ * Interface for Controller
+ */
+export declare interface IController {
+    app: Koatty;
+    readonly ctx: KoattyContext;
+    __befor?: () => Promise<any>;
+    __after?: () => Promise<any>;
+    readonly fail: (msg?: Error | string | ApiInput, data?: any, ret?: number) => Promise<any>;
+    readonly ok: (msg?: string | ApiInput, data?: any, ret?: number) => Promise<any>;
+}
+
+/**
+ * Interface for Middleware
+ */
+export declare interface IMiddleware {
+    run: (options: any, app: Koatty) => Koa.Middleware;
+}
+
+/**
+ * Interface for Plugin
+ */
+export declare interface IPlugin {
+    run: (options: any, app: Koatty) => Promise<any>;
+}
+
+/**
+ * Interface for Service
+ */
+export declare interface IService {
+    app: Koatty;
+}
+
+export declare const Logger: Logger_2;
+
+/**
+ * Indicates that an decorated class is a "middleware".
+ *
+ * @export
+ * @param {string} [identifier] middleware name
+ * @returns {ClassDecorator}
+ */
+export declare function Middleware(identifier?: string): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "plugin".
+ *
+ * @export
+ * @param {string} [identifier]
+ * @returns {ClassDecorator}
+ */
+export declare function Plugin(identifier?: string): ClassDecorator;
+
+/**
+ * Indicates that an decorated class is a "service".
+ *
+ * @export
+ * @param {string} [identifier] middleware name
+ * @returns {ClassDecorator}
+ */
+export declare function Service(identifier?: string): ClassDecorator;
+
+
+export * from "koatty_container";
+export * from "koatty_core";
+export * from "koatty_exception";
+export * from "koatty_router";
+export * from "koatty_serve";
+export * from "koatty_trace";
+
+export { }