koatty 3.11.4-2 → 3.11.6

package/dist/README.md

@@ -1,168 +1,177 @@
-# 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、WebSocket server.
-* Support loading environment configuration, parsing command line parameters (process.argv) and environment variables (process.env)
-* `@ExceptionHandler()` Register global exception handling
-* graceful shutdown and pre-exit event
-* custom decorator based on app events
-
-
-## Documentation
-
-[koatty_doc_CN](https://koatty.org/) （In progress💪）
-
-
-## Installation CLI tools
-
-```shell
-npm i -g koatty_cli
-```
-
-## Quick Start
-
-### 1.Create Project
-
-```shell
-kt new projectName
-
-```
-
-### 2. Install deps
-
-```
-cd ./projectName
-
-npm i
-```
-
-### 3. Start up
-
-```
-npm run dev
-
-// or
-npm start
-```
-
-## Code style
-
-default Controller:
-
-```javascript
-import { Controller, Autowired, GetMapping, RequestBody, PathVariable,
- PostMapping, RequestMapping, RequestMethod, Valid, Output } from "koatty";
-import { TestDTO } from "../model/dto/TestDTO";
-import { TestService } from "../service/TestService";
-import { App } from "../App";
-
-@Controller()
-export class IndexController {
-    app: App;
-    ctx: KoattyContext;
-
-    @Autowired()
-    private testService: TestService;
-
-    /**
-     * constructor
-     *
-     */
-    constructor(ctx: KoattyContext) {
-        this.ctx = ctx;
-    }
-
-    @RequestMapping("/:name", RequestMethod.ALL)
-    async default(@PathVariable("name") @Valid("IsNotEmpty") name: string) {
-        try {
-            const info = await this.testService.sayHello(name);
-            return Output.ok(this.ctx, "success", info);
-        } catch (err: Error) {
-            return Output.fail(this.ctx, err.message));
-        }
-    }
-
-    @PostMapping("/test")
-    @Validated() //need DTOClass
-    test(@RequestParam() params: TestDTO) {
-        return Output.ok(this.ctx, "test", params);
-    }
-}
-```
-
-## How to do Unit Testing
-
->only support `jest` UT framework now 
-
-```javascript
-import request from 'supertest';
-import { ExecBootStrap } from 'koatty';
-import { App } from '../src/App';
-
-describe('UT example', () => {
-
-  let server: any;
-  beforeAll(async () => {
-    jest.useFakeTimers();
-    const appInstance = await ExecBootStrap()(App);
-    server = await appInstance.listen();
-  });
-
-  afterAll(done => {
-    server.close();
-    done();
-  });
-
-  it('request', async () => {
-    const rsp = await request(server).get('/');
-    expect(rsp.status).toBe(200);
-  });
-});
-
-```
-
-## 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",
-            "outputCapture": "std",
-            "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/Koatty/koatty_template
-
-
-
+# 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、WebSocket server.
+* Support loading environment configuration, parsing command line parameters (process.argv) and environment variables (process.env)
+* `@ExceptionHandler()` Register global exception handling
+* graceful shutdown and pre-exit event
+* custom decorator based on app events
+
+
+## Documentation
+
+[koatty_doc_CN](https://koatty.org/) （In progress💪）
+
+
+## Installation CLI tools
+
+```shell
+npm i -g koatty_cli
+```
+
+## Quick Start
+
+### 1.Create Project
+
+```shell
+kt new projectName
+
+```
+
+### 2. Install deps
+
+```
+cd ./projectName
+
+npm i
+```
+
+### 3. Start up
+
+```
+npm run dev
+
+// or
+npm start
+```
+
+## Code style
+
+default Controller:
+
+```javascript
+import { Controller, Autowired, GetMapping, RequestBody, PathVariable,
+ PostMapping, RequestMapping, RequestMethod, Valid, Output } from "koatty";
+import { TestDTO } from "../model/dto/TestDTO";
+import { TestService } from "../service/TestService";
+import { App } from "../App";
+
+@Controller()
+export class IndexController {
+    app: App;
+    ctx: KoattyContext;
+
+    @Autowired()
+    private testService: TestService;
+
+    /**
+     * constructor
+     *
+     */
+    constructor(ctx: KoattyContext) {
+        this.ctx = ctx;
+    }
+
+    @GetMapping('/')
+    index() {
+        return Output.ok("Hello, koatty!");
+    }
+
+    @RequestMapping("/:name", RequestMethod.ALL)
+    async default(@PathVariable("name") @Valid("IsNotEmpty") name: string) {
+        try {
+            const info = await this.testService.sayHello(name);
+            return Output.ok(this.ctx, "success", info);
+        } catch (err: Error) {
+            return Output.fail(this.ctx, err.message));
+        }
+    }
+
+    @PostMapping("/test")
+    @Validated() //need DTOClass
+    test(@RequestParam() params: TestDTO) {
+        return Output.ok(this.ctx, "test", params);
+    }
+}
+```
+
+## How to do Unit Testing
+
+>only support `jest` UT framework now 
+
+```javascript
+import request from 'supertest';
+import { ExecBootStrap } from 'koatty';
+import { App } from '../src/App';
+
+describe('UT example', () => {
+
+  let app: KoattyApplication;
+  beforeAll(async () => {
+    jest.useFakeTimers();
+    // test env
+    process.env.KOATTY_ENV = 'ts-node';
+    app = await ExecBootStrap()(App);
+    // app.use(async (ctx: any) => {
+    //   ctx.body = 'Hello, World!';
+    // });
+  });
+
+  afterAll(done => {
+    done();
+    jest.clearAllMocks();
+  });
+
+  it('request', async () => {
+    const res = await request(app.callback()).get('/');
+    expect(res.status).toBe(200);
+  });
+});
+
+```
+
+## 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",
+            "outputCapture": "std",
+            "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/Koatty/koatty_template
+
+
+

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2024-04-15 05:09:35
+* @Date: 2024-12-05 11:22:38
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -9,20 +9,15 @@ import { AppEvent } from 'koatty_core';
 import { Config } from 'koatty_config';
 import { EventHookFunc } from 'koatty_core';
 import { Helper } from 'koatty_lib';
-import { IAspect } from 'koatty_container';
-import { Koatty } from 'koatty_core';
-import { KoattyContext } from 'koatty_core';
+import { KoattyApplication } from 'koatty_core';
 import { Logger as Logger_2 } from 'koatty_logger';
-import { Middleware as Middleware_2 } from 'koa';
-import { Next } from 'koa';
-import { Value } from 'koatty_config';
 
 /**
  * @description: bind App event hook func
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: Function) => {
- *   BindEventHook(AppEvent.appBoot, (app: Koatty) => {
+ *   BindEventHook(AppEvent.appBoot, (app: KoattyApplication) => {
  *      // todo
  *      return Promise.resolve();
  *   }, target)
@@ -36,7 +31,7 @@ import { Value } from 'koatty_config';
 export declare function BindEventHook(eventName: AppEvent, eventFunc: EventHookFunc, target: any): void;
 
 /**
- * Bootstrap application
+ * Bootstrap application decorator
  *
  * @export
  * @param {Function} [bootFunc]
@@ -44,15 +39,6 @@ export declare function BindEventHook(eventName: AppEvent, eventFunc: EventHookF
  */
 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
  *
@@ -73,15 +59,6 @@ export { Config }
  */
 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;
-
 /**
  * Actively perform dependency injection
  * Parse the decorator, return the instantiated app.
@@ -89,116 +66,15 @@ export declare function Controller(path?: string): ClassDecorator;
  * @param {Function} [bootFunc] callback function
  * @returns
  */
-export declare function ExecBootStrap(bootFunc?: Function): (target: any) => Promise<Koatty>;
+export declare function ExecBootStrap(bootFunc?: Function): (target: any) => Promise<KoattyApplication>;
 
 export { Helper }
 
-/**
- * Interface for Controller
- */
-export declare interface IController {
-    readonly app: Koatty;
-    readonly ctx: KoattyContext;
-}
-
-/**
- * Interface for Middleware
- */
-export declare interface IMiddleware {
-    run: (options: any, app: Koatty) => (ctx: KoattyContext, next: Next) => Promise<any>;
-}
-
-/**
- * check is implements Aspect Interface
- * @param cls
- * @returns
- */
-export declare function implementsAspectInterface(cls: any): cls is IAspect;
-
-/**
- * check is implements Controller Interface
- * @param cls
- * @returns
- */
-export declare function implementsControllerInterface(cls: any): cls is IController;
-
-/**
- * check is implements Middleware Interface
- * @param cls
- * @returns
- */
-export declare function implementsMiddlewareInterface(cls: any): cls is IMiddleware;
-
-/**
- * check is implements Plugin Interface
- * @param cls
- * @returns
- */
-export declare function implementsPluginInterface(cls: any): cls is IPlugin;
-
-/**
- * check is implements Service Interface
- * @param cls
- * @returns
- */
-export declare function implementsServiceInterface(cls: any): cls is IService;
-
-/**
- * Interface for Plugin
- */
-export declare interface IPlugin {
-    run: (options: any, app: Koatty) => Promise<any>;
-}
-
-/**
- * Interface for Service
- */
-export declare interface IService {
-    readonly app: Koatty;
-}
-
-/**
- * Interface for Middleware
- */
-export declare interface KoattyMiddleware extends Middleware_2 {
-}
-
 export declare const Logger: Logger_2;
 
-/**
- * Indicates that an decorated class is a "middleware".
- *
- * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
- */
-export declare function Middleware(identifier?: string): ClassDecorator;
-
-/**
- * Indicates that an decorated class is a "plugin".
- *
- * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
- */
-export declare function Plugin(identifier?: string): ClassDecorator;
-
-/**
- * Indicates that an decorated class is a "service".
- *
- * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
- */
-export declare function Service(identifier?: string): ClassDecorator;
-
-export { Value }
-
 
 export * from "koatty_container";
 export * from "koatty_core";
-export * from "koatty_exception";
 export * from "koatty_router";
-export * from "koatty_serve";
 
 export { }