koatty 3.10.4 → 3.11.1

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.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)
+
+
+### Features
+
+* 增加Output类 ([09e43c4](https://github.com/thinkkoa/koatty/commit/09e43c49e2e6bc6c9cb85cd03081bd5f25134c5b))
+
 ### [3.10.4](https://github.com/thinkkoa/koatty/compare/v3.10.4-5...v3.10.4) (2023-12-24)
 
 

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: 2023-12-24 10:16:31
+* @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';
 
 /**
@@ -37,6 +39,7 @@ export declare interface ApiOutput {
  * Base controller
  *
  * @export
+ * @deprecated When the framework version is > 3.10.5, do not need to inherit the Base class.
  * @class BaseController
  * @implements {IController}
  */
@@ -58,6 +61,7 @@ export declare class BaseController implements IController {
     /**
      * Response to normalize json format content for success
      *
+     * @deprecated 使用 Output.ok 代替
      * @param {(string | ApiInput)} msg   待处理的message消息
      * @param {*} [data]    待处理的数据
      * @param {number} [code=200]    错误码，默认0
@@ -68,6 +72,7 @@ export declare class BaseController implements IController {
     /**
      * Response to normalize json format content for fail
      *
+     * @deprecated 使用 Output.fail 代替
      * @param {(string | ApiInput)} msg
      * @param {*} [data]
      * @param {number} [code=1]
@@ -81,6 +86,7 @@ export declare class BaseController implements IController {
  * Base service
  *
  * @export
+ * @deprecated When the framework version is > 3.10.5, do not need to inherit the Base class.
  * @class Base
  */
 export declare class BaseService implements IService {
@@ -182,18 +188,50 @@ export { Helper }
 export declare interface IController {
     readonly app: Koatty;
     readonly ctx: KoattyContext;
-    init(...arg: any[]): void;
-    ok(msg: string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
-    fail(msg: Error | string | ApiInput, data?: any, code?: number): void;
 }
 
 /**
  * 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
+ * @returns
+ */
+export declare function implementsControllerInterface(cls: any): cls is IController;
+
+/**
+ * check is implements Middleware Interface
+ * @param cls
+ * @returns
+ */
+export declare function implementsMiddlewareInterface(cls: any): cls is IMiddleware;
+
+/**
+ * check is implements Plugin Interface
+ * @param cls
+ * @returns
+ */
+export declare function implementsPluginInterface(cls: any): cls is IPlugin;
+
+/**
+ * check is implements Service Interface
+ * @param cls
+ * @returns
+ */
+export declare function implementsServiceInterface(cls: any): cls is IService;
+
 /**
  * Interface for Plugin
  */
@@ -206,7 +244,6 @@ export declare interface IPlugin {
  */
 export declare interface IService {
     readonly app: Koatty;
-    init(...arg: any[]): void;
 }
 
 /**
@@ -226,6 +263,31 @@ export declare const Logger: Logger_2;
  */
 export declare function Middleware(identifier?: string): ClassDecorator;
 
+export declare 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: KoattyContext, msg: string | ApiInput, data?: any, code?: number): Promise<ApiOutput>;
+    /**
+     * 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: KoattyContext, msg: Error | string | ApiInput, data?: any, code?: number): void;
+}
+
 /**
  * Indicates that an decorated class is a "plugin".
  *