koatty 3.9.5 → 3.10.0

package/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "DevChat.DevChatPath": "/Users/richen/.chat/mamba/envs/devchat/bin/devchat",
+  "devchat.defaultModel": "gpt-4"
+}

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.10.0](https://github.com/thinkkoa/koatty/compare/v3.9.5...v3.10.0) (2023-11-08)
+
+
+### Features
+
+* add app event bind ([66e7a48](https://github.com/thinkkoa/koatty/commit/66e7a488c2aa833e37e1418a9d17c91b0872d255))
+* Custom decorator based on app events ([aa9d96c](https://github.com/thinkkoa/koatty/commit/aa9d96c8bda8364793d868c20eca5d479acb4f88))
+
+
+### Bug Fixes
+
+* key is null ([d851dc5](https://github.com/thinkkoa/koatty/commit/d851dc525933de9225ddf43bcbedc2ac29922648))
+* readme ([84ed9f4](https://github.com/thinkkoa/koatty/commit/84ed9f4261d9c338c1a70d685f3b44deb35a40ee))
+
 ### [3.9.5](https://github.com/thinkkoa/koatty/compare/v3.9.4...v3.9.5) (2023-09-12)
 
 

package/README.md

@@ -12,6 +12,7 @@ Use Typescript's decorator implement IOC and AOP.
 * 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

package/dist/README.md

@@ -12,6 +12,7 @@ Use Typescript's decorator implement IOC and AOP.
 * 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

package/dist/index.d.ts

@@ -1,11 +1,13 @@
 /*!
 * @Author: richen
-* @Date: 2023-09-12 11:22:25
+* @Date: 2023-11-08 15:28:11
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
+import { AppEvent } from 'koatty_core';
 import { Config } from 'koatty_config';
+import { EventHookFunc } from 'koatty_core';
 import { Helper } from 'koatty_lib';
 import { Koatty } from 'koatty_core';
 import { KoattyContext } from 'koatty_core';
@@ -31,8 +33,6 @@ export declare interface ApiOutput {
     data: any;
 }
 
-export declare type AppBootHookFunc = (app: Koatty) => Promise<any>;
-
 /**
  * Base controller
  *
@@ -100,22 +100,22 @@ export declare class BaseService implements IService {
 }
 
 /**
- * bind AppBootHookFunc
+ * @description: bind App event hook func
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {
- *   BindAppBootHook((app: Koatty) => {
+ *   BindEventHook(AppEvent.appBoot, (app: Koatty) => {
  *      // todo
  *      return Promise.resolve();
  *   }, target)
  *  }
  * }
- *
- * @export
- * @param {AppBootHookFunc} func
- * @param {*} target
+ * @param {AppEvent} eventName
+ * @param {EventHookFunc} eventFunc
+ * @param {any} target
+ * @return {*}
  */
-export declare function BindAppBootHook(func: AppBootHookFunc, target: any): void;
+export declare function BindEventHook(eventName: AppEvent, eventFunc: EventHookFunc, target: any): void;
 
 /**
  * Bootstrap application

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-09-12 11:22:03
+* @Date: 2023-11-08 15:27:56
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -152,7 +152,6 @@ function formatApiData(msg, data, defaultCode) {
  */
 const COMPONENT_SCAN = 'COMPONENT_SCAN';
 const CONFIGURATION_SCAN = 'CONFIGURATION_SCAN';
-const APP_BOOT_HOOK = "APP_BOOT_HOOK";
 // tslint:disable: no-irregular-whitespace
 const LOGO = `
 
@@ -294,10 +293,10 @@ class Loader {
         // define path
         const rootPath = app.rootPath || process.cwd();
         const appPath = app.appPath || path__namespace.resolve(rootPath, env.indexOf('ts-node') > -1 ? 'src' : 'dist');
-        const thinkPath = path__namespace.resolve(__dirname, '..');
+        const koattyPath = path__namespace.resolve(__dirname, '..');
         koatty_lib.Helper.define(app, 'rootPath', rootPath);
         koatty_lib.Helper.define(app, 'appPath', appPath);
-        koatty_lib.Helper.define(app, 'thinkPath', thinkPath);
+        koatty_lib.Helper.define(app, 'koattyPath', koattyPath);
         // 
         if (koatty_lib.Helper.isEmpty(app.name)) {
             const pkg = koatty_lib.Helper.safeRequire(`${path__namespace.dirname(appPath)}/package.json`);
@@ -308,12 +307,11 @@ class Loader {
         }
         process.env.ROOT_PATH = rootPath;
         process.env.APP_PATH = appPath;
-        process.env.THINK_PATH = thinkPath;
+        process.env.KOATTY_PATH = koattyPath;
         // Compatible with old version, will be deprecated
         koatty_lib.Helper.define(app, 'prevent', koatty_exception.prevent);
-        koatty_lib.Helper.define(app, 'root_path', rootPath);
-        koatty_lib.Helper.define(app, 'app_path', appPath);
-        koatty_lib.Helper.define(app, 'think_path', thinkPath);
+        koatty_lib.Helper.define(app, 'thinkPath', koattyPath);
+        process.env.THINK_PATH = koattyPath;
     }
     /**
      * Get component metadata
@@ -411,20 +409,49 @@ class Loader {
         }
     }
     /**
-     * Load app ready hook funcs
+     * Load app event hook funcs
      *
      * @static
      * @param {Koatty} app
      * @param {*} target
      * @memberof Loader
      */
-    static LoadAppBootHooks(app, target) {
-        const funcs = koatty_container.IOCContainer.getClassMetadata(koatty_container.TAGGED_CLS, APP_BOOT_HOOK, target);
-        if (koatty_lib.Helper.isArray(funcs)) {
-            funcs.forEach((element) => {
-                app.once('appBoot', () => element(app));
-                return null;
-            });
+    static LoadAppEventHooks(app, target) {
+        const eventFuncs = new Map();
+        for (const event of koatty_core.AppEventArr) {
+            let funcs;
+            switch (event) {
+                case "appBoot" /* AppEvent.appBoot */:
+                    funcs = koatty_container.IOCContainer.getClassMetadata(koatty_container.TAGGED_CLS, "appBoot" /* AppEvent.appBoot */, target);
+                    if (koatty_lib.Helper.isArray(funcs)) {
+                        eventFuncs.set("appBoot" /* AppEvent.appBoot */, funcs);
+                    }
+                    break;
+                case "appReady" /* AppEvent.appReady */:
+                    funcs = koatty_container.IOCContainer.getClassMetadata(koatty_container.TAGGED_CLS, "appReady" /* AppEvent.appReady */, target);
+                    if (koatty_lib.Helper.isArray(funcs)) {
+                        eventFuncs.set("appReady" /* AppEvent.appReady */, funcs);
+                    }
+                    break;
+                case "appStart" /* AppEvent.appStart */:
+                    funcs = koatty_container.IOCContainer.getClassMetadata(koatty_container.TAGGED_CLS, "appStart" /* AppEvent.appStart */, target);
+                    if (koatty_lib.Helper.isArray(funcs)) {
+                        eventFuncs.set("appStart" /* AppEvent.appStart */, funcs);
+                    }
+                    break;
+                case "appStop" /* AppEvent.appStop */:
+                    funcs = koatty_container.IOCContainer.getClassMetadata(koatty_container.TAGGED_CLS, "appStop" /* AppEvent.appStop */, target);
+                    if (koatty_lib.Helper.isArray(funcs)) {
+                        eventFuncs.set("appStop" /* AppEvent.appStop */, funcs);
+                    }
+                    break;
+            }
+        }
+        // loop event emit
+        for (const [event, funcs] of eventFuncs) {
+            for (const func of funcs) {
+                app.once(event, () => func(app));
+            }
         }
     }
     /**
@@ -438,7 +465,7 @@ class Loader {
     static LoadConfigs(app, loadPath) {
         const frameConfig = {};
         // Logger.Debug(`Load configuration path: ${app.thinkPath}/config`);
-        koatty_loader.Load(["./config"], app.thinkPath, function (name, path, exp) {
+        koatty_loader.Load(["./config"], app.koattyPath, function (name, path, exp) {
             frameConfig[name] = exp;
         });
         if (koatty_lib.Helper.isArray(loadPath)) {
@@ -462,7 +489,7 @@ class Loader {
             middlewareConf = { config: {}, list: [] };
         }
         //Mount default middleware
-        koatty_loader.Load(loadPath || ["./middleware"], app.thinkPath);
+        koatty_loader.Load(loadPath || ["./middleware"], app.koattyPath);
         //Mount application middleware
         // const middleware: any = {};
         const appMiddleware = koatty_container.IOCContainer.listClass("MIDDLEWARE") ?? [];
@@ -602,8 +629,12 @@ class Loader {
         const pluginConfList = pluginsConf.list;
         for (const key of pluginConfList) {
             const handle = koatty_container.IOCContainer.get(key, "COMPONENT");
+            if (!handle) {
+                Logger.Error(`Plugin ${key} load error.`);
+                continue;
+            }
             if (!koatty_lib.Helper.isFunction(handle.run)) {
-                Logger.Error(`plugin ${key} must be implements method 'run'.`);
+                Logger.Error(`Plugin ${key} must be implements method 'run'.`);
                 continue;
             }
             if (pluginsConf.config[key] === false) {
@@ -616,7 +647,7 @@ class Loader {
     }
 }
 
-var version = "3.9.5";
+var version = "3.10.0";
 var engines = {
 	node: ">12.0.0"
 };
@@ -713,10 +744,10 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         // configuration metadata
         const configurationMetas = Loader.GetConfigurationMetas(app, target);
         Loader.LoadConfigs(app, configurationMetas);
-        // Load App ready hooks
-        Loader.LoadAppBootHooks(app, target);
-        // app.emit("appBoot");
-        await asyncEvent(app, 'appBoot');
+        // Load App event hooks
+        Loader.LoadAppEventHooks(app, target);
+        Logger.Log('Koatty', '', 'Emit App Boot ...');
+        await asyncEvent(app, "appBoot" /* AppEvent.appBoot */);
         // Load Plugin
         Logger.Log('Koatty', '', 'Load Plugins ...');
         await Loader.LoadPlugins(app);
@@ -740,7 +771,7 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         koatty_lib.Helper.define(app, "router", koatty_serve.NewRouter(app));
         // Emit app ready event
         Logger.Log('Koatty', '', 'Emit App Ready ...');
-        await asyncEvent(app, 'appReady');
+        await asyncEvent(app, "appReady" /* AppEvent.appReady */);
         // Load Routers
         Logger.Log('Koatty', '', 'Load Routers ...');
         app.router.LoadRouter(controllers);
@@ -857,23 +888,23 @@ function ConfigurationScan(scanPath) {
     };
 }
 /**
- * bind AppBootHookFunc
+ * @description: bind App event hook func
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {
- *   BindAppBootHook((app: Koatty) => {
+ *   BindEventHook(AppEvent.appBoot, (app: Koatty) => {
  *      // todo
  *      return Promise.resolve();
  *   }, target)
  *  }
  * }
- *
- * @export
- * @param {AppBootHookFunc} func
- * @param {*} target
+ * @param {AppEvent} eventName
+ * @param {EventHookFunc} eventFunc
+ * @param {any} target
+ * @return {*}
  */
-function BindAppBootHook(func, target) {
-    koatty_container.IOCContainer.attachClassMetadata(koatty_container.TAGGED_CLS, APP_BOOT_HOOK, func, target);
+function BindEventHook(eventName, eventFunc, target) {
+    koatty_container.IOCContainer.attachClassMetadata(koatty_container.TAGGED_CLS, eventName, eventFunc, target);
 }
 
 /**
@@ -993,7 +1024,7 @@ Object.defineProperty(exports, 'Helper', {
 });
 exports.BaseController = BaseController;
 exports.BaseService = BaseService;
-exports.BindAppBootHook = BindAppBootHook;
+exports.BindEventHook = BindEventHook;
 exports.Bootstrap = Bootstrap;
 exports.Component = Component;
 exports.ComponentScan = ComponentScan;

package/dist/index.mjs

@@ -1,12 +1,12 @@
 /*!
 * @Author: richen
-* @Date: 2023-09-12 11:22:03
+* @Date: 2023-11-08 15:27:56
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
 import 'reflect-metadata';
-import { Koatty } from 'koatty_core';
+import { AppEventArr, Koatty } from 'koatty_core';
 export * from 'koatty_core';
 import * as path from 'path';
 import { Load } from 'koatty_loader';
@@ -138,7 +138,6 @@ function formatApiData(msg, data, defaultCode) {
  */
 const COMPONENT_SCAN = 'COMPONENT_SCAN';
 const CONFIGURATION_SCAN = 'CONFIGURATION_SCAN';
-const APP_BOOT_HOOK = "APP_BOOT_HOOK";
 // tslint:disable: no-irregular-whitespace
 const LOGO = `
 
@@ -280,10 +279,10 @@ class Loader {
         // define path
         const rootPath = app.rootPath || process.cwd();
         const appPath = app.appPath || path.resolve(rootPath, env.indexOf('ts-node') > -1 ? 'src' : 'dist');
-        const thinkPath = path.resolve(__dirname, '..');
+        const koattyPath = path.resolve(__dirname, '..');
         Helper.define(app, 'rootPath', rootPath);
         Helper.define(app, 'appPath', appPath);
-        Helper.define(app, 'thinkPath', thinkPath);
+        Helper.define(app, 'koattyPath', koattyPath);
         // 
         if (Helper.isEmpty(app.name)) {
             const pkg = Helper.safeRequire(`${path.dirname(appPath)}/package.json`);
@@ -294,12 +293,11 @@ class Loader {
         }
         process.env.ROOT_PATH = rootPath;
         process.env.APP_PATH = appPath;
-        process.env.THINK_PATH = thinkPath;
+        process.env.KOATTY_PATH = koattyPath;
         // Compatible with old version, will be deprecated
         Helper.define(app, 'prevent', prevent);
-        Helper.define(app, 'root_path', rootPath);
-        Helper.define(app, 'app_path', appPath);
-        Helper.define(app, 'think_path', thinkPath);
+        Helper.define(app, 'thinkPath', koattyPath);
+        process.env.THINK_PATH = koattyPath;
     }
     /**
      * Get component metadata
@@ -397,20 +395,49 @@ class Loader {
         }
     }
     /**
-     * Load app ready hook funcs
+     * Load app event hook funcs
      *
      * @static
      * @param {Koatty} app
      * @param {*} target
      * @memberof Loader
      */
-    static LoadAppBootHooks(app, target) {
-        const funcs = IOCContainer.getClassMetadata(TAGGED_CLS, APP_BOOT_HOOK, target);
-        if (Helper.isArray(funcs)) {
-            funcs.forEach((element) => {
-                app.once('appBoot', () => element(app));
-                return null;
-            });
+    static LoadAppEventHooks(app, target) {
+        const eventFuncs = new Map();
+        for (const event of AppEventArr) {
+            let funcs;
+            switch (event) {
+                case "appBoot" /* AppEvent.appBoot */:
+                    funcs = IOCContainer.getClassMetadata(TAGGED_CLS, "appBoot" /* AppEvent.appBoot */, target);
+                    if (Helper.isArray(funcs)) {
+                        eventFuncs.set("appBoot" /* AppEvent.appBoot */, funcs);
+                    }
+                    break;
+                case "appReady" /* AppEvent.appReady */:
+                    funcs = IOCContainer.getClassMetadata(TAGGED_CLS, "appReady" /* AppEvent.appReady */, target);
+                    if (Helper.isArray(funcs)) {
+                        eventFuncs.set("appReady" /* AppEvent.appReady */, funcs);
+                    }
+                    break;
+                case "appStart" /* AppEvent.appStart */:
+                    funcs = IOCContainer.getClassMetadata(TAGGED_CLS, "appStart" /* AppEvent.appStart */, target);
+                    if (Helper.isArray(funcs)) {
+                        eventFuncs.set("appStart" /* AppEvent.appStart */, funcs);
+                    }
+                    break;
+                case "appStop" /* AppEvent.appStop */:
+                    funcs = IOCContainer.getClassMetadata(TAGGED_CLS, "appStop" /* AppEvent.appStop */, target);
+                    if (Helper.isArray(funcs)) {
+                        eventFuncs.set("appStop" /* AppEvent.appStop */, funcs);
+                    }
+                    break;
+            }
+        }
+        // loop event emit
+        for (const [event, funcs] of eventFuncs) {
+            for (const func of funcs) {
+                app.once(event, () => func(app));
+            }
         }
     }
     /**
@@ -424,7 +451,7 @@ class Loader {
     static LoadConfigs(app, loadPath) {
         const frameConfig = {};
         // Logger.Debug(`Load configuration path: ${app.thinkPath}/config`);
-        Load(["./config"], app.thinkPath, function (name, path, exp) {
+        Load(["./config"], app.koattyPath, function (name, path, exp) {
             frameConfig[name] = exp;
         });
         if (Helper.isArray(loadPath)) {
@@ -448,7 +475,7 @@ class Loader {
             middlewareConf = { config: {}, list: [] };
         }
         //Mount default middleware
-        Load(loadPath || ["./middleware"], app.thinkPath);
+        Load(loadPath || ["./middleware"], app.koattyPath);
         //Mount application middleware
         // const middleware: any = {};
         const appMiddleware = IOCContainer.listClass("MIDDLEWARE") ?? [];
@@ -588,8 +615,12 @@ class Loader {
         const pluginConfList = pluginsConf.list;
         for (const key of pluginConfList) {
             const handle = IOCContainer.get(key, "COMPONENT");
+            if (!handle) {
+                Logger.Error(`Plugin ${key} load error.`);
+                continue;
+            }
             if (!Helper.isFunction(handle.run)) {
-                Logger.Error(`plugin ${key} must be implements method 'run'.`);
+                Logger.Error(`Plugin ${key} must be implements method 'run'.`);
                 continue;
             }
             if (pluginsConf.config[key] === false) {
@@ -602,7 +633,7 @@ class Loader {
     }
 }
 
-var version = "3.9.5";
+var version = "3.10.0";
 var engines = {
 	node: ">12.0.0"
 };
@@ -699,10 +730,10 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         // configuration metadata
         const configurationMetas = Loader.GetConfigurationMetas(app, target);
         Loader.LoadConfigs(app, configurationMetas);
-        // Load App ready hooks
-        Loader.LoadAppBootHooks(app, target);
-        // app.emit("appBoot");
-        await asyncEvent(app, 'appBoot');
+        // Load App event hooks
+        Loader.LoadAppEventHooks(app, target);
+        Logger.Log('Koatty', '', 'Emit App Boot ...');
+        await asyncEvent(app, "appBoot" /* AppEvent.appBoot */);
         // Load Plugin
         Logger.Log('Koatty', '', 'Load Plugins ...');
         await Loader.LoadPlugins(app);
@@ -726,7 +757,7 @@ const executeBootstrap = async function (target, bootFunc, isInitiative = false)
         Helper.define(app, "router", NewRouter(app));
         // Emit app ready event
         Logger.Log('Koatty', '', 'Emit App Ready ...');
-        await asyncEvent(app, 'appReady');
+        await asyncEvent(app, "appReady" /* AppEvent.appReady */);
         // Load Routers
         Logger.Log('Koatty', '', 'Load Routers ...');
         app.router.LoadRouter(controllers);
@@ -843,23 +874,23 @@ function ConfigurationScan(scanPath) {
     };
 }
 /**
- * bind AppBootHookFunc
+ * @description: bind App event hook func
  * example:
  * export function TestDecorator(): ClassDecorator {
  *  return (target: any) => {
- *   BindAppBootHook((app: Koatty) => {
+ *   BindEventHook(AppEvent.appBoot, (app: Koatty) => {
  *      // todo
  *      return Promise.resolve();
  *   }, target)
  *  }
  * }
- *
- * @export
- * @param {AppBootHookFunc} func
- * @param {*} target
+ * @param {AppEvent} eventName
+ * @param {EventHookFunc} eventFunc
+ * @param {any} target
+ * @return {*}
  */
-function BindAppBootHook(func, target) {
-    IOCContainer.attachClassMetadata(TAGGED_CLS, APP_BOOT_HOOK, func, target);
+function BindEventHook(eventName, eventFunc, target) {
+    IOCContainer.attachClassMetadata(TAGGED_CLS, eventName, eventFunc, target);
 }
 
 /**
@@ -965,4 +996,4 @@ class BaseService {
     }
 }
 
-export { BaseController, BaseService, BindAppBootHook, Bootstrap, Component, ComponentScan, ConfigurationScan, Controller, ExecBootStrap, Logger, Middleware, Plugin, Service };
+export { BaseController, BaseService, BindEventHook, Bootstrap, Component, ComponentScan, ConfigurationScan, Controller, ExecBootStrap, Logger, Middleware, Plugin, Service };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty",
-  "version": "3.9.5",
+  "version": "3.10.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",
@@ -81,7 +81,7 @@
     "koa": "^2.14.2",
     "koatty_config": "^1.1.6",
     "koatty_container": "^1.8.1",
-    "koatty_core": "^1.7.10",
+    "koatty_core": "^1.8.1",
     "koatty_exception": "^1.2.8",
     "koatty_lib": "^1.3.4",
     "koatty_loader": "^1.1.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty",
-  "version": "3.9.5",
+  "version": "3.10.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",
@@ -81,7 +81,7 @@
     "koa": "^2.14.2",
     "koatty_config": "^1.1.6",
     "koatty_container": "^1.8.1",
-    "koatty_core": "^1.7.10",
+    "koatty_core": "^1.8.1",
     "koatty_exception": "^1.2.8",
     "koatty_lib": "^1.3.4",
     "koatty_loader": "^1.1.0",