@kevisual/router 0.2.5 → 0.2.7

package/README.md

@@ -24,6 +24,11 @@ app
   })
   .addTo(app);
 ```
+## 浏览器模块使用 router
+
+```ts
+import { App } from '@kevisual/router/browser';
+```
 
 ## 核心概念
 
@@ -112,7 +117,7 @@ app
   .define(async (ctx) => {
     const { id } = ctx.query;
     if (!id) {
-      ctx.throw(400, '缺少参数', 'id is required');
+      ctx.throw(400, '缺少参数：id is required');
     }
     ctx.body = { success: true };
   })
@@ -129,7 +134,7 @@ const app = new App();
 // 定义中间件
 app
   .route({
-    rid: 'auth-example',
+    rid: 'auth',
     description: '权限校验中间件',
   })
   .define(async (ctx) => {
@@ -144,7 +149,7 @@ app
 
 // 使用中间件（通过 rid 引用）
 app
-  .route({ path: 'admin', key: 'panel', middleware: ['auth-example'] })
+  .route({ path: 'admin', key: 'panel', middleware: ['auth'] })
   .define(async (ctx) => {
     // 可以访问中间件设置的 state
     const { tokenUser } = ctx.state;
@@ -163,18 +168,18 @@ app
   .router({
     path: 'dog',
     key: 'info',
-    description: '获取狗的信息',
+    description: '获取小狗的信息',
     metadata: {
       args: {
-        name: z.string().describe('狗的姓名'),
-        age: z.number().describe('狗的年龄'),
+        name: z.string().describe('小狗的姓名'),
+        age: z.number().describe('小狗的年龄'),
       },
     },
   })
   .define(async (ctx) => {
     const { name, age } = ctx.query;
     ctx.body = {
-      content: `这是一只${age}岁的狗，名字是${name}`,
+      content: `这是一只${age}岁的小狗，名字是${name}`,
     };
   })
   .addTo(app);
@@ -184,9 +189,7 @@ app
 
 1. **path 和 key 的组合是路由的唯一标识**，同一个 path+key 只能添加一个路由，后添加的会覆盖之前的。
 
-2. **ctx.call vs ctx.run**：
-   - `call` 返回完整 context，包含所有属性
-   - `run` 返回 `{ code, data, message }` 格式，data 即 body
+2. `ctx.run` 返回 `{ code, data, message }` 格式，data 即 body
 
 3. **ctx.throw 会自动结束执行**，抛出自定义错误。
 
@@ -199,5 +202,3 @@ app
 7. **needSerialize 默认为 true**，会自动对 body 进行 JSON 序列化和反序列化。
 
 8. **progress 记录执行路径**，可用于调试和追踪路由调用链。
-
-9. **中间件找不到会返回 404**，错误信息中会包含找不到的中间件列表。

package/dist/app.js

@@ -3691,7 +3691,7 @@ var listenProcess = async ({ app, mockProcess, params = {}, timeout: timeout2 =
     const ctx = mergeParams?.context || {};
     if (!msg.path && !msg.id) {
       const route = app.routes.find((r) => r.path !== "router");
-      msg.id = route?.id;
+      msg.id = route?.rid;
     }
     const result = await app.run(msg, ctx);
     const response = {
@@ -17707,9 +17707,9 @@ class QueryRouter {
     if (!message?.path) {
       return Promise.resolve({ code: 404, body: null, message: "Not found path" });
     }
-    const { path, key = "", payload = {}, ...query } = message;
+    const { path, key = "", payload = {}, args = {}, ...query } = message;
     ctx = ctx || {};
-    ctx.query = { ...ctx.query, ...query, ...payload };
+    ctx.query = { ...ctx.query, ...query, ...payload, ...args };
     ctx.args = ctx.query;
     ctx.state = { ...ctx?.state };
     ctx.throw = this.throw;
@@ -17915,11 +17915,15 @@ class QueryRouterServer extends QueryRouter {
     }
     return super.run(msg, ctx);
   }
+  async runLocal(msg, ctx) {
+    return this.run(msg, { ...ctx, appId: this.appId });
+  }
   async runAction(api2, payload, ctx) {
     const { path, key, rid } = api2;
     return this.run({ path, key, rid, payload }, ctx);
   }
-  async createAuth(fun) {
+  async createAuth(fun, opts) {
+    const overwrite = opts?.overwrite ?? false;
     this.route({
       path: "auth",
       key: "auth",
@@ -17929,7 +17933,7 @@ class QueryRouterServer extends QueryRouter {
       if (fun) {
         await fun(ctx, "auth");
       }
-    }).addTo(this, { overwrite: false });
+    }).addTo(this, { overwrite });
     this.route({
       path: "auth-admin",
       key: "auth-admin",
@@ -17940,7 +17944,7 @@ class QueryRouterServer extends QueryRouter {
       if (fun) {
         await fun(ctx, "auth-admin");
       }
-    }).addTo(this, { overwrite: false });
+    }).addTo(this, { overwrite });
     this.route({
       path: "auth-can",
       key: "auth-can",
@@ -17950,7 +17954,7 @@ class QueryRouterServer extends QueryRouter {
       if (fun) {
         await fun(ctx, "auth-can");
       }
-    }).addTo(this, { overwrite: false });
+    }).addTo(this, { overwrite });
   }
 }
 
@@ -18899,7 +18903,7 @@ class App extends QueryRouterServer {
   }
 }
 
-// ../../node_modules/.pnpm/@kevisual+context@0.0.8/node_modules/@kevisual/context/dist/app.js
+// ../../node_modules/.pnpm/@kevisual+context@0.0.10/node_modules/@kevisual/context/dist/app.js
 var isBrowser22 = typeof window !== "undefined" && typeof window.document !== "undefined";
 function getDefaultExportFromCjs(x) {
   return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;
@@ -20108,7 +20112,7 @@ app
 10. **中间件找不到会返回 404**，错误信息中会包含找不到的中间件列表。
 `;
 // package.json
-var version2 = "0.2.4";
+var version2 = "0.2.6";
 
 // agent/routes/route-create.ts
 app.route({

package/dist/commander.d.ts

@@ -171,7 +171,7 @@ declare class Route<M extends SimpleObject = SimpleObject, U extends SimpleObjec
     description?: string;
     metadata?: M;
     middleware?: RouteMiddleware[];
-    type?: string | undefined;
+    type?: string;
     /**
      * 是否开启debug，开启后会打印错误信息
      */
@@ -247,6 +247,7 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<RouteContext<T, {}, {
@@ -263,13 +264,14 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<RouteContext<T, {}, {
         [key: string]: any;
     }> | {
         code: number;
-        body: null;
+        body: any;
         message: string;
     }>;
     /**
@@ -284,12 +286,13 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<{
-        code: number | undefined;
-        data: string | number | Object | null | undefined;
-        message: string | undefined;
+        code: number;
+        data: any;
+        message: string;
     }>;
     /**
      * Router Run获取数据
@@ -302,12 +305,13 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<{
-        code: number | undefined;
-        data: string | number | Object | null | undefined;
-        message: string | undefined;
+        code: number;
+        data: any;
+        message: string;
     }>;
     /**
      * 设置上下文
@@ -342,12 +346,12 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(...args: any[]): void;
-    hasRoute(path: string, key?: string): Route<SimpleObject, SimpleObject> | undefined;
+    hasRoute(path: string, key?: string): Route<SimpleObject, SimpleObject>;
     findRoute(opts?: {
         path?: string;
         key?: string;
         rid?: string;
-    }): Route<SimpleObject, SimpleObject> | undefined;
+    }): Route<SimpleObject, SimpleObject>;
     createRouteList(opts?: {
         force?: boolean;
         filter?: (route: Route) => boolean;
@@ -441,6 +445,21 @@ declare class QueryRouterServer<C extends SimpleObject = SimpleObject> extends Q
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
+        token?: string;
+        data?: any;
+    }, ctx?: Partial<RouteContext<C>>): Promise<any>;
+    /**
+     * 调用了handle
+     * @param param0
+     * @returns
+     */
+    runLocal(msg: {
+        rid?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+        args?: any;
         token?: string;
         data?: any;
     }, ctx?: Partial<RouteContext<C>>): Promise<any>;
@@ -456,7 +475,9 @@ declare class QueryRouterServer<C extends SimpleObject = SimpleObject> extends Q
      * 创建认证相关的中间件，默认是 auth, auth-admin, auth-can 三个中间件
      * @param fun 认证函数，接收 RouteContext 和认证类型
      */
-    createAuth(fun: (ctx: RouteContext<C>, type?: 'auth' | 'auth-admin' | 'auth-can') => any): Promise<void>;
+    createAuth(fun?: (ctx: RouteContext<C>, type?: 'auth' | 'auth-admin' | 'auth-can') => any, opts?: {
+        overwrite?: boolean;
+    }): Promise<void>;
 }
 /** JSON Schema 基本类型映射到 TypeScript 类型 */
 type JsonSchemaTypeToTS<T> = T extends {
@@ -791,17 +812,25 @@ declare class App<U = {}> extends QueryRouterServer<AppRouteContext<U>> {
     listen(handle: any, backlog?: number, listeningListener?: () => void): void;
     listen(handle: any, listeningListener?: () => void): void;
     Route: typeof Route;
-    static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<any>;
+    static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<{
+        cookies: Record<string, string>;
+        token: string;
+    }>;
     onServerRequest(fn: (req: IncomingMessage$1, res: ServerResponse$1) => void): void;
 }
 
 declare const groupByPath: (routes: App["routes"]) => Record<string, Route<SimpleObject, SimpleObject>[]>;
 declare const parseArgs: (args: string) => any;
 declare const parseDescription: (route: App["routes"][number]) => string;
-declare const createCommand: (opts: {
+declare const createCommandList: (opts: {
     app: any;
     program: Command;
 }) => void;
+declare const createCommand: (command: Command, opts: {
+    description?: string;
+    app: App;
+    route: any;
+}) => void;
 declare const parse: (opts: {
     app: any;
     description?: string;
@@ -818,4 +847,4 @@ declare const parse: (opts: {
     exitOnEnd?: boolean;
 }) => Promise<void>;
 
-export { createCommand, groupByPath, parse, parseArgs, parseDescription };
+export { createCommand, createCommandList, groupByPath, parse, parseArgs, parseDescription };

package/dist/commander.js

@@ -16243,51 +16243,61 @@ var parseDescription = (route) => {
   }
   return desc;
 };
-var createCommand2 = (opts) => {
+var createCommandList = (opts) => {
   const { program: program2 } = opts;
   const app = opts.app;
   const routes = app.routes;
   const groupRoutes = groupByPath(routes);
   for (const path in groupRoutes) {
     const routeList = groupRoutes[path];
-    const keys = routeList.map((route) => route.key).filter(Boolean);
+    if (!routeList)
+      continue;
+    const keys = routeList.map((route) => route.key);
     const subProgram = program2.command(path).description(`路由[${path}] ${keys.length > 0 ? ": " + keys.join(", ") : ""}`);
     routeList.forEach((route) => {
-      if (!route.key)
-        return;
       const description = parseDescription(route);
-      subProgram.command(route.key).description(description || "").option("--args <args>", `命令参数，支持 JSON 格式或 key=value 形式，例如: --args '{"a":1}' 或 --args 'a=1 b=2'`).argument("[args...]", `位置参数（推荐通过 -- 分隔传入），支持 JSON 或 key=value 格式，例如: -- a=1 b=2 或 -- '{"a":1}'`).action(async (passedArgs, options, _command) => {
-        const output = (data) => {
-          if (typeof data === "object") {
-            process.stdout.write(JSON.stringify(data, null, 2) + `
-`);
-          } else {
-            process.stdout.write(String(data) + `
-`);
-          }
-        };
-        try {
-          let args = {};
-          if (options.args) {
-            args = parseArgs(options.args);
-          } else if (passedArgs.length > 0) {
-            args = parseArgs(passedArgs.join(" "));
-          }
-          const res = await app.run({ path, key: route.key, payload: args }, { appId: app.appId });
-          if (res.code === 200) {
-            output(res.data);
-          } else {
-            output(`Error: ${res.message}`);
-          }
-        } catch (error48) {
-          output(`Execution error: ${error48 instanceof Error ? error48.message : String(error48)}`);
-        }
-      });
+      if (!route.key) {
+        createCommand2(subProgram, { description, app, route });
+        return;
+      }
+      const _sumCommandy = subProgram.command(route.key);
+      createCommand2(_sumCommandy, { description, app, route });
     });
   }
 };
+var createCommand2 = (command, opts) => {
+  const { description, app, route } = opts;
+  const path = route.path;
+  command.description(description || "").option("--args <args>", `命令参数，支持 JSON 格式或 key=value 形式，例如: --args '{"a":1}' 或 --args 'a=1 b=2'`).argument("[args...]", `位置参数（推荐通过 -- 分隔传入），支持 JSON 或 key=value 格式，例如: -- a=1 b=2 或 -- '{"a":1}'`).action(async (passedArgs, options, _command) => {
+    const output = (data) => {
+      if (typeof data === "object") {
+        process.stdout.write(JSON.stringify(data, null, 2) + `
+`);
+      } else {
+        process.stdout.write(String(data) + `
+`);
+      }
+    };
+    try {
+      let args = {};
+      if (options.args) {
+        args = parseArgs(options.args);
+      } else if (passedArgs.length > 0) {
+        args = parseArgs(passedArgs.join(" "));
+      }
+      const res = await app.run({ path, key: route.key, payload: args }, { appId: app.appId });
+      if (res.code === 200) {
+        output(res.data);
+      } else {
+        output(`Error: ${res.message}`);
+      }
+    } catch (error48) {
+      output(`Execution error: ${error48 instanceof Error ? error48.message : String(error48)}`);
+    }
+  });
+};
 var parse5 = async (opts) => {
-  const { description, parse: parse6 = true, version: version2, exitOnEnd = true } = opts;
+  const { description, parse: parse6 = true, version: version2, exitOnEnd = false } = opts;
   const app = opts.app;
   const _program = opts.program || program;
   _program.description(description || "Router 命令行工具");
@@ -16296,7 +16306,7 @@ var parse5 = async (opts) => {
   }
   app.createRouteList();
   createCliList(app);
-  createCommand2({ app, program: _program });
+  createCommandList({ app, program: _program });
   if (opts.remote) {
     const { token, username, id, url: url2 } = opts.remote;
     const remoteApp = new RemoteApp({
@@ -16405,5 +16415,6 @@ export {
   parseArgs,
   parse5 as parse,
   groupByPath,
+  createCommandList,
   createCommand2 as createCommand
 };

package/dist/opencode.d.ts

@@ -171,7 +171,7 @@ declare class Route<M extends SimpleObject = SimpleObject, U extends SimpleObjec
     description?: string;
     metadata?: M;
     middleware?: RouteMiddleware[];
-    type?: string | undefined;
+    type?: string;
     /**
      * 是否开启debug，开启后会打印错误信息
      */
@@ -247,6 +247,7 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<RouteContext<T, {}, {
@@ -263,13 +264,14 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<RouteContext<T, {}, {
         [key: string]: any;
     }> | {
         code: number;
-        body: null;
+        body: any;
         message: string;
     }>;
     /**
@@ -284,12 +286,13 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<{
-        code: number | undefined;
-        data: string | number | Object | null | undefined;
-        message: string | undefined;
+        code: number;
+        data: any;
+        message: string;
     }>;
     /**
      * Router Run获取数据
@@ -302,12 +305,13 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
     }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<{
-        code: number | undefined;
-        data: string | number | Object | null | undefined;
-        message: string | undefined;
+        code: number;
+        data: any;
+        message: string;
     }>;
     /**
      * 设置上下文
@@ -342,12 +346,12 @@ declare class QueryRouter<T extends SimpleObject = SimpleObject> implements thro
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(...args: any[]): void;
-    hasRoute(path: string, key?: string): Route<SimpleObject, SimpleObject> | undefined;
+    hasRoute(path: string, key?: string): Route<SimpleObject, SimpleObject>;
     findRoute(opts?: {
         path?: string;
         key?: string;
         rid?: string;
-    }): Route<SimpleObject, SimpleObject> | undefined;
+    }): Route<SimpleObject, SimpleObject>;
     createRouteList(opts?: {
         force?: boolean;
         filter?: (route: Route) => boolean;
@@ -441,6 +445,21 @@ declare class QueryRouterServer<C extends SimpleObject = SimpleObject> extends Q
         path?: string;
         key?: string;
         payload?: any;
+        args?: any;
+        token?: string;
+        data?: any;
+    }, ctx?: Partial<RouteContext<C>>): Promise<any>;
+    /**
+     * 调用了handle
+     * @param param0
+     * @returns
+     */
+    runLocal(msg: {
+        rid?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+        args?: any;
         token?: string;
         data?: any;
     }, ctx?: Partial<RouteContext<C>>): Promise<any>;
@@ -456,7 +475,9 @@ declare class QueryRouterServer<C extends SimpleObject = SimpleObject> extends Q
      * 创建认证相关的中间件，默认是 auth, auth-admin, auth-can 三个中间件
      * @param fun 认证函数，接收 RouteContext 和认证类型
      */
-    createAuth(fun: (ctx: RouteContext<C>, type?: 'auth' | 'auth-admin' | 'auth-can') => any): Promise<void>;
+    createAuth(fun?: (ctx: RouteContext<C>, type?: 'auth' | 'auth-admin' | 'auth-can') => any, opts?: {
+        overwrite?: boolean;
+    }): Promise<void>;
 }
 /** JSON Schema 基本类型映射到 TypeScript 类型 */
 type JsonSchemaTypeToTS<T> = T extends {
@@ -791,7 +812,10 @@ declare class App<U = {}> extends QueryRouterServer<AppRouteContext<U>> {
     listen(handle: any, backlog?: number, listeningListener?: () => void): void;
     listen(handle: any, listeningListener?: () => void): void;
     Route: typeof Route;
-    static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<any>;
+    static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<{
+        cookies: Record<string, string>;
+        token: string;
+    }>;
     onServerRequest(fn: (req: IncomingMessage$1, res: ServerResponse$1) => void): void;
 }
 

package/dist/opencode.js

@@ -685,7 +685,7 @@ var require_md5 = __commonJS((exports, module) => {
   });
 });
 
-// ../../node_modules/.pnpm/@kevisual+context@0.0.8/node_modules/@kevisual/context/dist/app.js
+// ../../node_modules/.pnpm/@kevisual+context@0.0.10/node_modules/@kevisual/context/dist/app.js
 var isBrowser2 = typeof window !== "undefined" && typeof window.document !== "undefined";
 function getDefaultExportFromCjs(x) {
   return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;