koatty 3.8.3 → 3.9.1-0

package/dist/README.md

@@ -1,162 +1,162 @@
-# 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
-
-
-## 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
-
-npm start
-```
-
-### 2. Install deps
-
-```
-cd ./projectName
-
-npm i
-```
-
-### 3. Start up
-
-```
-npm run dev
-
-// or
-npm start
-```
-
-## Code style
-
-default Controller:
-
-```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) {
-        try {
-            const info = await this.testService.sayHello(name);
-            return this.ok("success", info);
-        } catch (err: Error) {
-            return this.fail(err.message));
-        }
-    }
-
-    @PostMapping("/test")
-    @Validated() //need DTOClass
-    test(@RequestParam() params: TestDTO) {
-        return this.ok("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",
-            "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/
-
-
-
+# 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
+
+
+## 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
+
+npm start
+```
+
+### 2. Install deps
+
+```
+cd ./projectName
+
+npm i
+```
+
+### 3. Start up
+
+```
+npm run dev
+
+// or
+npm start
+```
+
+## Code style
+
+default Controller:
+
+```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) {
+        try {
+            const info = await this.testService.sayHello(name);
+            return this.ok("success", info);
+        } catch (err: Error) {
+            return this.fail(err.message));
+        }
+    }
+
+    @PostMapping("/test")
+    @Validated() //need DTOClass
+    test(@RequestParam() params: TestDTO) {
+        return this.ok("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",
+            "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,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-05-23 15:33:40
+* @Date: 2023-07-26 22:34:48
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -100,7 +100,7 @@ export declare class BaseService implements IService {
 }
 
 /**
- * bind AppReadyHookFunc
+ * bind AppBootHookFunc
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {
@@ -244,7 +244,6 @@ export { Value }
 export * from "koatty_container";
 export * from "koatty_core";
 export * from "koatty_exception";
-export * from "koatty_router";
 export * from "koatty_serve";
 
 export { }

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-05-23 15:33:18
+* @Date: 2023-07-26 22:34:34
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -8,19 +8,17 @@
 'use strict';
 
 require('reflect-metadata');
-var fs = require('fs');
 var koatty_core = require('koatty_core');
-var koatty_router = require('koatty_router');
-var koatty_container = require('koatty_container');
-var koatty_serve = require('koatty_serve');
 var path = require('path');
 var koatty_loader = require('koatty_loader');
 var koatty_config = require('koatty_config');
 var koatty_logger = require('koatty_logger');
 var koatty_exception = require('koatty_exception');
 var koatty_lib = require('koatty_lib');
+var koatty_container = require('koatty_container');
 var koatty_trace = require('koatty_trace');
 var koatty_payload = require('koatty_payload');
+var koatty_serve = require('koatty_serve');
 
 function _interopNamespaceDefault(e) {
   var n = Object.create(null);
@@ -154,13 +152,13 @@ const COMPONENT_SCAN = 'COMPONENT_SCAN';
 const CONFIGURATION_SCAN = 'CONFIGURATION_SCAN';
 const APP_BOOT_HOOK = "APP_BOOT_HOOK";
 // tslint:disable: no-irregular-whitespace
-const LOGO = `
-
-┬┌─┌─┐┌─┐┌┬┐┌┬┐┬ ┬
-├┴┐│ │├─┤ │  │ └┬┘
-┴ ┴└─┘┴ ┴ ┴  ┴  ┴ 
--------------------------------------------
-https://github.com/koatty
+const LOGO = `
+
+┬┌─┌─┐┌─┐┌┬┐┌┬┐┬ ┬
+├┴┐│ │├─┤ │  │ └┬┘
+┴ ┴└─┘┴ ┴ ┴  ┴  ┴ 
+-------------------------------------------
+https://github.com/koatty
 `;
 
 /**
@@ -616,7 +614,7 @@ class Loader {
     }
 }
 
-var version = "3.8.3";
+var version = "3.9.1-0";
 var engines = {
 	node: ">12.0.0"
 };
@@ -734,10 +732,10 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         const controllers = Loader.LoadControllers(app);
         // Create Server
         // app.server = newServe(app);
-        koatty_lib.Helper.define(app, "server", newServe(app));
+        koatty_lib.Helper.define(app, "server", koatty_serve.NewServe(app));
         // Create router
         // app.router = newRouter(app);
-        koatty_lib.Helper.define(app, "router", newRouter(app));
+        koatty_lib.Helper.define(app, "router", koatty_serve.NewRouter(app));
         // Emit app ready event
         Logger.Log('Koatty', '', 'Emit App Ready ...');
         await asyncEvent(app, 'appReady');
@@ -755,19 +753,6 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         process.exit();
     }
 };
-/**
- * create router
- *
- * @export
- * @param {Koatty} app
- * @returns {*}
- */
-const newRouter = function (app) {
-    const protocol = app.config("protocol") || "http";
-    const options = app.config(undefined, 'router') ?? {};
-    const router = koatty_router.NewRouter(app, options, protocol);
-    return router;
-};
 /**
  * Listening callback function
  *
@@ -791,43 +776,6 @@ const listenCallback = (app) => {
     // Set Logger
     Loader.SetLogger(app);
 };
-/**
- * create serve
- *
- * @param {Koatty} app
- * @returns {*}
- */
-const newServe = function (app) {
-    const protocol = app.config("protocol") || "http";
-    const port = process.env.PORT || process.env.APP_PORT ||
-        app.config('app_port') || 3000;
-    const hostname = process.env.IP ||
-        process.env.HOSTNAME?.replace(/-/g, '.') || app.config('app_host') || '127.0.0.1';
-    const options = {
-        hostname, port, protocol,
-        ext: {
-            key: "",
-            cert: "",
-            protoFile: "",
-        },
-    };
-    const pm = new Set(["https", "http2", "wss"]);
-    if (pm.has(options.protocol)) {
-        const keyFile = app.config("key_file") ?? "";
-        const crtFile = app.config("crt_file") ?? "";
-        options.ext.key = fs.readFileSync(keyFile).toString();
-        options.ext.cert = fs.readFileSync(crtFile).toString();
-    }
-    if (options.protocol === "https" || options.protocol === "http2") {
-        options.port = options.port == 80 ? 443 : options.port;
-    }
-    if (options.protocol === "grpc") {
-        const proto = app.config("protoFile", "router");
-        options.ext.protoFile = proto;
-    }
-    const server = koatty_serve.Serve(app, options);
-    return server;
-};
 /**
  * Execute event as async
  *
@@ -907,7 +855,7 @@ function ConfigurationScan(scanPath) {
     };
 }
 /**
- * bind AppReadyHookFunc
+ * bind AppBootHookFunc
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {
@@ -956,7 +904,7 @@ function Controller(path = "") {
     return (target) => {
         const identifier = koatty_container.IOCContainer.getIdentifier(target);
         koatty_container.IOCContainer.saveClass("CONTROLLER", target, identifier);
-        koatty_container.IOCContainer.savePropertyData(koatty_router.CONTROLLER_ROUTER, path, target, identifier);
+        koatty_container.IOCContainer.savePropertyData(koatty_serve.CONTROLLER_ROUTER, path, target, identifier);
     };
 }
 /**
@@ -1060,10 +1008,10 @@ Object.keys(koatty_core).forEach(function (k) {
     get: function () { return koatty_core[k]; }
   });
 });
-Object.keys(koatty_router).forEach(function (k) {
+Object.keys(koatty_exception).forEach(function (k) {
   if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
     enumerable: true,
-    get: function () { return koatty_router[k]; }
+    get: function () { return koatty_exception[k]; }
   });
 });
 Object.keys(koatty_container).forEach(function (k) {
@@ -1078,9 +1026,3 @@ Object.keys(koatty_serve).forEach(function (k) {
     get: function () { return koatty_serve[k]; }
   });
 });
-Object.keys(koatty_exception).forEach(function (k) {
-  if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return koatty_exception[k]; }
-  });
-});

package/dist/index.mjs

@@ -1,20 +1,13 @@
 /*!
 * @Author: richen
-* @Date: 2023-05-23 15:33:18
+* @Date: 2023-07-26 22:34:34
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
 import 'reflect-metadata';
-import fs from 'fs';
 import { Koatty } from 'koatty_core';
 export * from 'koatty_core';
-import { NewRouter, CONTROLLER_ROUTER } from 'koatty_router';
-export * from 'koatty_router';
-import { IOCContainer, TAGGED_CLS } from 'koatty_container';
-export * from 'koatty_container';
-import { BindProcessEvent, Serve } from 'koatty_serve';
-export * from 'koatty_serve';
 import * as path from 'path';
 import { Load } from 'koatty_loader';
 import { LoadConfigs } from 'koatty_config';
@@ -24,8 +17,12 @@ import { prevent } from 'koatty_exception';
 export * from 'koatty_exception';
 import { Helper } from 'koatty_lib';
 export { Helper } from 'koatty_lib';
+import { IOCContainer, TAGGED_CLS } from 'koatty_container';
+export * from 'koatty_container';
 import { Trace } from 'koatty_trace';
 import { Payload } from 'koatty_payload';
+import { NewServe, NewRouter, BindProcessEvent, CONTROLLER_ROUTER } from 'koatty_serve';
+export * from 'koatty_serve';
 
 /**
  * @ author: richen
@@ -140,13 +137,13 @@ const COMPONENT_SCAN = 'COMPONENT_SCAN';
 const CONFIGURATION_SCAN = 'CONFIGURATION_SCAN';
 const APP_BOOT_HOOK = "APP_BOOT_HOOK";
 // tslint:disable: no-irregular-whitespace
-const LOGO = `
-
-┬┌─┌─┐┌─┐┌┬┐┌┬┐┬ ┬
-├┴┐│ │├─┤ │  │ └┬┘
-┴ ┴└─┘┴ ┴ ┴  ┴  ┴ 
--------------------------------------------
-https://github.com/koatty
+const LOGO = `
+
+┬┌─┌─┐┌─┐┌┬┐┌┬┐┬ ┬
+├┴┐│ │├─┤ │  │ └┬┘
+┴ ┴└─┘┴ ┴ ┴  ┴  ┴ 
+-------------------------------------------
+https://github.com/koatty
 `;
 
 /**
@@ -602,7 +599,7 @@ class Loader {
     }
 }
 
-var version = "3.8.3";
+var version = "3.9.1-0";
 var engines = {
 	node: ">12.0.0"
 };
@@ -720,10 +717,10 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         const controllers = Loader.LoadControllers(app);
         // Create Server
         // app.server = newServe(app);
-        Helper.define(app, "server", newServe(app));
+        Helper.define(app, "server", NewServe(app));
         // Create router
         // app.router = newRouter(app);
-        Helper.define(app, "router", newRouter(app));
+        Helper.define(app, "router", NewRouter(app));
         // Emit app ready event
         Logger.Log('Koatty', '', 'Emit App Ready ...');
         await asyncEvent(app, 'appReady');
@@ -741,19 +738,6 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         process.exit();
     }
 };
-/**
- * create router
- *
- * @export
- * @param {Koatty} app
- * @returns {*}
- */
-const newRouter = function (app) {
-    const protocol = app.config("protocol") || "http";
-    const options = app.config(undefined, 'router') ?? {};
-    const router = NewRouter(app, options, protocol);
-    return router;
-};
 /**
  * Listening callback function
  *
@@ -777,43 +761,6 @@ const listenCallback = (app) => {
     // Set Logger
     Loader.SetLogger(app);
 };
-/**
- * create serve
- *
- * @param {Koatty} app
- * @returns {*}
- */
-const newServe = function (app) {
-    const protocol = app.config("protocol") || "http";
-    const port = process.env.PORT || process.env.APP_PORT ||
-        app.config('app_port') || 3000;
-    const hostname = process.env.IP ||
-        process.env.HOSTNAME?.replace(/-/g, '.') || app.config('app_host') || '127.0.0.1';
-    const options = {
-        hostname, port, protocol,
-        ext: {
-            key: "",
-            cert: "",
-            protoFile: "",
-        },
-    };
-    const pm = new Set(["https", "http2", "wss"]);
-    if (pm.has(options.protocol)) {
-        const keyFile = app.config("key_file") ?? "";
-        const crtFile = app.config("crt_file") ?? "";
-        options.ext.key = fs.readFileSync(keyFile).toString();
-        options.ext.cert = fs.readFileSync(crtFile).toString();
-    }
-    if (options.protocol === "https" || options.protocol === "http2") {
-        options.port = options.port == 80 ? 443 : options.port;
-    }
-    if (options.protocol === "grpc") {
-        const proto = app.config("protoFile", "router");
-        options.ext.protoFile = proto;
-    }
-    const server = Serve(app, options);
-    return server;
-};
 /**
  * Execute event as async
  *
@@ -893,7 +840,7 @@ function ConfigurationScan(scanPath) {
     };
 }
 /**
- * bind AppReadyHookFunc
+ * bind AppBootHookFunc
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {