@kevisual/router 0.2.10 → 0.2.12

package/dist/router-browser.d.ts

@@ -53,6 +53,80 @@ declare class MockProcess {
     on(fn: (msg?: any) => any): void;
     desctroy(): void;
 }
+type ListenProcessParams = {
+    message?: RunMessage;
+    context?: any;
+};
+type ListenProcessResponse = {
+    success?: boolean;
+    data?: {
+        code?: number;
+        data?: any;
+        message?: string;
+        [key: string]: any;
+    };
+    error?: any;
+    timestamp?: string;
+    [key: string]: any;
+};
+type ListenProcessOptions = {
+    app?: QueryRouterServer;
+    mockProcess?: MockProcess;
+    params?: ListenProcessParams;
+    timeout?: number;
+};
+declare const listenProcess: ({ app, mockProcess, params, timeout }: ListenProcessOptions) => Promise<void>;
+
+/** JSON Schema 基本类型映射到 TypeScript 类型 */
+type JsonSchemaTypeToTS<T> = T extends {
+    type: "string";
+} ? string : T extends {
+    type: "boolean";
+} ? boolean : T extends {
+    type: "number";
+} ? number : T extends {
+    type: "integer";
+} ? number : T extends {
+    type: "object";
+} ? object : T extends {
+    type: "array";
+} ? any[] : any;
+/** 将 args shape（key -> JSON Schema 类型）转换为 payload 类型，支持 optional: true 的字段为可选 */
+type ArgsShapeToPayload<T> = {
+    [K in keyof T as T[K] extends {
+        optional: true;
+    } ? never : K]: JsonSchemaTypeToTS<T[K]>;
+} & {
+    [K in keyof T as T[K] extends {
+        optional: true;
+    } ? K : never]?: JsonSchemaTypeToTS<T[K]>;
+};
+/** 处理两种 args 格式：完整 JSON Schema（含 properties）或简单 key->type 映射 */
+type ArgsToPayload<T> = T extends {
+    type: "object";
+    properties: infer P;
+} ? ArgsShapeToPayload<P> : ArgsShapeToPayload<T>;
+/** 从 API 定义中提取 metadata.args */
+type ExtractArgs<T> = T extends {
+    metadata: {
+        args: infer A;
+    };
+} ? A : {};
+/** 从 API 定义中提取 metadata.returns */
+type ExtractReturns<T> = T extends {
+    metadata: {
+        returns: infer R;
+    };
+} ? R : unknown;
+/** runAction 第二个参数的类型，根据第一个参数的 metadata.args 推断 */
+type RunActionPayload<T> = ArgsToPayload<ExtractArgs<T>>;
+/** runAction 的返回类型，根据 API 定义中的 metadata.returns 推断 data 字段类型 */
+type RunActionReturns<T> = {
+    code: number | string;
+    data?: unknown extends ExtractReturns<T> ? any : ArgsToPayload<ExtractReturns<T>>;
+    message?: string;
+    [key: string]: any;
+};
 
 type RouterContextT = {
     code?: number;
@@ -525,8 +599,9 @@ declare class QueryRouterServer<C extends SimpleObject$1 = SimpleObject$1> exten
         key?: string;
         metadata?: {
             args?: any;
+            returns?: any;
         };
-    } = {}>(api: T, payload: RunActionPayload<T>, ctx?: RouteContext<C>): Promise<any>;
+    } = {}>(api: T, payload: RunActionPayload<T>, ctx?: RouteContext<C>): Promise<RunActionReturns<T>>;
     /**
      * 创建认证相关的中间件，默认是 auth, auth-admin, auth-can 三个中间件
      * @param fun 认证函数，接收 RouteContext 和认证类型
@@ -537,43 +612,6 @@ declare class QueryRouterServer<C extends SimpleObject$1 = SimpleObject$1> exten
 }
 declare class Mini extends QueryRouterServer {
 }
-/** JSON Schema 基本类型映射到 TypeScript 类型 */
-type JsonSchemaTypeToTS<T> = T extends {
-    type: "string";
-} ? string : T extends {
-    type: "boolean";
-} ? boolean : T extends {
-    type: "number";
-} ? number : T extends {
-    type: "integer";
-} ? number : T extends {
-    type: "object";
-} ? object : T extends {
-    type: "array";
-} ? any[] : any;
-/** 将 args shape（key -> JSON Schema 类型）转换为 payload 类型，支持 optional: true 的字段为可选 */
-type ArgsShapeToPayload<T> = {
-    [K in keyof T as T[K] extends {
-        optional: true;
-    } ? never : K]: JsonSchemaTypeToTS<T[K]>;
-} & {
-    [K in keyof T as T[K] extends {
-        optional: true;
-    } ? K : never]?: JsonSchemaTypeToTS<T[K]>;
-};
-/** 处理两种 args 格式：完整 JSON Schema（含 properties）或简单 key->type 映射 */
-type ArgsToPayload<T> = T extends {
-    type: "object";
-    properties: infer P;
-} ? ArgsShapeToPayload<P> : ArgsShapeToPayload<T>;
-/** 从 API 定义中提取 metadata.args */
-type ExtractArgs<T> = T extends {
-    metadata: {
-        args: infer A;
-    };
-} ? A : {};
-/** runAction 第二个参数的类型，根据第一个参数的 metadata.args 推断 */
-type RunActionPayload<T> = ArgsToPayload<ExtractArgs<T>>;
 
 type BaseRule = {
     value?: any;
@@ -682,5 +720,5 @@ declare class QueryUtil<T extends RouteObject = RouteObject> {
 
 declare const App: typeof QueryRouterServer;
 
-export { App, CustomError, Mini, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, createSkill, define, fromJSONSchema, toJSONSchema, tool, util };
-export type { RouteArray, RouteContext, RouteInfo, RouteMiddleware, RouteObject, RouteOpts, Rule, Run, Schema, Skill };
+export { App, CustomError, Mini, MockProcess, QueryRouter, QueryRouterServer, QueryUtil, Route, createSchema, createSkill, define, fromJSONSchema, listenProcess, toJSONSchema, tool, util };
+export type { ListenProcessOptions, ListenProcessParams, ListenProcessResponse, RouteArray, RouteContext, RouteInfo, RouteMiddleware, RouteObject, RouteOpts, Rule, Run, Schema, Skill };