@medplum/core 5.1.17 → 5.1.18

package/dist/cjs/index.d.ts

@@ -3355,31 +3355,40 @@ export declare function isValidMedplumSemver(version: string): boolean;
 
 /**
  * Generic interface that an implementation of `WebSocket` must satisfy to be used with `ReconnectingWebSocket`.
- * This is a slightly modified fork of the `WebSocket` global type used in Node.
+ * This is a slightly modified fork of the `WebSocket` global type used in Node, narrowed to exactly the members
+ * `ReconnectingWebSocket` actually depends on.
  *
- * The main key difference is making all the `onclose`, `onerror`, etc. functions have `any[]` args, making `data` in `send()` of type `any`, and making `binaryType` of type string,
- * though the particular implementation should narrow each of these implementation-specific types.
+ * `addEventListener`/`removeEventListener` declare a typed overload against `IWebSocketEventMap` (the global event
+ * interfaces, used here rather than the local `WebSocketEventMap` since they are generic enough to describe the
+ * events `ReconnectingWebSocket` attaches to). They also declare the permissive string overload that the real
+ * `WebSocket` types carry, which is what lets conformant implementations whose event types do not structurally
+ * match the global ones (e.g. the `ws` library, whose events are a minimal subset and use `target: WebSocket`)
+ * still satisfy this interface.
+ *
+ * The `onopen`/`onclose`/`onmessage`/`onerror` handler properties are intentionally omitted: `ReconnectingWebSocket`
+ * never assigns to them (it uses `addEventListener`), and because they are function-valued properties their
+ * parameters are checked contravariantly, which no single precise event type can satisfy across implementations
+ * (e.g. `ws`'s events use `target: WebSocket` while the DOM's use `target: EventTarget | null`).
+ *
+ * `binaryType` is widened to `string` and `send()` accepts the full `Message` union; a particular implementation
+ * should narrow each of these implementation-specific types.
  */
 export declare interface IWebSocket {
     binaryType: string;
     readonly bufferedAmount: number;
     readonly extensions: string;
-    onclose: ((...args: any[]) => any) | null;
-    onerror: ((...args: any[]) => any) | null;
-    onmessage: ((...args: any[]) => any) | null;
-    onopen: ((...args: any[]) => any) | null;
     readonly protocol: string;
     readonly readyState: number;
     readonly url: string;
     close(code?: number, reason?: string): void;
-    send(data: any): void;
+    send(data: Message): void;
     readonly CLOSED: number;
     readonly CLOSING: number;
     readonly CONNECTING: number;
     readonly OPEN: number;
-    addEventListener<K extends keyof WebSocketEventMap_2>(type: K, listener: (ev: WebSocketEventMap_2[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener<K extends keyof IWebSocketEventMap>(type: K, listener: (event: IWebSocketEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-    removeEventListener<K extends keyof WebSocketEventMap_2>(type: K, listener: (ev: WebSocketEventMap_2[K]) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener<K extends keyof IWebSocketEventMap>(type: K, listener: (event: IWebSocketEventMap[K]) => void, options?: boolean | EventListenerOptions): void;
     removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
 }
 
@@ -6407,6 +6416,22 @@ export declare function normalizeCreateBinaryOptions(arg1: BinarySource | Create
 
 export declare function normalizeCreatePdfOptions(arg1: TDocumentDefinitions | CreatePdfOptions, arg2: string | undefined | MedplumRequestOptions, arg3: Record<string, CustomTableLayout> | undefined, arg4: TFontDictionary | undefined): CreatePdfOptions;
 
+/**
+ * Normalizes the various `error` event shapes dispatched by different `WebSocket` implementations
+ * into a single `ErrorEvent` carrying a real `Error`, so downstream listeners always get `message`
+ * and `error` regardless of the underlying implementation:
+ *
+ * - Browsers dispatch a plain `Event` with no error details (per the WHATWG WebSocket spec).
+ * - Node's `ws` library and Node's built-in (undici) `WebSocket` dispatch an `ErrorEvent` with both
+ *   `message` and `error`.
+ * - Bun dispatches a plain `Event` with a `message` string but no `error`.
+ *
+ * @param event - The `error` event as dispatched by the underlying `WebSocket`.
+ * @param target - The `ReconnectingWebSocket` instance the normalized event is dispatched from.
+ * @returns An `ErrorEvent` with a populated `message` and `error`.
+ */
+export declare function normalizeErrorEvent(event: Event | ErrorEvent_2, target: unknown): ErrorEvent_2;
+
 /**
  * Normalizes an error object into a displayable error string.
  * @param error - The error value which could be a string, Error, OperationOutcome, or other unknown type.

package/dist/esm/index.d.ts

@@ -3355,31 +3355,40 @@ export declare function isValidMedplumSemver(version: string): boolean;
 
 /**
  * Generic interface that an implementation of `WebSocket` must satisfy to be used with `ReconnectingWebSocket`.
- * This is a slightly modified fork of the `WebSocket` global type used in Node.
+ * This is a slightly modified fork of the `WebSocket` global type used in Node, narrowed to exactly the members
+ * `ReconnectingWebSocket` actually depends on.
  *
- * The main key difference is making all the `onclose`, `onerror`, etc. functions have `any[]` args, making `data` in `send()` of type `any`, and making `binaryType` of type string,
- * though the particular implementation should narrow each of these implementation-specific types.
+ * `addEventListener`/`removeEventListener` declare a typed overload against `IWebSocketEventMap` (the global event
+ * interfaces, used here rather than the local `WebSocketEventMap` since they are generic enough to describe the
+ * events `ReconnectingWebSocket` attaches to). They also declare the permissive string overload that the real
+ * `WebSocket` types carry, which is what lets conformant implementations whose event types do not structurally
+ * match the global ones (e.g. the `ws` library, whose events are a minimal subset and use `target: WebSocket`)
+ * still satisfy this interface.
+ *
+ * The `onopen`/`onclose`/`onmessage`/`onerror` handler properties are intentionally omitted: `ReconnectingWebSocket`
+ * never assigns to them (it uses `addEventListener`), and because they are function-valued properties their
+ * parameters are checked contravariantly, which no single precise event type can satisfy across implementations
+ * (e.g. `ws`'s events use `target: WebSocket` while the DOM's use `target: EventTarget | null`).
+ *
+ * `binaryType` is widened to `string` and `send()` accepts the full `Message` union; a particular implementation
+ * should narrow each of these implementation-specific types.
  */
 export declare interface IWebSocket {
     binaryType: string;
     readonly bufferedAmount: number;
     readonly extensions: string;
-    onclose: ((...args: any[]) => any) | null;
-    onerror: ((...args: any[]) => any) | null;
-    onmessage: ((...args: any[]) => any) | null;
-    onopen: ((...args: any[]) => any) | null;
     readonly protocol: string;
     readonly readyState: number;
     readonly url: string;
     close(code?: number, reason?: string): void;
-    send(data: any): void;
+    send(data: Message): void;
     readonly CLOSED: number;
     readonly CLOSING: number;
     readonly CONNECTING: number;
     readonly OPEN: number;
-    addEventListener<K extends keyof WebSocketEventMap_2>(type: K, listener: (ev: WebSocketEventMap_2[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener<K extends keyof IWebSocketEventMap>(type: K, listener: (event: IWebSocketEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-    removeEventListener<K extends keyof WebSocketEventMap_2>(type: K, listener: (ev: WebSocketEventMap_2[K]) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener<K extends keyof IWebSocketEventMap>(type: K, listener: (event: IWebSocketEventMap[K]) => void, options?: boolean | EventListenerOptions): void;
     removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
 }
 
@@ -6407,6 +6416,22 @@ export declare function normalizeCreateBinaryOptions(arg1: BinarySource | Create
 
 export declare function normalizeCreatePdfOptions(arg1: TDocumentDefinitions | CreatePdfOptions, arg2: string | undefined | MedplumRequestOptions, arg3: Record<string, CustomTableLayout> | undefined, arg4: TFontDictionary | undefined): CreatePdfOptions;
 
+/**
+ * Normalizes the various `error` event shapes dispatched by different `WebSocket` implementations
+ * into a single `ErrorEvent` carrying a real `Error`, so downstream listeners always get `message`
+ * and `error` regardless of the underlying implementation:
+ *
+ * - Browsers dispatch a plain `Event` with no error details (per the WHATWG WebSocket spec).
+ * - Node's `ws` library and Node's built-in (undici) `WebSocket` dispatch an `ErrorEvent` with both
+ *   `message` and `error`.
+ * - Bun dispatches a plain `Event` with a `message` string but no `error`.
+ *
+ * @param event - The `error` event as dispatched by the underlying `WebSocket`.
+ * @param target - The `ReconnectingWebSocket` instance the normalized event is dispatched from.
+ * @returns An `ErrorEvent` with a populated `message` and `error`.
+ */
+export declare function normalizeErrorEvent(event: Event | ErrorEvent_2, target: unknown): ErrorEvent_2;
+
 /**
  * Normalizes an error object into a displayable error string.
  * @param error - The error value which could be a string, Error, OperationOutcome, or other unknown type.