Relaxed WebSocket types to accept anything reasonable

neondatabase · Dec 18, 2024 · afbca19 · afbca19
1 parent 11d5525
commit afbca19
Show file tree

Hide file tree

Showing 14 changed files with 633 additions and 541 deletions.
diff --git a/api-extractor.json b/api-extractor.json
@@ -2,9 +2,7 @@
   "mainEntryPointFilePath": "dist/dts/export/index.d.ts",
   "newlineKind": "lf",
   "enumMemberOrder": "preserve",
-  "bundledPackages": [
-    "subtls"
-  ],
+  "bundledPackages": ["subtls"],
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "dist/dts/_extracted.d.ts"
@@ -25,4 +23,4 @@
       }
     }
   }
-}
+}
diff --git a/dist/dts/_extracted.d.ts b/dist/dts/_extracted.d.ts
@@ -475,7 +475,7 @@ declare interface SocketDefaults {
     fetchEndpoint: string | ((host: string, port: number | string, options?: FetchEndpointOptions) => string);
     fetchConnectionCache: boolean;
     fetchFunction: any;
-    webSocketConstructor: typeof WebSocket | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     wsProxy: string | ((host: string, port: number | string) => string);
     useSecureWebSocket: boolean;
     forceDisablePgSSL: boolean;
@@ -528,6 +528,18 @@ export { types }
 
 declare function u8FromHex(hex: string): Uint8Array<ArrayBuffer>;
 
+declare interface WebSocketConstructor {
+    new (...args: any[]): WebSocketLike;
+}
+
+declare interface WebSocketLike {
+    readonly readyState: number;
+    binaryType: string;
+    close(code?: number, reason?: string): void;
+    send(data: any): void;
+    addEventListener(type: 'open' | 'message' | 'close' | 'error', listener: (this: WebSocketLike, ev: any) => any, options?: any): void;
+}
+
 declare class WebSocketReadQueue extends ReadQueue {
     private socket;
     constructor(socket: WebSocket);

diff --git a/dist/dts/_extracted.d.ts.orig b/dist/dts/_extracted.d.ts.orig
@@ -475,7 +475,7 @@ declare interface SocketDefaults {
     fetchEndpoint: string | ((host: string, port: number | string, options?: FetchEndpointOptions) => string);
     fetchConnectionCache: boolean;
     fetchFunction: any;
-    webSocketConstructor: typeof WebSocket | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     wsProxy: string | ((host: string, port: number | string) => string);
     useSecureWebSocket: boolean;
     forceDisablePgSSL: boolean;
@@ -528,6 +528,18 @@ export { types }
 
 declare function u8FromHex(hex: string): Uint8Array<ArrayBuffer>;
 
+declare interface WebSocketConstructor {
+    new (...args: any[]): WebSocketLike;
+}
+
+declare interface WebSocketLike {
+    readonly readyState: number;
+    binaryType: string;
+    close(code?: number, reason?: string): void;
+    send(data: any): void;
+    addEventListener(type: 'open' | 'message' | 'close' | 'error', listener: (this: WebSocketLike, ev: any) => any, options?: any): void;
+}
+
 declare class WebSocketReadQueue extends ReadQueue {
     private socket;
     constructor(socket: WebSocket);

diff --git a/dist/dts/shims/net/index.d.ts b/dist/dts/shims/net/index.d.ts
@@ -7,6 +7,16 @@
  */
 import { EventEmitter } from 'events';
 import type * as subtls from 'subtls';
+interface WebSocketLike {
+    readonly readyState: number;
+    binaryType: string;
+    close(code?: number, reason?: string): void;
+    send(data: any): void;
+    addEventListener(type: 'open' | 'message' | 'close' | 'error', listener: (this: WebSocketLike, ev: any) => any, options?: any): void;
+}
+interface WebSocketConstructor {
+    new (...args: any[]): WebSocketLike;
+}
 export declare function isIP(input: string): number;
 interface FetchEndpointOptions {
     jwtAuth?: boolean;
@@ -16,7 +26,7 @@ export interface SocketDefaults {
     fetchEndpoint: string | ((host: string, port: number | string, options?: FetchEndpointOptions) => string);
     fetchConnectionCache: boolean;
     fetchFunction: any;
-    webSocketConstructor: typeof WebSocket | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     wsProxy: string | ((host: string, port: number | string) => string);
     useSecureWebSocket: boolean;
     forceDisablePgSSL: boolean;

diff --git a/dist/dts/shims/net/index.d.ts.orig b/dist/dts/shims/net/index.d.ts.orig
@@ -9,15 +9,16 @@ import { EventEmitter } from 'events';
 import type * as subtls from 'subtls';
 declare global {
     const debug: boolean;
-    interface WebSocket {
-        binaryType: 'arraybuffer' | 'blob';
-        accept?: () => void;
-    }
-    interface Response {
-        webSocket: WebSocket;
-    }
-    class __unstable_WebSocket extends WebSocket {
-    }
+}
+interface WebSocketLike {
+    readonly readyState: number;
+    binaryType: string;
+    close(code?: number, reason?: string): void;
+    send(data: any): void;
+    addEventListener(type: 'open' | 'message' | 'close' | 'error', listener: (this: WebSocketLike, ev: any) => any, options?: any): void;
+}
+interface WebSocketConstructor {
+    new (...args: any[]): WebSocketLike;
 }
 export declare function isIP(input: string): number;
 interface FetchEndpointOptions {
@@ -28,7 +29,7 @@ export interface SocketDefaults {
     fetchEndpoint: string | ((host: string, port: number | string, options?: FetchEndpointOptions) => string);
     fetchConnectionCache: boolean;
     fetchFunction: any;
-    webSocketConstructor: typeof WebSocket | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     wsProxy: string | ((host: string, port: number | string) => string);
     useSecureWebSocket: boolean;
     forceDisablePgSSL: boolean;

diff --git a/dist/jsr/index.d.ts b/dist/jsr/index.d.ts
@@ -477,7 +477,7 @@ declare interface SocketDefaults {
     fetchEndpoint: string | ((host: string, port: number | string, options?: FetchEndpointOptions) => string);
     fetchConnectionCache: boolean;
     fetchFunction: any;
-    webSocketConstructor: typeof WebSocket | undefined;
+    webSocketConstructor: WebSocketConstructor | undefined;
     wsProxy: string | ((host: string, port: number | string) => string);
     useSecureWebSocket: boolean;
     forceDisablePgSSL: boolean;
@@ -530,6 +530,18 @@ export { types }
 
 declare function u8FromHex(hex: string): Uint8Array<ArrayBuffer>;
 
+declare interface WebSocketConstructor {
+    new (...args: any[]): WebSocketLike;
+}
+
+declare interface WebSocketLike {
+    readonly readyState: number;
+    binaryType: string;
+    close(code?: number, reason?: string): void;
+    send(data: any): void;
+    addEventListener(type: 'open' | 'message' | 'close' | 'error', listener: (this: WebSocketLike, ev: any) => any, options?: any): void;
+}
+
 declare class WebSocketReadQueue extends ReadQueue {
     private socket;
     constructor(socket: WebSocket);