@kevisual/router 0.0.82 → 0.0.84

package/dist/router-define.d.ts

@@ -7,6 +7,11 @@ type CustomErrorOptions = {
     code?: number;
     message?: string;
 };
+interface throwError {
+    throw(code?: number | string, message?: string): void;
+    throw(code?: number | string, opts?: CustomErrorOptions): void;
+    throw(opts?: CustomErrorOptions): void;
+}
 
 declare class MockProcess {
     emitter?: EventEmitter;
@@ -25,9 +30,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 就不许重复的校验
      * 或者不需要登录的，直接调用
@@ -50,7 +66,14 @@ type RouteContext<T = {
     code?: number;
     /** return msg */
     message?: string;
+    /**
+     * 传递状态
+     */
     state?: S;
+    /**
+     * 当前routerId
+     */
+    currentId?: string;
     /**
      * 当前路径
      */
@@ -91,14 +114,12 @@ type RouteContext<T = {
         path: string;
         key?: string;
         payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }) => Promise<any>;
+    }, ctx?: RouteContext) => Promise<any>;
     index?: number;
-    throw?: (code?: number | string, message?: string, tips?: string) => void;
+    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 = {
@@ -109,7 +130,7 @@ type RunMessage = {
 };
 type NextRoute = Pick<Route, 'id' | 'path' | 'key'>;
 type RouteMiddleware = {
-    path: string;
+    path?: string;
     key?: string;
     id?: string;
 } | string;
@@ -136,9 +157,11 @@ type RouteOpts<U = {}, T = SimpleObject$1> = {
 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$1 = SimpleObject$1> {
+/**
+ * @M 是 route的 metadate的类型，默认是 SimpleObject
+ * @U 是 RouteContext 里 state的类型
+ */
+declare class Route<M extends SimpleObject$1 = SimpleObject$1, U extends SimpleObject$1 = SimpleObject$1> implements throwError {
     /**
      * 一级路径
      */
@@ -148,10 +171,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;
     /**
@@ -166,19 +189,19 @@ 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;
         [key: string]: any;
     }, opts?: AddOpts): void;
-    throw(code?: number | string, message?: string, tips?: string): void;
+    throw(...args: any[]): void;
 }
 /**
  * @parmas overwrite 是否覆盖已存在的route，默认true
@@ -186,11 +209,11 @@ declare class Route<U = {
 type AddOpts = {
     overwrite?: boolean;
 };
-declare class QueryRouter {
+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
@@ -218,7 +241,7 @@ declare class QueryRouter {
      * @param ctx
      * @returns
      */
-    runRoute(path: string, key: string, ctx?: RouteContext): any;
+    runRoute(path: string, key: string, ctx?: RouteContext<T>): Promise<RouteContext<T>>;
     /**
      * 第一次执行
      * @param message
@@ -229,9 +252,11 @@ declare class QueryRouter {
         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
@@ -243,9 +268,15 @@ declare class QueryRouter {
         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
@@ -261,9 +292,9 @@ declare class QueryRouter {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<{
-        code: any;
+        code: number;
         data: any;
-        message: any;
+        message: string;
     }>;
     /**
      * Router Run获取数据
@@ -276,12 +307,12 @@ declare class QueryRouter {
         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;
     }>;
     /**
      * 设置上下文
@@ -293,12 +324,12 @@ declare class QueryRouter {
     /**
      * 获取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;
@@ -312,24 +343,16 @@ declare class QueryRouter {
         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(code?: number | string, message?: string): void;
-    throw(code?: number | string, opts?: CustomErrorOptions): void;
-    throw(opts?: CustomErrorOptions): void;
-    hasRoute(path: string, key?: string): Route<{
-        [key: string]: any;
-    }, SimpleObject$1>;
+    throw(...args: any[]): void;
+    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;
@@ -371,10 +394,11 @@ declare class QueryRouter {
         [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: {
@@ -391,20 +415,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
@@ -415,9 +446,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 RouteObject = {