@kevisual/router 0.0.83 → 0.0.85

package/dist/opencode.d.ts

@@ -33,9 +33,20 @@ type RouterContextT = {
     code?: number;
     [key: string]: any;
 };
+type BuildRouteContext<M, U> = M extends {
+    args?: infer A;
+} ? A extends z.ZodObject<any> ? RouteContext<{
+    args?: z.infer<A>;
+}, U> : A extends Record<string, z.ZodTypeAny> ? RouteContext<{
+    args?: {
+        [K in keyof A]: z.infer<A[K]>;
+    };
+}, U> : RouteContext<U> : RouteContext<U>;
 type RouteContext<T = {
     code?: number;
-}, S = any> = {
+}, U extends SimpleObject = {}, S = {
+    [key: string]: any;
+}> = {
     /**
      * 本地自己调用的时候使用，可以标识为当前自调用，那么 auth 就不许重复的校验
      * 或者不需要登录的，直接调用
@@ -58,7 +69,14 @@ type RouteContext<T = {
     code?: number;
     /** return msg */
     message?: string;
+    /**
+     * 传递状态
+     */
     state?: S;
+    /**
+     * 当前routerId
+     */
+    currentId?: string;
     /**
      * 当前路径
      */
@@ -99,14 +117,12 @@ type RouteContext<T = {
         path: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }) => Promise<any>;
+    }, ctx?: RouteContext) => Promise<any>;
     index?: number;
     throw?: throwError['throw'];
     /** 是否需要序列化, 使用JSON.stringify和JSON.parse */
     needSerialize?: boolean;
-} & T;
+} & T & U;
 type SimpleObject = Record<string, any>;
 type Run<T extends SimpleObject = {}> = (ctx: Required<RouteContext<T>>) => Promise<typeof ctx | null | void>;
 type RunMessage = {
@@ -117,7 +133,7 @@ type RunMessage = {
 };
 type NextRoute = Pick<Route, 'id' | 'path' | 'key'>;
 type RouteMiddleware = {
-    path: string;
+    path?: string;
     key?: string;
     id?: string;
 } | string;
@@ -130,7 +146,7 @@ type RouteOpts<U = {}, T = SimpleObject> = {
     description?: string;
     metadata?: T;
     middleware?: RouteMiddleware[];
-    type?: 'route' | 'middleware';
+    type?: 'route' | 'middleware' | 'compound';
     /**
      * $#$ will be used to split path and key
      */
@@ -144,9 +160,11 @@ type RouteOpts<U = {}, T = SimpleObject> = {
 type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'nextRoute'>;
 declare const pickValue: readonly ["path", "key", "id", "description", "type", "middleware", "metadata"];
 type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
-declare class Route<U = {
-    [key: string]: any;
-}, T extends SimpleObject = SimpleObject> implements throwError {
+/**
+ * @M 是 route的 metadate的类型，默认是 SimpleObject
+ * @U 是 RouteContext 里 state的类型
+ */
+declare class Route<M extends SimpleObject = SimpleObject, U extends SimpleObject = SimpleObject> implements throwError {
     /**
      * 一级路径
      */
@@ -156,10 +174,10 @@ declare class Route<U = {
      */
     key?: string;
     id?: string;
-    run?: Run;
+    run?: Run<BuildRouteContext<M, U>>;
     nextRoute?: NextRoute;
     description?: string;
-    metadata?: T;
+    metadata?: M;
     middleware?: RouteMiddleware[];
     type?: string;
     /**
@@ -174,13 +192,13 @@ declare class Route<U = {
     } = RouterContextT>(opts: DefineRouteOpts): this;
     define<T extends {
         [key: string]: any;
-    } = RouterContextT>(fn: Run<T & U>): this;
+    } = RouterContextT>(fn: Run<T & BuildRouteContext<M, U>>): this;
     define<T extends {
         [key: string]: any;
-    } = RouterContextT>(key: string, fn: Run<T & U>): this;
+    } = RouterContextT>(key: string, fn: Run<T & BuildRouteContext<M, U>>): this;
     define<T extends {
         [key: string]: any;
-    } = RouterContextT>(path: string, key: string, fn: Run<T & U>): this;
+    } = RouterContextT>(path: string, key: string, fn: Run<T & BuildRouteContext<M, U>>): this;
     update(opts: DefineRouteOpts, onlyUpdateList?: string[]): this;
     addTo(router: QueryRouter | {
         add: (route: Route) => void;
@@ -194,11 +212,11 @@ declare class Route<U = {
 type AddOpts = {
     overwrite?: boolean;
 };
-declare class QueryRouter implements throwError {
+declare class QueryRouter<T extends SimpleObject = SimpleObject> implements throwError {
     appId: string;
     routes: Route[];
     maxNextRoute: number;
-    context?: RouteContext;
+    context?: RouteContext<T>;
     constructor();
     /**
      * add route
@@ -226,7 +244,7 @@ declare class QueryRouter implements throwError {
      * @param ctx
      * @returns
      */
-    runRoute(path: string, key: string, ctx?: RouteContext): any;
+    runRoute(path: string, key: string, ctx?: RouteContext<T>): Promise<RouteContext<T>>;
     /**
      * 第一次执行
      * @param message
@@ -237,9 +255,11 @@ declare class QueryRouter implements throwError {
         path: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
+    }, ctx?: RouteContext<T> & {
         [key: string]: any;
-    }): Promise<any>;
+    }): Promise<RouteContext<T, {}, {
+        [key: string]: any;
+    }>>;
     /**
      * 返回的数据包含所有的context的请求返回的内容，可做其他处理
      * @param message
@@ -251,9 +271,15 @@ declare class QueryRouter implements throwError {
         path?: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
+    }, ctx?: RouteContext<T> & {
         [key: string]: any;
-    }): Promise<any>;
+    }): Promise<RouteContext<T, {}, {
+        [key: string]: any;
+    }> | {
+        code: number;
+        body: any;
+        message: string;
+    }>;
     /**
      * 请求 result 的数据
      * @param message
@@ -269,9 +295,9 @@ declare class QueryRouter implements throwError {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<{
-        code: any;
+        code: number;
         data: any;
-        message: any;
+        message: string;
     }>;
     /**
      * Router Run获取数据
@@ -284,12 +310,12 @@ declare class QueryRouter implements throwError {
         path?: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
+    }, ctx?: RouteContext<T> & {
         [key: string]: any;
     }): Promise<{
-        code: any;
+        code: number;
         data: any;
-        message: any;
+        message: string;
     }>;
     /**
      * 设置上下文
@@ -301,12 +327,12 @@ declare class QueryRouter implements throwError {
     /**
      * 获取handle函数, 这里会去执行parse函数
      */
-    getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
+    getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn, ctx?: RouteContext): (msg: {
         id?: string;
         path?: string;
         key?: string;
         [key: string]: any;
-    }, handleContext?: RouteContext) => Promise<{
+    }, handleContext?: RouteContext<T>) => Promise<{
         [key: string]: any;
         code: string;
         data?: any;
@@ -320,22 +346,16 @@ declare class QueryRouter implements throwError {
         message: any;
         data?: undefined;
     }>;
-    exportRoutes(): Route<{
-        [key: string]: any;
-    }, SimpleObject>[];
+    exportRoutes(): Route<SimpleObject, SimpleObject>[];
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(...args: any[]): void;
-    hasRoute(path: string, key?: string): Route<{
-        [key: string]: any;
-    }, SimpleObject>;
+    hasRoute(path: string, key?: string): Route<SimpleObject, SimpleObject>;
     findRoute(opts?: {
         path?: string;
         key?: string;
         id?: string;
-    }): Route<{
-        [key: string]: any;
-    }, SimpleObject>;
+    }): Route<SimpleObject, SimpleObject>;
     createRouteList(opts?: {
         force?: boolean;
         filter?: (route: Route) => boolean;
@@ -377,10 +397,11 @@ declare class QueryRouter implements throwError {
         [key: string]: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
     };
 }
-type QueryRouterServerOpts = {
+type QueryRouterServerOpts<C extends SimpleObject = SimpleObject> = {
     handleFn?: HandleFn;
-    context?: RouteContext;
+    context?: RouteContext<C>;
     appId?: string;
+    initHandle?: boolean;
 };
 interface HandleFn<T = any> {
     (msg: {
@@ -397,20 +418,27 @@ interface HandleFn<T = any> {
 /**
  * QueryRouterServer
  * @description 移除server相关的功能，只保留router相关的功能，和http.createServer不相关，独立
+ * @template C 自定义 RouteContext 类型
  */
-declare class QueryRouterServer extends QueryRouter {
+declare class QueryRouterServer<C extends SimpleObject = SimpleObject> extends QueryRouter<C> {
     appId: string;
     handle: any;
-    constructor(opts?: QueryRouterServerOpts);
+    context: RouteContext<C>;
+    constructor(opts?: QueryRouterServerOpts<C>);
     setHandle(wrapperFn?: HandleFn, ctx?: RouteContext): void;
     addRoute(route: Route, opts?: AddOpts): void;
     Route: typeof Route;
-    route(opts: RouteOpts): Route<Required<RouteContext>>;
-    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>>;
+    route<M extends SimpleObject = SimpleObject>(opts: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject = SimpleObject>(path: string, opts?: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject = SimpleObject>(path: string, key?: string): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject = SimpleObject>(path: string, key?: string, opts?: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    prompt(description: string): Route<SimpleObject, SimpleObject>;
     /**
      * 调用了handle
      * @param param0
@@ -421,9 +449,7 @@ declare class QueryRouterServer extends QueryRouter {
         path?: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<any>;
+    }, ctx?: Partial<RouteContext<C>>): Promise<any>;
 }
 
 type Cors = {
@@ -477,15 +503,32 @@ type OnWebSocketOptions<T = {}> = {
     message: string | Buffer;
     pathname: string;
     token?: string;
+    /** data 的id提取出来 */
     id?: string;
 };
 type WS<T = {}> = {
     send: (data: any) => void;
     close: (code?: number, reason?: string) => void;
+    /**
+   * ws 自己生成的一个id，主要是为了区分不同的ws连接，方便在onWebSocket中使用
+   */
+    wsId?: string;
     data?: {
+        /**
+         * ws连接时的url，包含pathname和searchParams
+         */
         url: URL;
+        /**
+         * ws连接时的pathname
+         */
         pathname: string;
+        /**
+         * ws连接时的url中的token参数
+         */
         token?: string;
+        /**
+         * ws连接时的url中的id参数.
+         */
         id?: string;
         /**
          * 鉴权后的获取的信息
@@ -674,7 +717,7 @@ type RouterHandle = (msg: {
     [key: string]: any;
 };
 type AppOptions<T = {}> = {
-    router?: QueryRouter;
+    router?: QueryRouterServer;
     server?: ServerType;
     /** handle msg 关联 */
     routerHandle?: RouterHandle;
@@ -682,17 +725,18 @@ type AppOptions<T = {}> = {
     serverOptions?: ServerNodeOpts;
     appId?: string;
 };
-type AppRouteContext<T = {}> = HandleCtx & RouteContext<T> & {
+type AppRouteContext<T> = HandleCtx & RouteContext<T> & {
     app: App<T>;
 };
 /**
  *  封装了 Router 和 Server 的 App 模块，处理http的请求和响应，内置了 Cookie 和 Token 和 res 的处理
  *  U - Route Context的扩展类型
  */
-declare class App<U = {}> extends QueryRouter {
+declare class App<U = {}> extends QueryRouterServer<AppRouteContext<U>> {
     appId: string;
-    router: QueryRouter;
+    router: QueryRouterServer;
     server: ServerType;
+    context: AppRouteContext<U>;
     constructor(opts?: AppOptions<U>);
     listen(port: number, hostname?: string, backlog?: number, listeningListener?: () => void): void;
     listen(port: number, hostname?: string, listeningListener?: () => void): void;
@@ -702,34 +746,7 @@ declare class App<U = {}> extends QueryRouter {
     listen(path: string, listeningListener?: () => void): void;
     listen(handle: any, backlog?: number, listeningListener?: () => void): void;
     listen(handle: any, listeningListener?: () => void): void;
-    addRoute(route: Route, opts?: AddOpts): void;
     Route: typeof Route;
-    route(opts: RouteOpts<AppRouteContext<U>>): Route<AppRouteContext<U>>;
-    route(path: string, key?: string): Route<AppRouteContext<U>>;
-    route(path: string, opts?: RouteOpts<AppRouteContext<U>>): Route<AppRouteContext<U>>;
-    route(path: string, key?: string, opts?: RouteOpts<AppRouteContext<U>>): Route<AppRouteContext<U>>;
-    prompt(description: string): Route<AppRouteContext<U>>;
-    prompt(description: Function): Route<AppRouteContext<U>>;
-    call(message: {
-        id?: string;
-        path?: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: AppRouteContext<U> & {
-        [key: string]: any;
-    }): Promise<any>;
-    run(msg: {
-        id?: string;
-        path?: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: Partial<AppRouteContext<U>> & {
-        [key: string]: any;
-    }): Promise<{
-        code: any;
-        data: any;
-        message: any;
-    }>;
     static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<{
         cookies: Record<string, string>;
         token: string;

package/dist/opencode.js

@@ -14703,7 +14703,7 @@ var addCallFn = (app) => {
     path: "call",
     key: "",
     description: "调用",
-    middleware: ["auth"],
+    middleware: ["auth-admin"],
     metadata: {
       tags: ["opencode"],
       ...createSkill({
@@ -14717,7 +14717,7 @@ var addCallFn = (app) => {
         args: {
           path: tool.schema.string().describe("应用路径，例如 cnb"),
           key: tool.schema.string().optional().describe("应用key，例如 list-repos"),
-          payload: tool.schema.object({}).optional().describe("调用参数")
+          payload: tool.schema.object({}).optional().describe('调用参数, 为对象, 例如 { "query": "javascript" }')
         }
       })
     }
@@ -14745,8 +14745,13 @@ var createRouterAgentPluginFn = (opts) => {
   if (!router.hasRoute("call", "")) {
     addCallFn(router);
   }
-  if (!router.hasRoute("auth", "")) {
-    router.route({ path: "auth", key: "", id: "auth", description: "认证" }).define(async (ctx) => {}).addTo(router);
+  if (router) {
+    router.route({ path: "auth", key: "", id: "auth", description: "认证" }).define(async (ctx) => {}).addTo(router, {
+      overwrite: false
+    });
+    router.route({ path: "auth-admin", key: "", id: "auth-admin", description: "认证" }).define(async (ctx) => {}).addTo(router, {
+      overwrite: false
+    });
   }
   const _routes = filter(router.routes, opts?.query || "");
   const routes = _routes.filter((r) => {
@@ -14760,7 +14765,7 @@ var createRouterAgentPluginFn = (opts) => {
     return false;
   });
   const AgentPlugin = async (pluginInput) => {
-    useContextKey("plugin-input", () => pluginInput, true);
+    useContextKey("plugin-input", () => pluginInput, { isNew: true });
     const hooks = opts?.hooks ? await opts.hooks(pluginInput) : {};
     return {
       ...hooks,