trpc-uwebsockets 11.0.4 → 11.1.2

package/src/websockets.ts

@@ -84,6 +84,24 @@ export type WSConnectionHandlerOptions<TRouter extends AnyRouter> =
       CreateWSSContextFn<TRouter>
     >;
 
+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
  */
@@ -99,25 +117,7 @@ export type WebsocketsHandlerOptions<TRouter extends AnyRouter> =
      * @default false
      */
     ssl?: boolean | undefined;
-    keepAlive?:
-      | {
-          /**
-           * 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;
-        }
-      | undefined;
+    keepAlive?: WebsocketsKeepAlive | undefined;
     /**
      * Disable responding to ping messages from the client
      * **Not recommended** - this is mainly used for testing
@@ -504,7 +504,7 @@ export function getWSConnectionHandler<TRouter extends AnyRouter>(
         data.ctxCompleter = createCompleter();
 
         const useConnectionParams =
-          new URL(data.req.url).searchParams.get('connectionParams') === '1';
+          data.url.searchParams.get('connectionParams') === '1';
 
         try {
           data.ctx = await createContext?.({
@@ -520,7 +520,7 @@ export function getWSConnectionHandler<TRouter extends AnyRouter>(
               accept: null,
               type: 'unknown',
               signal: data.abortController.signal,
-              url: data.url, // was null
+              url: data.url,
             },
           });
           data.ctxCompleter.resolve();

package/types/___testHelpers.d.ts

@@ -0,0 +1,44 @@
+import { AnyTRPCRouter } from '@trpc/server';
+import { WebSocketBehaviorOptions, WebsocketsKeepAlive } from './websockets';
+import uWs from 'uWebSockets.js';
+import { CreateContextOptions } from './requestHandler';
+import type { HTTPHeaders, WebSocketClientOptions } from '@trpc/client';
+export interface ServerOptions<AppRouter extends AnyTRPCRouter> {
+    appRouter: AppRouter;
+    prefix?: string;
+    createContext?: (opts: CreateContextOptions) => Promise<any>;
+    uWsBehaviorOptions?: WebSocketBehaviorOptions;
+    keepAlive?: WebsocketsKeepAlive;
+}
+interface ClientOptions {
+    prefix?: string;
+    wsClientOptions?: Omit<WebSocketClientOptions, 'url'> | undefined;
+    queryParams?: Record<string, string> | undefined;
+    headers?: HTTPHeaders | undefined;
+    port: number;
+}
+export declare function testFactory<AppRouter extends AnyTRPCRouter>(serverOptions: ServerOptions<AppRouter>): {
+    server: uWs.TemplatedApp;
+    stop: () => void;
+    onServerErrorSpy: import("vitest").Mock<(...args: any[]) => any>;
+    port: number;
+    opts: ServerOptions<AppRouter>;
+    fetch(path: string, opts: RequestInit): Promise<Response>;
+    clientBatchStream(clientOptions?: Partial<ClientOptions> | undefined): {
+        client: import("@trpc/client").TRPCClient<AppRouter>;
+        orderedResults: number[];
+    };
+    clientBatch(clientOptions?: Partial<ClientOptions> | undefined): {
+        client: import("@trpc/client").TRPCClient<AppRouter>;
+    };
+    clientSse(clientOptions?: Partial<ClientOptions> | undefined): {
+        client: import("@trpc/client").TRPCClient<AppRouter>;
+        orderedResults: number[];
+    };
+    clientWs(clientOptions?: Partial<ClientOptions> | undefined): {
+        client: import("@trpc/client").TRPCClient<AppRouter>;
+        wsClient: import("@trpc/client/dist/links/wsLink/wsClient/wsClient").WsClient;
+        orderedResults: number[];
+    };
+};
+export {};

package/types/websockets.d.ts

@@ -21,6 +21,23 @@ export type CreateWSSContextFnOptions = NodeHTTPCreateContextFnOptions<Request,
 };
 export type CreateWSSContextFn<TRouter extends AnyRouter> = (opts: CreateWSSContextFnOptions) => MaybePromise<inferRouterContext<TRouter>>;
 export type WSConnectionHandlerOptions<TRouter extends AnyRouter> = BaseHandlerOptions<TRouter, Request> & CreateContextCallback<inferRouterContext<TRouter>, CreateWSSContextFn<TRouter>>;
+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
  */
@@ -35,23 +52,7 @@ export type WebsocketsHandlerOptions<TRouter extends AnyRouter> = WSConnectionHa
      * @default false
      */
     ssl?: boolean | undefined;
-    keepAlive?: {
-        /**
-         * 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;
-    } | undefined;
+    keepAlive?: WebsocketsKeepAlive | undefined;
     /**
      * Disable responding to ping messages from the client
      * **Not recommended** - this is mainly used for testing