koatty 3.10.4 → 3.11.1

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-24 10:16:17
+* @Date: 2024-01-04 07:59:12
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -131,92 +131,6 @@ function formatApiData(msg, data, defaultCode) {
     return obj;
 }
 
-/*
- * @Description: base controller
- * @Usage:
- * @Author: richen
- * @Date: 2023-12-09 21:56:32
- * @LastEditTime: 2023-12-09 23:03:09
- * @License: BSD (3-Clause)
- * @Copyright (c): <richenlin(at)gmail.com>
- */
-/**
- * Base controller
- *
- * @export
- * @class BaseController
- * @implements {IController}
- */
-class BaseController {
-    /**
-     * instance of BaseController.
-     * @param {Koatty} app
-     * @param {KoattyContext} ctx
-     * @memberof BaseController
-     */
-    constructor(ctx, ...arg) {
-        this.ctx = ctx;
-        this.init(arg);
-    }
-    /**
-     * init
-     *
-     * @memberof BaseController
-     */
-    init(...arg) {
-    }
-    /**
-     * 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, data, code = 0) {
-        const obj = formatApiData(msg, data, code);
-        return Promise.resolve(obj);
-    }
-    /**
-     * Response to normalize json format content for fail
-     *
-     * @param {(string | ApiInput)} msg
-     * @param {*} [data]
-     * @param {number} [code=1]
-     * @returns {*}
-     * @memberof BaseController
-     */
-    fail(msg, data, code = 1) {
-        const obj = formatApiData(msg, data, code);
-        this.ctx.body = obj.data;
-        this.ctx.throw(obj.message, obj.code, 200);
-    }
-}
-// const properties = ["constructor", "init"];
-// export const BaseController = new Proxy(Base, {
-//     set(target, key, value, receiver) {
-//         if (Reflect.get(target, key, receiver) === undefined) {
-//             return Reflect.set(target, key, value, receiver);
-//         } else if (key === "init") {
-//             return Reflect.set(target, key, value, receiver);
-//         } else {
-//             throw Error("Cannot redefine getter-only property");
-//         }
-//     },
-//     deleteProperty(target, key) {
-//         throw Error("Cannot delete getter-only property");
-//     },
-//     construct(target, args, newTarget) {
-//         Reflect.ownKeys(target.prototype).map((n) => {
-//             if (newTarget.prototype.hasOwnProperty(n) && !properties.includes(Helper.toString(n))) {
-//                 throw Error(`Cannot override the final method "${Helper.toString(n)}"`);
-//             }
-//         });
-//         return Reflect.construct(target, args, newTarget);
-//     }
-// });
-
 /*
  * @Description: framework logger
  * @Usage:
@@ -252,6 +166,127 @@ function SetLogger(app, config) {
     }
 }
 
+/*
+ * @Description: component interface
+ * @Usage:
+ * @Author: richen
+ * @Date: 2023-12-09 21:56:32
+ * @LastEditTime: 2024-01-04 07:43:03
+ * @License: BSD (3-Clause)
+ * @Copyright (c): <richenlin(at)gmail.com>
+ */
+// tslint:disable-next-line: no-import-side-effect
+/**
+ * Indicates that an decorated class is a "component".
+ *
+ * @export
+ * @param {string} [identifier] component name
+ * @returns {ClassDecorator}
+ */
+function Component(identifier) {
+    return (target) => {
+        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
+        koatty_container.IOCContainer.saveClass("COMPONENT", target, identifier);
+    };
+}
+/**
+ * Indicates that an decorated class is a "controller".
+ *
+ * @export
+ * @param {string} [path] controller router path
+ * @returns {ClassDecorator}
+ */
+function Controller(path = "") {
+    return (target) => {
+        const identifier = koatty_container.IOCContainer.getIdentifier(target);
+        koatty_container.IOCContainer.saveClass("CONTROLLER", target, identifier);
+        koatty_container.IOCContainer.savePropertyData(koatty_serve.CONTROLLER_ROUTER, path, target, identifier);
+    };
+}
+/**
+ * Indicates that an decorated class is a "middleware".
+ *
+ * @export
+ * @param {string} [identifier] class name
+ * @returns {ClassDecorator}
+ */
+function Middleware(identifier) {
+    return (target) => {
+        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
+        koatty_container.IOCContainer.saveClass("MIDDLEWARE", target, identifier);
+    };
+}
+/**
+ * Indicates that an decorated class is a "service".
+ *
+ * @export
+ * @param {string} [identifier] class name
+ * @returns {ClassDecorator}
+ */
+function Service(identifier) {
+    return (target) => {
+        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
+        koatty_container.IOCContainer.saveClass("SERVICE", target, identifier);
+    };
+}
+/**
+ * Indicates that an decorated class is a "plugin".
+ *
+ * @export
+ * @param {string} [identifier] class name
+ * @returns {ClassDecorator}
+ */
+function Plugin(identifier) {
+    return (target) => {
+        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
+        // 
+        if (!identifier.endsWith("Plugin")) {
+            throw Error("Plugin class name must be 'Plugin' suffix.");
+        }
+        koatty_container.IOCContainer.saveClass("COMPONENT", target, `${identifier}`);
+    };
+}
+/**
+ * check is implements Middleware Interface
+ * @param cls
+ * @returns
+ */
+function implementsMiddlewareInterface(cls) {
+    return 'run' in cls && koatty_lib.Helper.isFunction(cls.run);
+}
+/**
+ * check is implements Controller Interface
+ * @param cls
+ * @returns
+ */
+function implementsControllerInterface(cls) {
+    return 'app' in cls && 'ctx' in cls;
+}
+/**
+ * check is implements Service Interface
+ * @param cls
+ * @returns
+ */
+function implementsServiceInterface(cls) {
+    return 'app' in cls;
+}
+/**
+ * check is implements Plugin Interface
+ * @param cls
+ * @returns
+ */
+function implementsPluginInterface(cls) {
+    return 'run' in cls && koatty_lib.Helper.isFunction(cls.run);
+}
+/**
+ * check is implements Aspect Interface
+ * @param cls
+ * @returns
+ */
+function implementsAspectInterface(cls) {
+    return 'app' in cls && 'run' in cls && koatty_lib.Helper.isFunction(cls.run);
+}
+
 /*
  * @Description: framework constants
  * @Usage:
@@ -278,7 +313,7 @@ https://github.com/koatty
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 22:55:49
- * @LastEditTime: 2023-12-24 10:10:52
+ * @LastEditTime: 2024-01-04 05:52:31
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
@@ -523,6 +558,10 @@ class Loader {
             item.id = (item.id ?? "").replace("MIDDLEWARE:", "");
             if (item.id && koatty_lib.Helper.isClass(item.target)) {
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Prototype", type: "MIDDLEWARE", args: [] });
+                const ctl = koatty_container.IOCContainer.getInsByClass(item.target);
+                if (!implementsMiddlewareInterface(ctl)) {
+                    throw Error(`The middleware ${item.id} must implements interface 'IMiddleware'.`);
+                }
             }
         });
         const middlewareConfList = middlewareConf.list || [];
@@ -574,8 +613,8 @@ class Loader {
                 // registering to IOC
                 koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Prototype", type: "CONTROLLER", args: [] });
                 const ctl = koatty_container.IOCContainer.getInsByClass(item.target);
-                if (!(ctl instanceof BaseController)) {
-                    throw Error(`Controller class ${item.id} does not inherit from BaseController`);
+                if (!implementsControllerInterface(ctl)) {
+                    throw Error(`The controller ${item.id} must implements interface 'IController'.`);
                 }
                 controllers.push(item.id);
             }
@@ -597,6 +636,10 @@ 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 (!implementsServiceInterface(ctl)) {
+                    throw Error(`The service ${item.id} must implements interface 'IService'.`);
+                }
             }
         });
     }
@@ -631,11 +674,21 @@ class Loader {
         componentList.forEach(async (item) => {
             item.id = (item.id ?? "").replace("COMPONENT:", "");
             if (koatty_lib.Helper.isClass(item.target)) {
+                // registering to IOC
+                koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Singleton", type: "COMPONENT", args: [] });
                 if (item.id && (item.id).endsWith("Plugin")) {
+                    const ctl = koatty_container.IOCContainer.getInsByClass(item.target);
+                    if (!implementsPluginInterface(ctl)) {
+                        throw Error(`The plugin ${item.id} must implements interface 'IPlugin'.`);
+                    }
                     pluginList.push(item.id);
                 }
-                // registering to IOC
-                koatty_container.IOCContainer.reg(item.id, item.target, { scope: "Singleton", type: "COMPONENT", args: [] });
+                if (item.id && (item.id).endsWith("Aspect")) {
+                    const ctl = koatty_container.IOCContainer.getInsByClass(item.target);
+                    if (!implementsAspectInterface(ctl)) {
+                        throw Error(`The aspect ${item.id} must implements interface 'IAspect'.`);
+                    }
+                }
             }
         });
         // load plugin config
@@ -663,7 +716,7 @@ class Loader {
     }
 }
 
-var version = "3.10.4";
+var version = "3.11.1";
 var engines = {
 	node: ">12.0.0"
 };
@@ -926,119 +979,169 @@ function BindEventHook(eventName, eventFunc, target) {
 }
 
 /*
- * @Description: component interface
+ * @Description: base service
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 21:56:32
- * @LastEditTime: 2023-12-23 11:40:44
+ * @LastEditTime: 2024-01-03 21:57:26
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
-// tslint:disable-next-line: no-import-side-effect
-/**
- * Indicates that an decorated class is a "component".
- *
- * @export
- * @param {string} [identifier] component name
- * @returns {ClassDecorator}
- */
-function Component(identifier) {
-    return (target) => {
-        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
-        koatty_container.IOCContainer.saveClass("COMPONENT", target, identifier);
-    };
-}
-/**
- * Indicates that an decorated class is a "controller".
- *
- * @export
- * @param {string} [path] controller router path
- * @returns {ClassDecorator}
- */
-function Controller(path = "") {
-    return (target) => {
-        const identifier = koatty_container.IOCContainer.getIdentifier(target);
-        koatty_container.IOCContainer.saveClass("CONTROLLER", target, identifier);
-        koatty_container.IOCContainer.savePropertyData(koatty_serve.CONTROLLER_ROUTER, path, target, identifier);
-    };
-}
 /**
- * Indicates that an decorated class is a "middleware".
- *
- * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
- */
-function Middleware(identifier) {
-    return (target) => {
-        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
-        koatty_container.IOCContainer.saveClass("MIDDLEWARE", target, identifier);
-    };
-}
-/**
- * Indicates that an decorated class is a "service".
- *
- * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
- */
-function Service(identifier) {
-    return (target) => {
-        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
-        koatty_container.IOCContainer.saveClass("SERVICE", target, identifier);
-    };
-}
-/**
- * Indicates that an decorated class is a "plugin".
+ * Base service
  *
  * @export
- * @param {string} [identifier] class name
- * @returns {ClassDecorator}
+ * @deprecated When the framework version is > 3.10.5, do not need to inherit the Base class.
+ * @class Base
  */
-function Plugin(identifier) {
-    return (target) => {
-        identifier = identifier || koatty_container.IOCContainer.getIdentifier(target);
-        // 
-        if (!identifier.endsWith("Plugin")) {
-            throw Error("Plugin class name must be 'Plugin' suffix.");
-        }
-        koatty_container.IOCContainer.saveClass("COMPONENT", target, `${identifier}`);
-    };
+class BaseService {
+    /**
+     * instance of BaseController.
+     * @param {Koatty} app
+     * @param {KoattyContext} ctx
+     * @memberof BaseController
+     */
+    constructor(...arg) {
+        this.init(arg);
+    }
+    /**
+     * init
+     *
+     * @protected
+     * @memberof BaseController
+     */
+    init(...arg) {
+    }
 }
 
 /*
- * @Description: base service
+ * @Description: base controller
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 21:56:32
- * @LastEditTime: 2023-12-09 23:03:23
+ * @LastEditTime: 2024-01-03 21:57:20
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
 /**
- * Base service
+ * Base controller
  *
  * @export
- * @class Base
+ * @deprecated When the framework version is > 3.10.5, do not need to inherit the Base class.
+ * @class BaseController
+ * @implements {IController}
  */
-class BaseService {
+class BaseController {
     /**
      * instance of BaseController.
      * @param {Koatty} app
      * @param {KoattyContext} ctx
      * @memberof BaseController
      */
-    constructor(...arg) {
+    constructor(ctx, ...arg) {
+        this.ctx = ctx;
         this.init(arg);
     }
     /**
      * init
      *
-     * @protected
      * @memberof BaseController
      */
     init(...arg) {
     }
+    /**
+     * Response to normalize json format content for success
+     *
+     * @deprecated 使用 Output.ok 代替
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @memberof BaseController
+     */
+    ok(msg, data, code = 0) {
+        const obj = formatApiData(msg, data, code);
+        return Promise.resolve(obj);
+    }
+    /**
+     * Response to normalize json format content for fail
+     *
+     * @deprecated 使用 Output.fail 代替
+     * @param {(string | ApiInput)} msg
+     * @param {*} [data]
+     * @param {number} [code=1]
+     * @returns {*}
+     * @memberof BaseController
+     */
+    fail(msg, data, code = 1) {
+        const obj = formatApiData(msg, data, code);
+        this.ctx.body = obj.data;
+        this.ctx.throw(obj.message, obj.code, 200);
+    }
+}
+// const properties = ["constructor", "init"];
+// export const BaseController = new Proxy(Base, {
+//     set(target, key, value, receiver) {
+//         if (Reflect.get(target, key, receiver) === undefined) {
+//             return Reflect.set(target, key, value, receiver);
+//         } else if (key === "init") {
+//             return Reflect.set(target, key, value, receiver);
+//         } else {
+//             throw Error("Cannot redefine getter-only property");
+//         }
+//     },
+//     deleteProperty(target, key) {
+//         throw Error("Cannot delete getter-only property");
+//     },
+//     construct(target, args, newTarget) {
+//         Reflect.ownKeys(target.prototype).map((n) => {
+//             if (newTarget.prototype.hasOwnProperty(n) && !properties.includes(Helper.toString(n))) {
+//                 throw Error(`Cannot override the final method "${Helper.toString(n)}"`);
+//             }
+//         });
+//         return Reflect.construct(target, args, newTarget);
+//     }
+// });
+
+/*
+ * @Description: output data
+ * @Usage:
+ * @Author: richen
+ * @Date: 2024-01-03 22:03:34
+ * @LastEditTime: 2024-01-03 22:07:20
+ * @License: BSD (3-Clause)
+ * @Copyright (c): <richenlin(at)gmail.com>
+ */
+class Output {
+    /**
+     * Response to normalize json format content for success
+     *
+     * @param {KoattyContext} ctx
+     * @param {(string | ApiInput)} msg   待处理的message消息
+     * @param {*} [data]    待处理的数据
+     * @param {number} [code=200]    错误码，默认0
+     * @returns {*}
+     * @memberof BaseController
+     */
+    static ok(ctx, msg, data, code = 0) {
+        const obj = formatApiData(msg, data, code);
+        return Promise.resolve(obj);
+    }
+    /**
+     * Response to normalize json format content for fail
+     *
+     * @param {KoattyContext} ctx
+     * @param {(string | ApiInput)} msg
+     * @param {*} [data]
+     * @param {number} [code=1]
+     * @returns {*}
+     * @memberof BaseController
+     */
+    static fail(ctx, msg, data, code = 1) {
+        const obj = formatApiData(msg, data, code);
+        ctx.body = obj.data;
+        ctx.throw(obj.message, obj.code, 200);
+    }
 }
 
 Object.defineProperty(exports, 'Config', {
@@ -1064,8 +1167,14 @@ exports.Controller = Controller;
 exports.ExecBootStrap = ExecBootStrap;
 exports.Logger = Logger;
 exports.Middleware = Middleware;
+exports.Output = Output;
 exports.Plugin = Plugin;
 exports.Service = Service;
+exports.implementsAspectInterface = implementsAspectInterface;
+exports.implementsControllerInterface = implementsControllerInterface;
+exports.implementsMiddlewareInterface = implementsMiddlewareInterface;
+exports.implementsPluginInterface = implementsPluginInterface;
+exports.implementsServiceInterface = implementsServiceInterface;
 Object.keys(koatty_container).forEach(function (k) {
   if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
     enumerable: true,