import { type AnyRouter, type CreateContextCallback, inferRouterContext } from '@trpc/server'; import { NodeHTTPCreateContextFnOptions } from '@trpc/server/adapters/node-http'; import { type BaseHandlerOptions } from '@trpc/server/http'; import { type MaybePromise } from '@trpc/server/unstable-core-do-not-import'; import { URL } from 'url'; import type { TemplatedApp, WebSocket, WebSocketBehavior } from 'uWebSockets.js'; import { HttpResponseDecorated } from './fetchCompat'; type RemoveFunctions = { [K in keyof T as NonNullable extends Function ? never : K]: T[K]; }; /** * A structure holding settings for a WebSocket handler. */ export type WebSocketBehaviorOptions = RemoveFunctions>; export type WebSocketConnection = WebSocket; /** * @public */ export type CreateWSSContextFnOptions = NodeHTTPCreateContextFnOptions & { client: WebSocketConnection; }; export type CreateWSSContextFn = (opts: CreateWSSContextFnOptions) => MaybePromise>; export type WSConnectionHandlerOptions = BaseHandlerOptions & CreateContextCallback, CreateWSSContextFn>; export type WebsocketsKeepAlive = { /** * Enable heartbeat messages * @default false */ enabled: boolean; /** * Heartbeat interval in milliseconds * @default 30_000 */ pingMs?: number | undefined; /** * Terminate the WebSocket if no pong is received after this many milliseconds * @default 5_000 */ pongWaitMs?: number | undefined; }; /** * WebSockets handler definition */ export type WebsocketsHandlerOptions = WSConnectionHandlerOptions & { /** * Url path prefix where the tRPC server will be registered. * @default '' */ prefix?: string | undefined; /** * Specify if SSL is used. Set to true if you are using SSLApp or if the server is served behind SSL reverse proxy. * @default false */ ssl?: boolean | undefined; keepAlive?: WebsocketsKeepAlive | undefined; /** * Disable responding to ping messages from the client * **Not recommended** - this is mainly used for testing * @default false */ dangerouslyDisablePong?: boolean | undefined; /** * uWebSockets.js WebSocket hander settings */ uWsBehaviorOptions?: WebSocketBehaviorOptions | undefined; }; interface Completer { promise: Promise; resolve: () => void; reject: (error: Error) => void; } type WebsocketData = { req: Request; clientSubscriptions: Map; abortController: AbortController; ctx: inferRouterContext | undefined; /** * inside-out promise that resolves when context is ready. * * - when this is null, the context resolution will be started * - otherwise all requests must await context resolution */ ctxCompleter: Completer | null; keepAlive: KeepAliver | null; url: URL; }; export declare function getWSConnectionHandler(opts: WebsocketsHandlerOptions, allClients: Set): WebSocketBehavior; export declare function applyWebsocketHandler(app: TemplatedApp, opts: WebsocketsHandlerOptions): { broadcastReconnectNotification: () => void; }; type KeepAliver = { onMessage: () => void; onClose: () => void; }; export declare function handleKeepAlive(client: WebSocketConnection, pingMs?: number, pongWaitMs?: number): KeepAliver; export {};