@kevisual/router 0.0.26-alpha.4 → 0.0.26

package/dist/auto.d.ts

@@ -0,0 +1,472 @@
+import { z } from 'zod';
+export { Schema } from 'zod';
+
+type GlobOptions = {
+    cwd?: string;
+    load?: (args?: any) => Promise<any>;
+};
+declare const getMatchFiles: (match?: string, { cwd }?: GlobOptions) => Promise<string[]>;
+declare const loadTS: (match?: string, { cwd, load }?: GlobOptions) => Promise<any[]>;
+
+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 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;
+    /** 是否需要序列化, 使用JSON.stringify和JSON.parse */
+    needSerialize?: boolean;
+} & T;
+type SimpleObject = Record<string, any>;
+type Run<T extends SimpleObject = {}> = (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;
+    id?: string;
+    run?: Run;
+    nextRoute?: NextRoute;
+    description?: string;
+    metadata?: {
+        [key: string]: any;
+    };
+    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
+     */
+    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?: 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;
+    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;
+    }>;
+    /**
+     * 设置上下文
+     * @description 这里的上下文是为了在handle函数中使用
+     * @param ctx
+     */
+    setContext(ctx: RouteContext): 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>;
+}
+
+type ListenSocketOptions = {
+    /**
+     * Unix socket path, defaults to './app.sock'
+     */
+    path?: string;
+    app?: QueryRouterServer;
+    /**
+     * Unix socket path, defaults to './app.pid'
+     */
+    pidPath?: string;
+    /**
+     * Timeout for the server, defaults to 15 minutes.
+     * If the server is not responsive for this duration, it will be terminated
+     */
+    timeout?: number;
+};
+declare const listenSocket: (options?: ListenSocketOptions) => Promise<any>;
+
+/** 自定义错误 */
+declare class CustomError extends Error {
+    code?: number;
+    data?: any;
+    message: string;
+    tips?: string;
+    constructor(code?: number | string, message?: string, tips?: string);
+    static fromCode(code?: number): CustomError;
+    static fromErrorData(code?: number, data?: any): CustomError;
+    static parseError(e: CustomError): {
+        code: number;
+        data: any;
+        message: string;
+        tips: string;
+    };
+    /**
+     * 判断 throw 的错误是否不是当前这个错误
+     * @param err
+     * @returns
+     */
+    static isError(err: any): boolean;
+    parse(e?: CustomError): {
+        code: number;
+        data: any;
+        message: string;
+        tips: string;
+    };
+}
+
+type QueryData = {
+    path?: string;
+    key?: string;
+    payload?: any;
+    [key: string]: any;
+};
+type CallSockOptions = {
+    socketPath?: string;
+    timeout?: number;
+    method?: 'GET' | 'POST';
+};
+declare const autoCall: (data: QueryData, options?: Omit<CallSockOptions, "method">) => Promise<any>;
+
+declare const App: typeof QueryRouterServer;
+
+export { App, CustomError, QueryRouter, QueryRouterServer, Route, autoCall, createSchema, getMatchFiles, listenSocket, loadTS };
+export type { RouteContext, RouteOpts, Rule, Run };