koatty 3.5.12 → 3.6.0-0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.6.0-0](https://github.com/thinkkoa/koatty/compare/v3.5.16...v3.6.0-0) (2022-02-21)
+
+### [3.5.16](https://github.com/thinkkoa/koatty/compare/v3.5.14...v3.5.16) (2022-02-14)
+
+### [3.5.14](https://github.com/thinkkoa/koatty/compare/v3.5.12...v3.5.14) (2022-01-17)
+
 ### [3.5.12](https://github.com/thinkkoa/koatty/compare/v3.5.12-3...v3.5.12) (2021-12-23)
 
 ### [3.5.12-3](https://github.com/thinkkoa/koatty/compare/v3.5.12-2...v3.5.12-3) (2021-12-23)

package/README.md

@@ -8,10 +8,9 @@ Use Typescript's decorator implement IOC and AOP.
 
 ## 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)
+* 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
 
 
 ## Documentation
@@ -96,8 +95,12 @@ export class IndexController extends BaseController {
 
     @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;
+        try {
+            const info = await this.testService.sayHello(name);
+            return this.ok("success", info);
+        } catch (err: Error) {
+            return this.fail(err.message));
+        }
     }
 
     @PostMapping("/test")

package/dist/README.md

@@ -8,10 +8,9 @@ Use Typescript's decorator implement IOC and AOP.
 
 ## 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)
+* 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
 
 
 ## Documentation
@@ -96,8 +95,12 @@ export class IndexController extends BaseController {
 
     @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;
+        try {
+            const info = await this.testService.sayHello(name);
+            return this.ok("success", info);
+        } catch (err: Error) {
+            return this.fail(err.message));
+        }
     }
 
     @PostMapping("/test")

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 /*!
 * @Author: richen
-* @Date: 2021-12-23 15:31:27
+* @Date: 2022-02-21 18:02:28
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
+import { Config } from 'koatty_config';
 import { Helper } from 'koatty_lib';
 import { Koatty } from 'koatty_core';
 import { KoattyContext } from 'koatty_core';
 import { KoattyNext } from 'koatty_core';
 import { Logger as Logger_2 } from 'koatty_logger';
-import { ObjectDefinitionOptions } from 'koatty_container';
+import { Value } from 'koatty_config';
 
 /**
  * Interface for Api input
@@ -40,7 +41,7 @@ export declare type AppReadyHookFunc = (app: Koatty) => Promise<any>;
  * @implements {IController}
  */
 export declare class BaseController implements IController {
-    app: Koatty;
+    readonly app: Koatty;
     readonly ctx: KoattyContext;
     /**
      * instance of BaseController.
@@ -83,18 +84,18 @@ export declare class BaseController implements IController {
  * @class Base
  */
 export declare class BaseService implements IService {
-    app: Koatty;
+    readonly app: Koatty;
     /**
-     * instance of Base.
-     * @param {...any[]} arg
-     * @memberof Base
+     * instance of BaseController.
+     * @param {Koatty} app
+     * @param {KoattyContext} ctx
+     * @memberof BaseController
      */
     /**
      * init
      *
      * @protected
-     * @param {...any[]} arg
-     * @memberof Base
+     * @memberof BaseController
      */
 }
 
@@ -143,6 +144,8 @@ export declare function Component(identifier?: string): ClassDecorator;
  */
 export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
 
+export { Config }
+
 /**
  * Define project configuration scan path
  *
@@ -294,7 +297,7 @@ export declare class HttpController extends BaseController {
  * Interface for Controller
  */
 export declare interface IController {
-    app: Koatty;
+    readonly app: Koatty;
     readonly ctx: KoattyContext;
     __befor?: () => Promise<any>;
     __after?: () => Promise<any>;
@@ -320,7 +323,7 @@ export declare interface IPlugin {
  * Interface for Service
  */
 export declare interface IService {
-    app: Koatty;
+    readonly app: Koatty;
 }
 
 /**
@@ -334,7 +337,7 @@ export declare const Logger: Logger_2;
  * Indicates that an decorated class is a "middleware".
  *
  * @export
- * @param {string} [identifier] middleware name
+ * @param {string} [identifier] class name
  * @returns {ClassDecorator}
  */
 export declare function Middleware(identifier?: string): ClassDecorator;
@@ -343,7 +346,7 @@ export declare function Middleware(identifier?: string): ClassDecorator;
  * Indicates that an decorated class is a "plugin".
  *
  * @export
- * @param {string} [identifier]
+ * @param {string} [identifier] class name
  * @returns {ClassDecorator}
  */
 export declare function Plugin(identifier?: string): ClassDecorator;
@@ -352,17 +355,18 @@ export declare function Plugin(identifier?: string): ClassDecorator;
  * Indicates that an decorated class is a "service".
  *
  * @export
- * @param {string} [identifier] middleware name
+ * @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 * from "koatty_trace";
 
 export { }

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2021-12-23 15:31:08
+* @Date: 2022-02-21 18:02:12
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -136,9 +136,9 @@ class BaseController {
      * @param {KoattyContext} ctx
      * @memberof BaseController
      */
-    constructor(ctx) {
+    constructor(ctx, ...arg) {
         this.ctx = ctx;
-        this.init();
+        this.init(arg);
     }
     /**
      * init
@@ -146,10 +146,10 @@ class BaseController {
      * @protected
      * @memberof BaseController
      */
-    init() {
+    init(...arg) {
     }
     // /**
-    //  * Class pre-execution method, executed before each class member methods (except constructor, init, __after) are executed.
+    //  * Class pre-execution method (except constructor, init, __after).
     //  *
     //  * @returns {Promise<any>}
     //  * @memberof BaseController
@@ -158,7 +158,7 @@ class BaseController {
     //     return Promise.resolve();
     // }
     // /**
-    //  * Class after-execution method,after each class member methods (except constructor, init, __before) are executed.
+    //  * Class after-execution method (except constructor, init, __before).
     //  *
     //  * @public
     //  * @returns {*}
@@ -462,34 +462,6 @@ function SetLogger(config) {
     }
 }
 
-/**
- * Base class
- *
- * @export
- * @class Base
- */
-class BaseService {
-    /**
-     * instance of Base.
-     * @param {...any[]} arg
-     * @memberof Base
-     */
-    constructor(...arg) {
-        this.init(arg);
-    }
-    /**
-     * init
-     *
-     * @protected
-     * @param {...any[]} arg
-     * @memberof Base
-     */
-    init(...arg) {
-        // todo
-        // Logger.Debug(arg)
-    }
-}
-
 /**
  * @ author: richen
  * @ copyright: Copyright (c) - <richenlin(at)gmail.com>
@@ -728,7 +700,7 @@ class Loader {
      * @memberof Loader
      */
     static async LoadMiddlewares(app, loadPath) {
-        var _a, _b;
+        var _a;
         let middlewareConf = app.config(undefined, "middleware");
         if (koatty_lib.Helper.isEmpty(middlewareConf)) {
             middlewareConf = { config: {}, list: [] };
@@ -745,7 +717,6 @@ class Loader {
             item.id = ((_a = item.id) !== null && _a !== void 0 ? _a : "").replace("MIDDLEWARE:", "");
             if (item.id && koatty_lib.Helper.isClass(item.target)) {
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Prototype", type: "MIDDLEWARE", args: [] });
-                // middleware[item.id] = item.target;
             }
         });
         const middlewareConfList = middlewareConf.list;
@@ -755,9 +726,6 @@ class Loader {
                 defaultList.push(item);
             }
         });
-        // if (defaultList.length > middlewareConfList.length) {
-        //     Logger.Warn("Some middleware is loaded but not allowed to execute.");
-        // }
         //de-duplication
         const appMList = [...new Set(defaultList)];
         //Automatically call middleware
@@ -772,11 +740,17 @@ class Loader {
                 continue;
             }
             if (middlewareConf.config[key] === false) {
-                Logger.Warn(`Middleware ${key} is loaded but not allowed to execute.`);
-                continue;
+                // Default middleware cannot be disabled
+                if (defaultList.includes(key)) {
+                    Logger.Warn(`Middleware ${key} cannot be disabled.`);
+                }
+                else {
+                    Logger.Warn(`Middleware ${key} is loaded but not allowed to execute.`);
+                    continue;
+                }
             }
             Logger.Debug(`Load middleware: ${key}`);
-            const result = await handle.run((_b = middlewareConf.config[key]) !== null && _b !== void 0 ? _b : {}, app);
+            const result = await handle.run(middlewareConf.config[key] || {}, app);
             if (koatty_lib.Helper.isFunction(result)) {
                 if (result.length < 3) {
                     app.use(result);
@@ -786,7 +760,6 @@ class Loader {
                 }
             }
         }
-        // app.setMetaData("_middlewares", middleware);
     }
     /**
      * Load controllers
@@ -830,10 +803,6 @@ class Loader {
                 Logger.Debug(`Load service: ${item.id}`);
                 // registering to IOC
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Singleton", type: "SERVICE", args: [] });
-                const ctl = koatty_container.IOCContainer.getInsByClass(item.target);
-                if (!(ctl instanceof BaseService)) {
-                    throw new Error(`class ${item.id} does not inherit from BaseService`);
-                }
             }
         });
     }
@@ -851,8 +820,6 @@ class Loader {
             item.id = ((_a = item.id) !== null && _a !== void 0 ? _a : "").replace("COMPONENT:", "");
             if (item.id && !(item.id).endsWith("Plugin") && koatty_lib.Helper.isClass(item.target)) {
                 Logger.Debug(`Load component: ${item.id}`);
-                // inject schedule
-                // injectSchedule(item.target, item.target.prototype, IOCContainer);
                 // registering to IOC
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Singleton", type: "COMPONENT", args: [] });
             }
@@ -877,7 +844,6 @@ class Loader {
             var _a;
             item.id = ((_a = item.id) !== null && _a !== void 0 ? _a : "").replace("COMPONENT:", "");
             if (item.id && (item.id).endsWith("Plugin") && koatty_lib.Helper.isClass(item.target)) {
-                // Logger.Debug(`Load plugin: ${item.id}`);
                 // registering to IOC
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Singleton", type: "COMPONENT", args: [] });
                 pluginList.push(item.id);
@@ -896,14 +862,13 @@ class Loader {
             if (pluginsConf.config[key] === false) {
                 continue;
             }
-            // Logger.Debug(`Execute plugin: ${key}`);
             // sync exec 
             await handle.run((_a = pluginsConf.config[key]) !== null && _a !== void 0 ? _a : {}, app);
         }
     }
 }
 
-var version = "3.5.12";
+var version = "3.6.0-0";
 var engines = {
 	node: ">12.0.0"
 };
@@ -1088,7 +1053,6 @@ function Bootstrap(bootFunc) {
  * @returns {ClassDecorator}
  */
 function ComponentScan(scanPath) {
-    Logger.Log('think', '', 'ComponentScan');
     return (target) => {
         if (!(target.prototype instanceof koatty_core.Koatty)) {
             throw new Error(`class does not inherit from Koatty`);
@@ -1105,7 +1069,6 @@ function ComponentScan(scanPath) {
  * @returns {ClassDecorator}
  */
 function ConfigurationScan(scanPath) {
-    Logger.Log('think', '', 'ConfigurationScan');
     return (target) => {
         if (!(target.prototype instanceof koatty_core.Koatty)) {
             throw new Error(`class does not inherit from Koatty`);
@@ -1171,7 +1134,7 @@ function Controller(path = "") {
  * Indicates that an decorated class is a "middleware".
  *
  * @export
- * @param {string} [identifier] middleware name
+ * @param {string} [identifier] class name
  * @returns {ClassDecorator}
  */
 function Middleware(identifier) {
@@ -1184,7 +1147,7 @@ function Middleware(identifier) {
  * Indicates that an decorated class is a "service".
  *
  * @export
- * @param {string} [identifier] middleware name
+ * @param {string} [identifier] class name
  * @returns {ClassDecorator}
  */
 function Service(identifier) {
@@ -1197,7 +1160,7 @@ function Service(identifier) {
  * Indicates that an decorated class is a "plugin".
  *
  * @export
- * @param {string} [identifier]
+ * @param {string} [identifier] class name
  * @returns {ClassDecorator}
  */
 function Plugin(identifier) {
@@ -1211,10 +1174,44 @@ function Plugin(identifier) {
     };
 }
 
+/**
+ * Base class
+ *
+ * @export
+ * @class Base
+ */
+class BaseService {
+    /**
+     * instance of BaseController.
+     * @param {Koatty} app
+     * @param {KoattyContext} ctx
+     * @memberof BaseController
+     */
+    constructor(...arg) {
+        this.init(arg);
+    }
+    /**
+     * init
+     *
+     * @protected
+     * @memberof BaseController
+     */
+    init(...arg) {
+    }
+}
+
 Object.defineProperty(exports, 'Helper', {
     enumerable: true,
     get: function () { return koatty_lib.Helper; }
 });
+Object.defineProperty(exports, 'Config', {
+    enumerable: true,
+    get: function () { return koatty_config.Config; }
+});
+Object.defineProperty(exports, 'Value', {
+    enumerable: true,
+    get: function () { return koatty_config.Value; }
+});
 exports.BaseController = BaseController;
 exports.BaseService = BaseService;
 exports.BindAppReadyHook = BindAppReadyHook;
@@ -1258,9 +1255,3 @@ Object.keys(koatty_exception).forEach(function (k) {
         get: function () { return koatty_exception[k]; }
     });
 });
-Object.keys(koatty_trace).forEach(function (k) {
-    if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
-        enumerable: true,
-        get: function () { return koatty_trace[k]; }
-    });
-});