@exotel-npm-dev/webrtc-client-sdk 1.0.14 → 1.0.16

package/Changelog

@@ -1,5 +1,8 @@
 Change Log
 
+## v1.0.15 21 November, 2024
+-[VST-885] Retry Support for SDK Websocket Connection
+
 ## v1.0.14 12 September, 2024
 -[VST-807] Added call details with callsid and sip headers
 

package/dist/exotelsdk.js

@@ -1,6 +1,6 @@
 /*!
  * 
- * WebRTC CLient SIP version 1.0.14
+ * WebRTC CLient SIP version 1.0.16
  *
  */
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -53,7 +53,7 @@ const audioDeviceManager = {
     resetOutputDevice: false,
     currentAudioInputDeviceId: "default",
     currentAudioOutputDeviceId: "default",
-
+    mediaDevices: [],
 
     // Method to set the resetInputDevice flag
     setResetInputDeviceFlag(value) {
@@ -69,14 +69,14 @@ const audioDeviceManager = {
         logger.log(`SIPJSPhone:changeAudioInputDevice entry`);
         try {
             if (deviceId == audioDeviceManager.currentAudioInputDeviceId) {
-                logger.log(`SIPJSPhone:changeAudioInputDevice current input device is same as ${deviceId}`);
+                logger.log(`SIPJSPhone:changeAudioInputDevice current input device is same as ${deviceId} hence not changing`);
+                if (onError) onError("current input device is same as " + deviceId + " hence not changing");
                 return;
             }
-            const devices = await navigator.mediaDevices.enumerateDevices();
-            const inputDevice = devices.find(device => device.deviceId === deviceId && device.kind === 'audioinput');
+            const inputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audioinput');
             if (!inputDevice) {
                 logger.error("input device id " + deviceId + "not found");
-                onError("deviceIdNotFound");
+                if (onError) onError("deviceIdNotFound");
                 return;
             }
             logger.log(`SIPJSPhone:changeAudioInputDevice acquiring input device ${deviceId} : ${inputDevice.label}`);
@@ -86,7 +86,7 @@ const audioDeviceManager = {
             onSuccess(stream);
         } catch (error) {
             logger.error('SIPJSPhone:changeAudioInputDevice Error changing input device:', error);
-            onError(error);
+            if (onError) onError(error);
         }
     },
 
@@ -94,19 +94,26 @@ const audioDeviceManager = {
         logger.log(`audioDeviceManager:changeAudioOutputDevice : entry`);
         if (deviceId == audioDeviceManager.currentAudioOutputDeviceId) {
             logger.log(`SIPJSPhone:changeAudioOutputDevice current output device is same as ${deviceId}`);
+            if (onError) onError("current output device is same as " + deviceId);
             return;
         }
         const audioElement = audioRemote;
         if (typeof audioElement.sinkId !== 'undefined') {
             try {
-                const devices = await navigator.mediaDevices.enumerateDevices();
-                const outputDevice = devices.find(device => device.deviceId === deviceId && device.kind === 'audiooutput');
+
+                if (!audioDeviceManager.mediaDevices || audioDeviceManager.mediaDevices.length == 0) {
+                    logger.error("audioDeviceManager:changeAudioOutputDevice mediaDeviceList is empty ");
+                    if (onError) logger.error(deviceId + "not found in mediaDeviceList in audioManager");
+                    return;
+                }
+                const outputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === deviceId && device.kind === 'audiooutput');
                 if (!outputDevice) {
                     logger.error("audioDeviceManager:changeAudioOutputDevice output device id " + deviceId + "not found");
-                    onError("deviceIdNotFound");
+                    if (onError) onError("deviceIdNotFound");
                     return;
                 }
-                logger.log(`SIPJSPhone:changeAudioOutputDevice acquiring output device ${deviceId} : ${outputDevice.label}`);
+                logger.log(`audioDeviceManager:changeAudioOutputDevice acquiring output device ${deviceId} : ${outputDevice.label}`);
+                // audioElement.load();
                 await audioElement.setSinkId(deviceId);
                 audioDeviceManager.currentAudioOutputDeviceId = deviceId;
                 logger.log(`audioDeviceManager:changeAudioOutputDevice Output device changed to: ${deviceId}`);
@@ -136,21 +143,20 @@ const audioDeviceManager = {
     async _resetAudioDevice(audioRemote, onInputDeviceChangeCallback, onOutputDeviceChangecallback, resetOutputDevice, resetInputDevice) {
         logger.log("audioDeviceManager:_resetAudioDevice entry");
         try {
-            const devices = await navigator.mediaDevices.enumerateDevices();
 
             if (resetOutputDevice) {
-                const defaultOutputDevice = devices.find(device => device.deviceId === "default" && device.kind === 'audiooutput');
-                const outputDevice = devices.find(device => device.groupId == defaultOutputDevice.groupId && device.kind === 'audiooutput' && device.deviceId != 'default');
+                const defaultOutputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === "default" && device.kind === 'audiooutput');
+                const outputDevice = audioDeviceManager.mediaDevices.find(device => device.groupId == defaultOutputDevice.groupId && device.kind === 'audiooutput' && device.deviceId != 'default');
 
                 audioDeviceManager.changeAudioOutputDevice(audioRemote,
                     outputDevice.deviceId,
                     () => onOutputDeviceChangecallback(outputDevice.deviceId),
-                    (error) => logger.log(`audioDeviceManager:_resetAudioDevice Failed to change output device: ${error}`)
+                    (error) => logger.error(`audioDeviceManager:_resetAudioDevice Failed to change output device: ${error}`)
                 );
             }
             if (resetInputDevice) {
-                const defaultInputDevice = devices.find(device => device.deviceId === "default" && device.kind === 'audioinput');
-                const inputDevice = devices.find(device => device.groupId == defaultInputDevice.groupId && device.kind === 'audioinput' && device.deviceId != 'default');
+                const defaultInputDevice = audioDeviceManager.mediaDevices.find(device => device.deviceId === "default" && device.kind === 'audioinput');
+                const inputDevice = audioDeviceManager.mediaDevices.find(device => device.groupId == defaultInputDevice.groupId && device.kind === 'audioinput' && device.deviceId != 'default');
                 audioDeviceManager.changeAudioInputDevice(
                     inputDevice.deviceId,
                     (stream) => onInputDeviceChangeCallback(stream, inputDevice.deviceId),
@@ -158,13 +164,23 @@ const audioDeviceManager = {
                 );
             }
         } catch (error) {
-            logger.log("audioDeviceManager:_resetAudioDevice something went wrong", error);
+            logger.error("audioDeviceManager:_resetAudioDevice reset audio device failed", error);
         }
     },
 
-};
+    async enumerateDevices(callback) {
+        logger.log("audioDeviceManager:enumerateDevices entry")
+        try {
+            audioDeviceManager.mediaDevices = await navigator.mediaDevices.enumerateDevices();
+        } catch (e) {
+            logger.log("audioDeviceManager:enumerateDevices device enumeration failed", e);
+        }
+        if (callback) callback();
+    },
 
+};
 
+audioDeviceManager.enumerateDevices();
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (audioDeviceManager);
 
 /***/ }),
@@ -22032,21 +22048,30 @@ const SIPJSPhone = {
 				onSuccess();
 			} else {
 				logger.error("SIPJSPhone:changeAudioInputDevice failed");
-				onError("something went wrong , try again");
+				onError("replaceSenderTrack failed for webrtc");
 			}
 		}, onError);
 	},
-	onRemoteAudioOutputDeviceChanged(deviceId) {
-		ringtone.setSinkId(deviceId).catch((e) => {
-			logger.error("sipjsphone:onRemoteAudioOutputDeviceChanged ringtone changedevice failure ", e);
-		});
+	changeAudioOutputDeviceForAdditionalAudioElement(deviceId) {
+		const additionalAudioElements = [ringtone, beeptone, ringbacktone, dtmftone];
+		let i = 0;
+		let elem;
+		try {
+			for (i = 0; i < additionalAudioElements.length; i++) {
+				elem = additionalAudioElements[i];
+				elem.load();
+				elem.setSinkId(deviceId);
+			}
+		} catch (e) {
+			logger.error("sipjsphone:changeAudioOutputDeviceForAdditionalAudioElement failed to setSink for additonal AudioElements", e);
+		}
 	},
 	changeAudioOutputDevice(deviceId, onSuccess, onError) {
 		if (!ctxSip.callActiveID) {
 			audioRemote = document.createElement("audio");
 		}
 		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.changeAudioOutputDevice(audioRemote, deviceId, function () {
-			SIPJSPhone.onRemoteAudioOutputDeviceChanged(deviceId);
+			SIPJSPhone.changeAudioOutputDeviceForAdditionalAudioElement(deviceId);
 			onSuccess();
 		}, onError);
 	},
@@ -22098,11 +22123,12 @@ const SIPJSPhone = {
 	},
 	audioInputDeviceChangeCallback: null,
 	audioOutputDeviceChangeCallback: null,
-	registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback) {
+	onDeviceChangeCallback: null,
+	registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback, onDeviceChangeCallback) {
 		logger.log(`SIPJSPhone:registerAudioDeviceChangeCallback  entry`);
 		SIPJSPhone.audioInputDeviceChangeCallback = audioInputDeviceChangeCallback;
 		SIPJSPhone.audioOutputDeviceChangeCallback = audioOutputDeviceChangeCallback;
-
+		SIPJSPhone.onDeviceChangeCallback = onDeviceChangeCallback;
 	}
 
 };
@@ -22113,22 +22139,31 @@ navigator.mediaDevices.addEventListener('devicechange', function (event) {
 		if (!ctxSip.callActiveID) {
 			audioRemote = document.createElement("audio");
 		}
-		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.onAudioDeviceChange(audioRemote,
-			function (stream, deviceId) {
-				const trackChanged = SIPJSPhone.replaceSenderTrack(stream, deviceId);
-				if (trackChanged) {
-					_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioInputDeviceId = deviceId;
-					if (SIPJSPhone.audioInputDeviceChangeCallback) {
-						SIPJSPhone.audioInputDeviceChangeCallback(deviceId);
+		_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.enumerateDevices(function () {
+
+			if (SIPJSPhone.onDeviceChangeCallback) {
+				logger.info("SIPJSPhone:ondevicechange relaying event to callback");
+				SIPJSPhone.onDeviceChangeCallback(event);
+				return;
+			}
+			_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.onAudioDeviceChange(audioRemote,
+				function (stream, deviceId) {
+					const trackChanged = SIPJSPhone.replaceSenderTrack(stream, deviceId);
+					if (trackChanged) {
+						_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioInputDeviceId = deviceId;
+						if (SIPJSPhone.audioInputDeviceChangeCallback) {
+							SIPJSPhone.audioInputDeviceChangeCallback(deviceId);
+						}
 					}
-				}
-			}, function (deviceId) {
-				SIPJSPhone.onRemoteAudioOutputDeviceChanged(deviceId);
-				_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioOutputDeviceId = deviceId;
-				if (SIPJSPhone.audioOutputDeviceChangeCallback) {
-					SIPJSPhone.audioOutputDeviceChangeCallback(deviceId);
-				}
-			});
+				}, function (deviceId) {
+					SIPJSPhone.changeAudioOutputDeviceForAdditionalAudioElement(deviceId);
+					_audioDeviceManager_js__WEBPACK_IMPORTED_MODULE_0__.audioDeviceManager.currentAudioOutputDeviceId = deviceId;
+					if (SIPJSPhone.audioOutputDeviceChangeCallback) {
+						SIPJSPhone.audioOutputDeviceChangeCallback(deviceId);
+					}
+				});
+		});
+
 	} catch (e) {
 		logger.error("SIPJSPhone:ondevicechange something went wrong during device change", e);
 	}
@@ -22359,9 +22394,9 @@ const webrtcSIPPhone = {
 		logger.log(`webrtcSIPPhone:changeAudioOutputDevice entry`);
 		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].changeAudioOutputDevice(deviceId, onSuccess, onError);
 	},
-	registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback) {
+	registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback, onDeviceChangeCallback) {
 		logger.log(`webrtcSIPPhone:registerAudioDeviceChangeCallback  entry`);
-		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback);
+		_sipjsphone__WEBPACK_IMPORTED_MODULE_1__["default"].registerAudioDeviceChangeCallback(audioInputDeviceChangeCallback, audioOutputDeviceChangeCallback, onDeviceChangeCallback);
 	},
 	getLogger() {
 		return _coreSDKLogger__WEBPACK_IMPORTED_MODULE_0__["default"];
@@ -23426,15 +23461,17 @@ function DoRegister(sipAccountInfo, exWebClient) {
    * CHANGE IS REQUIRED - in the initialize function provision is to be given to pass Callback functions as arguments
    */
   try {
-    exWebClient.initialize(userContext, sipAccountInfo.domain,
-    //hostname
-    sipAccountInfo.userName,
-    //subscriberName
-    sipAccountInfo.displayname,
-    //displayName
-    sipAccountInfo.accountSid,
-    //accountSid
-    '', sipAccountInfo); // subscriberToken
+    setTimeout(function () {
+      exWebClient.initialize(userContext, sipAccountInfo.domain,
+      //hostname
+      sipAccountInfo.userName,
+      //subscriberName
+      sipAccountInfo.displayname,
+      //displayName
+      sipAccountInfo.accountSid,
+      //accountSid
+      '', sipAccountInfo); // subscriberToken        
+    }, 500);
   } catch (e) {
     logger.log("Register failed ", e);
   }
@@ -23970,10 +24007,14 @@ function ExSynchronousHandler() {
 }
 class ExotelWebClient {
   ctrlr = null;
-  call = null;
+  call;
   eventListener = null;
   callListener = null;
   callFromNumber = null;
+  shouldAutoRetry = false;
+  unregisterInitiated = false;
+  registrationInProgress = false;
+  isReadyToRegister = true;
   /* OLD-Way to be revisited for multile phone support */
   //this.webRTCPhones = {};
 
@@ -24005,9 +24046,16 @@ class ExotelWebClient {
     return true;
   };
   DoRegister = () => {
+    logger.log("ExWebClient:DoRegister Entry");
+    if (!this.isReadyToRegister) {
+      logger.warn("ExWebClient:DoRegister SDK is not ready to register");
+      return false;
+    }
     (0,_api_registerAPI_RegisterListener__WEBPACK_IMPORTED_MODULE_1__.DoRegister)(this.sipAccountInfo, this);
+    return true;
   };
   UnRegister = () => {
+    logger.log("ExWebClient:UnRegister Entry");
     (0,_api_registerAPI_RegisterListener__WEBPACK_IMPORTED_MODULE_1__.UnRegister)(this.sipAccountInfo, this);
   };
   initDiagnostics = (saveDiagnosticsCallback, keyValueSetCallback) => {
@@ -24074,11 +24122,26 @@ class ExotelWebClient {
        * When registration is successful then send the phone number of the same to UI
        */
       this.eventListener.onInitializationSuccess(phone);
+      this.registrationInProgress = false;
+      if (this.unregisterInitiated) {
+        logger.log("ExWebClient:registerEventCallback unregistering due to unregisterInitiated");
+        this.unregisterInitiated = false;
+        this.unregister();
+      }
     } else if (event === "failed_to_start" || event === "transport_error") {
       /**
        * If registration fails
        */
       this.eventListener.onInitializationFailure(phone);
+      if (this.unregisterInitiated) {
+        this.shouldAutoRetry = false;
+        this.unregisterInitiated = false;
+        this.isReadyToRegister = true;
+      }
+      if (this.shouldAutoRetry) {
+        logger.log("ExWebClient:registerEventCallback Autoretrying");
+        (0,_api_registerAPI_RegisterListener__WEBPACK_IMPORTED_MODULE_1__.DoRegister)(this.sipAccountInfo, this);
+      }
     } else if (event === "sent_request") {
       /**
        * If registration request waiting...
@@ -24118,8 +24181,14 @@ class ExotelWebClient {
    * @param {*} sipAccountInfo 
    */
   unregister = sipAccountInfo => {
-    // webrtcSIPPhone.unregister(sipAccountInfo)
-    _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.sipUnRegisterWebRTC();
+    logger.log("ExWebClient:unregister Entry");
+    this.shouldAutoRetry = false;
+    this.unregisterInitiated = true;
+    if (!this.registrationInProgress) {
+      setTimeout(function () {
+        _exotel_npm_dev_webrtc_core_sdk__WEBPACK_IMPORTED_MODULE_8__.webrtcSIPPhone.sipUnRegisterWebRTC();
+      }, 500);
+    }
   };
   webRTCStatusCallbackHandler = (msg1, arg1) => {
     logger.log("webRTCStatusCallbackHandler: " + msg1 + " " + arg1);
@@ -24131,6 +24200,9 @@ class ExotelWebClient {
   initialize = (uiContext, hostName, subscriberName, displayName, accountSid, subscriberToken, sipAccountInfo) => {
     let wssPort = sipAccountInfo.port;
     let wsPort = 4442;
+    this.isReadyToRegister = false;
+    this.registrationInProgress = true;
+    this.shouldAutoRetry = true;
     this.sipAccntInfo = {
       'userName': '',
       'authUser': '',