@kevisual/router 0.0.35 → 0.0.37

package/dist/router-define.d.ts

@@ -48,7 +48,7 @@ declare class QueryChain {
      * @param queryData
      * @returns
      */
-    getKey(queryData?: SimpleObject): Pick<RouteOpts, 'path' | 'key' | 'metadata' | 'description' | 'validator'>;
+    getKey(queryData?: SimpleObject): Pick<RouteOpts, 'path' | 'key' | 'metadata' | 'description'>;
     post<R = SimpleObject, P = SimpleObject>(data: P, options?: DataOpts): Promise<Result<R>>;
     get<R = SimpleObject, P = SimpleObject>(data: P, options?: DataOpts): Promise<Result<R>>;
 }

package/dist/router.d.ts

@@ -1,50 +1,13 @@
-import { z } from 'zod';
 import http, { IncomingMessage, ServerResponse } from 'node:http';
 import https from 'node:https';
 import http2 from 'node:http2';
 import * as cookie from 'cookie';
+import { z } from 'zod';
 import { WebSocketServer, WebSocket } from 'ws';
 import { IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'http';
 import { RouteOpts as RouteOpts$1, QueryRouterServer as QueryRouterServer$1, RouteMiddleware as RouteMiddleware$1, Run as Run$1 } from '@kevisual/router';
 import { Query, DataOpts, Result } from '@kevisual/query/query';
 
-type BaseRule = {
-    value?: any;
-    required?: boolean;
-    message?: string;
-};
-type RuleString = {
-    type: 'string';
-    min?: number;
-    max?: number;
-    regex?: string;
-} & BaseRule;
-type RuleNumber = {
-    type: 'number';
-    min?: number;
-    max?: number;
-} & BaseRule;
-type RuleBoolean = {
-    type: 'boolean';
-} & BaseRule;
-type RuleArray = {
-    type: 'array';
-    items: Rule;
-} & BaseRule;
-type RuleObject = {
-    type: 'object';
-    properties: {
-        [key: string]: Rule;
-    };
-} & BaseRule;
-type RuleAny = {
-    type: 'any';
-} & BaseRule;
-type Rule = RuleString | RuleNumber | RuleBoolean | RuleArray | RuleObject | RuleAny;
-declare const createSchema: (rule: Rule) => z.ZodType<any, any, any>;
-
-type Schema = z.ZodType<any, any, any>;
-
 type RouterContextT = {
     code?: number;
     [key: string]: any;
@@ -57,6 +20,11 @@ type RouteContext<T = {
     };
     /** return body */
     body?: number | string | Object;
+    forward?: (response: {
+        code: number;
+        data?: any;
+        message?: any;
+    }) => void;
     /** return code */
     code?: number;
     /** return msg */
@@ -82,12 +50,9 @@ type RouteContext<T = {
         [key: string]: any;
     };
     end?: boolean;
-    /**
-     * 请求 route的返回结果，包函ctx
-     */
-    queryRouter?: QueryRouter;
+    app?: QueryRouter;
     error?: any;
-    /** 请求 route的返回结果，包函ctx */
+    /** 请求 route的返回结果，不解析body为data */
     call?: (message: {
         path: string;
         key?: string;
@@ -100,8 +65,8 @@ type RouteContext<T = {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }) => Promise<any>;
-    /** 请求 route的返回结果，不包函ctx */
-    queryRoute?: (message: {
+    /** 请求 route的返回结果，解析了body为data，就类同于 query.post获取的数据*/
+    run?: (message: {
         path: string;
         key?: string;
         payload?: any;
@@ -121,11 +86,11 @@ type RouteMiddleware = {
     key?: string;
     id?: string;
 } | string;
-type RouteOpts = {
+type RouteOpts<T = {}> = {
     path?: string;
     key?: string;
     id?: string;
-    run?: Run;
+    run?: Run<T>;
     nextRoute?: NextRoute;
     description?: string;
     metadata?: {
@@ -133,23 +98,6 @@ type RouteOpts = {
     };
     middleware?: RouteMiddleware[];
     type?: 'route' | 'middleware';
-    /**
-     * validator: {
-     *  packageName: {
-     *    type: 'string',
-     *    required: true,
-     *  },
-     * }
-     */
-    validator?: {
-        [key: string]: Rule;
-    };
-    schema?: {
-        [key: string]: any;
-    };
-    isVerify?: boolean;
-    verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
-    verifyKey?: (key: string, ctx?: RouteContext, dev?: boolean) => boolean;
     /**
      * $#$ will be used to split path and key
      */
@@ -160,8 +108,8 @@ type RouteOpts = {
     delimiter?: string;
     isDebug?: boolean;
 };
-type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'verify' | 'verifyKey' | 'nextRoute'>;
-declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware", "metadata"];
+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;
@@ -183,59 +131,12 @@ declare class Route<U = {
     };
     middleware?: RouteMiddleware[];
     type?: string;
-    private _validator?;
-    schema?: {
-        [key: string]: any;
-    };
     data?: any;
-    /**
-     * 是否需要验证
-     */
-    isVerify?: boolean;
     /**
      * 是否开启debug，开启后会打印错误信息
      */
     isDebug?: boolean;
     constructor(path?: string, key?: string, opts?: RouteOpts);
-    private createSchema;
-    /**
-     * set validator and create schema
-     * @param validator
-     */
-    set validator(validator: {
-        [key: string]: Rule;
-    });
-    get validator(): {
-        [key: string]: Rule;
-    };
-    /**
-     * has code, body, message in ctx, return ctx if has error
-     * @param ctx
-     * @param dev
-     * @returns
-     */
-    verify(ctx: RouteContext, dev?: boolean): void;
-    /**
-     * Need to manully call return ctx fn and configure body, code, message
-     * @param key
-     * @param ctx
-     * @param dev
-     * @returns
-     */
-    verifyKey(key: string, ctx: RouteContext, dev?: boolean): {
-        message: string;
-        path: string;
-        key: string;
-        error: any;
-    } | {
-        message: string;
-        path: string;
-        key: string;
-        error?: undefined;
-    };
-    setValidator(validator: {
-        [key: string]: Rule;
-    }): this;
     prompt(description: string): this;
     prompt(description: Function): this;
     define<T extends {
@@ -444,8 +345,9 @@ declare class QueryRouterServer extends QueryRouter {
      * @param param0
      * @returns
      */
-    run({ path, key, payload }: {
-        path: string;
+    run(msg: {
+        id?: string;
+        path?: string;
         key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
@@ -553,7 +455,7 @@ declare class Server {
      * @description 主要是为了兼容其他的监听
      * @param listener
      */
-    on(listener: Listener | Listener[]): void;
+    on(listener: Listener | Listener[]): () => void;
     get callback(): any;
     get server(): http.Server<typeof IncomingMessage, typeof ServerResponse> | https.Server<typeof IncomingMessage, typeof ServerResponse> | http2.Http2SecureServer<typeof IncomingMessage, typeof ServerResponse, typeof http2.Http2ServerRequest, typeof http2.Http2ServerResponse>;
 }
@@ -602,6 +504,43 @@ declare class CustomError extends Error {
     };
 }
 
+type BaseRule = {
+    value?: any;
+    required?: boolean;
+    message?: string;
+};
+type RuleString = {
+    type: 'string';
+    min?: number;
+    max?: number;
+    regex?: string;
+} & BaseRule;
+type RuleNumber = {
+    type: 'number';
+    min?: number;
+    max?: number;
+} & BaseRule;
+type RuleBoolean = {
+    type: 'boolean';
+} & BaseRule;
+type RuleArray = {
+    type: 'array';
+    items: Rule;
+} & BaseRule;
+type RuleObject = {
+    type: 'object';
+    properties: {
+        [key: string]: Rule;
+    };
+} & BaseRule;
+type RuleAny = {
+    type: 'any';
+} & BaseRule;
+type Rule = RuleString | RuleNumber | RuleBoolean | RuleArray | RuleObject | RuleAny;
+declare const createSchema: (rule: Rule) => z.ZodType<any, any, any>;
+
+type Schema = z.ZodType<any, any, any>;
+
 type WsServerBaseOpts = {
     wss?: WebSocketServer;
     path?: string;
@@ -678,7 +617,7 @@ declare class QueryChain {
      * @param queryData
      * @returns
      */
-    getKey(queryData?: SimpleObject): Pick<RouteOpts$1, 'path' | 'key' | 'metadata' | 'description' | 'validator'>;
+    getKey(queryData?: SimpleObject): Pick<RouteOpts$1, 'path' | 'key' | 'metadata' | 'description'>;
     post<R = SimpleObject, P = SimpleObject>(data: P, options?: DataOpts): Promise<Result<R>>;
     get<R = SimpleObject, P = SimpleObject>(data: P, options?: DataOpts): Promise<Result<R>>;
 }
@@ -723,15 +662,18 @@ type AppOptions<T = {}> = {
         path?: string;
     };
 };
-type AppReqRes = HandleCtx;
+type AppRouteContext<T = {}> = HandleCtx & RouteContext<T> & {
+    app: App<T>;
+};
 /**
  *  封装了 Router 和 Server 的 App 模块，处理http的请求和响应，内置了 Cookie 和 Token 和 res 的处理
+ *  U - Route Context的扩展类型
  */
-declare class App<T = {}, U = AppReqRes> {
+declare class App<U = {}> {
     router: QueryRouter;
     server: Server;
     io: WsServer;
-    constructor(opts?: AppOptions<T>);
+    constructor(opts?: AppOptions<U>);
     listen(port: number, hostname?: string, backlog?: number, listeningListener?: () => void): void;
     listen(port: number, hostname?: string, listeningListener?: () => void): void;
     listen(port: number, backlog?: number, listeningListener?: () => void): void;
@@ -744,21 +686,36 @@ declare class App<T = {}, U = AppReqRes> {
     addRoute(route: Route): void;
     add: (route: Route) => void;
     Route: typeof Route;
-    route(opts: RouteOpts): Route<U>;
-    route(path: string, key?: string): Route<U>;
-    route(path: string, opts?: RouteOpts): Route<U>;
-    route(path: string, key?: string, opts?: RouteOpts): Route<U>;
-    prompt(description: string): Route<Required<RouteContext>>;
-    prompt(description: Function): Route<Required<RouteContext>>;
+    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?: RouteContext & {
+    }, ctx?: AppRouteContext<U> & {
         [key: string]: any;
     }): Promise<any>;
-    queryRoute(path: string, key?: string, payload?: any, ctx?: RouteContext & {
+    /**
+     * @deprecated
+     */
+    queryRoute(path: string, key?: string, payload?: any, ctx?: AppRouteContext<U> & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
+    run(msg: {
+        id?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: AppRouteContext<U> & {
         [key: string]: any;
     }): Promise<{
         code: any;