@desklink/react-native 0.5.2 → 0.5.4

package/src/native.ios.ts

@@ -95,8 +95,13 @@ export function preferH264(sdp: string): string {
     return lines.join('\r\n');
 }
 
-function failure(id: string, error: unknown) {
-    emit(id, 'failure', { code: 'transport', message: error instanceof Error ? error.message : String(error) });
+/**
+ * One native failure, with its `reason` so the hook can tell an ICE failure
+ * (the peer's path died, which the session can be held across) from an SDP or
+ * candidate failure (the negotiation itself is broken, which stays terminal).
+ */
+function failure(id: string, error: unknown, reason: 'ice' | 'sdp' | 'candidate' | 'control') {
+    emit(id, 'failure', { code: 'transport', reason, message: error instanceof Error ? error.message : String(error) });
 }
 
 export const nativeDesklink: NativeDesklinkModule = {
@@ -121,7 +126,7 @@ export const nativeDesklink: NativeDesklinkModule = {
             };
             peer.oniceconnectionstatechange = () => {
                 emit(id, 'ice', { state: peer.iceConnectionState.toUpperCase() });
-                if (peer.iceConnectionState === 'failed') failure(id, 'the connection to the desktop was lost');
+                if (peer.iceConnectionState === 'failed') failure(id, 'the connection to the desktop was lost', 'ice');
             };
             peer.ontrack = (event) => {
                 if (session.closed || event.track.kind !== 'video') return;
@@ -148,7 +153,7 @@ export const nativeDesklink: NativeDesklinkModule = {
     setRemoteDescription(id, type, sdp) {
         const session = sessions.get(id);
         if (!session) return false;
-        if (type !== 'offer') { failure(id, 'the engine must send an offer'); return false; }
+        if (type !== 'offer') { failure(id, 'the engine must send an offer', 'sdp'); return false; }
         void (async () => {
             try {
                 await session.peer.setRemoteDescription({ type: 'offer', sdp: preferH264(sdp.replace(PLAYOUT_DELAY, '')) });
@@ -158,7 +163,7 @@ export const nativeDesklink: NativeDesklinkModule = {
                 const answer = await session.peer.createAnswer();
                 await session.peer.setLocalDescription(answer);
                 if (!session.closed) emit(id, 'answer', { sdp: session.peer.localDescription?.sdp ?? answer.sdp });
-            } catch (error) { if (!session.closed) failure(id, error); }
+            } catch (error) { if (!session.closed) failure(id, error, 'sdp'); }
         })();
         return true;
     },
@@ -167,7 +172,7 @@ export const nativeDesklink: NativeDesklinkModule = {
         if (!session) return false;
         const ice = { candidate, sdpMid, sdpMLineIndex: sdpMLineIndex ?? 0 };
         if (!session.remoteSet) session.candidates.push(ice);
-        else void session.peer.addIceCandidate(ice).catch((error) => failure(id, error));
+        else void session.peer.addIceCandidate(ice).catch((error) => failure(id, error, 'candidate'));
         return true;
     },
     sendControl(id, message) {
@@ -178,7 +183,7 @@ export const nativeDesklink: NativeDesklinkModule = {
             if (!session.input && ['pointer', 'wheel', 'key', 'text', 'clipboard_read', 'clipboard_write'].includes(String(control.kind))) return false;
             session.channel.send(JSON.stringify({ ...control, seq: ++session.seq }));
             return true;
-        } catch (error) { failure(id, error); return false; }
+        } catch (error) { failure(id, error, 'control'); return false; }
     },
     setInputEnabled(id, enabled) {
         const session = sessions.get(id);

package/src/native.web.ts

@@ -127,6 +127,8 @@ interface WebSession {
     chordsDown: Set<string>;
     /** Re-measure what the keyboard covers; null until a surface is attached. */
     followKeyboard: (() => void) | null;
+    /** Whether the first frame was already reported; renegotiation must not re-mark a stale picture. */
+    presented: boolean;
     /** Candidates that arrived before the offer; applied once it is set. */
     remoteDescriptionSet: boolean;
     pendingCandidates: RTCIceCandidateInit[];
@@ -960,6 +962,7 @@ export const nativeDesklink: NativeDesklinkModule = {
             compositionSent: '',
             composing: false,
             chordsDown: new Set<string>(),
+            presented: false,
             remoteDescriptionSet: false,
             pendingCandidates: [],
             detach: null,
@@ -982,6 +985,12 @@ export const nativeDesklink: NativeDesklinkModule = {
             // track and produce nothing.
             const presented = (): void => {
                 if (sessions.get(id) !== session) return;
+                // Readiness is the first frame. Renegotiation re-fires ontrack
+                // and the compositor repaints the frame it already holds, and a
+                // repaint is not a new frame: a second mark would read a stale
+                // picture as live and reset the recovery budget mid-outage.
+                if (session.presented) return;
+                session.presented = true;
                 video.style.opacity = '1';
                 emit(id, 'presented', {});
             };
@@ -1009,7 +1018,7 @@ export const nativeDesklink: NativeDesklinkModule = {
         peer.onconnectionstatechange = () => {
             if (sessions.get(id) !== session) return;
             if (peer.connectionState === 'failed') {
-                emit(id, 'failure', { code: 'transport', message: 'the connection to the desktop was lost' });
+                emit(id, 'failure', { code: 'transport', reason: 'ice', message: 'the connection to the desktop was lost' });
             }
         };
         peer.oniceconnectionstatechange = () => {
@@ -1026,7 +1035,7 @@ export const nativeDesklink: NativeDesklinkModule = {
         const session = sessions.get(id);
         if (session === undefined) return false;
         if (type !== 'offer') {
-            emit(id, 'failure', { code: 'transport', message: 'the engine must send an offer' });
+            emit(id, 'failure', { code: 'transport', reason: 'sdp', message: 'the engine must send an offer' });
             return false;
         }
         void (async () => {
@@ -1043,6 +1052,7 @@ export const nativeDesklink: NativeDesklinkModule = {
             } catch (error) {
                 emit(id, 'failure', {
                     code: 'transport',
+                    reason: 'sdp',
                     message: error instanceof Error ? error.message : 'the desktop refused our answer',
                 });
             }

package/src/protocol.ts

@@ -103,6 +103,8 @@ export interface CursorSample {
  * the new session corrupts or kills a healthy recovery.
  */
 export type SessionEvent =
+    /** Optional carrier notification, distinct from the native peer's `closed`. */
+    | { kind: 'carrier-closed'; sessionId?: never }
     | { kind: 'description'; description: RtcDescription; sessionId?: string }
     | { kind: 'candidate'; candidate: RtcCandidate; sessionId?: string }
     | ({ kind: 'cursor' } & CursorSample)
@@ -120,15 +122,21 @@ export type SessionEvent =
  * The package calls these and nothing else, so an application can carry them
  * over its existing encrypted request path, a socket, or an in-process bridge.
  * `subscribe` delivers engine notifications until the returned function runs.
+ * The application's authorize() resolves only once this carrier is open. Its
+ * rejection rules (transport vs. refusal) are in the README's Signaling section.
  */
 export interface Signaling {
     /**
-     * Send one request. A rejection may carry a stable `code` — the engine's or
+     * Send one request. Reject pending and future requests with `code: 'transport'`
+     * once the carrier is gone; never queue requests on a dead carrier.
+     * A rejection may carry a stable `code` — the engine's or
      * the host's own token — which the package reads to classify a refusal, so a
      * refusal is not retried as though it were a network failure.
      */
     request<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>;
     subscribe(handler: (event: SessionEvent) => void): () => void;
+    /** Optional: end this carrier now. Called once the package has declared it dead. */
+    close?(): void;
 }
 
 export type SessionStatus =
@@ -173,7 +181,7 @@ export interface SessionSnapshot {
 }
 
 /**
- * Control-channel messages. `seq` is monotonic per generation; the engine
+ * Control-channel messages. `seq` is monotonic per session; the engine
  * refuses a repeat, so a replayed gesture cannot move the pointer twice.
  */
 export type ControlMessage =