@kyneta/websocket-transport 1.3.0 → 1.4.0

package/dist/types-DdNb8cAz.d.ts

@@ -1,149 +0,0 @@
-import { StateTransition, TransitionListener as TransitionListener$1, PeerId } from '@kyneta/transport';
-
-/**
- * Websocket ready states — mirrors the standard WebSocket readyState
- * values as human-readable strings.
- */
-type SocketReadyState = "connecting" | "open" | "closing" | "closed";
-/**
- * Framework-agnostic Websocket interface.
- *
- * This allows the adapter to work with any Websocket library:
- * - Browser `WebSocket` via `wrapStandardWebsocket()`
- * - Node.js `ws` library via `wrapNodeWebsocket()`
- * - Bun `ServerWebSocket` via `wrapBunWebsocket()`
- *
- * The interface is intentionally minimal — only the operations the
- * adapter needs are exposed.
- */
-interface Socket {
-    /** Send binary or text data through the Websocket. */
-    send(data: Uint8Array | string): void;
-    /** Close the Websocket connection. */
-    close(code?: number, reason?: string): void;
-    /** Register a handler for incoming messages (binary or text). */
-    onMessage(handler: (data: Uint8Array | string) => void): void;
-    /** Register a handler for connection close. */
-    onClose(handler: (code: number, reason: string) => void): void;
-    /** Register a handler for errors. */
-    onError(handler: (error: Error) => void): void;
-    /** The current ready state of the Websocket. */
-    readonly readyState: SocketReadyState;
-}
-/**
- * Options for handling a new Websocket connection on the server.
- */
-interface WebsocketConnectionOptions {
-    /** The Websocket instance, wrapped in the Socket interface. */
-    socket: Socket;
-    /** Optional peer ID extracted from the upgrade request. */
-    peerId?: PeerId;
-    /** Optional authentication token from the upgrade request. */
-    authToken?: string;
-}
-/**
- * Handle for an active Websocket connection.
- */
-interface WebsocketConnectionHandle {
-    /** The peer ID for this connection. */
-    readonly peerId: PeerId;
-    /** The channel ID for this connection. */
-    readonly channelId: number;
-    /** Close the connection. */
-    close(code?: number, reason?: string): void;
-}
-/**
- * Result of handling a Websocket connection on the server.
- */
-interface WebsocketConnectionResult {
-    /** The connection handle for managing this peer. */
-    connection: WebsocketConnectionHandle;
-    /** Call this to start processing messages. */
-    start(): void;
-}
-/**
- * Discriminated union describing why a Websocket connection was lost.
- */
-type DisconnectReason = {
-    type: "intentional";
-} | {
-    type: "error";
-    error: Error;
-} | {
-    type: "closed";
-    code: number;
-    reason: string;
-} | {
-    type: "max-retries-exceeded";
-    attempts: number;
-} | {
-    type: "not-started";
-};
-/**
- * All possible states of the Websocket client.
- *
- * State machine transitions:
- * ```
- * disconnected → connecting → connected → ready
- *                    ↓            ↓         ↓
- *               reconnecting ← ─ ┴ ─ ─ ─ ─ ┘
- *                    ↓
- *               connecting (retry)
- *                    ↓
- *               disconnected (max retries)
- * ```
- */
-type WebsocketClientState = {
-    status: "disconnected";
-    reason?: DisconnectReason;
-} | {
-    status: "connecting";
-    attempt: number;
-} | {
-    status: "connected";
-} | {
-    status: "ready";
-} | {
-    status: "reconnecting";
-    attempt: number;
-    nextAttemptMs: number;
-};
-/**
- * A state transition event for websocket client states.
- * Specialized from the generic `StateTransition<S>`.
- */
-type WebsocketClientStateTransition = StateTransition<WebsocketClientState>;
-/**
- * Listener for websocket client state transitions.
- * Specialized from the generic `TransitionListener<S>`.
- */
-type TransitionListener = TransitionListener$1<WebsocketClientState>;
-/**
- * Wrap a standard `WebSocket` (browser or Node.js `ws` via `ws` package
- * in `WebSocket`-compatible mode) into the `Socket` interface.
- *
- * Handles `ArrayBuffer`, `Blob`, and string messages.
- */
-declare function wrapStandardWebsocket(ws: WebSocket): Socket;
-/**
- * The minimal interface we need from the Node.js `ws` library's `WebSocket`.
- *
- * Using a structural type rather than importing `ws` — consumers provide
- * the actual `ws` instance, we just need these methods.
- */
-interface NodeWebsocketLike {
-    send(data: Uint8Array | string): void;
-    close(code?: number, reason?: string): void;
-    on(event: "message", handler: (data: Buffer | ArrayBuffer | string, isBinary: boolean) => void): void;
-    on(event: "close", handler: (code: number, reason: Buffer) => void): void;
-    on(event: "error", handler: (error: Error) => void): void;
-    readyState: number;
-}
-/**
- * Wrap a Node.js `ws` library WebSocket into the `Socket` interface.
- *
- * Handles `Buffer` → `Uint8Array` conversion for binary messages.
- */
-declare function wrapNodeWebsocket(ws: NodeWebsocketLike): Socket;
-
-export { type DisconnectReason as D, type NodeWebsocketLike as N, type Socket as S, type TransitionListener as T, type WebsocketClientState as W, type SocketReadyState as a, type WebsocketClientStateTransition as b, type WebsocketConnectionOptions as c, type WebsocketConnectionResult as d, type WebsocketConnectionHandle as e, wrapNodeWebsocket as f, wrapStandardWebsocket as w };