@actuallab/rpc 12.3.83 → 12.4.1

package/dist/index.d.cts

@@ -748,7 +748,7 @@ declare const RPC_CLOSE_CODE_UNSUPPORTED_FORMAT = 4001;
 /** Maximum time to wait for the server's handshake response after opening the socket. */
 declare const HANDSHAKE_TIMEOUT_MS = 10000;
 /** Builds the WebSocket connection URL for an RpcClientPeer. */
-type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string;
+type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string | Promise<string>;
 /** Default connection URL provider — sets `clientId` and `f` query parameters,
  *  replacing any existing values to keep the wire format consistent with the
  *  peer's actual `serializationFormat`. */
@@ -995,7 +995,7 @@ interface RpcStreamRef {
     readonly hostId: string;
     readonly localId: number;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     readonly allowReconnect: boolean;
     readonly isRealTime: boolean;
 }
@@ -1009,13 +1009,13 @@ type RpcStreamSource<T> = AsyncIterable<T> | ((abortSignal: AbortSignal) => Asyn
 /** Configuration options for creating a local (origin-side) RpcStream. */
 interface RpcStreamOptions<T> {
     ackPeriod?: number;
-    ackAdvance?: number;
+    bufferSize?: number;
     allowReconnect?: boolean;
     isRealTime?: boolean;
     canSkipTo?: (item: T) => boolean;
 }
 /**
- * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{ackAdvance}".
+ * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{bufferSize}".
  * Returns null if the value is not a valid stream reference.
  */
 declare function parseStreamRef(value: unknown): RpcStreamRef | null;
@@ -1047,7 +1047,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
     readonly isRealTime: boolean;
     readonly canSkipTo: (item: T) => boolean;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     readonly localSource?: RpcStreamSource<T>;
     readonly peer: RpcPeer;
     private _sender?;
@@ -1078,7 +1078,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
      * stream reference.
      *
      * For binary peers the ref is a MessagePack-compatible object
-     * (`{ SerializedId, AckPeriod, AckAdvance, AllowReconnect }`);
+     * (`{ SerializedId, AckPeriod, BufferSize, AllowReconnect }`);
      * for text peers it is a comma-separated string.
      *
      * Can only be called once per stream.
@@ -1104,7 +1104,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
  * Recursively walks a deserialized value and replaces any stream ref strings
  * with live RpcStream<unknown> instances registered on the given peer.
  * This handles nested stream refs inside complex return types (e.g. Table<T>
- * containing RpcStream<Row<T>> fields serialized as "{hostId},{localId},{ackPeriod},{ackAdvance}").
+ * containing RpcStream<Row<T>> fields serialized as "{hostId},{localId},{ackPeriod},{bufferSize}").
  */
 declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
 
@@ -1123,13 +1123,12 @@ declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
  * The pump is ACK-driven: the main loop blocks on `_whenAckReady` until a
  * client ACK is queued, processes it (updating `_lastAckedIndex`, rewinding
  * `_index` on mustReset, trimming the replay buffer), then sends items up
- * to `ack.nextIndex + ackAdvance`. While the peer is disconnected no ACKs
+ * to `ack.nextIndex + bufferSize`. While the peer is disconnected no ACKs
  * arrive, so the source is never pulled — the sender naturally pauses
  * instead of spinning.
  *
  * Direct port of .NET `RpcSharedStream<T>` at
- * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs — including the
- * separate non-real-time / real-time pump variants.
+ * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs.
  */
 declare class RpcStreamSender<T> implements IRpcObject {
     private static readonly _emptyGuid;
@@ -1140,7 +1139,7 @@ declare class RpcStreamSender<T> implements IRpcObject {
     readonly canSkipTo: (item: T) => boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     /**
      * If true, the source was produced by a factory `(abortSignal) => AsyncIterable<T>`
      * and may honor the AbortSignal to exit gracefully. `disconnect()` first aborts
@@ -1161,7 +1160,7 @@ declare class RpcStreamSender<T> implements IRpcObject {
     private _iterator;
     private _acks;
     private _whenAckReady;
-    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number, allowReconnect?: boolean, isRealTime?: boolean, canSkipTo?: (item: T) => boolean, sourceUsesAbortSignal?: boolean);
+    constructor(peer: RpcPeer, ackPeriod?: number, bufferSize?: number, allowReconnect?: boolean, isRealTime?: boolean, canSkipTo?: (item: T) => boolean, sourceUsesAbortSignal?: boolean);
     /** AbortSignal that is aborted when the sender is disconnected. */
     get abortSignal(): AbortSignal;
     /** Returns the stream reference string for the $sys.Ok response. */
@@ -1192,25 +1191,16 @@ declare class RpcStreamSender<T> implements IRpcObject {
     /**
      * Consume an AsyncIterable and send all items to the client.
      *
-     * Dispatches to the non-real-time or real-time pump, matching .NET
-     * `RpcSharedStream<T>.OnRun` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:105-108.
+     * Matches .NET `RpcSharedStream<T>.OnRun` at
+     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs.
      */
     writeFrom(source: AsyncIterable<T>): Promise<void>;
     /**
-     * Non-real-time pump — back-pressure through buffered ACKs.
-     *
-     * Direct port of .NET `OnRunNonRealTime` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:110-217.
-     */
-    private _runNonRealTime;
-    /**
-     * Real-time pump — drops stale items to stay close to the source's head.
-     *
-     * Direct port of .NET `OnRunRealTime` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:219-420.
+     * ACK-driven pump. Non-real-time streams apply normal backpressure at
+     * `bufferSize`; real-time streams may compact the already-buffered unsent
+     * suffix to the latest buffered `canSkipTo` item after the consumer ACKs.
      */
-    private _runRealTime;
+    private _run;
     /** Drain all queued ACKs, returning the most recent one (or null if none). */
     private _tryProcessAcks;
     /** Wait for the ACK queue to have at least one entry (or `_ended`). */

package/dist/index.d.ts

@@ -748,7 +748,7 @@ declare const RPC_CLOSE_CODE_UNSUPPORTED_FORMAT = 4001;
 /** Maximum time to wait for the server's handshake response after opening the socket. */
 declare const HANDSHAKE_TIMEOUT_MS = 10000;
 /** Builds the WebSocket connection URL for an RpcClientPeer. */
-type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string;
+type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string | Promise<string>;
 /** Default connection URL provider — sets `clientId` and `f` query parameters,
  *  replacing any existing values to keep the wire format consistent with the
  *  peer's actual `serializationFormat`. */
@@ -995,7 +995,7 @@ interface RpcStreamRef {
     readonly hostId: string;
     readonly localId: number;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     readonly allowReconnect: boolean;
     readonly isRealTime: boolean;
 }
@@ -1009,13 +1009,13 @@ type RpcStreamSource<T> = AsyncIterable<T> | ((abortSignal: AbortSignal) => Asyn
 /** Configuration options for creating a local (origin-side) RpcStream. */
 interface RpcStreamOptions<T> {
     ackPeriod?: number;
-    ackAdvance?: number;
+    bufferSize?: number;
     allowReconnect?: boolean;
     isRealTime?: boolean;
     canSkipTo?: (item: T) => boolean;
 }
 /**
- * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{ackAdvance}".
+ * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{bufferSize}".
  * Returns null if the value is not a valid stream reference.
  */
 declare function parseStreamRef(value: unknown): RpcStreamRef | null;
@@ -1047,7 +1047,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
     readonly isRealTime: boolean;
     readonly canSkipTo: (item: T) => boolean;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     readonly localSource?: RpcStreamSource<T>;
     readonly peer: RpcPeer;
     private _sender?;
@@ -1078,7 +1078,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
      * stream reference.
      *
      * For binary peers the ref is a MessagePack-compatible object
-     * (`{ SerializedId, AckPeriod, AckAdvance, AllowReconnect }`);
+     * (`{ SerializedId, AckPeriod, BufferSize, AllowReconnect }`);
      * for text peers it is a comma-separated string.
      *
      * Can only be called once per stream.
@@ -1104,7 +1104,7 @@ declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
  * Recursively walks a deserialized value and replaces any stream ref strings
  * with live RpcStream<unknown> instances registered on the given peer.
  * This handles nested stream refs inside complex return types (e.g. Table<T>
- * containing RpcStream<Row<T>> fields serialized as "{hostId},{localId},{ackPeriod},{ackAdvance}").
+ * containing RpcStream<Row<T>> fields serialized as "{hostId},{localId},{ackPeriod},{bufferSize}").
  */
 declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
 
@@ -1123,13 +1123,12 @@ declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
  * The pump is ACK-driven: the main loop blocks on `_whenAckReady` until a
  * client ACK is queued, processes it (updating `_lastAckedIndex`, rewinding
  * `_index` on mustReset, trimming the replay buffer), then sends items up
- * to `ack.nextIndex + ackAdvance`. While the peer is disconnected no ACKs
+ * to `ack.nextIndex + bufferSize`. While the peer is disconnected no ACKs
  * arrive, so the source is never pulled — the sender naturally pauses
  * instead of spinning.
  *
  * Direct port of .NET `RpcSharedStream<T>` at
- * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs — including the
- * separate non-real-time / real-time pump variants.
+ * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs.
  */
 declare class RpcStreamSender<T> implements IRpcObject {
     private static readonly _emptyGuid;
@@ -1140,7 +1139,7 @@ declare class RpcStreamSender<T> implements IRpcObject {
     readonly canSkipTo: (item: T) => boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
-    readonly ackAdvance: number;
+    readonly bufferSize: number;
     /**
      * If true, the source was produced by a factory `(abortSignal) => AsyncIterable<T>`
      * and may honor the AbortSignal to exit gracefully. `disconnect()` first aborts
@@ -1161,7 +1160,7 @@ declare class RpcStreamSender<T> implements IRpcObject {
     private _iterator;
     private _acks;
     private _whenAckReady;
-    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number, allowReconnect?: boolean, isRealTime?: boolean, canSkipTo?: (item: T) => boolean, sourceUsesAbortSignal?: boolean);
+    constructor(peer: RpcPeer, ackPeriod?: number, bufferSize?: number, allowReconnect?: boolean, isRealTime?: boolean, canSkipTo?: (item: T) => boolean, sourceUsesAbortSignal?: boolean);
     /** AbortSignal that is aborted when the sender is disconnected. */
     get abortSignal(): AbortSignal;
     /** Returns the stream reference string for the $sys.Ok response. */
@@ -1192,25 +1191,16 @@ declare class RpcStreamSender<T> implements IRpcObject {
     /**
      * Consume an AsyncIterable and send all items to the client.
      *
-     * Dispatches to the non-real-time or real-time pump, matching .NET
-     * `RpcSharedStream<T>.OnRun` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:105-108.
+     * Matches .NET `RpcSharedStream<T>.OnRun` at
+     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs.
      */
     writeFrom(source: AsyncIterable<T>): Promise<void>;
     /**
-     * Non-real-time pump — back-pressure through buffered ACKs.
-     *
-     * Direct port of .NET `OnRunNonRealTime` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:110-217.
-     */
-    private _runNonRealTime;
-    /**
-     * Real-time pump — drops stale items to stay close to the source's head.
-     *
-     * Direct port of .NET `OnRunRealTime` at
-     * src/ActualLab.Rpc/Infrastructure/RpcSharedStream.cs:219-420.
+     * ACK-driven pump. Non-real-time streams apply normal backpressure at
+     * `bufferSize`; real-time streams may compact the already-buffered unsent
+     * suffix to the latest buffered `canSkipTo` item after the consumer ACKs.
      */
-    private _runRealTime;
+    private _run;
     /** Drain all queued ACKs, returning the most recent one (or null if none). */
     private _tryProcessAcks;
     /** Wait for the ACK queue to have at least one entry (or `_ended`). */