@kevisual/router 0.0.83 → 0.0.85

package/dist/router.d.ts

@@ -80,9 +80,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$1 = {}, S = {
+    [key: string]: any;
+}> = {
     /**
      * 本地自己调用的时候使用，可以标识为当前自调用，那么 auth 就不许重复的校验
      * 或者不需要登录的，直接调用
@@ -105,7 +116,14 @@ type RouteContext<T = {
     code?: number;
     /** return msg */
     message?: string;
+    /**
+     * 传递状态
+     */
     state?: S;
+    /**
+     * 当前routerId
+     */
+    currentId?: string;
     /**
      * 当前路径
      */
@@ -146,14 +164,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$1 = Record<string, any>;
 type Run<T extends SimpleObject$1 = {}> = (ctx: Required<RouteContext<T>>) => Promise<typeof ctx | null | void>;
 type RunMessage = {
@@ -164,7 +180,7 @@ type RunMessage = {
 };
 type NextRoute = Pick<Route, 'id' | 'path' | 'key'>;
 type RouteMiddleware = {
-    path: string;
+    path?: string;
     key?: string;
     id?: string;
 } | string;
@@ -177,7 +193,7 @@ type RouteOpts<U = {}, T = SimpleObject$1> = {
     description?: string;
     metadata?: T;
     middleware?: RouteMiddleware[];
-    type?: 'route' | 'middleware';
+    type?: 'route' | 'middleware' | 'compound';
     /**
      * $#$ will be used to split path and key
      */
@@ -205,9 +221,11 @@ declare const tool: {
 /** */
 declare const createSkill: <T = SimpleObject$1>(skill: Skill<T>) => Skill<T>;
 type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
-declare class Route<U = {
-    [key: string]: any;
-}, T extends SimpleObject$1 = SimpleObject$1> implements throwError {
+/**
+ * @M 是 route的 metadate的类型，默认是 SimpleObject
+ * @U 是 RouteContext 里 state的类型
+ */
+declare class Route<M extends SimpleObject$1 = SimpleObject$1, U extends SimpleObject$1 = SimpleObject$1> implements throwError {
     /**
      * 一级路径
      */
@@ -217,10 +235,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;
     /**
@@ -235,13 +253,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;
@@ -272,11 +290,11 @@ declare const fromJSONSchema: <Merge extends boolean = false>(args?: any, opts?:
 type AddOpts = {
     overwrite?: boolean;
 };
-declare class QueryRouter implements throwError {
+declare class QueryRouter<T extends SimpleObject$1 = SimpleObject$1> implements throwError {
     appId: string;
     routes: Route[];
     maxNextRoute: number;
-    context?: RouteContext;
+    context?: RouteContext<T>;
     constructor();
     /**
      * add route
@@ -304,7 +322,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
@@ -315,9 +333,11 @@ declare class QueryRouter implements throwError {
         path: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
+    }, ctx?: RouteContext<T> & {
+        [key: string]: any;
+    }): Promise<RouteContext<T, {}, {
         [key: string]: any;
-    }): Promise<any>;
+    }>>;
     /**
      * 返回的数据包含所有的context的请求返回的内容，可做其他处理
      * @param message
@@ -329,9 +349,15 @@ declare class QueryRouter implements throwError {
         path?: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
+    }, ctx?: RouteContext<T> & {
+        [key: string]: any;
+    }): Promise<RouteContext<T, {}, {
         [key: string]: any;
-    }): Promise<any>;
+    }> | {
+        code: number;
+        body: any;
+        message: string;
+    }>;
     /**
      * 请求 result 的数据
      * @param message
@@ -347,9 +373,9 @@ declare class QueryRouter implements throwError {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<{
-        code: any;
+        code: number;
         data: any;
-        message: any;
+        message: string;
     }>;
     /**
      * Router Run获取数据
@@ -362,12 +388,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;
     }>;
     /**
      * 设置上下文
@@ -379,12 +405,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;
@@ -398,22 +424,16 @@ declare class QueryRouter implements throwError {
         message: any;
         data?: undefined;
     }>;
-    exportRoutes(): Route<{
-        [key: string]: any;
-    }, SimpleObject$1>[];
+    exportRoutes(): Route<SimpleObject$1, SimpleObject$1>[];
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(...args: any[]): void;
-    hasRoute(path: string, key?: string): Route<{
-        [key: string]: any;
-    }, SimpleObject$1>;
+    hasRoute(path: string, key?: string): Route<SimpleObject$1, SimpleObject$1>;
     findRoute(opts?: {
         path?: string;
         key?: string;
         id?: string;
-    }): Route<{
-        [key: string]: any;
-    }, SimpleObject$1>;
+    }): Route<SimpleObject$1, SimpleObject$1>;
     createRouteList(opts?: {
         force?: boolean;
         filter?: (route: Route) => boolean;
@@ -455,10 +475,11 @@ declare class QueryRouter implements throwError {
         [key: string]: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
     };
 }
-type QueryRouterServerOpts = {
+type QueryRouterServerOpts<C extends SimpleObject$1 = SimpleObject$1> = {
     handleFn?: HandleFn;
-    context?: RouteContext;
+    context?: RouteContext<C>;
     appId?: string;
+    initHandle?: boolean;
 };
 interface HandleFn<T = any> {
     (msg: {
@@ -475,20 +496,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$1 = SimpleObject$1> 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$1 = SimpleObject$1>(opts: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject$1 = SimpleObject$1>(path: string, opts?: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject$1 = SimpleObject$1>(path: string, key?: string): Route<M, Required<RouteContext<C>>>;
+    route<M extends SimpleObject$1 = SimpleObject$1>(path: string, key?: string, opts?: RouteOpts & {
+        metadata?: M;
+    }): Route<M, Required<RouteContext<C>>>;
+    prompt(description: string): Route<SimpleObject$1, SimpleObject$1>;
     /**
      * 调用了handle
      * @param param0
@@ -499,9 +527,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>;
 }
 declare class Mini extends QueryRouterServer {
 }
@@ -662,16 +688,33 @@ type OnWebSocketOptions<T = {}> = {
     message: string | Buffer;
     pathname: string;
     token?: string;
+    /** data 的id提取出来 */
     id?: string;
 };
 type OnWebSocketFn = (options: OnWebSocketOptions) => Promise<void> | void;
 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;
         /**
          * 鉴权后的获取的信息
@@ -890,6 +933,7 @@ declare class ServerBase implements ServerType {
      */
     onWsClose(ws: WS): Promise<void>;
     sendConnected(ws: WS): Promise<void>;
+    createId(): string;
 }
 
 type WsServerBaseOpts = {
@@ -902,6 +946,7 @@ declare class WsServerBase {
     server: ServerType;
     constructor(opts: WsServerBaseOpts);
     listen(): void;
+    createId(): string;
 }
 declare class WsServer extends WsServerBase {
     constructor(server: ServerType);
@@ -957,7 +1002,7 @@ type RouterHandle = (msg: {
     [key: string]: any;
 };
 type AppOptions<T = {}> = {
-    router?: QueryRouter;
+    router?: QueryRouterServer;
     server?: ServerType;
     /** handle msg 关联 */
     routerHandle?: RouterHandle;
@@ -965,17 +1010,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;
@@ -985,34 +1031,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/router.js

@@ -3091,7 +3091,7 @@ function pick(obj, keys) {
 // node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.mjs
 var import__ = __toESM(require_eventemitter3(), 1);
 
-// node_modules/.pnpm/es-toolkit@1.44.0/node_modules/es-toolkit/dist/predicate/isPlainObject.mjs
+// node_modules/.pnpm/es-toolkit@1.45.1/node_modules/es-toolkit/dist/predicate/isPlainObject.mjs
 function isPlainObject(value) {
   if (!value || typeof value !== "object") {
     return false;
@@ -3104,12 +3104,12 @@ function isPlainObject(value) {
   return Object.prototype.toString.call(value) === "[object Object]";
 }
 
-// node_modules/.pnpm/es-toolkit@1.44.0/node_modules/es-toolkit/dist/_internal/isUnsafeProperty.mjs
+// node_modules/.pnpm/es-toolkit@1.45.1/node_modules/es-toolkit/dist/_internal/isUnsafeProperty.mjs
 function isUnsafeProperty(key) {
   return key === "__proto__";
 }
 
-// node_modules/.pnpm/es-toolkit@1.44.0/node_modules/es-toolkit/dist/object/merge.mjs
+// node_modules/.pnpm/es-toolkit@1.45.1/node_modules/es-toolkit/dist/object/merge.mjs
 function merge(target, source) {
   const sourceKeys = Object.keys(source);
   for (let i = 0;i < sourceKeys.length; i++) {
@@ -16929,7 +16929,7 @@ class Route {
     if (opts) {
       this.id = opts.id || randomId(12, "rand-");
       if (!opts.id && opts.idUsePath) {
-        const delimiter = opts.delimiter ?? "$#$";
+        const delimiter = opts.delimiter ?? "$$";
         this.id = path + delimiter + key;
       }
       this.run = opts.run;
@@ -17052,6 +17052,7 @@ class QueryRouter {
     const maxNextRoute = this.maxNextRoute;
     ctx = ctx || {};
     ctx.currentPath = path;
+    ctx.currentId = route?.id;
     ctx.currentKey = key;
     ctx.currentRoute = route;
     ctx.index = (ctx.index || 0) + 1;
@@ -17065,7 +17066,7 @@ class QueryRouter {
       ctx.code = 500;
       ctx.message = "Too many nextRoute";
       ctx.body = null;
-      return;
+      return ctx;
     }
     if (route && route.middleware && route.middleware.length > 0) {
       const errorMiddleware = [];
@@ -17140,7 +17141,9 @@ class QueryRouter {
             }
             return ctx;
           }
-          if (ctx.end) {}
+          if (ctx.end) {
+            return ctx;
+          }
         }
       }
     }
@@ -17334,7 +17337,7 @@ class QueryRouter {
         description: "列出当前应用下的所有的路由信息",
         middleware: opts?.middleware || [],
         run: async (ctx) => {
-          const tokenUser = ctx.state.tokenUser;
+          const tokenUser = ctx.state;
           let isUser = !!tokenUser;
           const list = this.getList(opts?.filter).filter((item) => {
             if (item.id === "auth" || item.id === "auth-can" || item.id === "check-auth-admin" || item.id === "auth-admin") {
@@ -17369,7 +17372,10 @@ class QueryRouterServer extends QueryRouter {
   handle;
   constructor(opts) {
     super();
-    this.handle = this.getHandle(this, opts?.handleFn, opts?.context);
+    const initHandle = opts?.initHandle ?? true;
+    if (initHandle || opts?.handleFn) {
+      this.handle = this.getHandle(this, opts?.handleFn, opts?.context);
+    }
     this.setContext({ needSerialize: false, ...opts?.context });
     if (opts?.appId) {
       this.appId = opts.appId;
@@ -17400,15 +17406,8 @@ 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() || "";
-    }
-    return new Route("", "", { description });
+  prompt(description) {
+    return new Route(undefined, undefined, { description });
   }
   async run(msg, ctx) {
     const handle = this.handle;
@@ -18089,7 +18088,7 @@ class ServerBase {
     }
   }
   async onWsClose(ws) {
-    const id = ws?.data?.id || "";
+    const id = ws?.wsId || "";
     if (id) {
       this.emitter.emit("close--" + id, { type: "close", ws, id });
       setTimeout(() => {
@@ -18102,6 +18101,9 @@ class ServerBase {
     if (this.showConnected)
       ws.send(JSON.stringify({ type: "connected" }));
   }
+  createId() {
+    return Math.random().toString(36).substring(2, 15);
+  }
 }
 
 // node_modules/.pnpm/@kevisual+ws@8.0.0/node_modules/@kevisual/ws/wrapper.mjs
@@ -18142,6 +18144,9 @@ class WsServerBase {
         token,
         id
       };
+      if (!ws.wsId) {
+        ws.wsId = this.createId();
+      }
       ws.on("message", async (message) => {
         await this.server.onWebSocket({ ws, message, pathname, token, id });
       });
@@ -18152,6 +18157,9 @@ class WsServerBase {
       });
     });
   }
+  createId() {
+    return Math.random().toString(36).substring(2, 15);
+  }
 }
 
 class WsServer extends WsServerBase {
@@ -18466,10 +18474,14 @@ class BunServer extends ServerBase {
         open: (ws) => {
           this.sendConnected(ws);
         },
-        message: async (ws, message) => {
+        message: async (bunWs, message) => {
+          const ws = bunWs;
           const pathname = ws.data.pathname || "";
           const token = ws.data.token || "";
           const id = ws.data.id || "";
+          if (!ws.wsId) {
+            ws.wsId = this.createId();
+          }
           await this.onWebSocket({ ws, message, pathname, token, id });
         },
         close: (ws) => {
@@ -18484,11 +18496,11 @@ class BunServer extends ServerBase {
   }
 }
 // src/app.ts
-class App extends QueryRouter {
+class App extends QueryRouterServer {
   router;
   server;
   constructor(opts) {
-    super();
+    super({ initHandle: false, context: { needSerialize: true, ...opts?.routerContext } });
     const router = this;
     let server = opts?.server;
     if (!server) {
@@ -18500,7 +18512,6 @@ class App extends QueryRouter {
       }
     }
     server.setHandle(router.getHandle(router, opts?.routerHandle, opts?.routerContext));
-    router.setContext({ needSerialize: true, ...opts?.routerContext });
     this.router = router;
     this.server = server;
     if (opts?.appId) {
@@ -18513,42 +18524,7 @@ class App extends QueryRouter {
   listen(...args) {
     this.server.listen(...args);
   }
-  addRoute(route, opts) {
-    super.add(route, opts);
-  }
   Route = Route;
-  route(...args) {
-    const [path, key, opts] = args;
-    if (typeof path === "object") {
-      return new Route(path.path, path.key, path);
-    }
-    if (typeof path === "string") {
-      if (opts) {
-        return new Route(path, key, opts);
-      }
-      if (key && typeof key === "object") {
-        return new Route(path, key?.key || "", key);
-      }
-      return new Route(path, key);
-    }
-    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() || "";
-    }
-    return new Route("", "", { description });
-  }
-  async call(message, ctx) {
-    return await super.call(message, ctx);
-  }
-  async run(msg, ctx) {
-    return await super.run(msg, ctx);
-  }
   static handleRequest(req, res) {
     return handleServer(req, res);
   }