@kevisual/router 0.0.15 → 0.0.17

package/dist/router-define.d.ts

@@ -1,393 +1,5 @@
-import * as zod from 'zod';
-import { Schema } from 'zod';
-
-type BaseRule = {
-    value?: any;
-    required?: boolean;
-    message?: string;
-};
-type RuleString = {
-    type: 'string';
-    minLength?: number;
-    maxLength?: number;
-    regex?: string;
-} & BaseRule;
-type RuleNumber = {
-    type: 'number';
-    min?: number;
-    max?: number;
-} & BaseRule;
-type RuleBoolean = {
-    type: 'boolean';
-} & BaseRule;
-type RuleArray = {
-    type: 'array';
-    items: Rule;
-    minItems?: number;
-    maxItems?: number;
-} & BaseRule;
-type RuleObject = {
-    type: 'object';
-    properties: {
-        [key: string]: Rule;
-    };
-} & BaseRule;
-type RuleAny = {
-    type: 'any';
-} & BaseRule;
-type Rule = RuleString | RuleNumber | RuleBoolean | RuleArray | RuleObject | RuleAny;
-
-type RouterContextT = {
-    code?: number;
-    [key: string]: any;
-};
-type RouteContext<T = {
-    code?: number;
-}, S = any> = {
-    query?: {
-        [key: string]: any;
-    };
-    /** return body */
-    body?: number | string | Object;
-    /** return code */
-    code?: number;
-    /** return msg */
-    message?: string;
-    state?: S;
-    /**
-     * 当前路径
-     */
-    currentPath?: string;
-    /**
-     * 当前key
-     */
-    currentKey?: string;
-    /**
-     * 当前route
-     */
-    currentRoute?: Route;
-    /**
-     * 进度
-     */
-    progress?: [string, string][];
-    nextQuery?: {
-        [key: string]: any;
-    };
-    end?: boolean;
-    /**
-     * 请求 route的返回结果，包函ctx
-     */
-    queryRouter?: QueryRouter;
-    error?: any;
-    /** 请求 route的返回结果，包函ctx */
-    call?: (message: {
-        path: string;
-        key?: string;
-        payload?: any;
-        [key: string]: any;
-    } | {
-        id: string;
-        apyload?: any;
-        [key: string]: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }) => Promise<any>;
-    /** 请求 route的返回结果，不包函ctx */
-    queryRoute?: (message: {
-        path: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }) => Promise<any>;
-    index?: number;
-    throw?: (code?: number | string, message?: string, tips?: string) => void;
-    /** 是否需要序列化 */
-    needSerialize?: boolean;
-} & T;
-type Run<T = any> = (ctx: RouteContext<T>) => Promise<typeof ctx | null | void>;
-type NextRoute = Pick<Route, 'id' | 'path' | 'key'>;
-type RouteOpts = {
-    path?: string;
-    key?: string;
-    id?: string;
-    run?: Run;
-    nextRoute?: NextRoute;
-    description?: string;
-    metadata?: {
-        [key: string]: any;
-    };
-    middleware?: Route[] | string[];
-    type?: 'route' | 'middleware';
-    /**
-     * validator: {
-     *  packageName: {
-     *    type: 'string',
-     *    required: true,
-     *  },
-     * }
-     */
-    validator?: {
-        [key: string]: Rule;
-    };
-    schema?: {
-        [key: string]: Schema<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
-     */
-    idUsePath?: boolean;
-    /**
-     * id 合并的分隔符，默认为 $#$
-     */
-    delimiter?: string;
-    isDebug?: boolean;
-};
-type DefineRouteOpts = Omit<RouteOpts, 'idUsePath' | 'verify' | 'verifyKey' | 'nextRoute'>;
-declare const pickValue: readonly ["path", "key", "id", "description", "type", "validator", "middleware"];
-type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
-declare class Route<U = {
-    [key: string]: any;
-}> {
-    /**
-     * 一级路径
-     */
-    path?: string;
-    /**
-     * 二级路径
-     */
-    key?: string;
-    id?: string;
-    share?: boolean;
-    run?: Run;
-    nextRoute?: NextRoute;
-    description?: string;
-    metadata?: {
-        [key: string]: any;
-    };
-    middleware?: (Route | string)[];
-    type?: string;
-    private _validator?;
-    schema?: {
-        [key: string]: Schema<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;
-    define<T extends {
-        [key: string]: any;
-    } = RouterContextT>(opts: DefineRouteOpts): this;
-    define<T extends {
-        [key: string]: any;
-    } = RouterContextT>(fn: Run<T & U>): this;
-    define<T extends {
-        [key: string]: any;
-    } = RouterContextT>(key: string, fn: Run<T & U>): this;
-    define<T extends {
-        [key: string]: any;
-    } = RouterContextT>(path: string, key: string, fn: Run<T & U>): this;
-    addTo(router: QueryRouter | {
-        add: (route: Route) => void;
-        [key: string]: any;
-    }): void;
-    setData(data: any): this;
-    throw(code?: number | string, message?: string, tips?: string): void;
-}
-declare class QueryRouter {
-    routes: Route[];
-    maxNextRoute: number;
-    context?: RouteContext;
-    constructor();
-    add(route: Route): void;
-    /**
-     * remove route by path and key
-     * @param route
-     */
-    remove(route: Route | {
-        path: string;
-        key?: string;
-    }): void;
-    /**
-     * remove route by id
-     * @param uniqueId
-     */
-    removeById(unique: string): void;
-    /**
-     * 执行route
-     * @param path
-     * @param key
-     * @param ctx
-     * @returns
-     */
-    runRoute(path: string, key: string, ctx?: RouteContext): any;
-    /**
-     * 第一次执行
-     * @param message
-     * @param ctx
-     * @returns
-     */
-    parse(message: {
-        path: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<any>;
-    /**
-     * 返回的数据包含所有的context的请求返回的内容，可做其他处理
-     * @param message
-     * @param ctx
-     * @returns
-     */
-    call(message: {
-        id?: string;
-        path?: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<any>;
-    /**
-     * 请求 result 的数据
-     * @param message
-     * @param ctx
-     * @returns
-     */
-    queryRoute(message: {
-        path: string;
-        key?: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<{
-        code: any;
-        data: any;
-        message: any;
-    }>;
-    setContext(ctx: RouteContext): Promise<void>;
-    getList(): RouteInfo[];
-    /**
-     * 获取handle函数, 这里会去执行parse函数
-     */
-    getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
-        path: string;
-        key?: string;
-        [key: string]: any;
-    }, handleContext?: RouteContext) => Promise<{
-        [key: string]: any;
-        code: string;
-        data?: any;
-        message?: string;
-    } | {
-        code: any;
-        data: any;
-        message: any;
-    } | {
-        code: number;
-        message: any;
-        data?: undefined;
-    }>;
-    exportRoutes(): Route<{
-        [key: string]: any;
-    }>[];
-    importRoutes(routes: Route[]): void;
-    importRouter(router: QueryRouter): void;
-    throw(code?: number | string, message?: string, tips?: string): void;
-    hasRoute(path: string, key?: string): Route<{
-        [key: string]: any;
-    }>;
-}
-type QueryRouterServerOpts = {
-    handleFn?: HandleFn;
-    context?: RouteContext;
-};
-interface HandleFn<T = any> {
-    (msg: {
-        path: string;
-        [key: string]: any;
-    }, ctx?: any): {
-        code: string;
-        data?: any;
-        message?: string;
-        [key: string]: any;
-    };
-    (res: RouteContext<T>): any;
-}
-/**
- * QueryRouterServer
- * @description 移除server相关的功能，只保留router相关的功能，和http.createServer不相关，独立
- */
-declare class QueryRouterServer extends QueryRouter {
-    handle: any;
-    constructor(opts?: QueryRouterServerOpts);
-    setHandle(wrapperFn?: HandleFn, ctx?: RouteContext): void;
-    use(path: string, fn: (ctx: any) => any, opts?: RouteOpts): void;
-    addRoute(route: Route): 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>>;
-    /**
-     * 等于queryRoute，但是调用了handle
-     * @param param0
-     * @returns
-     */
-    run({ path, key, payload }: {
-        path: string;
-        key?: string;
-        payload?: any;
-    }): Promise<any>;
-}
+import { RouteOpts, QueryRouterServer, RouteMiddleware, Run } from '@kevisual/router';
+export { RouteOpts } from '@kevisual/router';
 
 type RouteObject = {
     [key: string]: RouteOpts;
@@ -410,7 +22,7 @@ declare class Chain {
         [key: string]: any;
     }): this;
     setPath(path: string): this;
-    setMiddleware(middleware: string[] | Route[]): this;
+    setMiddleware(middleware: RouteMiddleware[]): this;
     setKey(key: string): this;
     setId(key: string): this;
     setRun(run: Run): this;
@@ -428,32 +40,8 @@ declare class QueryUtil<T extends RouteObject = RouteObject> {
     static create<U extends Record<string, RouteOpts>>(value: U, opts?: ChainOptions): QueryUtil<U>;
     get<K extends keyof T>(key: K): RouteOpts;
     chain<K extends keyof T>(key: K, opts?: ChainOptions): Chain;
-    queryChain<K extends keyof T>(key: K): (queryData?: Record<string, any>) => {
-        path?: string;
-        key?: string;
-        id?: string;
-        run?: Run;
-        nextRoute?: NextRoute;
-        description?: string;
-        metadata?: {
-            [key: string]: any;
-        };
-        middleware?: Route[] | string[];
-        type?: "route" | "middleware";
-        validator?: {
-            [key: string]: Rule;
-        };
-        schema?: {
-            [key: string]: zod.ZodType<any>;
-        };
-        isVerify?: boolean;
-        verify?: (ctx?: RouteContext, dev?: boolean) => boolean;
-        verifyKey?: (key: string, ctx?: RouteContext, dev?: boolean) => boolean;
-        idUsePath?: boolean;
-        delimiter?: string;
-        isDebug?: boolean;
-    };
+    queryChain<K extends keyof T>(key: K): (queryData?: Record<string, any>) => RouteOpts;
 }
 
 export { QueryUtil, define, util };
-export type { RouteArray, RouteObject, RouteOpts };
+export type { RouteArray, RouteObject };

package/dist/router.d.ts

@@ -5,6 +5,7 @@ import https from 'node:https';
 import http2 from 'node:http2';
 import * as cookie from 'cookie';
 import { WebSocketServer, WebSocket } from 'ws';
+import { RouteOpts as RouteOpts$1, QueryRouterServer as QueryRouterServer$1, RouteMiddleware as RouteMiddleware$1, Run as Run$1 } from '@kevisual/router';
 
 type BaseRule = {
     value?: any;
@@ -113,6 +114,11 @@ type RouteContext<T = {
 } & T;
 type Run<T = any> = (ctx: RouteContext<T>) => Promise<typeof ctx | null | void>;
 type NextRoute = Pick<Route, 'id' | 'path' | 'key'>;
+type RouteMiddleware = {
+    path: string;
+    key?: string;
+    id?: string;
+} | string;
 type RouteOpts = {
     path?: string;
     key?: string;
@@ -123,7 +129,7 @@ type RouteOpts = {
     metadata?: {
         [key: string]: any;
     };
-    middleware?: Route[] | string[];
+    middleware?: RouteMiddleware[];
     type?: 'route' | 'middleware';
     /**
      * validator: {
@@ -174,7 +180,7 @@ declare class Route<U = {
     metadata?: {
         [key: string]: any;
     };
-    middleware?: (Route | string)[];
+    middleware?: RouteMiddleware[];
     type?: string;
     private _validator?;
     schema?: {
@@ -572,6 +578,48 @@ declare class WsServer extends WsServerBase {
     listen(): void;
 }
 
+type RouteObject = {
+    [key: string]: RouteOpts$1;
+};
+declare function define<T extends Record<string, RouteOpts$1>>(value: T): {
+    [K in keyof T]: T[K] & RouteOpts$1;
+};
+type RouteArray = RouteOpts$1[];
+type ChainOptions = {
+    app: QueryRouterServer$1;
+};
+declare class Chain {
+    object: RouteOpts$1;
+    app?: QueryRouterServer$1;
+    constructor(object: RouteOpts$1, opts?: ChainOptions);
+    get key(): string;
+    get path(): string;
+    setDescription(desc: string): this;
+    setMeta(metadata: {
+        [key: string]: any;
+    }): this;
+    setPath(path: string): this;
+    setMiddleware(middleware: RouteMiddleware$1[]): this;
+    setKey(key: string): this;
+    setId(key: string): this;
+    setRun(run: Run$1): this;
+    define(run: Run$1): this;
+    createRoute(): this;
+}
+declare const util: {
+    getChain: (obj: RouteOpts$1, opts?: ChainOptions) => Chain;
+};
+declare class QueryUtil<T extends RouteObject = RouteObject> {
+    routeObject: T;
+    app: QueryRouterServer$1;
+    constructor(object: T, opts?: ChainOptions);
+    static createFormObj<U extends RouteObject>(object: U, opts?: ChainOptions): QueryUtil<U>;
+    static create<U extends Record<string, RouteOpts$1>>(value: U, opts?: ChainOptions): QueryUtil<U>;
+    get<K extends keyof T>(key: K): RouteOpts$1;
+    chain<K extends keyof T>(key: K, opts?: ChainOptions): Chain;
+    queryChain<K extends keyof T>(key: K): (queryData?: Record<string, any>) => RouteOpts$1;
+}
+
 type RouterHandle = (msg: {
     path: string;
     [key: string]: any;
@@ -642,5 +690,5 @@ declare class App<T = {}, U = AppReqRes> {
     throw(code?: number | string, message?: string, tips?: string): void;
 }
 
-export { App, Connect, CustomError, QueryConnect, QueryRouter, QueryRouterServer, Route, Server, createSchema, handleServer };
-export type { RouteContext, RouteOpts, Rule, Run };
+export { App, Connect, CustomError, QueryConnect, QueryRouter, QueryRouterServer, QueryUtil, Route, Server, createSchema, define, handleServer, util };
+export type { RouteArray, RouteContext, RouteMiddleware, RouteObject, RouteOpts, Rule, Run };