koatty_router 1.7.8 → 1.7.10

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.10](https://github.com/koatty/koatty_router/compare/v1.7.9...v1.7.10) (2022-10-31)
+
+### [1.7.9](https://github.com/koatty/koatty_router/compare/v1.7.8...v1.7.9) (2022-08-19)
+
+
+### Bug Fixes
+
+* querystring must be convert type ([1bec352](https://github.com/koatty/koatty_router/commit/1bec3528a4f29d398a3158a25bcab4824e483433))
+
 ### [1.7.8](https://github.com/koatty/koatty_router/compare/v1.7.7...v1.7.8) (2022-08-19)
 
 ### [1.7.7](https://github.com/koatty/koatty_router/compare/v1.7.6...v1.7.7) (2022-08-19)

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2022-08-19 14:43:08
+* @Date: 2022-10-31 15:15:47
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -71,6 +71,7 @@ export declare const GetMapping: (path?: string, routerOptions?: {
 
 export declare class GrpcRouter implements KoattyRouter {
     app: Koatty;
+    readonly protocol: string;
     options: GrpcRouterOptions;
     router: Map<string, ServiceImplementation>;
     constructor(app: Koatty, options?: RouterOptions);
@@ -138,6 +139,7 @@ export declare type HttpImplementation = (ctx: KoattyContext, next: KoattyNext)
  */
 export declare class HttpRouter implements KoattyRouter {
     app: Koatty;
+    readonly protocol: string;
     options: RouterOptions;
     router: KoaRouter;
     constructor(app: Koatty, options?: RouterOptions);
@@ -370,6 +372,7 @@ export declare interface ServiceImplementation {
 
 export declare class WebsocketRouter implements KoattyRouter {
     app: Koatty;
+    readonly protocol: string;
     options: WebsocketRouterOptions;
     router: KoaRouter;
     constructor(app: Koatty, options?: RouterOptions);

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2022-08-19 14:42:55
+* @Date: 2022-10-31 15:15:33
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -46,7 +46,7 @@ var KoaRouter__default = /*#__PURE__*/_interopDefaultLegacy(KoaRouter);
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-24 23:21:26
- * @LastEditTime: 2022-08-19 14:33:52
+ * @LastEditTime: 2022-08-19 15:37:12
  */
 /**
  * Parameter binding assignment.
@@ -104,13 +104,12 @@ async function checkParams(app, value, opt) {
             }
         }
         else {
+            // querystring must be convert type
+            value = koatty_validation.convertParamsType(value, opt.type);
             //@Valid()
             if (opt.validRule) {
                 validatorFuncs(`${opt.index}`, value, opt.type, opt.validRule, opt.validOpt);
             }
-            if (!koatty_validation.checkParamsType(value, opt.type)) {
-                throw new koatty_exception.Exception(`TypeError: invalid arguments`, 1, 400);
-            }
         }
         return value;
     }
@@ -413,7 +412,7 @@ function injectParam(app, target, instance) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:10:30
- * @LastEditTime: 2022-03-15 17:10:19
+ * @LastEditTime: 2022-10-29 11:24:18
  */
 class GrpcRouter {
     constructor(app, options) {
@@ -521,7 +520,7 @@ class GrpcRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-28 19:02:06
- * @LastEditTime: 2022-03-15 17:10:25
+ * @LastEditTime: 2022-10-29 11:24:21
  */
 /**
  * HttpRouter class
@@ -576,11 +575,14 @@ class HttpRouter {
                     const path = router.path;
                     const requestMethod = router.requestMethod;
                     const params = ctlParams[method];
-                    koatty_logger.DefaultLogger.Debug(`Register request mapping: [${requestMethod}] : ["${path}" => ${n}.${method}]`);
-                    this.SetRouter(path, (ctx) => {
-                        const ctl = koatty_container.IOCContainer.getInsByClass(ctlClass, [ctx]);
-                        return Handler(this.app, ctx, ctl, method, params);
-                    }, requestMethod);
+                    // websocket only handler get request 
+                    if (requestMethod == exports.RequestMethod.GET || requestMethod == exports.RequestMethod.ALL) {
+                        koatty_logger.DefaultLogger.Debug(`Register request mapping: [${requestMethod}] : ["${path}" => ${n}.${method}]`);
+                        this.SetRouter(path, (ctx) => {
+                            const ctl = koatty_container.IOCContainer.getInsByClass(ctlClass, [ctx]);
+                            return Handler(this.app, ctx, ctl, method, params);
+                        }, requestMethod);
+                    }
                 }
             }
             // exp: in middleware
@@ -599,7 +601,7 @@ class HttpRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:16:44
- * @LastEditTime: 2022-03-15 17:10:30
+ * @LastEditTime: 2022-10-29 11:25:18
  */
 class WebsocketRouter {
     constructor(app, options) {
@@ -670,6 +672,41 @@ class WebsocketRouter {
     }
 }
 
+/*
+ * @Description:
+ * @Usage:
+ * @Author: richen
+ * @Date: 2022-10-29 11:15:30
+ * @LastEditTime: 2022-10-29 11:26:39
+ */
+/**
+ * get instance of Router
+ *
+ * @export
+ * @param {Koatty} app
+ * @param {RouterOptions} options
+ * @param {string} [protocol]
+ * @returns {*}  {KoattyRouter}
+ */
+function NewRouter(app, options, protocol) {
+    let router;
+    switch (protocol) {
+        case "grpc":
+            router = new GrpcRouter(app, options);
+            Helper.Helper.define(router, "protocol", protocol);
+            break;
+        case "ws":
+        case "wss":
+            router = new WebsocketRouter(app, options);
+            Helper.Helper.define(router, "protocol", protocol);
+            break;
+        default:
+            router = new HttpRouter(app, options);
+            Helper.Helper.define(router, "protocol", protocol);
+    }
+    return router;
+}
+
 /*
  * @Description:
  * @Usage:
@@ -848,38 +885,6 @@ const Inject = (fn, name) => {
     };
 };
 
-/*
- * @Description:
- * @Usage:
- * @Author: richen
- * @Date: 2021-06-28 18:48:14
- * @LastEditTime: 2022-03-15 17:10:39
- */
-/**
- * get instance of Router
- *
- * @export
- * @param {Koatty} app
- * @param {RouterOptions} options
- * @param {string} [protocol]
- * @returns {*}  {KoattyRouter}
- */
-function NewRouter(app, options, protocol) {
-    let router;
-    switch (protocol) {
-        case "grpc":
-            router = new GrpcRouter(app, options);
-            break;
-        case "ws":
-        case "wss":
-            router = new WebsocketRouter(app, options);
-            break;
-        default:
-            router = new HttpRouter(app, options);
-    }
-    return router;
-}
-
 exports.Body = Body;
 exports.CONTROLLER_ROUTER = CONTROLLER_ROUTER;
 exports.DeleteMapping = DeleteMapping;

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2022-08-19 14:42:55
+* @Date: 2022-10-31 15:15:33
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -11,7 +11,7 @@ import { IOCContainer, RecursiveGetMetadata, TAGGED_PARAM, getOriginMetadata } f
 import { LoadProto, ListServices } from 'koatty_proto';
 import { DefaultLogger } from 'koatty_logger';
 import { Exception } from 'koatty_exception';
-import { ClassValidator, plainToClass, checkParamsType, FunctionValidator, PARAM_RULE_KEY, PARAM_CHECK_KEY, PARAM_TYPE_KEY, paramterTypes } from 'koatty_validation';
+import { ClassValidator, plainToClass, convertParamsType, FunctionValidator, PARAM_RULE_KEY, PARAM_CHECK_KEY, PARAM_TYPE_KEY, paramterTypes } from 'koatty_validation';
 import 'reflect-metadata';
 import KoaRouter from '@koa/router';
 
@@ -20,7 +20,7 @@ import KoaRouter from '@koa/router';
  * @Usage:
  * @Author: richen
  * @Date: 2021-11-24 23:21:26
- * @LastEditTime: 2022-08-19 14:33:52
+ * @LastEditTime: 2022-08-19 15:37:12
  */
 /**
  * Parameter binding assignment.
@@ -78,13 +78,12 @@ async function checkParams(app, value, opt) {
             }
         }
         else {
+            // querystring must be convert type
+            value = convertParamsType(value, opt.type);
             //@Valid()
             if (opt.validRule) {
                 validatorFuncs(`${opt.index}`, value, opt.type, opt.validRule, opt.validOpt);
             }
-            if (!checkParamsType(value, opt.type)) {
-                throw new Exception(`TypeError: invalid arguments`, 1, 400);
-            }
         }
         return value;
     }
@@ -387,7 +386,7 @@ function injectParam(app, target, instance) {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:10:30
- * @LastEditTime: 2022-03-15 17:10:19
+ * @LastEditTime: 2022-10-29 11:24:18
  */
 class GrpcRouter {
     constructor(app, options) {
@@ -495,7 +494,7 @@ class GrpcRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-28 19:02:06
- * @LastEditTime: 2022-03-15 17:10:25
+ * @LastEditTime: 2022-10-29 11:24:21
  */
 /**
  * HttpRouter class
@@ -550,11 +549,14 @@ class HttpRouter {
                     const path = router.path;
                     const requestMethod = router.requestMethod;
                     const params = ctlParams[method];
-                    DefaultLogger.Debug(`Register request mapping: [${requestMethod}] : ["${path}" => ${n}.${method}]`);
-                    this.SetRouter(path, (ctx) => {
-                        const ctl = IOCContainer.getInsByClass(ctlClass, [ctx]);
-                        return Handler(this.app, ctx, ctl, method, params);
-                    }, requestMethod);
+                    // websocket only handler get request 
+                    if (requestMethod == RequestMethod.GET || requestMethod == RequestMethod.ALL) {
+                        DefaultLogger.Debug(`Register request mapping: [${requestMethod}] : ["${path}" => ${n}.${method}]`);
+                        this.SetRouter(path, (ctx) => {
+                            const ctl = IOCContainer.getInsByClass(ctlClass, [ctx]);
+                            return Handler(this.app, ctx, ctl, method, params);
+                        }, requestMethod);
+                    }
                 }
             }
             // exp: in middleware
@@ -573,7 +575,7 @@ class HttpRouter {
  * @Usage:
  * @Author: richen
  * @Date: 2021-06-29 14:16:44
- * @LastEditTime: 2022-03-15 17:10:30
+ * @LastEditTime: 2022-10-29 11:25:18
  */
 class WebsocketRouter {
     constructor(app, options) {
@@ -644,6 +646,41 @@ class WebsocketRouter {
     }
 }
 
+/*
+ * @Description:
+ * @Usage:
+ * @Author: richen
+ * @Date: 2022-10-29 11:15:30
+ * @LastEditTime: 2022-10-29 11:26:39
+ */
+/**
+ * get instance of Router
+ *
+ * @export
+ * @param {Koatty} app
+ * @param {RouterOptions} options
+ * @param {string} [protocol]
+ * @returns {*}  {KoattyRouter}
+ */
+function NewRouter(app, options, protocol) {
+    let router;
+    switch (protocol) {
+        case "grpc":
+            router = new GrpcRouter(app, options);
+            Helper$1.define(router, "protocol", protocol);
+            break;
+        case "ws":
+        case "wss":
+            router = new WebsocketRouter(app, options);
+            Helper$1.define(router, "protocol", protocol);
+            break;
+        default:
+            router = new HttpRouter(app, options);
+            Helper$1.define(router, "protocol", protocol);
+    }
+    return router;
+}
+
 /*
  * @Description:
  * @Usage:
@@ -822,36 +859,4 @@ const Inject = (fn, name) => {
     };
 };
 
-/*
- * @Description:
- * @Usage:
- * @Author: richen
- * @Date: 2021-06-28 18:48:14
- * @LastEditTime: 2022-03-15 17:10:39
- */
-/**
- * get instance of Router
- *
- * @export
- * @param {Koatty} app
- * @param {RouterOptions} options
- * @param {string} [protocol]
- * @returns {*}  {KoattyRouter}
- */
-function NewRouter(app, options, protocol) {
-    let router;
-    switch (protocol) {
-        case "grpc":
-            router = new GrpcRouter(app, options);
-            break;
-        case "ws":
-        case "wss":
-            router = new WebsocketRouter(app, options);
-            break;
-        default:
-            router = new HttpRouter(app, options);
-    }
-    return router;
-}
-
 export { Body, CONTROLLER_ROUTER, DeleteMapping, File, Get, GetMapping, GrpcRouter, HeadMapping, Header, HttpRouter, NewRouter, OptionsMapping, Param, PatchMapping, PathVariable, Post, PostMapping, PutMapping, ROUTER_KEY, RequestBody, RequestMapping, RequestMethod, RequestParam, WebsocketRouter };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_router",
-  "version": "1.7.8",
+  "version": "1.7.10",
   "description": "Koatty routing component, adapt to http1/2, websocket, gRPC.",
   "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_router",
-  "version": "1.7.8",
+  "version": "1.7.10",
   "description": "Koatty routing component, adapt to http1/2, websocket, gRPC.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",