@actuallab/rpc 12.1.69 → 12.1.115

package/dist/index.d.cts

@@ -272,6 +272,7 @@ type RpcObjectKind = (typeof RpcObjectKind)[keyof typeof RpcObjectKind];
 interface IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: RpcObjectKind;
+    readonly allowReconnect: boolean;
     reconnect(): void;
     disconnect(): void;
 }
@@ -301,6 +302,8 @@ declare class RpcSharedObjectTracker {
  * so "json5np" (System.Text.Json, no polymorphism) is the correct match.
  */
 declare const DEFAULT_SERIALIZATION_FORMAT = "json5np";
+/** WebSocket close code sent by the server when the client's serialization format is unsupported. */
+declare const RPC_CLOSE_CODE_UNSUPPORTED_FORMAT = 4001;
 /** Builds the WebSocket connection URL for an RpcClientPeer. */
 type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string;
 /** Default connection URL provider — appends `clientId` and `f` query parameters. */
@@ -383,6 +386,10 @@ declare class RpcClientPeer extends RpcPeer {
     /** Builds the WebSocket URL for this peer. Replace to customize URL construction. */
     connectionUrlResolver: RpcConnectionUrlResolver;
     readonly peerChanged: EventHandlerSet<void>;
+    /** Fired when the server rejects the connection due to an unsupported serialization format (close code 4010). */
+    readonly unsupportedFormat: EventHandlerSet<{
+        reason: string;
+    }>;
     readonly reconnectDelayer: RpcClientPeerReconnectDelayer;
     readonly reconnectsAtChanged: EventHandlerSet<void>;
     get reconnectsAt(): number;
@@ -423,6 +430,7 @@ interface RpcStreamRef {
     readonly localId: number;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
+    readonly allowReconnect: boolean;
 }
 /**
  * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{ackAdvance}".
@@ -443,6 +451,7 @@ declare function parseStreamRef(value: unknown): RpcStreamRef | null;
 declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: 1;
+    readonly allowReconnect: boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
@@ -494,13 +503,14 @@ declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
 declare class RpcStreamSender<T> implements IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: 0;
+    readonly allowReconnect: boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
     private _nextIndex;
     private _ended;
     private _started;
-    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number);
+    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number, allowReconnect?: boolean);
     /** Returns the stream reference string for the $sys.Ok response. */
     toRef(): string;
     /** Called by system call handler when $sys.Ack is received from the client. */
@@ -586,4 +596,4 @@ declare class RpcPeerStateMonitor {
     private _scheduleRecompute;
 }
 
-export { ARG_DELIMITER, DEFAULT_SERIALIZATION_FORMAT, ENVELOPE_DELIMITER, FRAME_DELIMITER, type IRpcObject, type MethodMeta, type RemoteHandshake, type RpcCallOptions, RpcCallTypeId, RpcClientPeer, RpcClientPeerReconnectDelayer, type RpcConnection, type RpcConnectionUrlResolver, type RpcDispatchContext, RpcHub, RpcInboundCall, RpcInboundCallTracker, type RpcMessage, RpcMessageChannelConnection, type RpcMethodDef, type RpcMethodDefInput, type RpcObjectId, RpcObjectKind, RpcOutboundCall, RpcOutboundCallTracker, RpcPeer, RpcPeerConnectionKind, type RpcPeerState, RpcPeerStateKind, RpcPeerStateMonitor, RpcRemoteObjectTracker, RpcServerPeer, type RpcServiceDef, RpcServiceHost, type RpcServiceImpl, RpcSharedObjectTracker, RpcStream, type RpcStreamRef, RpcStreamSender, RpcSystemCallHandler, RpcSystemCallSender, RpcSystemCalls, RpcType, RpcWebSocketConnection, type ServiceMeta, type WebSocketLike, type WebSocketServer, WebSocketState, createMessageChannelPair, createRpcClient, defaultConnectionUrlResolver, defineRpcService, deserializeMessage, getMethodsMeta, getServiceMeta, getStateDescription, isConnected, likelyConnected, parseStreamRef, resolveStreamRefs, rpcMethod, rpcService, serializeFrame, serializeMessage, splitFrame, wireMethodName };
+export { ARG_DELIMITER, DEFAULT_SERIALIZATION_FORMAT, ENVELOPE_DELIMITER, FRAME_DELIMITER, type IRpcObject, type MethodMeta, RPC_CLOSE_CODE_UNSUPPORTED_FORMAT, type RemoteHandshake, type RpcCallOptions, RpcCallTypeId, RpcClientPeer, RpcClientPeerReconnectDelayer, type RpcConnection, type RpcConnectionUrlResolver, type RpcDispatchContext, RpcHub, RpcInboundCall, RpcInboundCallTracker, type RpcMessage, RpcMessageChannelConnection, type RpcMethodDef, type RpcMethodDefInput, type RpcObjectId, RpcObjectKind, RpcOutboundCall, RpcOutboundCallTracker, RpcPeer, RpcPeerConnectionKind, type RpcPeerState, RpcPeerStateKind, RpcPeerStateMonitor, RpcRemoteObjectTracker, RpcServerPeer, type RpcServiceDef, RpcServiceHost, type RpcServiceImpl, RpcSharedObjectTracker, RpcStream, type RpcStreamRef, RpcStreamSender, RpcSystemCallHandler, RpcSystemCallSender, RpcSystemCalls, RpcType, RpcWebSocketConnection, type ServiceMeta, type WebSocketLike, type WebSocketServer, WebSocketState, createMessageChannelPair, createRpcClient, defaultConnectionUrlResolver, defineRpcService, deserializeMessage, getMethodsMeta, getServiceMeta, getStateDescription, isConnected, likelyConnected, parseStreamRef, resolveStreamRefs, rpcMethod, rpcService, serializeFrame, serializeMessage, splitFrame, wireMethodName };

package/dist/index.d.ts

@@ -272,6 +272,7 @@ type RpcObjectKind = (typeof RpcObjectKind)[keyof typeof RpcObjectKind];
 interface IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: RpcObjectKind;
+    readonly allowReconnect: boolean;
     reconnect(): void;
     disconnect(): void;
 }
@@ -301,6 +302,8 @@ declare class RpcSharedObjectTracker {
  * so "json5np" (System.Text.Json, no polymorphism) is the correct match.
  */
 declare const DEFAULT_SERIALIZATION_FORMAT = "json5np";
+/** WebSocket close code sent by the server when the client's serialization format is unsupported. */
+declare const RPC_CLOSE_CODE_UNSUPPORTED_FORMAT = 4001;
 /** Builds the WebSocket connection URL for an RpcClientPeer. */
 type RpcConnectionUrlResolver = (peer: RpcClientPeer) => string;
 /** Default connection URL provider — appends `clientId` and `f` query parameters. */
@@ -383,6 +386,10 @@ declare class RpcClientPeer extends RpcPeer {
     /** Builds the WebSocket URL for this peer. Replace to customize URL construction. */
     connectionUrlResolver: RpcConnectionUrlResolver;
     readonly peerChanged: EventHandlerSet<void>;
+    /** Fired when the server rejects the connection due to an unsupported serialization format (close code 4010). */
+    readonly unsupportedFormat: EventHandlerSet<{
+        reason: string;
+    }>;
     readonly reconnectDelayer: RpcClientPeerReconnectDelayer;
     readonly reconnectsAtChanged: EventHandlerSet<void>;
     get reconnectsAt(): number;
@@ -423,6 +430,7 @@ interface RpcStreamRef {
     readonly localId: number;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
+    readonly allowReconnect: boolean;
 }
 /**
  * Parses a stream reference string of the form "{hostId},{localId},{ackPeriod},{ackAdvance}".
@@ -443,6 +451,7 @@ declare function parseStreamRef(value: unknown): RpcStreamRef | null;
 declare class RpcStream<T> implements AsyncIterable<T>, IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: 1;
+    readonly allowReconnect: boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
@@ -494,13 +503,14 @@ declare function resolveStreamRefs(value: unknown, peer: RpcPeer): unknown;
 declare class RpcStreamSender<T> implements IRpcObject {
     readonly id: RpcObjectId;
     readonly kind: 0;
+    readonly allowReconnect: boolean;
     readonly peer: RpcPeer;
     readonly ackPeriod: number;
     readonly ackAdvance: number;
     private _nextIndex;
     private _ended;
     private _started;
-    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number);
+    constructor(peer: RpcPeer, ackPeriod?: number, ackAdvance?: number, allowReconnect?: boolean);
     /** Returns the stream reference string for the $sys.Ok response. */
     toRef(): string;
     /** Called by system call handler when $sys.Ack is received from the client. */
@@ -586,4 +596,4 @@ declare class RpcPeerStateMonitor {
     private _scheduleRecompute;
 }
 
-export { ARG_DELIMITER, DEFAULT_SERIALIZATION_FORMAT, ENVELOPE_DELIMITER, FRAME_DELIMITER, type IRpcObject, type MethodMeta, type RemoteHandshake, type RpcCallOptions, RpcCallTypeId, RpcClientPeer, RpcClientPeerReconnectDelayer, type RpcConnection, type RpcConnectionUrlResolver, type RpcDispatchContext, RpcHub, RpcInboundCall, RpcInboundCallTracker, type RpcMessage, RpcMessageChannelConnection, type RpcMethodDef, type RpcMethodDefInput, type RpcObjectId, RpcObjectKind, RpcOutboundCall, RpcOutboundCallTracker, RpcPeer, RpcPeerConnectionKind, type RpcPeerState, RpcPeerStateKind, RpcPeerStateMonitor, RpcRemoteObjectTracker, RpcServerPeer, type RpcServiceDef, RpcServiceHost, type RpcServiceImpl, RpcSharedObjectTracker, RpcStream, type RpcStreamRef, RpcStreamSender, RpcSystemCallHandler, RpcSystemCallSender, RpcSystemCalls, RpcType, RpcWebSocketConnection, type ServiceMeta, type WebSocketLike, type WebSocketServer, WebSocketState, createMessageChannelPair, createRpcClient, defaultConnectionUrlResolver, defineRpcService, deserializeMessage, getMethodsMeta, getServiceMeta, getStateDescription, isConnected, likelyConnected, parseStreamRef, resolveStreamRefs, rpcMethod, rpcService, serializeFrame, serializeMessage, splitFrame, wireMethodName };
+export { ARG_DELIMITER, DEFAULT_SERIALIZATION_FORMAT, ENVELOPE_DELIMITER, FRAME_DELIMITER, type IRpcObject, type MethodMeta, RPC_CLOSE_CODE_UNSUPPORTED_FORMAT, type RemoteHandshake, type RpcCallOptions, RpcCallTypeId, RpcClientPeer, RpcClientPeerReconnectDelayer, type RpcConnection, type RpcConnectionUrlResolver, type RpcDispatchContext, RpcHub, RpcInboundCall, RpcInboundCallTracker, type RpcMessage, RpcMessageChannelConnection, type RpcMethodDef, type RpcMethodDefInput, type RpcObjectId, RpcObjectKind, RpcOutboundCall, RpcOutboundCallTracker, RpcPeer, RpcPeerConnectionKind, type RpcPeerState, RpcPeerStateKind, RpcPeerStateMonitor, RpcRemoteObjectTracker, RpcServerPeer, type RpcServiceDef, RpcServiceHost, type RpcServiceImpl, RpcSharedObjectTracker, RpcStream, type RpcStreamRef, RpcStreamSender, RpcSystemCallHandler, RpcSystemCallSender, RpcSystemCalls, RpcType, RpcWebSocketConnection, type ServiceMeta, type WebSocketLike, type WebSocketServer, WebSocketState, createMessageChannelPair, createRpcClient, defaultConnectionUrlResolver, defineRpcService, deserializeMessage, getMethodsMeta, getServiceMeta, getStateDescription, isConnected, likelyConnected, parseStreamRef, resolveStreamRefs, rpcMethod, rpcService, serializeFrame, serializeMessage, splitFrame, wireMethodName };

package/dist/index.js

@@ -310,17 +310,19 @@ var RpcObjectKind = { Local: 0, Remote: 1 };
 function parseStreamRef(value) {
   if (typeof value !== "string") return null;
   const parts = value.split(",");
-  if (parts.length !== 4) return null;
+  if (parts.length < 4 || parts.length > 5) return null;
   const hostId = parts[0];
   const localId = parseInt(parts[1], 10);
   const ackPeriod = parseInt(parts[2], 10);
   const ackAdvance = parseInt(parts[3], 10);
   if (isNaN(localId) || isNaN(ackPeriod) || isNaN(ackAdvance)) return null;
-  return { hostId, localId, ackPeriod, ackAdvance };
+  const allowReconnect = parts.length < 5 || parts[4] !== "0";
+  return { hostId, localId, ackPeriod, ackAdvance, allowReconnect };
 }
 var RpcStream = class {
   id;
   kind = RpcObjectKind.Remote;
+  allowReconnect;
   peer;
   ackPeriod;
   ackAdvance;
@@ -335,6 +337,7 @@ var RpcStream = class {
   _ackSentUpTo = 0;
   constructor(ref, peer) {
     this.id = { hostId: ref.hostId, localId: ref.localId };
+    this.allowReconnect = ref.allowReconnect;
     this.peer = peer;
     this.ackPeriod = ref.ackPeriod;
     this.ackAdvance = ref.ackAdvance;
@@ -380,7 +383,11 @@ var RpcStream = class {
   }
   // -- IRpcObject --
   reconnect() {
-    this._sendAck(this._nextExpectedIndex, true);
+    if (this.allowReconnect) {
+      this._sendAck(this._nextExpectedIndex, true);
+    } else {
+      this.disconnect();
+    }
   }
   disconnect() {
     if (this._completed) return;
@@ -633,22 +640,24 @@ var DEFAULT_ACK_ADVANCE = 128;
 var RpcStreamSender = class {
   id;
   kind = RpcObjectKind.Local;
+  allowReconnect;
   peer;
   ackPeriod;
   ackAdvance;
   _nextIndex = 0;
   _ended = false;
   _started = new PromiseSource4();
-  constructor(peer, ackPeriod = DEFAULT_ACK_PERIOD, ackAdvance = DEFAULT_ACK_ADVANCE) {
+  constructor(peer, ackPeriod = DEFAULT_ACK_PERIOD, ackAdvance = DEFAULT_ACK_ADVANCE, allowReconnect = true) {
     const localId = peer.sharedObjects.nextId();
     this.id = { hostId: peer.hub.hubId, localId };
+    this.allowReconnect = allowReconnect;
     this.peer = peer;
     this.ackPeriod = ackPeriod;
     this.ackAdvance = ackAdvance;
   }
   /** Returns the stream reference string for the $sys.Ok response. */
   toRef() {
-    return `${this.id.hostId},${this.id.localId},${this.ackPeriod},${this.ackAdvance}`;
+    return `${this.id.hostId},${this.id.localId},${this.ackPeriod},${this.ackAdvance},${this.allowReconnect ? "1" : "0"}`;
   }
   /** Called by system call handler when $sys.Ack is received from the client. */
   onAck(_nextIndex, _hostId) {
@@ -738,7 +747,10 @@ var RpcRemoteObjectTracker = class {
   }
   reconnectAll() {
     for (const obj of this._objects.values()) {
-      obj.reconnect();
+      if (obj.allowReconnect)
+        obj.reconnect();
+      else
+        obj.disconnect();
     }
   }
 };
@@ -781,6 +793,7 @@ var RpcClientPeerReconnectDelayer = class extends RetryDelayer {
 
 // src/rpc-peer.ts
 var DEFAULT_SERIALIZATION_FORMAT = "json5np";
+var RPC_CLOSE_CODE_UNSUPPORTED_FORMAT = 4001;
 var defaultConnectionUrlResolver = (peer) => {
   const sep = peer.ref.includes("?") ? "&" : "?";
   return peer.ref + sep + `clientId=${peer.clientId}&f=${peer.serializationFormat}`;
@@ -986,6 +999,8 @@ var RpcClientPeer = class extends RpcPeer {
   /** Builds the WebSocket URL for this peer. Replace to customize URL construction. */
   connectionUrlResolver = defaultConnectionUrlResolver;
   peerChanged = new EventHandlerSet3();
+  /** Fired when the server rejects the connection due to an unsupported serialization format (close code 4010). */
+  unsupportedFormat = new EventHandlerSet3();
   reconnectDelayer = new RpcClientPeerReconnectDelayer();
   reconnectsAtChanged = new EventHandlerSet3();
   get reconnectsAt() {
@@ -1013,10 +1028,16 @@ var RpcClientPeer = class extends RpcPeer {
   async run(wsFactory) {
     const connUrl = this.connectionUrlResolver(this);
     while (!this._disposed) {
+      let lastCloseCode = 0;
+      let lastCloseReason = "";
       try {
         const ws = wsFactory?.(connUrl) ?? new WebSocket(connUrl);
         const conn = new RpcWebSocketConnection(ws);
         this._connectionKind = 1 /* Connecting */;
+        conn.closed.add((ev) => {
+          lastCloseCode = ev.code;
+          lastCloseReason = ev.reason;
+        });
         this._pendingHandshake = new PromiseSource5();
         this.setupConnection(conn);
         this._connection = void 0;
@@ -1049,6 +1070,11 @@ var RpcClientPeer = class extends RpcPeer {
       }
       this._connectionKind = 0 /* Disconnected */;
       if (this._disposed) break;
+      if (lastCloseCode === RPC_CLOSE_CODE_UNSUPPORTED_FORMAT) {
+        this.unsupportedFormat.trigger({ reason: lastCloseReason });
+        this._disposed = true;
+        break;
+      }
       this._tryIndex++;
       const delay = this.reconnectDelayer.getDelay(this._tryIndex);
       if (delay.isLimitExceeded) {
@@ -1519,6 +1545,7 @@ export {
   DEFAULT_SERIALIZATION_FORMAT,
   ENVELOPE_DELIMITER,
   FRAME_DELIMITER,
+  RPC_CLOSE_CODE_UNSUPPORTED_FORMAT,
   RpcCallTypeId,
   RpcClientPeer,
   RpcClientPeerReconnectDelayer,