@kevisual/router 0.0.30 → 0.0.32

package/dist/router-browser.d.ts

@@ -157,7 +157,7 @@ type RouteOpts = {
     isDebug?: boolean;
 };
 type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'verify' | 'verifyKey' | 'nextRoute'>;
-declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware"];
+declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware", "metadata"];
 type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
 declare class Route<U = {
     [key: string]: any;
@@ -193,7 +193,7 @@ declare class Route<U = {
      * 是否开启debug，开启后会打印错误信息
      */
     isDebug?: boolean;
-    constructor(path: string, key?: string, opts?: RouteOpts);
+    constructor(path?: string, key?: string, opts?: RouteOpts);
     private createSchema;
     /**
      * set validator and create schema
@@ -413,6 +413,8 @@ declare class QueryRouterServer extends QueryRouter {
     route(path: string, key?: string): Route<Required<RouteContext>>;
     route(path: string, opts?: RouteOpts): Route<Required<RouteContext>>;
     route(path: string, key?: string, opts?: RouteOpts): Route<Required<RouteContext>>;
+    prompt(description: string): Route<Required<RouteContext>>;
+    prompt(description: Function): Route<Required<RouteContext>>;
     /**
      * 等于queryRoute，但是调用了handle
      * @param param0

package/dist/router-browser.js

@@ -4788,7 +4788,7 @@ const listenProcess = async ({ app, emitter, params, timeout = 10 * 60 * 60 * 10
     }
 };
 
-const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware'];
+const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware', 'metadata'];
 class Route {
     /**
      * 一级路径
@@ -4817,7 +4817,7 @@ class Route {
      * 是否开启debug，开启后会打印错误信息
      */
     isDebug;
-    constructor(path, key = '', opts) {
+    constructor(path = '', key = '', opts) {
         if (!path) {
             path = nanoid$1(8);
         }
@@ -5445,6 +5445,17 @@ class QueryRouterServer extends QueryRouter {
         }
         return new Route(path, key, opts);
     }
+    prompt(...args) {
+        const [desc] = args;
+        let description = '';
+        if (typeof desc === 'string') {
+            description = desc;
+        }
+        else if (typeof desc === 'function') {
+            description = desc() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+        }
+        return new Route('', '', { description });
+    }
     /**
      * 等于queryRoute，但是调用了handle
      * @param param0

package/dist/router.d.ts

@@ -161,7 +161,7 @@ type RouteOpts = {
     isDebug?: boolean;
 };
 type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'verify' | 'verifyKey' | 'nextRoute'>;
-declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware"];
+declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware", "metadata"];
 type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
 declare class Route<U = {
     [key: string]: any;
@@ -197,7 +197,7 @@ declare class Route<U = {
      * 是否开启debug，开启后会打印错误信息
      */
     isDebug?: boolean;
-    constructor(path: string, key?: string, opts?: RouteOpts);
+    constructor(path?: string, key?: string, opts?: RouteOpts);
     private createSchema;
     /**
      * set validator and create schema
@@ -417,6 +417,8 @@ declare class QueryRouterServer extends QueryRouter {
     route(path: string, key?: string): Route<Required<RouteContext>>;
     route(path: string, opts?: RouteOpts): Route<Required<RouteContext>>;
     route(path: string, key?: string, opts?: RouteOpts): Route<Required<RouteContext>>;
+    prompt(description: string): Route<Required<RouteContext>>;
+    prompt(description: Function): Route<Required<RouteContext>>;
     /**
      * 等于queryRoute，但是调用了handle
      * @param param0
@@ -723,6 +725,8 @@ declare class App<T = {}, U = AppReqRes> {
     route(path: string, key?: string): Route<U>;
     route(path: string, opts?: RouteOpts): Route<U>;
     route(path: string, key?: string, opts?: RouteOpts): Route<U>;
+    prompt(description: string): Route<Required<RouteContext>>;
+    prompt(description: Function): Route<Required<RouteContext>>;
     call(message: {
         id?: string;
         path?: string;

package/dist/router.js

@@ -4810,7 +4810,7 @@ const listenProcess = async ({ app, emitter, params, timeout = 10 * 60 * 60 * 10
     }
 };
 
-const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware'];
+const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware', 'metadata'];
 class Route {
     /**
      * 一级路径
@@ -4839,7 +4839,7 @@ class Route {
      * 是否开启debug，开启后会打印错误信息
      */
     isDebug;
-    constructor(path, key = '', opts) {
+    constructor(path = '', key = '', opts) {
         if (!path) {
             path = nanoid$1(8);
         }
@@ -5467,6 +5467,17 @@ class QueryRouterServer extends QueryRouter {
         }
         return new Route(path, key, opts);
     }
+    prompt(...args) {
+        const [desc] = args;
+        let description = '';
+        if (typeof desc === 'string') {
+            description = desc;
+        }
+        else if (typeof desc === 'function') {
+            description = desc() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+        }
+        return new Route('', '', { description });
+    }
     /**
      * 等于queryRoute，但是调用了handle
      * @param param0
@@ -11371,6 +11382,17 @@ class App {
         }
         return new Route(path, key, opts);
     }
+    prompt(...args) {
+        const [desc] = args;
+        let description = '';
+        if (typeof desc === 'string') {
+            description = desc;
+        }
+        else if (typeof desc === 'function') {
+            description = desc() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+        }
+        return new Route('', '', { description });
+    }
     async call(message, ctx) {
         const router = this.router;
         return await router.call(message, ctx);

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@kevisual/router",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "description": "",
   "type": "module",
   "main": "./dist/router.js",
@@ -23,19 +23,19 @@
   "devDependencies": {
     "@kevisual/local-proxy": "^0.0.6",
     "@kevisual/query": "^0.0.29",
-    "@rollup/plugin-alias": "^5.1.1",
-    "@rollup/plugin-commonjs": "28.0.6",
+    "@rollup/plugin-alias": "^6.0.0",
+    "@rollup/plugin-commonjs": "29.0.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-typescript": "^12.1.4",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^24.7.2",
-    "@types/send": "^1.2.0",
+    "@types/node": "^24.10.1",
+    "@types/send": "^1.2.1",
     "@types/ws": "^8.18.1",
     "@types/xml2js": "^0.4.14",
     "cookie": "^1.0.2",
     "lodash-es": "^4.17.21",
     "nanoid": "^5.1.6",
-    "rollup": "^4.52.4",
+    "rollup": "^4.53.2",
     "rollup-plugin-dts": "^6.2.3",
     "ts-loader": "^9.5.4",
     "ts-node": "^10.9.2",
@@ -51,7 +51,7 @@
   },
   "dependencies": {
     "path-to-regexp": "^8.3.0",
-    "selfsigned": "^3.0.1",
+    "selfsigned": "^4.0.0",
     "send": "^1.2.0"
   },
   "publishConfig": {

package/src/app.ts

@@ -5,7 +5,7 @@ import { CustomError } from './result/error.ts';
 import { handleServer } from './server/handle-server.ts';
 import { IncomingMessage, ServerResponse } from 'http';
 
-type RouterHandle = (msg: { path: string; [key: string]: any }) => { code: string; data?: any; message?: string; [key: string]: any };
+type RouterHandle = (msg: { path: string;[key: string]: any }) => { code: string; data?: any; message?: string;[key: string]: any };
 type AppOptions<T = {}> = {
   router?: QueryRouter;
   server?: Server;
@@ -82,6 +82,19 @@ export class App<T = {}, U = AppReqRes> {
     }
     return new Route(path, key, opts);
   }
+  prompt(description: string): Route<Required<RouteContext>>;
+  prompt(description: Function): Route<Required<RouteContext>>;
+  prompt(...args: any[]) {
+    const [desc] = args;
+    let description = ''
+    if (typeof desc === 'string') {
+      description = desc;
+    } else if (typeof desc === 'function') {
+      description = desc() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+    }
+    return new Route('', '', { description });
+  }
+  
   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/chat.ts

@@ -0,0 +1,40 @@
+import { QueryRouter } from "./route.ts";
+
+type RouterChatOptions = {
+  router?: QueryRouter;
+}
+export class RouterChat {
+  router: QueryRouter;
+  prompt: string = '';
+  constructor(opts?: RouterChatOptions) {
+    this.router = opts?.router || new QueryRouter();
+  }
+  prefix(wrapperFn?: (routes: any[]) => string) {
+    if (this.prompt) {
+      return this.prompt;
+    }
+    let _prompt = `你是一个调用函数工具的助手，当用户询问时，如果拥有工具，请返回 JSON 数据，数据的值的内容是 id 和 payload 。如果有参数，请放到 payload 当中。
+
+下面是你可以使用的工具列表：
+
+`;
+    if (!wrapperFn) {
+      _prompt += this.router.routes.map(r => `工具名称: ${r.id}\n描述: ${r.description}\n`).join('\n');
+    } else {
+      _prompt += wrapperFn(this.router.exportRoutes());
+    }
+    _prompt += `当你需要使用工具时，请严格按照以下格式返回：
+{
+  "id": "工具名称",
+  "payload": {
+    // 参数列表
+  }
+}
+如果你不需要使用工具，直接返回用户想要的内容即可，不要返回任何多余的信息。`;
+    return _prompt;
+  }
+  chat() {
+    const prompt = this.prefix();
+    return prompt;
+  }
+}

package/src/route.ts

@@ -103,7 +103,7 @@ export type RouteOpts = {
   isDebug?: boolean;
 };
 export type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'verify' | 'verifyKey' | 'nextRoute'>;
-const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware'] as const;
+const pickValue = ['path', 'key', 'id', 'description', 'type', 'validator', 'middleware', 'metadata'] as const;
 export type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
 export class Route<U = { [key: string]: any }> {
   /**
@@ -133,7 +133,7 @@ export class Route<U = { [key: string]: any }> {
    * 是否开启debug，开启后会打印错误信息
    */
   isDebug?: boolean;
-  constructor(path: string, key: string = '', opts?: RouteOpts) {
+  constructor(path: string = '', key: string = '', opts?: RouteOpts) {
     if (!path) {
       path = nanoid(8)
     }
@@ -702,6 +702,19 @@ export class QueryRouter {
   hasRoute(path: string, key: string = '') {
     return this.routes.find((r) => r.path === path && r.key === key);
   }
+  createRouteList(force: boolean = false) {
+    const hasListRoute = this.hasRoute('route', 'list');
+    if (!hasListRoute || force) {
+      const listRoute = new Route('route', 'list', {
+        description: '列出当前应用下的所有的路由信息',
+        run: async (ctx: RouteContext) => {
+          const list = this.getList();
+          ctx.body = list;
+        },
+      });
+      this.add(listRoute);
+    }
+  }
   /**
    * 等待程序运行, 获取到message的数据,就执行
    *
@@ -710,7 +723,11 @@ export class QueryRouter {
    * -- .on
    * -- .send
    */
-  wait(params?: { path?: string; key?: string; payload?: any }, opts?: { emitter?: any, timeout?: number }) {
+  wait(params?: { path?: string; key?: string; payload?: any }, opts?: { emitter?: any, timeout?: number, getList?: boolean }) {
+    const getList = opts?.getList ?? true;
+    if (getList) {
+      this.createRouteList();
+    }
     return listenProcess({ app: this, params, ...opts });
   }
 }
@@ -767,6 +784,18 @@ export class QueryRouterServer extends QueryRouter {
     }
     return new Route(path, key, opts);
   }
+  prompt(description: string): Route<Required<RouteContext>>;
+  prompt(description: Function): Route<Required<RouteContext>>;
+  prompt(...args: any[]) {
+    const [desc] = args;
+    let description = ''
+    if (typeof desc === 'string') {
+      description = desc;
+    } else if (typeof desc === 'function') {
+      description = desc() || ''; // 如果是Promise，需要addTo App之前就要获取应有的函数了。
+    }
+    return new Route('', '', { description });
+  }
 
   /**
    * 等于queryRoute，但是调用了handle

package/src/test/chat.ts

@@ -0,0 +1,17 @@
+import { App } from '../app.ts'
+import { RouterChat } from '@/chat.ts';
+
+const app = new App();
+
+app.prompt(`获取时间的工具`).define(async (ctx) => {
+  ctx.body = '123'
+}).addTo(app);
+
+app.prompt('获取天气的工具。\n参数是 city 为对应的城市').define(async (ctx) => {
+  ctx.body = '晴天'
+}).addTo(app);
+
+
+export const chat = new RouterChat({ router: app.router });
+
+console.log(chat.chat());