@ajna-inc/webrtc 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-present Hyperledger Contributors.
+   Copyright 2021 Queen’s Printer for Ontario. Mostafa Youssef (https://github.com/MosCD3), Amit Padmani (https://github.com/nbAmit), Prasad Katkar (https://github.com/NB-PrasadKatkar), Mike Richardson (https://github.com/NB-MikeRichardson)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,38 +1,95 @@
-# @credo-ts/webrtc
+# @ajna-inc/webrtc
 
-DIDComm v2 signaling protocol for WebRTC P2P calls.
+DIDComm v2 signaling protocol for WebRTC P2P calls with full NAT/firewall traversal support.
 
 - PIURI: `https://didcomm.org/webrtc/1.0`
-- Messages: `propose`, `offer`, `answer`, `ice`, `end`
+- Messages: `propose`, `offer`, `answer`, `ice`, `renegotiate`, `end`
 - Advertises support via Discover Features; works with mediators and message pickup.
 
+## Features
+
+- **Module-level ICE server defaults** - Configure STUN/TURN servers once
+- **ICE policy control** - `all`, `relay-preferred`, or `relay-only` for strict firewall environments
+- **ICE restart support** - Recover from failed connections
+- **Trickle ICE** - Efficient candidate exchange
+- **Propose message** - Share ICE servers before SDP exchange
+
 ## Install
 
 This package is part of the monorepo. Add the module to your Agent options:
 
 ```ts
-import { WebRTCModule } from '@credo-ts/webrtc'
+import { WebRTCModule } from '@ajna-inc/webrtc'
 
 const agent = new Agent({
   config: { /* ... */ },
   dependencies: agentDependencies,
   modules: {
-    webrtc: new WebRTCModule(),
+    webrtc: new WebRTCModule({
+      // Configure default ICE servers (optional - has sensible defaults)
+      iceServers: [
+        { urls: 'stun:stun.l.google.com:19302' },
+        { urls: 'turn:turn.example.org:3478', username: 'user', credential: 'pass' },
+      ],
+      // Default ICE policy: 'all' | 'relay-preferred' | 'relay-only'
+      defaultPolicy: 'relay-preferred',
+      // Enable trickle ICE by default
+      defaultTrickle: true,
+    }),
+  },
+})
+```
+
+## NAT/Firewall Traversal
+
+For peers behind restrictive NAT or firewalls, use TURN servers:
+
+```ts
+const agent = new Agent({
+  modules: {
+    webrtc: new WebRTCModule({
+      iceServers: [
+        // STUN for simple NAT
+        { urls: 'stun:stun.l.google.com:19302' },
+        // TURN for symmetric NAT and firewalls
+        { urls: 'turn:turn.yourserver.com:3478', username: 'user', credential: 'pass' },
+        // TURNS (TLS) for stricter firewalls
+        { urls: 'turns:turn.yourserver.com:5349', username: 'user', credential: 'pass' },
+      ],
+      // Force relay-only for maximum compatibility (hides IP addresses too)
+      defaultPolicy: 'relay-only',
+    }),
   },
 })
 ```
 
 ## Frontend usage (browser)
 
-Below is a minimal setup for P2P WebRTC using Credo TS for signaling.
+Below is a setup for P2P WebRTC using Credo TS for signaling.
 
 ```ts
+// Get configured ICE servers from module
+const iceServers = agent.modules.webrtc.getDefaultIceServers()
+
 // Subscribe to inbound signaling
+agent.events.on('WebRTCEvents.IncomingPropose', async ({ payload }) => {
+  const { thid, iceServers, policy, media } = payload
+  // Caller is proposing a call - you can accept by sending an offer
+  // The iceServers from propose can be used to configure RTCPeerConnection
+  console.log('Incoming call proposal:', { media, iceServers })
+})
+
 agent.events.on('WebRTCEvents.IncomingOffer', async ({ payload }) => {
-  const { thid, sdp, context } = payload
-  const pc = ensurePeer(thid)
-  await pc.setRemoteDescription({ type: 'offer', sdp })
+  const { thid, sdp, iceServers, policy, context } = payload
 
+  // Use ICE servers from offer (or fall back to module defaults)
+  const pc = new RTCPeerConnection({
+    iceServers: iceServers ?? agent.modules.webrtc.getDefaultIceServers(),
+    iceTransportPolicy: policy === 'relay-only' ? 'relay' : 'all',
+  })
+  peers.set(thid, pc)
+
+  await pc.setRemoteDescription({ type: 'offer', sdp })
   const answer = await pc.createAnswer()
   await pc.setLocalDescription(answer)
 
@@ -44,8 +101,11 @@ agent.events.on('WebRTCEvents.IncomingOffer', async ({ payload }) => {
 })
 
 agent.events.on('WebRTCEvents.IncomingAnswer', async ({ payload }) => {
-  const { thid, sdp } = payload
-  const pc = ensurePeer(thid)
+  const { thid, sdp, iceServers } = payload
+  const pc = peers.get(thid)
+  if (!pc) return
+
+  // If callee provided additional ICE servers, you might want to restart ICE
   await pc.setRemoteDescription({ type: 'answer', sdp })
 })
 
@@ -57,16 +117,41 @@ agent.events.on('WebRTCEvents.IncomingIce', async ({ payload }) => {
   else await pc.addIceCandidate(candidate as RTCIceCandidateInit)
 })
 
+// Handle renegotiation requests (e.g., ICE restart)
+agent.events.on('WebRTCEvents.RenegotiateRequested', async ({ payload }) => {
+  const { thid, iceRestart, iceServers, reason } = payload
+  const pc = peers.get(thid)
+  if (!pc) return
+
+  if (iceRestart) {
+    // Perform ICE restart
+    const offer = await pc.createOffer({ iceRestart: true })
+    await pc.setLocalDescription(offer)
+    // Send new offer...
+  }
+})
+
 // Start call (caller)
 async function startCall(connectionId: string, localStream: MediaStream) {
   const thid = crypto.randomUUID()
-  const pc = new RTCPeerConnection({
-    iceServers: [{ urls: 'stun:stun.l.google.com:19302' }],
-  })
+
+  // Use module's default ICE servers
+  const iceServers = agent.modules.webrtc.getDefaultIceServers()
+
+  const pc = new RTCPeerConnection({ iceServers })
   peers.set(thid, pc)
 
+  // Handle ICE connection failures
+  pc.oniceconnectionstatechange = () => {
+    if (pc.iceConnectionState === 'failed') {
+      // Request ICE restart
+      agent.modules.webrtc.restartIce({ connectionId, threadId: thid })
+    }
+  }
+
   // Render remote stream
   pc.ontrack = e => (remoteVideo.srcObject = e.streams[0])
+
   // Send ICE via DIDComm
   pc.onicecandidate = e => agent.modules.webrtc.sendIce({
     connectionId,
@@ -74,23 +159,64 @@ async function startCall(connectionId: string, localStream: MediaStream) {
     candidate: e.candidate ?? undefined,
     endOfCandidates: e.candidate == null,
   })
+
   // Add local tracks
   for (const track of localStream.getTracks()) pc.addTrack(track, localStream)
 
   const offer = await pc.createOffer({ offerToReceiveVideo: true, offerToReceiveAudio: true })
   await pc.setLocalDescription(offer)
 
+  // Start call - ICE servers are automatically included from module config
   await agent.modules.webrtc.startCall({
     connectionId,
     threadId: thid,
     sdp: offer.sdp!,
-    iceServers: [{ urls: 'stun:stun.l.google.com:19302' }],
+    // Optionally override policy for this specific call
+    policy: 'relay-preferred',
+  })
+}
+
+// Request ICE restart when connection fails
+async function handleConnectionFailure(connectionId: string, thid: string) {
+  await agent.modules.webrtc.restartIce({
+    connectionId,
+    threadId: thid,
+    // Optionally provide new ICE servers
+    iceServers: [{ urls: 'turn:backup-turn.example.org:3478', username: 'u', credential: 'p' }],
   })
 }
 ```
 
-Notes:
+## API Reference
+
+### WebRTCApi Methods
+
+| Method | Description |
+|--------|-------------|
+| `proposeCall()` | Send a call proposal with ICE servers before offer |
+| `startCall()` | Send SDP offer with ICE servers |
+| `acceptCall()` | Send SDP answer |
+| `sendIce()` | Send ICE candidate |
+| `renegotiate()` | Request renegotiation (track changes, codec changes) |
+| `restartIce()` | Request ICE restart (connection recovery) |
+| `endCall()` | End the call |
+| `getDefaultIceServers()` | Get configured default ICE servers |
+
+### Events
+
+| Event | Description |
+|-------|-------------|
+| `IncomingPropose` | Call proposal received (includes ICE servers) |
+| `IncomingOffer` | SDP offer received |
+| `IncomingAnswer` | SDP answer received |
+| `IncomingIce` | ICE candidate received |
+| `RenegotiateRequested` | Renegotiation requested (e.g., ICE restart) |
+| `CallEnded` | Call ended |
+
+## Notes
+
 - This module moves only signaling over DIDComm; media flows via WebRTC/DTLS-SRTP.
-- For NAT traversal, pass TURN servers in `iceServers` in `offer` if needed.
+- For NAT traversal, configure TURN servers in the module config or per-call.
+- Use `relay-only` policy for maximum firewall compatibility (also hides IP addresses).
 - Works with mediators and message pickup (offline delivery), as with any DIDComm message.
 

package/build/index.d.ts

@@ -1,4 +1,8 @@
-export { WebRTCModule } from './webrtc/WebRTCModule';
+export { WebRTCModule, WebRTCModuleConfigToken } from './webrtc/WebRTCModule';
+export type { WebRTCModuleConfig, WebRTCIceServerConfig } from './webrtc/WebRTCModule';
 export { WebRTCApi } from './webrtc/WebRTCApi';
-export { WebRTCEvents, type IncomingOfferEvent, type IncomingIceEvent } from './webrtc/WebRTCEvents';
+export { WebRTCEvents, type IceServerEventConfig, type IncomingProposeEvent, type IncomingOfferEvent, type IncomingAnswerEvent, type IncomingIceEvent, type RenegotiateRequestedEvent, type CallEndedEvent, } from './webrtc/WebRTCEvents';
 export * from './webrtc/messages';
+export type { IcePolicy, IceServerConfig } from './webrtc/messages/OfferMessage';
+export type { MediaType } from './webrtc/messages/ProposeMessage';
+export type { RenegotiateReason } from './webrtc/messages/RenegotiateMessage';

package/build/index.js

@@ -14,12 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebRTCEvents = exports.WebRTCApi = exports.WebRTCModule = void 0;
+exports.WebRTCEvents = exports.WebRTCApi = exports.WebRTCModuleConfigToken = exports.WebRTCModule = void 0;
+// Module and API
 var WebRTCModule_1 = require("./webrtc/WebRTCModule");
 Object.defineProperty(exports, "WebRTCModule", { enumerable: true, get: function () { return WebRTCModule_1.WebRTCModule; } });
+Object.defineProperty(exports, "WebRTCModuleConfigToken", { enumerable: true, get: function () { return WebRTCModule_1.WebRTCModuleConfigToken; } });
 var WebRTCApi_1 = require("./webrtc/WebRTCApi");
 Object.defineProperty(exports, "WebRTCApi", { enumerable: true, get: function () { return WebRTCApi_1.WebRTCApi; } });
+// Events
 var WebRTCEvents_1 = require("./webrtc/WebRTCEvents");
 Object.defineProperty(exports, "WebRTCEvents", { enumerable: true, get: function () { return WebRTCEvents_1.WebRTCEvents; } });
+// Messages
 __exportStar(require("./webrtc/messages"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,sDAAoD;AAA3C,4GAAA,YAAY,OAAA;AACrB,gDAA8C;AAArC,sGAAA,SAAS,OAAA;AAClB,sDAAoG;AAA3F,4GAAA,YAAY,OAAA;AACrB,oDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iBAAiB;AACjB,sDAA6E;AAApE,4GAAA,YAAY,OAAA;AAAE,uHAAA,uBAAuB,OAAA;AAE9C,gDAA8C;AAArC,sGAAA,SAAS,OAAA;AAElB,SAAS;AACT,sDAS8B;AAR5B,4GAAA,YAAY,OAAA;AAUd,WAAW;AACX,oDAAiC"}

package/build/webrtc/WebRTCApi.d.ts

@@ -1,36 +1,125 @@
 import { ConnectionService, MessageSender, AgentContext } from '@credo-ts/core';
 import { WebRTCService } from './services/WebRTCService';
+import type { IcePolicy, IceServerConfig } from './messages/OfferMessage';
+import type { MediaType } from './messages/ProposeMessage';
+import type { RenegotiateReason } from './messages/RenegotiateMessage';
+import { type WebRTCModuleConfig } from './WebRTCModule';
 export declare class WebRTCApi {
     private connectionService;
     private messageSender;
     private webrtcService;
     private agentContext;
+    private config;
     constructor(connectionService: ConnectionService, messageSender: MessageSender, webrtcService: WebRTCService, agentContext: AgentContext);
     onAgentReady: boolean;
+    /**
+     * Get the configured default ICE servers
+     */
+    getDefaultIceServers(): WebRTCModuleConfig['iceServers'];
+    /**
+     * Propose a call to a peer (before sending offer)
+     * This allows sharing ICE servers and negotiating capabilities before the SDP exchange
+     */
+    proposeCall(options: {
+        connectionId: string;
+        threadId?: string;
+        parentThreadId?: string;
+        /** Requested media types */
+        media?: MediaType[];
+        /** Whether data channel is requested */
+        data?: boolean;
+        /** Topology: 'mesh' (P2P) or 'sfu' */
+        topology?: 'mesh' | 'sfu';
+        /** Whether trickle ICE is supported (defaults to module config) */
+        trickle?: boolean;
+        /** ICE policy (defaults to module config) */
+        policy?: IcePolicy;
+        /** ICE servers - uses module defaults if not provided */
+        iceServers?: IceServerConfig[];
+        /** Optional reason/context */
+        reason?: string;
+    }): Promise<{
+        threadId: string;
+    }>;
+    /**
+     * Start a call by sending an SDP offer
+     */
     startCall(options: {
         connectionId: string;
         threadId: string;
+        parentThreadId?: string;
         sdp: string;
-        iceServers?: {
-            urls: string;
-            username?: string;
-            credential?: string;
-        }[];
+        /** ICE servers - uses module defaults if not provided */
+        iceServers?: IceServerConfig[];
+        /** ICE policy (defaults to module config) */
+        policy?: IcePolicy;
+        /** Whether trickle ICE is enabled (defaults to module config) */
+        trickle?: boolean;
     }): Promise<import("./repository/WebRTCCallRecord").WebRTCCallRecord>;
+    /**
+     * Accept a call by sending an SDP answer
+     */
     acceptCall(options: {
         connectionId: string;
         threadId: string;
+        parentThreadId?: string;
         sdp: string;
+        /** Optional ICE servers from callee (if different from caller's) */
+        iceServers?: IceServerConfig[];
     }): Promise<void>;
+    /**
+     * Send an ICE candidate
+     */
     sendIce(options: {
         connectionId: string;
         threadId: string;
+        parentThreadId?: string;
         candidate?: Record<string, unknown>;
         endOfCandidates?: boolean;
     }): Promise<void>;
+    /**
+     * Request renegotiation (for ICE restart, adding/removing tracks, etc.)
+     *
+     * Use this when:
+     * - ICE connection failed and needs restart
+     * - Adding screenshare or switching cameras
+     * - Network changed (WiFi to cellular)
+     * - Changing codec or bandwidth settings
+     */
+    renegotiate(options: {
+        connectionId: string;
+        threadId: string;
+        parentThreadId?: string;
+        /** Reason for renegotiation */
+        reason: RenegotiateReason | string;
+        /** Whether to perform ICE restart (required for recovering failed connections) */
+        iceRestart?: boolean;
+        /** New ICE servers (useful when switching networks) */
+        iceServers?: IceServerConfig[];
+        /** Updated ICE policy */
+        policy?: IcePolicy;
+    }): Promise<void>;
+    /**
+     * Request ICE restart (convenience method for renegotiate with iceRestart=true)
+     *
+     * Use when the WebRTC connection has failed or disconnected
+     */
+    restartIce(options: {
+        connectionId: string;
+        threadId: string;
+        parentThreadId?: string;
+        /** New ICE servers (optional, useful when original servers are unreachable) */
+        iceServers?: IceServerConfig[];
+        /** Updated ICE policy */
+        policy?: IcePolicy;
+    }): Promise<void>;
+    /**
+     * End a call
+     */
     endCall(options: {
         connectionId: string;
         threadId: string;
+        parentThreadId?: string;
         reason?: string;
     }): Promise<void>;
 }