@procedures/client 0.0.0-stage → 0.1.0

package/dist/adapters/websocket/client/transport.d.ts

@@ -0,0 +1,106 @@
+/**
+ * WebSocket Client Transport Implementation
+ *
+ * Provides persistent bidirectional RPC over WebSocket.
+ * Supports automatic reconnection, heartbeats, and streaming.
+ */
+import type { Transport, Message, ResponseItem } from "../../../client/types.js";
+import type { WebSocketTransportOptions } from "./types.js";
+import { WebSocketState } from "./types.js";
+export declare class WebSocketTransport implements Transport {
+    readonly name = "websocket";
+    private ws;
+    private state;
+    private options;
+    /** The requests in progress, by wire id */
+    private pendingRequests;
+    /**
+     * The transport makes the id of each request on the wire. Before, the wire id was the
+     * message id: a retry with the same id, or two calls with one id, took each other's frames
+     * (deep dive TRN-8/9).
+     */
+    private wireSeq;
+    /** The functions that run at each state change (the callers that wait for a connection) */
+    private stateListeners;
+    /** Set by close(): the connection is being closed on purpose, so it must not reconnect */
+    private closing;
+    private reconnectAttempts;
+    private reconnectTimer;
+    private heartbeatTimer;
+    private heartbeatTimeout;
+    constructor(options: WebSocketTransportOptions);
+    /** Change the state, and tell the callers that wait for a connection. */
+    private setState;
+    /**
+     * Connect to WebSocket server.
+     */
+    private connect;
+    /**
+     * Leave the current socket without waiting for its close handshake, and handle the close
+     * now. A dead peer never answers the handshake: before, the heartbeat called close() and
+     * waited, so the state stayed CONNECTED and the requests hung (deep dive TRN-6).
+     */
+    private dropConnection;
+    /** Fail every request in progress (a stream ends with the error too). */
+    private failPending;
+    /**
+     * Handle WebSocket close.
+     */
+    private handleClose;
+    /**
+     * Schedule reconnection with exponential backoff.
+     */
+    private scheduleReconnect;
+    /**
+     * Start heartbeat to keep connection alive.
+     */
+    private startHeartbeat;
+    /**
+     * Stop heartbeat.
+     */
+    private stopHeartbeat;
+    /**
+     * Handle incoming message.
+     */
+    private handleMessage;
+    /**
+     * Send a request and yield its response items as they arrive: one item for a request/response
+     * call, each item of a stream. When the reader stops early or the message's signal aborts, the
+     * transport sends a "cancel" message, and the server stops the stream.
+     *
+     * Flow control (deep dive TRN-3): the request gives the server credit for `streamWindow`
+     * items. As the reader takes items, the transport sends more credit, so the server never
+     * runs ahead of a slow reader by more than the window.
+     *
+     * @param message - Message to send
+     * @returns Async iterable of response items
+     */
+    send<TReq, TRes>(message: Message<TReq>): AsyncIterable<ResponseItem<TRes>>;
+    /** This function tells the server to stop a request (a stream that nobody reads). */
+    private sendCancel;
+    /** This function gives the server credit for more items of a stream. */
+    private sendCredit;
+    /**
+     * Wait for WebSocket connection. The wait follows the state changes. Before, each waiting
+     * call polled every 100 ms, and the poller ran on after a timeout until the connection came
+     * back (deep dive TRN-14).
+     */
+    private waitForConnection;
+    /**
+     * Handle server-initiated procedure call.
+     */
+    private handleServerRequest;
+    /**
+     * Close WebSocket connection. The requests in progress fail.
+     */
+    close(): Promise<void>;
+    /**
+     * Get current connection state.
+     */
+    getState(): WebSocketState;
+    /**
+     * Check if connected.
+     */
+    isConnected(): boolean;
+}
+//# sourceMappingURL=transport.d.ts.map

package/dist/adapters/websocket/client/transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../../../src/adapters/websocket/client/transport.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,KAAK,EAAE,yBAAyB,EAAwD,MAAM,YAAY,CAAC;AAClH,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAsF5C,qBAAa,kBAAmB,YAAW,SAAS;IAClD,QAAQ,CAAC,IAAI,eAAe;IAE5B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,KAAK,CAA+C;IAC5D,OAAO,CAAC,OAAO,CAuBb;IACF,2CAA2C;IAC3C,OAAO,CAAC,eAAe,CAA0C;IACjE;;;;OAIG;IACH,OAAO,CAAC,OAAO,CAAK;IACpB,2FAA2F;IAC3F,OAAO,CAAC,cAAc,CAAyB;IAC/C,0FAA0F;IAC1F,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,cAAc,CAAwD;IAC9E,OAAO,CAAC,cAAc,CAAwD;IAC9E,OAAO,CAAC,gBAAgB,CAAwD;IAEhF,YAAY,OAAO,EAAE,yBAAyB,EA4B7C;IAED,yEAAyE;IACzE,OAAO,CAAC,QAAQ;IAKhB;;OAEG;IACH,OAAO,CAAC,OAAO;IAiEf;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAiBtB,yEAAyE;IACzE,OAAO,CAAC,WAAW;IAUnB;;OAEG;IACH,OAAO,CAAC,WAAW;IAqBnB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA2BzB;;OAEG;IACH,OAAO,CAAC,cAAc;IAuBtB;;OAEG;IACH,OAAO,CAAC,aAAa;IAWrB;;OAEG;IACH,OAAO,CAAC,aAAa;IA8HrB;;;;;;;;;;;OAWG;IACI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CA2EjF;IAED,qFAAqF;IACrF,OAAO,CAAC,UAAU;IAOlB,wEAAwE;IACxE,OAAO,CAAC,UAAU;IAOlB;;;;OAIG;YACW,iBAAiB;IA4B/B;;OAEG;YACW,mBAAmB;IA8CjC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CA0B3B;IAED;;OAEG;IACH,QAAQ,IAAI,cAAc,CAEzB;IAED;;OAEG;IACH,WAAW,IAAI,OAAO,CAErB;CACF"}