@kevisual/router 0.0.34 → 0.0.36

package/dist/router-browser.d.ts

@@ -4,43 +4,6 @@ import { IncomingMessage } from 'node: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;
@@ -53,6 +16,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 */
@@ -78,12 +46,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;
@@ -96,8 +61,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;
@@ -117,11 +82,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?: {
@@ -129,23 +94,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
      */
@@ -156,8 +104,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;
@@ -179,59 +127,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 {
@@ -312,6 +213,7 @@ declare class QueryRouter {
      * 请求 result 的数据
      * @param message
      * @param ctx
+     * @deprecated use run or call instead
      * @returns
      */
     queryRoute(message: {
@@ -326,6 +228,24 @@ declare class QueryRouter {
         data: any;
         message: any;
     }>;
+    /**
+     * Router Run获取数据
+     * @param message
+     * @param ctx
+     * @returns
+     */
+    run(message: {
+        id?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
     /**
      * 设置上下文
      * @description 这里的上下文是为了在handle函数中使用
@@ -417,7 +337,7 @@ declare class QueryRouterServer extends QueryRouter {
     prompt(description: string): Route<Required<RouteContext>>;
     prompt(description: Function): Route<Required<RouteContext>>;
     /**
-     * 等于queryRoute，但是调用了handle
+     * 调用了handle
      * @param param0
      * @returns
      */
@@ -425,9 +345,49 @@ declare class QueryRouterServer extends QueryRouter {
         path: string;
         key?: string;
         payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
     }): Promise<any>;
 }
-declare const Mini: typeof QueryRouterServer;
+declare class Mini extends QueryRouterServer {
+}
+
+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>;
 
 /** 自定义错误 */
 declare class CustomError extends Error {
@@ -514,7 +474,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>>;
 }