@kevisual/router 0.0.29 → 0.0.30

package/dist/router-browser.d.ts

@@ -141,7 +141,7 @@ type RouteOpts = {
         [key: string]: Rule;
     };
     schema?: {
-        [key: string]: Schema<any>;
+        [key: string]: any;
     };
     isVerify?: boolean;
     verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
@@ -182,7 +182,7 @@ declare class Route<U = {
     type?: string;
     private _validator?;
     schema?: {
-        [key: string]: Schema<any>;
+        [key: string]: any;
     };
     data?: any;
     /**
@@ -233,6 +233,8 @@ declare class Route<U = {
     setValidator(validator: {
         [key: string]: Rule;
     }): this;
+    prompt(description: string): this;
+    prompt(description: Function): this;
     define<T extends {
         [key: string]: any;
     } = RouterContextT>(opts: DefineRouteOpts): this;
@@ -245,6 +247,7 @@ declare class Route<U = {
     define<T extends {
         [key: string]: any;
     } = RouterContextT>(path: string, key: string, fn: Run<T & U>): this;
+    update(opts: DefineRouteOpts, checkList?: string[]): this;
     addTo(router: QueryRouter | {
         add: (route: Route) => void;
         [key: string]: any;
@@ -313,6 +316,7 @@ declare class QueryRouter {
      * @returns
      */
     queryRoute(message: {
+        id?: string;
         path: string;
         key?: string;
         payload?: any;
@@ -334,7 +338,8 @@ declare class QueryRouter {
      * 获取handle函数, 这里会去执行parse函数
      */
     getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
-        path: string;
+        id?: string;
+        path?: string;
         key?: string;
         [key: string]: any;
     }, handleContext?: RouteContext) => Promise<{
@@ -419,6 +424,7 @@ declare class QueryRouterServer extends QueryRouter {
         payload?: any;
     }): Promise<any>;
 }
+declare const Mini: typeof QueryRouterServer;
 
 /** 自定义错误 */
 declare class CustomError extends Error {
@@ -529,5 +535,5 @@ declare class QueryUtil<T extends RouteObject = RouteObject> {
 
 declare const App: typeof QueryRouterServer;
 
-export { App, CustomError, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, define, parseBody, parseSearch, parseSearchValue, util };
+export { App, CustomError, Mini, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, define, parseBody, parseSearch, parseSearchValue, util };
 export type { RouteArray, RouteContext, RouteObject, RouteOpts, Rule, Run, Schema };

package/dist/router-browser.js

@@ -4818,6 +4818,9 @@ class Route {
      */
     isDebug;
     constructor(path, key = '', opts) {
+        if (!path) {
+            path = nanoid$1(8);
+        }
         path = path.trim();
         key = key.trim();
         this.path = path;
@@ -4946,6 +4949,16 @@ class Route {
         this.validator = validator;
         return this;
     }
+    prompt(...args) {
+        const [description] = args;
+        if (typeof description === 'string') {
+            this.description = description;
+        }
+        else if (typeof description === 'function') {
+            this.description = description() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+        }
+        return this;
+    }
     define(...args) {
         const [path, key, opts] = args;
         // 全覆盖，所以opts需要准确，不能由idUsePath 需要check的变量
@@ -4985,6 +4998,26 @@ class Route {
         }
         return this;
     }
+    update(opts, checkList) {
+        const keys = Object.keys(opts);
+        const defaultCheckList = ['path', 'key', 'run', 'nextRoute', 'description', 'metadata', 'middleware', 'type', 'validator', 'isVerify', 'isDebug'];
+        checkList = checkList || defaultCheckList;
+        for (let item of keys) {
+            if (!checkList.includes(item)) {
+                continue;
+            }
+            if (item === 'validator') {
+                this.validator = opts[item];
+                continue;
+            }
+            if (item === 'middleware') {
+                this.middleware = this.middleware.concat(opts[item]);
+                continue;
+            }
+            this[item] = opts[item];
+        }
+        return this;
+    }
     addTo(router) {
         router.add(this);
     }
@@ -5265,19 +5298,20 @@ class QueryRouter {
      */
     async call(message, ctx) {
         let path = message.path;
-        message.key;
+        let key = message.key;
         if (message.id) {
             const route = this.routes.find((r) => r.id === message.id);
             if (route) {
                 path = route.path;
-                route.key;
+                key = route.key;
             }
             else {
                 return { code: 404, body: null, message: 'Not found route' };
             }
+            return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
         }
         else if (path) {
-            return await this.parse({ ...message, path }, { ...this.context, ...ctx });
+            return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
         }
         else {
             return { code: 404, body: null, message: 'Not found path' };
@@ -5317,6 +5351,17 @@ class QueryRouter {
         return async (msg, handleContext) => {
             try {
                 const context = { ...ctx, ...handleContext };
+                if (msg.id) {
+                    const route = router.routes.find((r) => r.id === msg.id);
+                    if (route) {
+                        msg.path = route.path;
+                        msg.key = route.key;
+                    }
+                    else {
+                        return { code: 404, message: 'Not found route' };
+                    }
+                }
+                // @ts-ignore
                 const res = await router.parse(msg, context);
                 if (wrapperFn) {
                     res.data = res.body;
@@ -5431,6 +5476,7 @@ class QueryRouterServer extends QueryRouter {
         }
     }
 }
+const Mini = QueryRouterServer;
 
 const parseBody = async (req) => {
     return new Promise((resolve, reject) => {
@@ -5635,4 +5681,4 @@ class QueryUtil {
 
 const App = QueryRouterServer;
 
-export { App, CustomError, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, define, parseBody, parseSearch, parseSearchValue, util };
+export { App, CustomError, Mini, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, define, parseBody, parseSearch, parseSearchValue, util };

package/dist/router.d.ts

@@ -145,7 +145,7 @@ type RouteOpts = {
         [key: string]: Rule;
     };
     schema?: {
-        [key: string]: Schema<any>;
+        [key: string]: any;
     };
     isVerify?: boolean;
     verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
@@ -186,7 +186,7 @@ declare class Route<U = {
     type?: string;
     private _validator?;
     schema?: {
-        [key: string]: Schema<any>;
+        [key: string]: any;
     };
     data?: any;
     /**
@@ -237,6 +237,8 @@ declare class Route<U = {
     setValidator(validator: {
         [key: string]: Rule;
     }): this;
+    prompt(description: string): this;
+    prompt(description: Function): this;
     define<T extends {
         [key: string]: any;
     } = RouterContextT>(opts: DefineRouteOpts): this;
@@ -249,6 +251,7 @@ declare class Route<U = {
     define<T extends {
         [key: string]: any;
     } = RouterContextT>(path: string, key: string, fn: Run<T & U>): this;
+    update(opts: DefineRouteOpts, checkList?: string[]): this;
     addTo(router: QueryRouter | {
         add: (route: Route) => void;
         [key: string]: any;
@@ -317,6 +320,7 @@ declare class QueryRouter {
      * @returns
      */
     queryRoute(message: {
+        id?: string;
         path: string;
         key?: string;
         payload?: any;
@@ -338,7 +342,8 @@ declare class QueryRouter {
      * 获取handle函数, 这里会去执行parse函数
      */
     getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
-        path: string;
+        id?: string;
+        path?: string;
         key?: string;
         [key: string]: any;
     }, handleContext?: RouteContext) => Promise<{
@@ -423,6 +428,7 @@ declare class QueryRouterServer extends QueryRouter {
         payload?: any;
     }): Promise<any>;
 }
+declare const Mini: typeof QueryRouterServer;
 
 declare class Connect {
     path: string;
@@ -718,7 +724,8 @@ declare class App<T = {}, U = AppReqRes> {
     route(path: string, opts?: RouteOpts): Route<U>;
     route(path: string, key?: string, opts?: RouteOpts): Route<U>;
     call(message: {
-        path: string;
+        id?: string;
+        path?: string;
         key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
@@ -744,5 +751,5 @@ declare class App<T = {}, U = AppReqRes> {
     onServerRequest(fn: (req: IncomingMessage$1, res: ServerResponse$1) => void): void;
 }
 
-export { App, Connect, CustomError, QueryConnect, QueryRouter, QueryRouterServer, QueryUtil, Route, Server, createSchema, define, handleServer, util };
+export { App, Connect, CustomError, Mini, QueryConnect, QueryRouter, QueryRouterServer, QueryUtil, Route, Server, createSchema, define, handleServer, util };
 export type { RouteArray, RouteContext, RouteMiddleware, RouteObject, RouteOpts, Rule, Run, Schema };

package/dist/router.js

@@ -4840,6 +4840,9 @@ class Route {
      */
     isDebug;
     constructor(path, key = '', opts) {
+        if (!path) {
+            path = nanoid$1(8);
+        }
         path = path.trim();
         key = key.trim();
         this.path = path;
@@ -4968,6 +4971,16 @@ class Route {
         this.validator = validator;
         return this;
     }
+    prompt(...args) {
+        const [description] = args;
+        if (typeof description === 'string') {
+            this.description = description;
+        }
+        else if (typeof description === 'function') {
+            this.description = description() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+        }
+        return this;
+    }
     define(...args) {
         const [path, key, opts] = args;
         // 全覆盖，所以opts需要准确，不能由idUsePath 需要check的变量
@@ -5007,6 +5020,26 @@ class Route {
         }
         return this;
     }
+    update(opts, checkList) {
+        const keys = Object.keys(opts);
+        const defaultCheckList = ['path', 'key', 'run', 'nextRoute', 'description', 'metadata', 'middleware', 'type', 'validator', 'isVerify', 'isDebug'];
+        checkList = checkList || defaultCheckList;
+        for (let item of keys) {
+            if (!checkList.includes(item)) {
+                continue;
+            }
+            if (item === 'validator') {
+                this.validator = opts[item];
+                continue;
+            }
+            if (item === 'middleware') {
+                this.middleware = this.middleware.concat(opts[item]);
+                continue;
+            }
+            this[item] = opts[item];
+        }
+        return this;
+    }
     addTo(router) {
         router.add(this);
     }
@@ -5287,19 +5320,20 @@ class QueryRouter {
      */
     async call(message, ctx) {
         let path = message.path;
-        message.key;
+        let key = message.key;
         if (message.id) {
             const route = this.routes.find((r) => r.id === message.id);
             if (route) {
                 path = route.path;
-                route.key;
+                key = route.key;
             }
             else {
                 return { code: 404, body: null, message: 'Not found route' };
             }
+            return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
         }
         else if (path) {
-            return await this.parse({ ...message, path }, { ...this.context, ...ctx });
+            return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
         }
         else {
             return { code: 404, body: null, message: 'Not found path' };
@@ -5339,6 +5373,17 @@ class QueryRouter {
         return async (msg, handleContext) => {
             try {
                 const context = { ...ctx, ...handleContext };
+                if (msg.id) {
+                    const route = router.routes.find((r) => r.id === msg.id);
+                    if (route) {
+                        msg.path = route.path;
+                        msg.key = route.key;
+                    }
+                    else {
+                        return { code: 404, message: 'Not found route' };
+                    }
+                }
+                // @ts-ignore
                 const res = await router.parse(msg, context);
                 if (wrapperFn) {
                     res.data = res.body;
@@ -5453,6 +5498,7 @@ class QueryRouterServer extends QueryRouter {
         }
     }
 }
+const Mini = QueryRouterServer;
 
 class Connect {
     path;
@@ -11355,4 +11401,4 @@ class App {
     }
 }
 
-export { App, Connect, CustomError, QueryConnect, QueryRouter, QueryRouterServer, QueryUtil, Route, Server, createSchema, define, handleServer, util };
+export { App, Connect, CustomError, Mini, QueryConnect, QueryRouter, QueryRouterServer, QueryUtil, Route, Server, createSchema, define, handleServer, util };

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@kevisual/router",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "",
   "type": "module",
   "main": "./dist/router.js",

package/src/app.ts

@@ -82,7 +82,7 @@ export class App<T = {}, U = AppReqRes> {
     }
     return new Route(path, key, opts);
   }
-  async call(message: { path: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) {
+  async call(message: { id?: string, path?: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) {
     const router = this.router;
     return await router.call(message, ctx);
   }

package/src/browser.ts

@@ -1,4 +1,4 @@
-export { Route, QueryRouter, QueryRouterServer } from './route.ts';
+export { Route, QueryRouter, QueryRouterServer, Mini } from './route.ts';
 
 export type { Rule, Schema } from './validator/index.ts';
 

package/src/index.ts

@@ -1,4 +1,4 @@
-export { Route, QueryRouter, QueryRouterServer } from './route.ts';
+export { Route, QueryRouter, QueryRouterServer, Mini } from './route.ts';
 export { Connect, QueryConnect } from './connect.ts';
 
 export type { RouteContext, RouteOpts, RouteMiddleware } from './route.ts';
@@ -11,7 +11,9 @@ export { Server, handleServer } from './server/index.ts';
  */
 export { CustomError } from './result/error.ts';
 
-export { Rule, Schema, createSchema } from './validator/index.ts';
+export { createSchema } from './validator/index.ts';
+
+export type { Rule, Schema,  } from './validator/index.ts';
 
 export { App } from './app.ts';
 

package/src/route.ts

@@ -1,4 +1,4 @@
-import { nanoid } from 'nanoid';
+import { nanoid, random } from 'nanoid';
 import { CustomError } from './result/error.ts';
 import { Schema, Rule, createSchema } from './validator/index.ts';
 import { pick } from './utils/pick.ts';
@@ -88,7 +88,7 @@ export type RouteOpts = {
    * }
    */
   validator?: { [key: string]: Rule };
-  schema?: { [key: string]: Schema<any> };
+  schema?: { [key: string]: any };
   isVerify?: boolean;
   verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
   verifyKey?: (key: string, ctx?: RouteContext, dev?: boolean) => boolean;
@@ -123,7 +123,7 @@ export class Route<U = { [key: string]: any }> {
   middleware?: RouteMiddleware[]; // middleware
   type? = 'route';
   private _validator?: { [key: string]: Rule };
-  schema?: { [key: string]: Schema<any> };
+  schema?: { [key: string]: any };
   data?: any;
   /**
    * 是否需要验证
@@ -134,6 +134,9 @@ export class Route<U = { [key: string]: any }> {
    */
   isDebug?: boolean;
   constructor(path: string, key: string = '', opts?: RouteOpts) {
+    if (!path) {
+      path = nanoid(8)
+    }
     path = path.trim();
     key = key.trim();
     this.path = path;
@@ -261,6 +264,17 @@ export class Route<U = { [key: string]: any }> {
     this.validator = validator;
     return this;
   }
+  prompt(description: string): this;
+  prompt(description: Function): this;
+  prompt(...args: any[]) {
+    const [description] = args;
+    if (typeof description === 'string') {
+      this.description = description;
+    } else if (typeof description === 'function') {
+      this.description = description() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+    }
+    return this;
+  }
   define<T extends { [key: string]: any } = RouterContextT>(opts: DefineRouteOpts): this;
   define<T extends { [key: string]: any } = RouterContextT>(fn: Run<T & U>): this;
   define<T extends { [key: string]: any } = RouterContextT>(key: string, fn: Run<T & U>): this;
@@ -304,6 +318,27 @@ export class Route<U = { [key: string]: any }> {
     }
     return this;
   }
+
+  update(opts: DefineRouteOpts, checkList?: string[]): this {
+    const keys = Object.keys(opts);
+    const defaultCheckList = ['path', 'key', 'run', 'nextRoute', 'description', 'metadata', 'middleware', 'type', 'validator', 'isVerify', 'isDebug'];
+    checkList = checkList || defaultCheckList;
+    for (let item of keys) {
+      if (!checkList.includes(item)) {
+        continue;
+      }
+      if (item === 'validator') {
+        this.validator = opts[item];
+        continue;
+      }
+      if (item === 'middleware') {
+        this.middleware = this.middleware.concat(opts[item]);
+        continue;
+      }
+      this[item] = opts[item];
+    }
+    return this;
+  }
   addTo(router: QueryRouter | { add: (route: Route) => void;[key: string]: any }) {
     router.add(this);
   }
@@ -583,8 +618,9 @@ export class QueryRouter {
       } else {
         return { code: 404, body: null, message: 'Not found route' };
       }
+      return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
     } else if (path) {
-      return await this.parse({ ...message, path }, { ...this.context, ...ctx });
+      return await this.parse({ ...message, path, key }, { ...this.context, ...ctx });
     } else {
       return { code: 404, body: null, message: 'Not found path' };
     }
@@ -596,7 +632,7 @@ export class QueryRouter {
    * @param ctx
    * @returns
    */
-  async queryRoute(message: { path: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) {
+  async queryRoute(message: { id?: string; path: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) {
     const res = await this.parse(message, { ...this.context, ...ctx });
     return {
       code: res.code,
@@ -621,9 +657,19 @@ export class QueryRouter {
    * 获取handle函数, 这里会去执行parse函数
    */
   getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext) {
-    return async (msg: { path: string; key?: string;[key: string]: any }, handleContext?: RouteContext) => {
+    return async (msg: { id?: string; path?: string; key?: string;[key: string]: any }, handleContext?: RouteContext) => {
       try {
         const context = { ...ctx, ...handleContext };
+        if (msg.id) {
+          const route = router.routes.find((r) => r.id === msg.id);
+          if (route) {
+            msg.path = route.path;
+            msg.key = route.key;
+          } else {
+            return { code: 404, message: 'Not found route' };
+          }
+        }
+        // @ts-ignore
         const res = await router.parse(msg, context);
         if (wrapperFn) {
           res.data = res.body;
@@ -751,3 +797,6 @@ export class QueryRouterServer extends QueryRouter {
     }
   }
 }
+
+
+export const Mini = QueryRouterServer