@opentiny/agent 0.3.1 → 0.3.3

package/index.d.ts

@@ -2,6 +2,9 @@ import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { Client } from '@modelcontextprotocol/sdk/client/index.js';
 import { SSEServerTransport } from '@modelcontextprotocol/sdk/server/sse.js';
 import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
+import { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
+import { JSONRPCMessage } from '@modelcontextprotocol/sdk/types.js';
+import WebSocket from 'ws';
 import { AuthInfo } from '@modelcontextprotocol/sdk/server/auth/types.js';
 import { Response, RequestHandler, Request, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
@@ -10,6 +13,21 @@ import { AuthorizationParams, OAuthServerProvider } from '@modelcontextprotocol/
 import { OAuthRegisteredClientsStore } from '@modelcontextprotocol/sdk/server/auth/clients.js';
 import { AuthRouterOptions } from '@modelcontextprotocol/sdk/server/auth/router.js';
 
+/**
+ * Server transport for WebSocket: this will listen to clients over the WebSocket protocol.
+ */
+declare class WebSocketServerTransport implements Transport {
+    private _socket?;
+    sessionId?: string;
+    onclose?: () => void;
+    onerror?: (error: Error) => void;
+    onmessage?: (message: JSONRPCMessage) => void;
+    constructor(socket: WebSocket);
+    start(): Promise<void>;
+    close(): Promise<void>;
+    send(message: JSONRPCMessage): Promise<void>;
+}
+
 declare const ACCESS_TOKEN_EXPIRES_IN: number;
 declare const REFRESH_TOKEN_EXPIRES_IN: number;
 /**
@@ -374,7 +392,7 @@ interface ClientInfo {
     /**
      * 客户端连接的 Transport 实例
      */
-    transport: SSEServerTransport | StreamableHTTPServerTransport;
+    transport: SSEServerTransport | StreamableHTTPServerTransport | WebSocketServerTransport;
     /**
      * 连接的用户信息
      */
@@ -403,7 +421,7 @@ interface ClientInfo {
     /**
      * 客户端连接的 Transport 类型
      */
-    type: 'SSE' | 'StreamableHTTP';
+    type: 'SSE' | 'StreamableHTTP' | 'WebSocket';
 }
 /**
  * 遥控端连接的信息，包括服务端实例、用户信息和 Transport 类型。
@@ -462,7 +480,7 @@ interface ClientError {
     /**
      * 客户端连接的 Transport 实例
      */
-    transport: SSEServerTransport | StreamableHTTPServerTransport;
+    transport: SSEServerTransport | StreamableHTTPServerTransport | WebSocketServerTransport;
     /**
      * 错误信息
      */
@@ -470,7 +488,7 @@ interface ClientError {
     /**
      * 服务端连接的 Transport 类型
      */
-    type: 'SSE' | 'StreamableHTTP';
+    type: 'SSE' | 'StreamableHTTP' | 'WebSocket';
 }
 /**
  * RemoterError 接口，在遥控端连接或处理过程中发生的错误。
@@ -516,6 +534,14 @@ declare module 'express' {
 declare const auth: ({ secret }: {
     secret: string;
 }) => (req: Request, res: Response, next: NextFunction) => void;
+/**
+ * 请求认证，用于校验 JWT Token。
+ *
+ * 检查 request.query 中的 token 字段。
+ * 校验通过后，将解码后的用户信息挂载到 req.user
+ * 校验失败或缺失 token 时，抛出异常。
+ */
+declare const jwtAuth: (req: Request, secret: string) => void;
 /**
  * SSE 与 Streamable HTTP 连接的处理函数，同时返回所有客户端代理实例。
  */
@@ -525,6 +551,7 @@ declare const useProxyHandles: () => {
     handleSseMessage: (req: Request, res: Response) => Promise<void>;
     handleStreamRequest: (req: Request, res: Response) => Promise<void>;
     handleStreamInspector: (req: Request, res: Response) => Promise<void>;
+    handleWebSocket: (socket: WebSocket, req: Request) => Promise<void>;
     clients: Record<string, ClientInfo>;
     remoters: Record<string, RemoterInfo>;
     transports: Record<string, any>;
@@ -538,5 +565,5 @@ declare const useProxyHandles: () => {
     onRemoterError: (onError: (error: RemoterError) => void) => void;
 };
 
-export { ACCESS_TOKEN_EXPIRES_IN, AuthServerProvider, MemoryAccessTokensStore, MemoryAuthorizationCodeStore, MemoryClientsStore, MemoryRefreshTokensStore, REFRESH_TOKEN_EXPIRES_IN, auth, createAuthCallbackRouter, createAuthMetadataRouter, createAuthMiddleware, createAuthRouter, useProxyHandles };
+export { ACCESS_TOKEN_EXPIRES_IN, AuthServerProvider, MemoryAccessTokensStore, MemoryAuthorizationCodeStore, MemoryClientsStore, MemoryRefreshTokensStore, REFRESH_TOKEN_EXPIRES_IN, WebSocketServerTransport, auth, createAuthCallbackRouter, createAuthMetadataRouter, createAuthMiddleware, createAuthRouter, jwtAuth, useProxyHandles };
 export type { AuthServerProviderOptions, ClientError, ClientInfo, OAuthAccessTokensStore, OAuthAuthorizationCodeStore, OAuthRefreshTokensStore, RemoterError, RemoterInfo };