openrtc-netcode 0.1.0 → 1.0.0

package/README.md

@@ -11,6 +11,13 @@ and Firestore remain part of OpenRTC's control plane for identity, discovery,
 rooms, tickets, and browser signaling metadata; `openrtc-netcode` does not use
 Firestore as a state or message relay.
 
+`preferredPayloadTransports` filters OpenRTC's typed application-readiness
+query; it does not request promotion. When netcode creates the runtime,
+`transports` and `transportPriority` are forwarded to `OpenRTC(...)` at
+construction. An injected runtime must be configured by its owner. OpenRTC owns
+optional transport promotion and recovery, while netcode only observes later
+route events and never requests or suppresses upgrades.
+
 ```ts
 import { createNetcode } from 'openrtc-netcode';
 

package/dist/client.d.ts

@@ -29,7 +29,6 @@ export declare class OpenRtcNetcodeClient implements NetcodeClientInterface {
     private readonly connectionIds;
     private readonly pendingPeerIds;
     private readonly directSendWarnings;
-    private readonly requestedWebRtcUpgradeConnectionIds;
     private readonly introPeerIds;
     private readonly seenEnvelopeIds;
     private readonly seenEnvelopeOrder;
@@ -81,6 +80,7 @@ export declare class OpenRtcNetcodeClient implements NetcodeClientInterface {
     private sendObjectSnapshot;
     private broadcastMemberMetadata;
     private startPeerPingLoop;
+    private refreshPeerPayloadState;
     private stopPeerPingLoop;
     private broadcastEnvelope;
     private sendEnvelope;
@@ -101,7 +101,6 @@ export declare class OpenRtcNetcodeClient implements NetcodeClientInterface {
     private resolvePeerTransport;
     private isPeerPayloadReady;
     private resolvePayloadConnection;
-    private requestPreferredTransportUpgrade;
     private payloadReadinessOptions;
     private refreshLobby;
     private requireRuntime;

package/dist/client.js

@@ -40,7 +40,6 @@ export class OpenRtcNetcodeClient {
         this.connectionIds = new Set();
         this.pendingPeerIds = new Set();
         this.directSendWarnings = new Set();
-        this.requestedWebRtcUpgradeConnectionIds = new Set();
         this.introPeerIds = new Set();
         this.seenEnvelopeIds = new Set();
         this.seenEnvelopeOrder = [];
@@ -120,7 +119,6 @@ export class OpenRtcNetcodeClient {
         this.connectionIds.clear();
         this.pendingPeerIds.clear();
         this.directSendWarnings.clear();
-        this.requestedWebRtcUpgradeConnectionIds.clear();
         this.introPeerIds.clear();
         this.peerStatsById.clear();
         this.seenEnvelopeIds.clear();
@@ -312,13 +310,9 @@ export class OpenRtcNetcodeClient {
                 if (this.fallbackChannel) {
                     continue;
                 }
-                const connection = this.connectionsByPeer.get(peerId);
                 this.peersById.delete(peerId);
                 this.connectionsByPeer.delete(peerId);
                 this.pendingPeerIds.delete(peerId);
-                if (connection?.id) {
-                    this.requestedWebRtcUpgradeConnectionIds.delete(connection.id);
-                }
                 this.introPeerIds.delete(peerId);
                 this.peerStatsById.delete(peerId);
                 this.emitter.emit('peer:left', clonePeer(peer));
@@ -370,7 +364,6 @@ export class OpenRtcNetcodeClient {
             this.connectionIds.add(connectionId);
         }
         this.connectionsByPeer.set(peerId, connection);
-        this.requestPreferredTransportUpgrade(connection);
         const payloadReady = this.isPeerPayloadReady(peerId);
         const peer = this.upsertPeer(peerId, { connected: payloadReady });
         this.updatePeerStats(peerId, {
@@ -384,13 +377,15 @@ export class OpenRtcNetcodeClient {
         connection.onMessage((message) => {
             this.handleConnectionMessage(peerId, message);
         });
+        connection.onUpgradeStateChange?.(() => {
+            this.refreshPeerPayloadState(peerId);
+        });
         connection.onDisconnect(() => {
             if (this.connectionsByPeer.get(peerId) === connection) {
                 this.connectionsByPeer.delete(peerId);
             }
             if (connectionId) {
                 this.connectionIds.delete(connectionId);
-                this.requestedWebRtcUpgradeConnectionIds.delete(connectionId);
             }
             const disconnected = this.upsertPeer(peerId, { connected: false });
             this.updatePeerStats(peerId, {
@@ -653,29 +648,28 @@ export class OpenRtcNetcodeClient {
                 return;
             }
             for (const peer of this.peersById.values()) {
-                const payloadReady = this.isPeerPayloadReady(peer.id);
-                if (!payloadReady) {
-                    const connection = this.connectionsByPeer.get(peer.id);
-                    if (connection) {
-                        this.requestPreferredTransportUpgrade(connection);
-                    }
-                }
-                if (payloadReady && !peer.connected) {
-                    const connected = this.upsertPeer(peer.id, { connected: true });
-                    this.emitter.emit('peer:connected', clonePeer(connected));
-                    void this.voiceController.handlePeerConnected(peer.id);
-                    this.queuePeerIntro(peer.id, true);
-                }
+                const payloadReady = this.refreshPeerPayloadState(peer.id);
                 if (payloadReady) {
                     void this.sendEnvelope(peer.id, 'ping', {});
                 }
-                this.updatePeerStats(peer.id, {
-                    connected: payloadReady,
-                    transport: this.resolvePeerTransport(peer.id),
-                });
             }
         }, PING_INTERVAL_MS);
     }
+    refreshPeerPayloadState(peerId) {
+        const payloadReady = this.isPeerPayloadReady(peerId);
+        const peer = this.peersById.get(peerId);
+        if (payloadReady && peer && !peer.connected) {
+            const connected = this.upsertPeer(peerId, { connected: true });
+            this.emitter.emit('peer:connected', clonePeer(connected));
+            void this.voiceController.handlePeerConnected(peerId);
+            this.queuePeerIntro(peerId, true);
+        }
+        this.updatePeerStats(peerId, {
+            connected: payloadReady,
+            transport: this.resolvePeerTransport(peerId),
+        });
+        return payloadReady;
+    }
     stopPeerPingLoop() {
         if (this.peerPingTimer) {
             clearInterval(this.peerPingTimer);
@@ -974,28 +968,11 @@ export class OpenRtcNetcodeClient {
         }
         return this.connectionsByPeer.get(peerId) ?? null;
     }
-    requestPreferredTransportUpgrade(connection) {
-        const preferredTransports = this.payloadReadinessOptions().preferredTransports ?? [];
-        const wantsWebRtc = preferredTransports.some((transport) => transport === 'webrtc' || transport === 'webrtc-lan');
-        if (!wantsWebRtc || typeof connection.requestWebRTCUpgrade !== 'function') {
-            return;
-        }
-        const remotePeerId = connection.remoteNodeId ?? connection.deviceId;
-        if (this.localPeerId && remotePeerId && this.localPeerId.localeCompare(remotePeerId) <= 0) {
-            return;
-        }
-        const upgradeKey = connection.id ?? connection.remoteNodeId ?? connection.deviceId;
-        if (upgradeKey && this.requestedWebRtcUpgradeConnectionIds.has(upgradeKey)) {
-            return;
-        }
-        if (upgradeKey) {
-            this.requestedWebRtcUpgradeConnectionIds.add(upgradeKey);
-        }
-        connection.requestWebRTCUpgrade('openrtc-netcode-preferred-payload');
-    }
     payloadReadinessOptions() {
         const preferredTransports = this.options.preferredPayloadTransports
-            ?? derivePreferredPayloadTransports(this.options.transports, this.options.transportPriority);
+            ?? (this.ownsRuntime
+                ? derivePreferredPayloadTransports(this.options.transports, this.options.transportPriority)
+                : []);
         if (preferredTransports.length === 0) {
             return {};
         }

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { OpenRTC } from 'openrtc';
-import type { RuntimeClient } from 'openrtc/runtime';
+import type { RuntimeApplicationPayloadReadinessOptions as OpenRtcApplicationPayloadReadinessOptions, RuntimeClient } from 'openrtc/runtime';
 import type { MetadataBody, NetcodeEnvelope, ObjectRemoveBody, ObjectSnapshotBody, ObjectUpsertBody, StatePatchBody, StateSnapshotBody, UserMessageBody, VoiceSignalBody } from './protocol.js';
 type OpenrtcClientOptions = Parameters<typeof OpenRTC>[0];
 export type NetcodeRuntime = RuntimeClient;
@@ -235,16 +235,14 @@ export type RuntimeConnectionLike = {
         parallelTransport?: string | null;
     };
     getAvailableTransports?(): string[];
+    onUpgradeStateChange?(callback: (state: 'none' | 'upgrading' | 'upgraded' | 'failed') => void): void;
     requestWebRTCUpgrade?(reason?: string): void;
     send(message: unknown): Promise<void> | void;
     onMessage(callback: (message: unknown) => void): void | (() => void);
     onDisconnect(callback: () => void): void | (() => void);
     disconnect?(): Promise<void> | void;
 };
-export type RuntimeApplicationPayloadReadinessOptions = {
-    preferredTransports?: string[];
-    allowFallbackAfterPreferredTransportFailure?: boolean;
-};
+export type RuntimeApplicationPayloadReadinessOptions = OpenRtcApplicationPayloadReadinessOptions;
 export type RuntimeMemberLike = {
     nodeId?: string;
     userId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openrtc-netcode",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "private": false,
   "type": "module",
   "sideEffects": false,
@@ -42,7 +42,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "openrtc": "^0.2.0"
+    "openrtc": "^1.0.0"
   },
   "devDependencies": {
     "@types/node": "^24.10.1",