@vonage/client-sdk 2.3.1-alpha.1 → 2.4.0-alpha.0

package/dist/client/index.cjs

@@ -34506,6 +34506,13 @@ function requireClientsdkClientcore () {
 		  function onConversationEvent(event) {
 		  }
 		  initMetadataForInterface(ConversationEventListener, 'ConversationEventListener');
+		  function onRTCHangup(conversationId, legId, hangup) {
+		  }
+		  function onRTCTransfer(conversationId, legId) {
+		  }
+		  function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
+		  }
+		  initMetadataForInterface(RTCEventListener, 'RTCEventListener');
 		  function onAudioSay() {
 		  }
 		  function onAudioMuteUpdate(conversationId, legId, isMuted) {
@@ -34515,14 +34522,7 @@ function requireClientsdkClientcore () {
 		  function onAudioDTMFUpdate(conversationId, legId, digits) {
 		  }
 		  initMetadataForInterface(AudioEventListener, 'AudioEventListener');
-		  function onRTCHangup(conversationId, legId, hangup) {
-		  }
-		  function onRTCTransfer(conversationId, legId) {
-		  }
-		  function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
-		  }
-		  initMetadataForInterface(RTCEventListener, 'RTCEventListener');
-		  initMetadataForClass(ChatAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, AudioEventListener, RTCEventListener]);
+		  initMetadataForClass(ChatAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
 		  initMetadataForClass(ChatAPIImpl, 'ChatAPIImpl', VOID, VOID, [ChatAPI]);
 		  initMetadataForClass(LoggingLevel, 'LoggingLevel', VOID, Enum);
 		  initMetadataForObject(DefaultConfig, 'DefaultConfig');
@@ -34678,7 +34678,7 @@ function requireClientsdkClientcore () {
 		  initMetadataForClass(HangupReason, 'HangupReason', VOID, Enum);
 		  initMetadataForClass(LegStatus, 'LegStatus', VOID, Enum);
 		  initMetadataForClass(CallDisconnectReason, 'CallDisconnectReason', VOID, Enum);
-		  initMetadataForClass(VoiceAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, AudioEventListener, RTCEventListener]);
+		  initMetadataForClass(VoiceAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
 		  initMetadataForClass(VoiceAPIImpl, 'VoiceAPIImpl');
 		  initMetadataForInterface(CallEvent, 'CallEvent');
 		  initMetadataForClass(SetupOutboundCall, 'SetupOutboundCall', VOID, VOID, [CallEvent]);
@@ -34897,7 +34897,7 @@ function requireClientsdkClientcore () {
 		  initMetadataForClass(runAfterDelay$1);
 		  //endregion
 		  function BuildKonfig() {
-		    this.t1e_1 = '2.3.1-alpha.1';
+		    this.t1e_1 = '2.4.0-alpha.0';
 		  }
 		  var BuildKonfig_instance;
 		  function BuildKonfig_getInstance() {
@@ -89557,15 +89557,23 @@ class HttpClient {
     }
 }
 
+const ICE_GATHERING_TIMEOUT_MS = 10000;
 const waitFirstICEGatheringComplete = (peerConnection) => __awaiter(void 0, void 0, void 0, function* () {
     let offer_sent = false;
-    return new Promise((resolve) => {
-        peerConnection.onicecandidate = (event) => {
+    return new Promise((resolve, reject) => {
+        const handler = (event) => {
             if (event.candidate && !offer_sent) {
                 offer_sent = true;
+                clearTimeout(timeoutId);
+                peerConnection.removeEventListener('icecandidate', handler);
                 resolve();
             }
         };
+        peerConnection.addEventListener('icecandidate', handler);
+        const timeoutId = setTimeout(() => {
+            peerConnection.removeEventListener('icecandidate', handler);
+            reject(new Error(`ICE gathering timed out after ${ICE_GATHERING_TIMEOUT_MS}ms`));
+        }, ICE_GATHERING_TIMEOUT_MS);
     });
 });
 function createDummyCandidateSDP(pc) {
@@ -89820,8 +89828,25 @@ const TrackType = {
 class MediaClient {
     constructor() {
         this.pcs = new Map();
+        this.pcListeners = new WeakMap();
         this.audio = undefined;
     }
+    setPeerConnectionCreatedCallback(callback) {
+        this.peerConnectionCreatedCallback = callback;
+    }
+    addPCListener(pc, type, listener) {
+        var _a;
+        pc.addEventListener(type, listener);
+        const list = (_a = this.pcListeners.get(pc)) !== null && _a !== void 0 ? _a : [];
+        list.push({ type, listener });
+        this.pcListeners.set(pc, list);
+    }
+    removeAllPCListeners(pc) {
+        var _a;
+        (_a = this.pcListeners
+            .get(pc)) === null || _a === void 0 ? void 0 : _a.forEach(({ type, listener }) => pc.removeEventListener(type, listener));
+        this.pcListeners.delete(pc);
+    }
     enableRtcStatsCollection(id, interval, closure) {
         const pc = this.pcs.get(id);
         if (!pc) {
@@ -89846,11 +89871,11 @@ class MediaClient {
     enableMediaInbound(rtcId, offerSDP, closure) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const pc = yield this.getNewPC();
-                pc.onconnectionstatechange = () => {
+                const pc = yield this.getNewPC(rtcId);
+                this.addPCListener(pc, 'connectionstatechange', (() => {
                     var _a;
                     (_a = this.delegate) === null || _a === void 0 ? void 0 : _a.onConnectionChange(rtcId, pc.connectionState);
-                };
+                }));
                 this.pcs.set(rtcId, pc);
                 const sdp = yield createAnswer(pc, offerSDP);
                 closure(null, sdp);
@@ -89863,8 +89888,9 @@ class MediaClient {
     }
     enableMediaOutbound(closure) {
         return __awaiter(this, void 0, void 0, function* () {
+            let pc;
             try {
-                const pc = yield this.getNewPC();
+                pc = yield this.getNewPC(null);
                 const sdp = yield createOffer(pc);
                 closure(null, sdp, (legId) => {
                     if (!legId) {
@@ -89873,13 +89899,15 @@ class MediaClient {
                         return;
                     }
                     this.pcs.set(legId, pc);
-                    pc.onconnectionstatechange = () => {
+                    this.addPCListener(pc, 'connectionstatechange', (() => {
                         var _a;
                         (_a = this.delegate) === null || _a === void 0 ? void 0 : _a.onConnectionChange(legId, pc.connectionState);
-                    };
+                    }));
                 });
             }
             catch (err) {
+                if (pc)
+                    this.closePeerConnection(pc);
                 const message = err instanceof Error ? err.message : null;
                 closure(new clientsdkClientcore_jsExports.vonage.CreateOfferErrorJS(message), null, () => {
                     throw new Error('Callback not implemented, and should never get called');
@@ -89887,10 +89915,11 @@ class MediaClient {
             }
         });
     }
-    getNewPC() {
+    getNewPC(callId) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const pc = yield createRtcAudioConnection();
-            pc.ontrack = (evt) => {
+            this.addPCListener(pc, 'track', ((evt) => {
                 const stream = evt.streams[0];
                 if (stream) {
                     const audio = new Audio();
@@ -89898,7 +89927,8 @@ class MediaClient {
                     audio.autoplay = true;
                     this.audio = audio;
                 }
-            };
+            }));
+            (_a = this.peerConnectionCreatedCallback) === null || _a === void 0 ? void 0 : _a.call(this, callId, pc);
             return pc;
         });
     }
@@ -89986,6 +90016,7 @@ class MediaClient {
     // Private Methods
     closePeerConnection(pc) {
         var _a;
+        this.removeAllPCListeners(pc);
         pc.close();
         pc.getSenders().forEach((sender) => {
             var _a;
@@ -90436,7 +90467,8 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
         super.emitter = value;
     }
     constructor(config = new ClientInitConfig()) {
-        super(convertInitConfig(config), new HttpClient(), new SocketClient(), new MediaClient());
+        const mediaClient = new MediaClient();
+        super(convertInitConfig(config), new HttpClient(), new SocketClient(), mediaClient);
         /**
          * Proxy object to allow for registering callbacks via `on()`
          * @internal
@@ -90466,13 +90498,17 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
                 };
             }
         });
+        mediaClient.setPeerConnectionCreatedCallback((callId, pc) => {
+            var _a, _b;
+            (_b = (_a = this.emitter) === null || _a === void 0 ? void 0 : _a.peerConnectionCreated) === null || _b === void 0 ? void 0 : _b.call(_a, callId, pc);
+        });
         this.setConfig(config);
     }
     /**
      * Set a configuration for the client SDK
      *
      * @example
-     * [[include: snippet_SetClientConfig.txt]]
+     * [[include: snippet_Config.txt]]
      *
      * @param config - A configuration object
      * @returns void
@@ -90548,17 +90584,24 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
         callbacks.clear();
     }
     /**
-     * Create a session with a token and optional sessionId
-     * If no sessionId is provided, a new one will be generated
-     * and returned. If a sessionId is provided, it will be used
-     * to resume an existing session.
+     * Create (or reconnect to) a session.
+     *
+     * When `sessionId` is omitted or `null`, a completely new session is created.
+     *
+     * When `sessionId` is set to the value returned by a **previous** `createSession` call, the
+     * Conversation Service will replay any pending events into the new session.  In particular, an
+     * unanswered inbound call invite that arrived before a page refresh will be re-delivered so that
+     * `onCallInvite` fires automatically — no extra API call is needed.
+     *
+     * **Important:** The Conversation Service retains pending events for approximately 30 seconds.
+     * Persist the session ID (e.g. in `sessionStorage`) and pass it back within that window.
      *
      * @example
      * [[include: snippet_SessionCreate.txt]]
      *
-     * @param token
-     * @param sessionId - optional sessionId to use
-     * @returns the `sessionId` of the session
+     * @param token - JWT token of the user.
+     * @param sessionId - Optional previous session ID. Omit or pass `null` for a fresh session.
+     * @returns The `sessionId` of the newly established session.
      */
     createSession(token, sessionId) {
         const _super = Object.create(null, {

package/dist/client/index.mjs

@@ -34482,6 +34482,13 @@ function requireClientsdkClientcore () {
 		  function onConversationEvent(event) {
 		  }
 		  initMetadataForInterface(ConversationEventListener, 'ConversationEventListener');
+		  function onRTCHangup(conversationId, legId, hangup) {
+		  }
+		  function onRTCTransfer(conversationId, legId) {
+		  }
+		  function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
+		  }
+		  initMetadataForInterface(RTCEventListener, 'RTCEventListener');
 		  function onAudioSay() {
 		  }
 		  function onAudioMuteUpdate(conversationId, legId, isMuted) {
@@ -34491,14 +34498,7 @@ function requireClientsdkClientcore () {
 		  function onAudioDTMFUpdate(conversationId, legId, digits) {
 		  }
 		  initMetadataForInterface(AudioEventListener, 'AudioEventListener');
-		  function onRTCHangup(conversationId, legId, hangup) {
-		  }
-		  function onRTCTransfer(conversationId, legId) {
-		  }
-		  function onLegStatusUpdate(conversationId, legId, fromUserId, status) {
-		  }
-		  initMetadataForInterface(RTCEventListener, 'RTCEventListener');
-		  initMetadataForClass(ChatAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, AudioEventListener, RTCEventListener]);
+		  initMetadataForClass(ChatAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
 		  initMetadataForClass(ChatAPIImpl, 'ChatAPIImpl', VOID, VOID, [ChatAPI]);
 		  initMetadataForClass(LoggingLevel, 'LoggingLevel', VOID, Enum);
 		  initMetadataForObject(DefaultConfig, 'DefaultConfig');
@@ -34654,7 +34654,7 @@ function requireClientsdkClientcore () {
 		  initMetadataForClass(HangupReason, 'HangupReason', VOID, Enum);
 		  initMetadataForClass(LegStatus, 'LegStatus', VOID, Enum);
 		  initMetadataForClass(CallDisconnectReason, 'CallDisconnectReason', VOID, Enum);
-		  initMetadataForClass(VoiceAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, AudioEventListener, RTCEventListener]);
+		  initMetadataForClass(VoiceAPIImpl$1, VOID, VOID, VOID, [ConversationEventListener, RTCEventListener, AudioEventListener]);
 		  initMetadataForClass(VoiceAPIImpl, 'VoiceAPIImpl');
 		  initMetadataForInterface(CallEvent, 'CallEvent');
 		  initMetadataForClass(SetupOutboundCall, 'SetupOutboundCall', VOID, VOID, [CallEvent]);
@@ -34873,7 +34873,7 @@ function requireClientsdkClientcore () {
 		  initMetadataForClass(runAfterDelay$1);
 		  //endregion
 		  function BuildKonfig() {
-		    this.t1e_1 = '2.3.1-alpha.1';
+		    this.t1e_1 = '2.4.0-alpha.0';
 		  }
 		  var BuildKonfig_instance;
 		  function BuildKonfig_getInstance() {
@@ -89533,15 +89533,23 @@ class HttpClient {
     }
 }
 
+const ICE_GATHERING_TIMEOUT_MS = 10000;
 const waitFirstICEGatheringComplete = (peerConnection) => __awaiter(void 0, void 0, void 0, function* () {
     let offer_sent = false;
-    return new Promise((resolve) => {
-        peerConnection.onicecandidate = (event) => {
+    return new Promise((resolve, reject) => {
+        const handler = (event) => {
             if (event.candidate && !offer_sent) {
                 offer_sent = true;
+                clearTimeout(timeoutId);
+                peerConnection.removeEventListener('icecandidate', handler);
                 resolve();
             }
         };
+        peerConnection.addEventListener('icecandidate', handler);
+        const timeoutId = setTimeout(() => {
+            peerConnection.removeEventListener('icecandidate', handler);
+            reject(new Error(`ICE gathering timed out after ${ICE_GATHERING_TIMEOUT_MS}ms`));
+        }, ICE_GATHERING_TIMEOUT_MS);
     });
 });
 function createDummyCandidateSDP(pc) {
@@ -89796,8 +89804,25 @@ const TrackType = {
 class MediaClient {
     constructor() {
         this.pcs = new Map();
+        this.pcListeners = new WeakMap();
         this.audio = undefined;
     }
+    setPeerConnectionCreatedCallback(callback) {
+        this.peerConnectionCreatedCallback = callback;
+    }
+    addPCListener(pc, type, listener) {
+        var _a;
+        pc.addEventListener(type, listener);
+        const list = (_a = this.pcListeners.get(pc)) !== null && _a !== void 0 ? _a : [];
+        list.push({ type, listener });
+        this.pcListeners.set(pc, list);
+    }
+    removeAllPCListeners(pc) {
+        var _a;
+        (_a = this.pcListeners
+            .get(pc)) === null || _a === void 0 ? void 0 : _a.forEach(({ type, listener }) => pc.removeEventListener(type, listener));
+        this.pcListeners.delete(pc);
+    }
     enableRtcStatsCollection(id, interval, closure) {
         const pc = this.pcs.get(id);
         if (!pc) {
@@ -89822,11 +89847,11 @@ class MediaClient {
     enableMediaInbound(rtcId, offerSDP, closure) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const pc = yield this.getNewPC();
-                pc.onconnectionstatechange = () => {
+                const pc = yield this.getNewPC(rtcId);
+                this.addPCListener(pc, 'connectionstatechange', (() => {
                     var _a;
                     (_a = this.delegate) === null || _a === void 0 ? void 0 : _a.onConnectionChange(rtcId, pc.connectionState);
-                };
+                }));
                 this.pcs.set(rtcId, pc);
                 const sdp = yield createAnswer(pc, offerSDP);
                 closure(null, sdp);
@@ -89839,8 +89864,9 @@ class MediaClient {
     }
     enableMediaOutbound(closure) {
         return __awaiter(this, void 0, void 0, function* () {
+            let pc;
             try {
-                const pc = yield this.getNewPC();
+                pc = yield this.getNewPC(null);
                 const sdp = yield createOffer(pc);
                 closure(null, sdp, (legId) => {
                     if (!legId) {
@@ -89849,13 +89875,15 @@ class MediaClient {
                         return;
                     }
                     this.pcs.set(legId, pc);
-                    pc.onconnectionstatechange = () => {
+                    this.addPCListener(pc, 'connectionstatechange', (() => {
                         var _a;
                         (_a = this.delegate) === null || _a === void 0 ? void 0 : _a.onConnectionChange(legId, pc.connectionState);
-                    };
+                    }));
                 });
             }
             catch (err) {
+                if (pc)
+                    this.closePeerConnection(pc);
                 const message = err instanceof Error ? err.message : null;
                 closure(new clientsdkClientcore_jsExports.vonage.CreateOfferErrorJS(message), null, () => {
                     throw new Error('Callback not implemented, and should never get called');
@@ -89863,10 +89891,11 @@ class MediaClient {
             }
         });
     }
-    getNewPC() {
+    getNewPC(callId) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const pc = yield createRtcAudioConnection();
-            pc.ontrack = (evt) => {
+            this.addPCListener(pc, 'track', ((evt) => {
                 const stream = evt.streams[0];
                 if (stream) {
                     const audio = new Audio();
@@ -89874,7 +89903,8 @@ class MediaClient {
                     audio.autoplay = true;
                     this.audio = audio;
                 }
-            };
+            }));
+            (_a = this.peerConnectionCreatedCallback) === null || _a === void 0 ? void 0 : _a.call(this, callId, pc);
             return pc;
         });
     }
@@ -89962,6 +89992,7 @@ class MediaClient {
     // Private Methods
     closePeerConnection(pc) {
         var _a;
+        this.removeAllPCListeners(pc);
         pc.close();
         pc.getSenders().forEach((sender) => {
             var _a;
@@ -90412,7 +90443,8 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
         super.emitter = value;
     }
     constructor(config = new ClientInitConfig()) {
-        super(convertInitConfig(config), new HttpClient(), new SocketClient(), new MediaClient());
+        const mediaClient = new MediaClient();
+        super(convertInitConfig(config), new HttpClient(), new SocketClient(), mediaClient);
         /**
          * Proxy object to allow for registering callbacks via `on()`
          * @internal
@@ -90442,13 +90474,17 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
                 };
             }
         });
+        mediaClient.setPeerConnectionCreatedCallback((callId, pc) => {
+            var _a, _b;
+            (_b = (_a = this.emitter) === null || _a === void 0 ? void 0 : _a.peerConnectionCreated) === null || _b === void 0 ? void 0 : _b.call(_a, callId, pc);
+        });
         this.setConfig(config);
     }
     /**
      * Set a configuration for the client SDK
      *
      * @example
-     * [[include: snippet_SetClientConfig.txt]]
+     * [[include: snippet_Config.txt]]
      *
      * @param config - A configuration object
      * @returns void
@@ -90524,17 +90560,24 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
         callbacks.clear();
     }
     /**
-     * Create a session with a token and optional sessionId
-     * If no sessionId is provided, a new one will be generated
-     * and returned. If a sessionId is provided, it will be used
-     * to resume an existing session.
+     * Create (or reconnect to) a session.
+     *
+     * When `sessionId` is omitted or `null`, a completely new session is created.
+     *
+     * When `sessionId` is set to the value returned by a **previous** `createSession` call, the
+     * Conversation Service will replay any pending events into the new session.  In particular, an
+     * unanswered inbound call invite that arrived before a page refresh will be re-delivered so that
+     * `onCallInvite` fires automatically — no extra API call is needed.
+     *
+     * **Important:** The Conversation Service retains pending events for approximately 30 seconds.
+     * Persist the session ID (e.g. in `sessionStorage`) and pass it back within that window.
      *
      * @example
      * [[include: snippet_SessionCreate.txt]]
      *
-     * @param token
-     * @param sessionId - optional sessionId to use
-     * @returns the `sessionId` of the session
+     * @param token - JWT token of the user.
+     * @param sessionId - Optional previous session ID. Omit or pass `null` for a fresh session.
+     * @returns The `sessionId` of the newly established session.
      */
     createSession(token, sessionId) {
         const _super = Object.create(null, {

package/dist/utils/ClientConfig.d.ts

@@ -27,7 +27,7 @@ export declare const ConfigRegion: typeof vonage.CoreClientConfigRegionJS;
  * @property emergencySecondaryRegion The secondary region URL for emergency services
  *
  * @example
- * [[include:snippet_SetClientConfig.txt]]
+ * [[include:snippet_Config.txt]]
  */
 export type ClientConfigObject = ConfigObjectJS | ({
     region?: ConfigRegion;