@kevisual/router 0.0.56 → 0.0.58

package/dist/opencode.d.ts

@@ -0,0 +1,369 @@
+import { Plugin } from '@opencode-ai/plugin';
+
+type RouterContextT = {
+    code?: number;
+    [key: string]: any;
+};
+type RouteContext<T = {
+    code?: number;
+}, S = any> = {
+    /**
+     * 本地自己调用的时候使用，可以标识为当前自调用，那么 auth 就不许重复的校验
+     * 或者不需要登录的，直接调用
+     */
+    appId?: string;
+    query?: {
+        [key: string]: any;
+    };
+    /** return body */
+    body?: number | string | Object;
+    forward?: (response: {
+        code: number;
+        data?: any;
+        message?: any;
+    }) => void;
+    /** 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;
+    app?: QueryRouter;
+    error?: any;
+    /** 请求 route的返回结果，不解析body为data */
+    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的返回结果，解析了body为data，就类同于 query.post获取的数据*/
+    run?: (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<U = {}, T = SimpleObject> = {
+    path?: string;
+    key?: string;
+    id?: string;
+    run?: Run<U>;
+    nextRoute?: NextRoute;
+    description?: string;
+    metadata?: T;
+    middleware?: RouteMiddleware[];
+    type?: 'route' | 'middleware';
+    /**
+     * $#$ will be used to split path and key
+     */
+    idUsePath?: boolean;
+    /**
+     * id 合并的分隔符，默认为 $#$
+     */
+    delimiter?: string;
+    isDebug?: boolean;
+};
+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;
+}, T extends SimpleObject = SimpleObject> {
+    /**
+     * 一级路径
+     */
+    path?: string;
+    /**
+     * 二级路径
+     */
+    key?: string;
+    id?: string;
+    run?: Run;
+    nextRoute?: NextRoute;
+    description?: string;
+    metadata?: T;
+    middleware?: RouteMiddleware[];
+    type?: string;
+    data?: any;
+    /**
+     * 是否开启debug，开启后会打印错误信息
+     */
+    isDebug?: boolean;
+    constructor(path?: string, key?: string, opts?: RouteOpts);
+    prompt(description: string): this;
+    prompt(description: Function): 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;
+    update(opts: DefineRouteOpts, checkList?: string[]): 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 {
+    appId: string;
+    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
+     * @deprecated use run or call instead
+     * @returns
+     */
+    queryRoute(message: {
+        id?: string;
+        path: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        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函数中使用
+     * @param ctx
+     */
+    setContext(ctx: RouteContext): void;
+    getList(filter?: (route: Route) => boolean): RouteInfo[];
+    /**
+     * 获取handle函数, 这里会去执行parse函数
+     */
+    getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
+        id?: string;
+        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;
+    }, SimpleObject>[];
+    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;
+    }, SimpleObject>;
+    findRoute(opts?: {
+        path?: string;
+        key?: string;
+        id?: string;
+    }): Route<{
+        [key: string]: any;
+    }, SimpleObject>;
+    createRouteList(force?: boolean, filter?: (route: Route) => boolean): void;
+    /**
+     * 等待程序运行, 获取到message的数据,就执行
+     *
+     * emitter = process
+     * -- .exit
+     * -- .on
+     * -- .send
+     */
+    wait(params?: {
+        path?: string;
+        key?: string;
+        payload?: any;
+    }, opts?: {
+        emitter?: any;
+        timeout?: number;
+        getList?: boolean;
+        force?: boolean;
+        filter?: (route: Route) => boolean;
+    }): Promise<void>;
+}
+type QueryRouterServerOpts = {
+    handleFn?: HandleFn;
+    context?: RouteContext;
+    appId?: string;
+};
+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 {
+    appId: string;
+    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>>;
+    prompt(description: string): Route<Required<RouteContext>>;
+    prompt(description: Function): Route<Required<RouteContext>>;
+    /**
+     * 调用了handle
+     * @param param0
+     * @returns
+     */
+    run(msg: {
+        id?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<any>;
+}
+
+declare const addCallFn: (app: QueryRouterServer) => void;
+declare const createRouterAgentPluginFn: (opts?: {
+    router?: QueryRouter;
+    query?: string;
+}) => Plugin;
+
+export { addCallFn, createRouterAgentPluginFn };