@kevisual/router 0.0.57 → 0.0.59

package/dist/opencode.d.ts

@@ -1,3 +1,7 @@
+import { EventEmitter } from 'eventemitter3';
+import * as http from 'node:http';
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'http';
 import { Plugin } from '@opencode-ai/plugin';
 
 type RouterContextT = {
@@ -310,6 +314,11 @@ declare class QueryRouter {
         filter?: (route: Route) => boolean;
     }): Promise<void>;
 }
+type QueryRouterServerOpts = {
+    handleFn?: HandleFn;
+    context?: RouteContext;
+    appId?: string;
+};
 interface HandleFn<T = any> {
     (msg: {
         path: string;
@@ -322,10 +331,347 @@ interface HandleFn<T = 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;
+    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 createRouterAgentPluginFn: (opts?: {
+type Cors = {
+    /**
+     * @default '*''
+     */
+    origin?: string | undefined;
+};
+type ServerOpts<T = {}> = {
+    /**path default `/api/router` */
+    path?: string;
+    /**handle Fn */
+    handle?: (msg?: {
+        path: string;
+        key?: string;
+        [key: string]: any;
+    }, ctx?: {
+        req: http.IncomingMessage;
+        res: http.ServerResponse;
+    }) => any;
+    cors?: Cors;
+    io?: boolean;
+    showConnected?: boolean;
+} & T;
+interface ServerType {
+    path?: string;
+    server?: any;
+    handle: ServerOpts['handle'];
+    setHandle(handle?: any): void;
+    listeners: Listener[];
+    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;
+    listen(port: number, listeningListener?: () => void): void;
+    listen(path: string, backlog?: number, listeningListener?: () => void): void;
+    listen(path: string, listeningListener?: () => void): void;
+    listen(handle: any, backlog?: number, listeningListener?: () => void): void;
+    listen(handle: any, listeningListener?: () => void): void;
+    /**
+     * 兜底监听，当除开 `/api/router` 之外的请求，框架只监听一个api，所以有其他的请求都执行其他的监听
+     * @description 主要是为了兼容其他的监听
+     * @param listener
+     */
+    on(listener: OnListener): void;
+    onWebSocket({ ws, message, pathname, token, id }: OnWebSocketOptions): void;
+    onWsClose<T = {}>(ws: WS<T>): void;
+    sendConnected<T = {}>(ws: WS<T>): void;
+}
+type OnWebSocketOptions<T = {}> = {
+    ws: WS<T>;
+    message: string | Buffer;
+    pathname: string;
+    token?: string;
+    id?: string;
+};
+type WS<T = {}> = {
+    send: (data: any) => void;
+    close: (code?: number, reason?: string) => void;
+    data?: {
+        url: URL;
+        pathname: string;
+        token?: string;
+        id?: string;
+        /**
+         * 鉴权后的获取的信息
+         */
+        userApp?: string;
+    } & T;
+};
+type Listener = {
+    id?: string;
+    io?: boolean;
+    path?: string;
+    func: WebSocketListenerFun | HttpListenerFun;
+    /**
+   * @description 是否默认解析为 JSON，如果为 true，则 message 会被 JSON.parse 处理，默认是 true
+   */
+    json?: boolean;
+};
+type WebSocketListenerFun = (req: WebSocketReq, res: WebSocketRes) => Promise<void> | void;
+type HttpListenerFun = (req: RouterReq, res: RouterRes) => Promise<void> | void;
+type WebSocketReq<T = {}, U = Record<string, any>> = {
+    emitter?: EventEmitter;
+    ws: WS<T>;
+    data?: U;
+    message?: string | Buffer;
+    pathname?: string;
+    token?: string;
+    id?: string;
+};
+type WebSocketRes = {
+    end: (data: any) => void;
+};
+type ListenerFun = WebSocketListenerFun | HttpListenerFun;
+type OnListener = Listener | ListenerFun | (Listener | ListenerFun)[];
+type RouterReq<T = {}> = {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    socket?: {
+        remoteAddress?: string;
+        remotePort?: number;
+    };
+    body?: string;
+    cookies?: Record<string, string>;
+} & T;
+type RouterRes<T = {}> = {
+    statusCode: number;
+    headersSent: boolean;
+    _headers: Record<string, string | string[]>;
+    _bodyChunks: any[];
+    writableEnded: boolean;
+    writeHead: (statusCode: number, headers?: Record<string, string>) => void;
+    setHeader: (name: string, value: string | string[]) => void;
+    cookie: (name: string, value: string, options?: any) => void;
+    write: (chunk: any) => void;
+    pipe: (stream: any) => void;
+    end: (data?: any) => void;
+} & T;
+
+interface StringifyOptions {
+    /**
+     * Specifies a function that will be used to encode a [cookie-value](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.1).
+     * Since value of a cookie has a limited character set (and must be a simple string), this function can be used to encode
+     * a value into a string suited for a cookie's value, and should mirror `decode` when parsing.
+     *
+     * @default encodeURIComponent
+     */
+    encode?: (str: string) => string;
+}
+/**
+ * Set-Cookie object.
+ */
+interface SetCookie {
+    /**
+     * Specifies the name of the cookie.
+     */
+    name: string;
+    /**
+     * Specifies the string to be the value for the cookie.
+     */
+    value: string | undefined;
+    /**
+     * Specifies the `number` (in seconds) to be the value for the [`Max-Age` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.2).
+     *
+     * The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
+     * `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this,
+     * so if both are set, they should point to the same date and time.
+     */
+    maxAge?: number;
+    /**
+     * Specifies the `Date` object to be the value for the [`Expires` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.1).
+     * When no expiration is set, clients consider this a "non-persistent cookie" and delete it when the current session is over.
+     *
+     * The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
+     * `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this,
+     * so if both are set, they should point to the same date and time.
+     */
+    expires?: Date;
+    /**
+     * Specifies the value for the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3).
+     * When no domain is set, clients consider the cookie to apply to the current domain only.
+     */
+    domain?: string;
+    /**
+     * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
+     * When no path is set, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4).
+     */
+    path?: string;
+    /**
+     * Enables the [`HttpOnly` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6).
+     * When enabled, clients will not allow client-side JavaScript to see the cookie in `document.cookie`.
+     */
+    httpOnly?: boolean;
+    /**
+     * Enables the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5).
+     * When enabled, clients will only send the cookie back if the browser has an HTTPS connection.
+     */
+    secure?: boolean;
+    /**
+     * Enables the [`Partitioned` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-cutler-httpbis-partitioned-cookies/).
+     * When enabled, clients will only send the cookie back when the current domain _and_ top-level domain matches.
+     *
+     * This is an attribute that has not yet been fully standardized, and may change in the future.
+     * This also means clients may ignore this attribute until they understand it. More information
+     * about can be found in [the proposal](https://github.com/privacycg/CHIPS).
+     */
+    partitioned?: boolean;
+    /**
+     * Specifies the value for the [`Priority` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1).
+     *
+     * - `'low'` will set the `Priority` attribute to `Low`.
+     * - `'medium'` will set the `Priority` attribute to `Medium`, the default priority when not set.
+     * - `'high'` will set the `Priority` attribute to `High`.
+     *
+     * More information about priority levels can be found in [the specification](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1).
+     */
+    priority?: "low" | "medium" | "high";
+    /**
+     * Specifies the value for the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7).
+     *
+     * - `true` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     * - `'lax'` will set the `SameSite` attribute to `Lax` for lax same site enforcement.
+     * - `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
+     * - `'strict'` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     *
+     * More information about enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7).
+     */
+    sameSite?: boolean | "lax" | "strict" | "none";
+}
+/**
+ * Backward compatibility serialize options.
+ */
+type SerializeOptions = StringifyOptions & Omit<SetCookie, "name" | "value">;
+
+type CookieFn = (name: string, value: string, options?: SerializeOptions, end?: boolean) => void;
+type HandleCtx = {
+    req: IncomingMessage & {
+        cookies: Record<string, string>;
+    };
+    res: ServerResponse & {
+        /**
+         * cookie 函数， end 参数用于设置是否立即设置到响应头，设置了后面的cookie再设置会覆盖前面的
+         */
+        cookie: CookieFn;
+    };
+};
+
+type ServerNodeOpts = ServerOpts<{
+    httpType?: 'http' | 'https' | 'http2';
+    httpsKey?: string;
+    httpsCert?: string;
+}>;
+
+type RouterHandle = (msg: {
+    path: string;
+    [key: string]: any;
+}) => {
+    code: string;
+    data?: any;
+    message?: string;
+    [key: string]: any;
+};
+type AppOptions<T = {}> = {
     router?: QueryRouter;
+    server?: ServerType;
+    /** handle msg 关联 */
+    routerHandle?: RouterHandle;
+    routerContext?: RouteContext<T>;
+    serverOptions?: ServerNodeOpts;
+    appId?: string;
+};
+type AppRouteContext<T = {}> = HandleCtx & RouteContext<T> & {
+    app: App<T>;
+};
+/**
+ *  封装了 Router 和 Server 的 App 模块，处理http的请求和响应，内置了 Cookie 和 Token 和 res 的处理
+ *  U - Route Context的扩展类型
+ */
+declare class App<U = {}> extends QueryRouter {
+    appId: string;
+    router: QueryRouter;
+    server: ServerType;
+    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;
+    listen(port: number, listeningListener?: () => void): void;
+    listen(path: string, backlog?: number, listeningListener?: () => void): void;
+    listen(path: string, listeningListener?: () => void): void;
+    listen(handle: any, backlog?: number, listeningListener?: () => void): void;
+    listen(handle: any, listeningListener?: () => void): void;
+    addRoute(route: Route): void;
+    Route: typeof Route;
+    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?: AppRouteContext<U> & {
+        [key: string]: any;
+    }): Promise<any>;
+    run(msg: {
+        id?: string;
+        path?: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: Partial<AppRouteContext<U>> & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
+    static handleRequest(req: IncomingMessage$1, res: ServerResponse$1): Promise<{
+        cookies: Record<string, string>;
+        token: string;
+    }>;
+    onServerRequest(fn: (req: IncomingMessage$1, res: ServerResponse$1) => void): void;
+}
+
+declare const addCallFn: (app: App) => void;
+declare const createRouterAgentPluginFn: (opts?: {
+    router?: App | QueryRouterServer;
     query?: string;
 }) => Plugin;
 
-export { createRouterAgentPluginFn };
+export { addCallFn, createRouterAgentPluginFn };