koatty 3.11.0 → 3.11.1

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.11.1](https://github.com/thinkkoa/koatty/compare/v3.11.0...v3.11.1) (2024-01-03)
+
+
+### Bug Fixes
+
+* aspect interface ([03b1884](https://github.com/thinkkoa/koatty/commit/03b188401d694ca116c58c71fc0270da8c163cc1))
+
 ## [3.11.0](https://github.com/thinkkoa/koatty/compare/v3.10.4...v3.11.0) (2024-01-03)
 
 

package/README.md

@@ -57,37 +57,41 @@ npm start
 default Controller:
 
 ```javascript
-import { Controller, BaseController, Autowired, GetMapping, RequestBody, PathVariable,
- PostMapping, RequestMapping, RequestMethod, Valid } from "koatty";
+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 extends BaseController {
+export class IndexController {
     app: App;
 
     @Autowired()
     private testService: TestService;
 
-    init() {
-        this.cache = {};
+    /**
+     * 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 this.ok("success", info);
+            return Output.ok(this.ctx, "success", info);
         } catch (err: Error) {
-            return this.fail(err.message));
+            return Output.fail(this.ctx, err.message));
         }
     }
 
     @PostMapping("/test")
     @Validated() //need DTOClass
     test(@RequestParam() params: TestDTO) {
-        return this.ok("test", params);
+        return Output.ok(this.ctx, "test", params);
     }
 }
 ```

package/dist/README.md

@@ -57,37 +57,41 @@ npm start
 default Controller:
 
 ```javascript
-import { Controller, BaseController, Autowired, GetMapping, RequestBody, PathVariable,
- PostMapping, RequestMapping, RequestMethod, Valid } from "koatty";
+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 extends BaseController {
+export class IndexController {
     app: App;
 
     @Autowired()
     private testService: TestService;
 
-    init() {
-        this.cache = {};
+    /**
+     * 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 this.ok("success", info);
+            return Output.ok(this.ctx, "success", info);
         } catch (err: Error) {
-            return this.fail(err.message));
+            return Output.fail(this.ctx, err.message));
         }
     }
 
     @PostMapping("/test")
     @Validated() //need DTOClass
     test(@RequestParam() params: TestDTO) {
-        return this.ok("test", params);
+        return Output.ok(this.ctx, "test", params);
     }
 }
 ```

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-03 23:02:24
+* @Date: 2024-01-04 07:59:26
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -9,10 +9,12 @@ 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 { Logger as Logger_2 } from 'koatty_logger';
 import { Middleware as Middleware_2 } from 'koa';
+import { Next } from 'koa';
 import { Value } from 'koatty_config';
 
 /**
@@ -192,9 +194,16 @@ export declare interface IController {
  * Interface for Middleware
  */
 export declare interface IMiddleware {
-    run: (options: any, app: Koatty) => KoattyMiddleware;
+    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
@@ -235,7 +244,6 @@ export declare interface IPlugin {
  */
 export declare interface IService {
     readonly app: Koatty;
-    init(...arg: any[]): void;
 }
 
 /**

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-03 23:02:11
+* @Date: 2024-01-04 07:59:12
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -171,7 +171,7 @@ function SetLogger(app, config) {
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 21:56:32
- * @LastEditTime: 2024-01-03 21:27:20
+ * @LastEditTime: 2024-01-04 07:43:03
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
@@ -278,6 +278,14 @@ function implementsServiceInterface(cls) {
 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
@@ -305,7 +313,7 @@ https://github.com/koatty
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 22:55:49
- * @LastEditTime: 2024-01-03 21:56:07
+ * @LastEditTime: 2024-01-04 05:52:31
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
@@ -675,6 +683,12 @@ class Loader {
                     }
                     pluginList.push(item.id);
                 }
+                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
@@ -702,7 +716,7 @@ class Loader {
     }
 }
 
-var version = "3.11.0";
+var version = "3.11.1";
 var engines = {
 	node: ">12.0.0"
 };
@@ -1156,6 +1170,7 @@ exports.Middleware = Middleware;
 exports.Output = Output;
 exports.Plugin = Plugin;
 exports.Service = Service;
+exports.implementsAspectInterface = implementsAspectInterface;
 exports.implementsControllerInterface = implementsControllerInterface;
 exports.implementsMiddlewareInterface = implementsMiddlewareInterface;
 exports.implementsPluginInterface = implementsPluginInterface;

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-03 23:02:11
+* @Date: 2024-01-04 07:59:12
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -156,7 +156,7 @@ function SetLogger(app, config) {
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 21:56:32
- * @LastEditTime: 2024-01-03 21:27:20
+ * @LastEditTime: 2024-01-04 07:43:03
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
@@ -263,6 +263,14 @@ function implementsServiceInterface(cls) {
 function implementsPluginInterface(cls) {
     return 'run' in cls && Helper.isFunction(cls.run);
 }
+/**
+ * check is implements Aspect Interface
+ * @param cls
+ * @returns
+ */
+function implementsAspectInterface(cls) {
+    return 'app' in cls && 'run' in cls && Helper.isFunction(cls.run);
+}
 
 /*
  * @Description: framework constants
@@ -290,7 +298,7 @@ https://github.com/koatty
  * @Usage:
  * @Author: richen
  * @Date: 2023-12-09 22:55:49
- * @LastEditTime: 2024-01-03 21:56:07
+ * @LastEditTime: 2024-01-04 05:52:31
  * @License: BSD (3-Clause)
  * @Copyright (c): <richenlin(at)gmail.com>
  */
@@ -660,6 +668,12 @@ class Loader {
                     }
                     pluginList.push(item.id);
                 }
+                if (item.id && (item.id).endsWith("Aspect")) {
+                    const ctl = IOCContainer.getInsByClass(item.target);
+                    if (!implementsAspectInterface(ctl)) {
+                        throw Error(`The aspect ${item.id} must implements interface 'IAspect'.`);
+                    }
+                }
             }
         });
         // load plugin config
@@ -687,7 +701,7 @@ class Loader {
     }
 }
 
-var version = "3.11.0";
+var version = "3.11.1";
 var engines = {
 	node: ">12.0.0"
 };
@@ -1115,4 +1129,4 @@ class Output {
     }
 }
 
-export { BaseController, BaseService, BindEventHook, Bootstrap, Component, ComponentScan, ConfigurationScan, Controller, ExecBootStrap, Logger, Middleware, Output, Plugin, Service, implementsControllerInterface, implementsMiddlewareInterface, implementsPluginInterface, implementsServiceInterface };
+export { BaseController, BaseService, BindEventHook, Bootstrap, Component, ComponentScan, ConfigurationScan, Controller, ExecBootStrap, Logger, Middleware, Output, Plugin, Service, implementsAspectInterface, implementsControllerInterface, implementsMiddlewareInterface, implementsPluginInterface, implementsServiceInterface };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty",
-  "version": "3.11.0",
+  "version": "3.11.1",
   "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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty",
-  "version": "3.11.0",
+  "version": "3.11.1",
   "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",