koatty_router 1.7.1 → 1.7.4

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.
 
+### [1.7.4](https://github.com/koatty/koatty_router/compare/v1.7.3...v1.7.4) (2022-03-14)
+
+### [1.7.3](https://github.com/koatty/koatty_router/compare/v1.7.2...v1.7.3) (2022-03-09)
+
+### [1.7.2](https://github.com/koatty/koatty_router/compare/v1.7.1...v1.7.2) (2022-02-25)
+
 ### [1.7.1](https://github.com/koatty/koatty_router/compare/v1.7.0...v1.7.1) (2022-02-23)
 
 ## [1.7.0](https://github.com/koatty/koatty_router/compare/v1.7.0-1...v1.7.0) (2022-02-21)

package/dist/index.d.ts

@@ -1,17 +1,27 @@
 /*!
 * @Author: richen
-* @Date: 2022-02-23 14:57:59
+* @Date: 2022-03-14 16:52:33
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
+import { DefaultContext } from 'koa';
+import { DefaultState } from 'koa';
 import KoaRouter from '@koa/router';
 import { Koatty } from 'koatty_core';
+import { KoattyContext } from 'koatty_core';
+import { KoattyNext } from 'koatty_core';
 import { KoattyRouter } from 'koatty_core';
 import { ServiceDefinition } from '@grpc/grpc-js';
 import { UntypedHandleCall } from '@grpc/grpc-js';
 import { UntypedServiceImplementation } from '@grpc/grpc-js';
-import { WebSocket } from 'ws';
+
+/**
+ * Alias of @RequestBody
+ * @param {*}
+ * @return {*}
+ */
+export declare const Body: typeof RequestBody;
 
 export declare const CONTROLLER_ROUTER = "CONTROLLER_ROUTER";
 
@@ -77,7 +87,7 @@ export declare class GrpcRouter implements KoattyRouter {
     /**
      * ListRouter
      *
-     * @returns {*}  {ServiceImplementation[]}
+     * @returns {*}  {Map<string, ServiceImplementation>}
      * @memberof GrpcRouter
      */
     ListRouter(): Map<string, ServiceImplementation>;
@@ -121,13 +131,15 @@ export declare const HeadMapping: (path?: string, routerOptions?: {
     routerName?: string;
 }) => MethodDecorator;
 
+export declare type HttpImplementation = (ctx: KoattyContext, next: KoattyNext) => Promise<any>;
+
 /**
  * HttpRouter class
  */
 export declare class HttpRouter implements KoattyRouter {
     app: Koatty;
     options: RouterOptions;
-    router: KoaRouter<any, unknown>;
+    router: KoaRouter;
     constructor(app: Koatty, options?: RouterOptions);
     /**
      * Set router
@@ -135,7 +147,13 @@ export declare class HttpRouter implements KoattyRouter {
      * @param {string} path
      * @param {RequestMethod} [method]
      */
-    SetRouter(path: string, func: Function, method?: RequestMethod): void;
+    SetRouter(path: string, func: HttpImplementation, method?: RequestMethod): void;
+    /**
+     * ListRouter
+     *
+     * @returns {*}  {KoaRouter.Middleware<any, unknown>}
+     */
+    ListRouter(): KoaRouter.Middleware<DefaultState, DefaultContext>;
     /**
      *
      *
@@ -178,6 +196,13 @@ export declare const OptionsMapping: (path?: string, routerOptions?: {
     routerName?: string;
 }) => MethodDecorator;
 
+/**
+ * Alias of @RequestParam
+ * @param {*}
+ * @return {*}
+ */
+export declare const Param: typeof RequestParam;
+
 /**
  * Routes HTTP PATCH requests to the specified path.
  *
@@ -346,23 +371,24 @@ export declare interface ServiceImplementation {
 export declare class WebsocketRouter implements KoattyRouter {
     app: Koatty;
     options: WebsocketRouterOptions;
-    router: Map<string, WsImplementation>;
+    router: KoaRouter;
     constructor(app: Koatty, options?: RouterOptions);
     /**
-     * SetRouter
+     * Set router
      *
-     * @param {string} method
+     * @param {string} path
      * @param {WsImplementation} func
+     * @param {RequestMethod} [method]
+     * @returns {*}
      * @memberof WebsocketRouter
      */
-    SetRouter(method: string, func: WsImplementation): void;
+    SetRouter(path: string, func: WsImplementation, method?: RequestMethod): void;
     /**
+     * ListRouter
      *
-     *
-     * @returns {*}
-     * @memberof WebsocketRouter
+     * @returns {*} {KoaRouter.Middleware<any, unknown>}
      */
-    ListRouter(): Map<string, WsImplementation>;
+    ListRouter(): KoaRouter.Middleware<DefaultState, DefaultContext>;
     /**
      *
      *
@@ -381,6 +407,6 @@ export declare interface WebsocketRouterOptions extends RouterOptions {
     prefix: string;
 }
 
-export declare type WsImplementation = (socket: WebSocket, request: any, data: any) => Promise<any>;
+export declare type WsImplementation = (ctx: KoattyContext, next: KoattyNext) => Promise<any>;
 
 export { }

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2022-02-23 14:57:45
+* @Date: 2022-03-14 16:52:19
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -13,6 +13,7 @@ var Helper = require('koatty_lib');
 var koatty_container = require('koatty_container');
 var koatty_proto = require('koatty_proto');
 var koatty_logger = require('koatty_logger');
+var koatty_exception = require('koatty_exception');
 var koatty_validation = require('koatty_validation');
 require('reflect-metadata');
 var KoaRouter = require('@koa/router');
@@ -45,7 +46,7 @@ var KoaRouter__default = /*#__PURE__*/_interopDefaultLegacy(KoaRouter);
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-24 23:21:26
- * @LastEditTime: 2022-02-19 00:33:49
+ * @LastEditTime: 2022-03-09 18:14:25
  */
 /**
  * Parameter binding assignment.
@@ -68,7 +69,8 @@ async function getParamter(app, ctx, params) {
             index: k,
             isDto: v.isDto,
             type: v.type,
-            validRules: v.rule,
+            validRule: v.rule,
+            validOpt: v.options,
             dtoCheck: v.dtoCheck,
             dtoRule: v.dtoRule,
             clazz: v.clazz,
@@ -87,29 +89,71 @@ async function getParamter(app, ctx, params) {
  * @returns {*}
  */
 async function checkParams(app, value, opt) {
-    if (opt.isDto) {
-        // DTO class
-        if (!opt.clazz) {
-            opt.clazz = koatty_container.IOCContainer.getClass(opt.type, "COMPONENT");
-        }
-        if (opt.dtoCheck) {
-            value = await koatty_validation.ClassValidator.valid(opt.clazz, value, true);
+    try {
+        if (opt.isDto) {
+            // DTO class
+            if (!opt.clazz) {
+                opt.clazz = koatty_container.IOCContainer.getClass(opt.type, "COMPONENT");
+            }
+            if (opt.dtoCheck) {
+                value = await koatty_validation.ClassValidator.valid(opt.clazz, value, true);
+            }
+            else {
+                value = koatty_validation.plainToClass(opt.clazz, value, true);
+            }
         }
         else {
-            value = koatty_validation.plainToClass(opt.clazz, value, true);
+            value = koatty_validation.convertParamsType(value, opt.type);
+            //@Valid()
+            if (opt) {
+                const { type, validRule, validOpt } = opt;
+                if (type && validRule) {
+                    validatorFuncs(`${opt.index}`, value, type, validRule, validOpt, false);
+                }
+            }
         }
+        return value;
+    }
+    catch (err) {
+        throw new koatty_exception.Exception(err.message || `ValidatorError: invalid arguments.`, 1, 400);
+    }
+}
+/**
+ * Validated by funcs.
+ *
+ * @export
+ * @param {string} name
+ * @param {*} value
+ * @param {string} type
+ * @param {(ValidRules | ValidRules[] | Function)} rule
+ * @param {ValidOtpions} [options]
+ * @param {boolean} [checkType=true]
+ * @returns
+ */
+function validatorFuncs(name, value, type, rule, options, checkType = true) {
+    // check type
+    if (checkType && !koatty_validation.checkParamsType(value, type)) {
+        throw new koatty_exception.Exception(options.message || `TypeError: invalid arguments '${name}'.`, 1, 400);
+    }
+    if (Helper__namespace.isFunction(rule)) {
+        // Function no return value
+        rule(value);
     }
     else {
-        value = koatty_validation.convertParamsType(value, opt.type);
-        //@Valid()
-        if (opt.validRules[opt.index]) {
-            const { type, rule, message } = opt.validRules[opt.index];
-            if (type && rule) {
-                koatty_validation.ValidatorFuncs(`${opt.index}`, value, type, rule, message, false);
+        const funcs = [];
+        if (Helper__namespace.isString(rule)) {
+            funcs.push(rule);
+        }
+        else if (Helper__namespace.isArray(rule)) {
+            funcs.push(...rule);
+        }
+        for (const func of funcs) {
+            if (Object.hasOwnProperty.call(koatty_validation.FunctionValidator, func)) {
+                // FunctionValidator just throws error, no return value
+                koatty_validation.FunctionValidator[func](value, options);
             }
         }
     }
-    return value;
 }
 
 /**
@@ -255,7 +299,7 @@ const HeadMapping = (path = "/", routerOptions = {}) => {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-10 16:58:57
- * @LastEditTime: 2022-02-22 14:35:08
+ * @LastEditTime: 2022-03-09 18:14:12
  */
 /**
  * controller handler
@@ -332,6 +376,7 @@ function injectParam(app, target, instance) {
     const validatedMetaDatas = koatty_container.RecursiveGetMetadata(koatty_validation.PARAM_CHECK_KEY, target);
     const argsMetaObj = {};
     for (const meta in metaDatas) {
+        // 实例方法带规则形参必须小于等于原型形参(如果不存在验证规则，则小于)
         if (instance[meta] && instance[meta].length <= metaDatas[meta].length) {
             koatty_logger.DefaultLogger.Debug(`Register inject param key ${koatty_container.IOCContainer.getIdentifier(target)}: ${Helper__namespace.toString(meta)} => value: ${JSON.stringify(metaDatas[meta])}`);
             // cover to obj
@@ -339,10 +384,10 @@ function injectParam(app, target, instance) {
             const validData = (_b = validMetaDatas[meta]) !== null && _b !== void 0 ? _b : [];
             data.forEach((v) => {
                 var _a;
-                v.rule = {};
                 validData.forEach((it) => {
-                    if (v.index === it.index) {
-                        v.rule = it;
+                    if (v.index === it.index && it.name === v.name) {
+                        v.rule = it.rule;
+                        v.options = it.options;
                     }
                 });
                 if (v.type) {
@@ -372,7 +417,7 @@ function injectParam(app, target, instance) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:10:30
- * @LastEditTime: 2022-02-23 14:53:16
+ * @LastEditTime: 2022-03-14 16:29:52
  */
 class GrpcRouter {
     constructor(app, options) {
@@ -394,6 +439,7 @@ class GrpcRouter {
      * @memberof GrpcRouter
      */
     SetRouter(name, service, implementation) {
+        var _a, _b;
         if (Helper__namespace.isEmpty(name)) {
             return;
         }
@@ -402,11 +448,12 @@ class GrpcRouter {
             implementation: implementation
         };
         this.router.set(name, value);
+        (_b = (_a = this.app) === null || _a === void 0 ? void 0 : _a.server) === null || _b === void 0 ? void 0 : _b.RegisterService(value);
     }
     /**
      * ListRouter
      *
-     * @returns {*}  {ServiceImplementation[]}
+     * @returns {*}  {Map<string, ServiceImplementation>}
      * @memberof GrpcRouter
      */
     ListRouter() {
@@ -419,7 +466,6 @@ class GrpcRouter {
      */
     async LoadRouter(list) {
         try {
-            const app = this.app;
             // load proto files
             const pdef = koatty_proto.LoadProto(this.options.protoFile);
             const services = koatty_proto.ListServices(pdef);
@@ -427,9 +473,9 @@ class GrpcRouter {
             for (const n in list) {
                 const ctlClass = koatty_container.IOCContainer.getClass(n, "CONTROLLER");
                 // inject router
-                const ctlRouters = injectRouter(app, ctlClass);
+                const ctlRouters = injectRouter(this.app, ctlClass);
                 // inject param
-                const ctlParams = injectParam(app, ctlClass);
+                const ctlParams = injectParam(this.app, ctlClass);
                 for (const it in ctlRouters) {
                     const router = ctlRouters[it];
                     const method = router.method;
@@ -458,9 +504,9 @@ class GrpcRouter {
                         const ctlItem = ctls[path];
                         koatty_logger.DefaultLogger.Debug(`Register request mapping: ["${path}" => ${ctlItem.name}.${ctlItem.method}]`);
                         impl[handler.name] = (call, callback) => {
-                            return app.callback("grpc", (ctx) => {
+                            return this.app.callback("grpc", (ctx) => {
                                 const ctl = koatty_container.IOCContainer.getInsByClass(ctlItem.ctl, [ctx]);
-                                return Handler(app, ctx, ctl, ctlItem.method, ctlItem.params);
+                                return Handler(this.app, ctx, ctl, ctlItem.method, ctlItem.params);
                             })(call, callback);
                         };
                     }
@@ -479,7 +525,7 @@ class GrpcRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-28 19:02:06
- * @LastEditTime: 2022-02-23 11:19:01
+ * @LastEditTime: 2022-03-14 10:16:14
  */
 /**
  * HttpRouter class
@@ -503,8 +549,17 @@ class HttpRouter {
         if (Helper__namespace.isEmpty(method)) {
             return;
         }
+        method = method !== null && method !== void 0 ? method : exports.RequestMethod.ALL;
         this.router[method](path, func);
     }
+    /**
+     * ListRouter
+     *
+     * @returns {*}  {KoaRouter.Middleware<any, unknown>}
+     */
+    ListRouter() {
+        return this.router.routes();
+    }
     /**
      *
      *
@@ -512,15 +567,13 @@ class HttpRouter {
      */
     LoadRouter(list) {
         try {
-            const app = this.app;
-            const kRouter = this.router;
             // tslint:disable-next-line: forin
             for (const n in list) {
                 const ctlClass = koatty_container.IOCContainer.getClass(n, "CONTROLLER");
                 // inject router
-                const ctlRouters = injectRouter(app, ctlClass);
+                const ctlRouters = injectRouter(this.app, ctlClass);
                 // inject param
-                const ctlParams = injectParam(app, ctlClass);
+                const ctlParams = injectParam(this.app, ctlClass);
                 // tslint:disable-next-line: forin
                 for (const it in ctlRouters) {
                     const router = ctlRouters[it];
@@ -529,18 +582,16 @@ class HttpRouter {
                     const requestMethod = router.requestMethod;
                     const params = ctlParams[method];
                     koatty_logger.DefaultLogger.Debug(`Register request mapping: [${requestMethod}] : ["${path}" => ${n}.${method}]`);
-                    kRouter[requestMethod](path, function (ctx) {
+                    this.SetRouter(path, (ctx) => {
                         const ctl = koatty_container.IOCContainer.getInsByClass(ctlClass, [ctx]);
-                        return Handler(app, ctx, ctl, method, params);
-                    });
+                        return Handler(this.app, ctx, ctl, method, params);
+                    }, requestMethod);
                 }
             }
-            // Load in the 'appStart' event to facilitate the expansion of middleware
             // exp: in middleware
             // app.Router.SetRouter('/xxx',  (ctx: Koa.KoattyContext): any => {...}, 'GET')
-            app.on('appStart', () => {
-                app.use(kRouter.routes()).use(kRouter.allowedMethods());
-            });
+            this.app.use(this.ListRouter()).
+                use(this.router.allowedMethods());
         }
         catch (err) {
             koatty_logger.DefaultLogger.Error(err);
@@ -553,7 +604,7 @@ class HttpRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:16:44
- * @LastEditTime: 2022-02-23 11:19:40
+ * @LastEditTime: 2022-03-14 16:50:53
  */
 class WebsocketRouter {
     constructor(app, options) {
@@ -561,26 +612,31 @@ class WebsocketRouter {
         this.options = Object.assign({
             prefix: options.prefix
         }, options);
-        this.router = new Map();
+        this.router = new KoaRouter__default["default"](this.options);
     }
     /**
-     * SetRouter
+     * Set router
      *
-     * @param {string} method
+     * @param {string} path
      * @param {WsImplementation} func
+     * @param {RequestMethod} [method]
+     * @returns {*}
      * @memberof WebsocketRouter
      */
-    SetRouter(method, func) {
-        this.router.set(method, func);
+    SetRouter(path, func, method) {
+        if (Helper.Helper.isEmpty(method)) {
+            return;
+        }
+        method = method !== null && method !== void 0 ? method : exports.RequestMethod.ALL;
+        this.router[method](path, func);
     }
     /**
+     * ListRouter
      *
-     *
-     * @returns {*}
-     * @memberof WebsocketRouter
+     * @returns {*} {KoaRouter.Middleware<any, unknown>}
      */
     ListRouter() {
-        return this.router;
+        return this.router.routes();
     }
     /**
      *
@@ -588,32 +644,31 @@ class WebsocketRouter {
      * @param {any[]} list
      */
     LoadRouter(list) {
-        var _a;
         try {
-            const app = this.app;
-            const protocol = (_a = app.config("protocol")) !== null && _a !== void 0 ? _a : "ws";
             // tslint:disable-next-line: forin
             for (const n in list) {
                 const ctlClass = koatty_container.IOCContainer.getClass(n, "CONTROLLER");
                 // inject router
-                const ctlRouters = injectRouter(app, ctlClass);
+                const ctlRouters = injectRouter(this.app, ctlClass);
                 // inject param
-                const ctlParams = injectParam(app, ctlClass);
+                const ctlParams = injectParam(this.app, ctlClass);
                 // tslint:disable-next-line: forin
                 for (const it in ctlRouters) {
                     const router = ctlRouters[it];
+                    const path = router.path;
                     const method = router.method;
+                    const requestMethod = router.requestMethod;
                     const params = ctlParams[method];
-                    koatty_logger.DefaultLogger.Debug(`Register request mapping: ["${ctlRouters[it].path}" => ${n}.${method}]`);
-                    this.SetRouter(ctlRouters[it].path, (socket, request, data) => {
-                        request.data = data;
-                        return app.callback(protocol, (ctx) => {
-                            const ctl = koatty_container.IOCContainer.getInsByClass(ctlClass, [ctx]);
-                            return Handler(app, ctx, ctl, method, params);
-                        })(request, socket);
-                    });
+                    koatty_logger.DefaultLogger.Debug(`Register request mapping: ["${path}" => ${n}.${method}]`);
+                    this.SetRouter(path, (ctx) => {
+                        const ctl = koatty_container.IOCContainer.getInsByClass(ctlClass, [ctx]);
+                        return Handler(this.app, ctx, ctl, method, params);
+                    }, requestMethod);
                 }
             }
+            // Add websocket handler
+            this.app.use(this.ListRouter()).
+                use(this.router.allowedMethods());
         }
         catch (err) {
             koatty_logger.DefaultLogger.Error(err);
@@ -626,7 +681,7 @@ class WebsocketRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-17 17:36:13
- * @LastEditTime: 2022-02-22 14:48:38
+ * @LastEditTime: 2022-03-14 11:23:26
  */
 /**
  * Get request header.
@@ -725,6 +780,12 @@ function RequestBody() {
         return ctx.bodyParser();
     }, "RequestBody");
 }
+/**
+ * Alias of @RequestBody
+ * @param {*}
+ * @return {*}
+ */
+const Body = RequestBody;
 /**
  * Get POST/GET parameters, POST priority
  *
@@ -745,6 +806,12 @@ function RequestParam(name) {
         });
     }, "RequestParam");
 }
+/**
+ * Alias of @RequestParam
+ * @param {*}
+ * @return {*}
+ */
+const Param = RequestParam;
 /**
  * Inject ParameterDecorator
  *
@@ -819,6 +886,7 @@ function NewRouter(app, options, protocol) {
     return router;
 }
 
+exports.Body = Body;
 exports.CONTROLLER_ROUTER = CONTROLLER_ROUTER;
 exports.DeleteMapping = DeleteMapping;
 exports.File = File;
@@ -830,6 +898,7 @@ exports.Header = Header;
 exports.HttpRouter = HttpRouter;
 exports.NewRouter = NewRouter;
 exports.OptionsMapping = OptionsMapping;
+exports.Param = Param;
 exports.PatchMapping = PatchMapping;
 exports.PathVariable = PathVariable;
 exports.Post = Post;