@telegenta/webclient 3.1.1 → 3.2.0

package/docs/phone-client.js.html

@@ -3,10 +3,10 @@
     <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="EventClient.html">EventClient</a></div><div class="sidebar-section-children"><a href="EventServiceNotConnected.html">EventServiceNotConnected</a></div><div class="sidebar-section-children"><a href="InvalidMediaDevice.html">InvalidMediaDevice</a></div><div class="sidebar-section-children"><a href="InvalidOptions.html">InvalidOptions</a></div><div class="sidebar-section-children"><a href="InvalidParameter.html">InvalidParameter</a></div><div class="sidebar-section-children"><a href="LogHandler.html">LogHandler</a></div><div class="sidebar-section-children"><a href="MediaNotPrepared.html">MediaNotPrepared</a></div><div class="sidebar-section-children"><a href="NoActiveSession.html">NoActiveSession</a></div><div class="sidebar-section-children"><a href="NotAllowed.html">NotAllowed</a></div><div class="sidebar-section-children"><a href="NotReady.html">NotReady</a></div><div class="sidebar-section-children"><a href="Phone.html">Phone</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Requestor.html">Requestor</a></div><div class="sidebar-section-children"><a href="Session.html">Session</a></div><div class="sidebar-section-children"><a href="UnableToConnect.html">UnableToConnect</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-events"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#event:callDataInfo">callDataInfo</a></div><div class="sidebar-section-children"><a href="global.html#event:callDurationUpdate">callDurationUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:callEnded">callEnded</a></div><div class="sidebar-section-children"><a href="global.html#event:callQualityReportUpdate">callQualityReportUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:connectionStateChange">connectionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:holdStateChange">holdStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:incomingCall">incomingCall</a></div><div class="sidebar-section-children"><a href="global.html#event:muteStateChange">muteStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:recordingStateChange">recordingStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionCreated">sessionCreated</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionRemoved">sessionRemoved</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionStateChange">sessionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:whisperModeChange">whisperModeChange</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#CALL_DIRECTION">CALL_DIRECTION</a></div><div class="sidebar-section-children"><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></div><div class="sidebar-section-children"><a href="global.html#CONNECTION_STATE">CONNECTION_STATE</a></div><div class="sidebar-section-children"><a href="global.html#LOGLVL">LOGLVL</a></div><div class="sidebar-section-children"><a href="global.html#SESSION_STATE">SESSION_STATE</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">phone-client.js</h1></header><article><pre class="prettyprint source lang-js"><code>// 'use strict';
 import EventEmitter from 'events';
 import JsSIP from 'jssip';
-import { LogHandler, LOGLVL } from './logger';
-import * as Exceptions from './exceptions';
-import * as Tools from './tools';
-import { EventClient } from './event-client';
+import { LogHandler, LOGLVL } from './logger.js';
+import * as Exceptions from './exceptions.js';
+import * as Tools from './tools.js';
+import { EventClient } from './event-client.js';
 import camelcaseKeys from 'camelcase-keys';
 
 const options = {
@@ -112,6 +112,9 @@ export class Phone extends EventEmitter {
         this._eventClient = null;
         this._options = null;
 
+        // getUserMedia audio constraint: true (default device) or { deviceId: { exact } }
+        this._audioConstraints = true;
+
         // List of active sessions
         this._sessionCounter = 0;
         this._activeSessions = {};
@@ -127,6 +130,7 @@ export class Phone extends EventEmitter {
         this._repeatToneActive = false;
         this._repeatToneSequence = [];
         this._repeatToneSequencePos = 0;
+        this._toneContext = null;
         this._toneGainProcessor = null;
         this._oscillator1 = null;
         this._oscillator2 = null;
@@ -146,29 +150,83 @@ export class Phone extends EventEmitter {
      * Prepare media and get media permission from browser
      * This must be done prior to using the phone or getting device lists.
      *
-     * @return A promise which will be resolved when user accepts access to media devices
+     * On failure the previously selected input device (see {@link setInputDevice}) and the
+     * current media-permission state are left untouched, unless the browser reports the
+     * request was actually denied (NotAllowedError / SecurityError), in which case
+     * hasMediaPermission/hasMediaPermissionError are updated to reflect that.
      *
+     * @param {object} [mediaOptions]
+     * @param {string} [mediaOptions.deviceId] Microphone deviceId (from enumerateDevices); omit or leave
+     *   out to select the browser default device, which also resets a device previously chosen with
+     *   {@link setInputDevice}
+     * @return {Promise} Resolved when user accepts access to media devices; rejected (never thrown
+     *   synchronously) otherwise, e.g. when the browser denies permission or has no mediaDevices API
      */
-    prepareMedia() {
+    async prepareMedia(mediaOptions = {}) {
         this.log.info('Get media permission');
-        const self = this;
-        const constraints = { audio: true, video: false };
-        return new Promise(function (resolve, reject) {
-            navigator.mediaDevices.getUserMedia(constraints).then(
-                () => {
-                    self._mediaPermission = true;
-                    self._mediaPermissionError = false;
-                    self.log.info('Media permission granted');
-                    resolve();
-                },
-                (err) => {
-                    self._mediaPermission = false;
-                    self._mediaPermissionError = true;
-                    self.log.error('Denied media permission: ' + err);
-                    reject(err);
-                },
-            );
-        });
+        const deviceId = (mediaOptions || {}).deviceId || null;
+        const audioConstraints = deviceId ? { deviceId: { exact: deviceId } } : true;
+        const constraints = { audio: audioConstraints, video: false };
+
+        try {
+            const stream = await navigator.mediaDevices.getUserMedia(constraints);
+            // Only the permission is needed here; release the device again.
+            stream.getTracks().forEach((track) => track.stop());
+            this.setInputDevice(deviceId);
+            this._mediaPermission = true;
+            this._mediaPermissionError = false;
+            this.log.info('Media permission granted');
+        } catch (err) {
+            if (err &amp;&amp; (err.name === 'NotAllowedError' || err.name === 'SecurityError')) {
+                this._mediaPermission = false;
+                this._mediaPermissionError = true;
+                this.log.error('Denied media permission: ' + err);
+            } else {
+                this.log.error('Unable to get requested media device: ' + err);
+            }
+            throw err;
+        }
+    }
+
+    /**
+     * Select the microphone used for subsequent calls and answers.
+     * @param {string|null} deviceId Microphone deviceId, or null for the browser default
+     */
+    setInputDevice(deviceId) {
+        this._audioConstraints = deviceId ? { deviceId: { exact: deviceId } } : true;
+    }
+
+    /**
+     * Current getUserMedia audio constraint (true = default device)
+     */
+    get audioConstraints() {
+        return this._audioConstraints;
+    }
+
+    /**
+     * True when the browser can route audio to a chosen output device (HTMLMediaElement.setSinkId)
+     */
+    get outputDeviceSelectionSupported() {
+        return typeof this._remoteAudioElement.setSinkId === 'function';
+    }
+
+    /**
+     * Route call audio and signal tones to an output device.
+     * @param {string|null} deviceId Output deviceId (from enumerateDevices), or null for the default
+     * @return {Promise&lt;boolean>} false when the browser does not support output selection
+     * @throws Rejects if the browser's HTMLMediaElement.setSinkId() call rejects, e.g. for an
+     *   unknown deviceId or one the browser is not allowed to use (NotAllowedError)
+     */
+    async setOutputDevice(deviceId) {
+        if (!this.outputDeviceSelectionSupported) {
+            return false;
+        }
+        const sinkId = deviceId || '';
+        await Promise.all([
+            this._remoteAudioElement.setSinkId(sinkId),
+            this._toneAudioElement.setSinkId(sinkId),
+        ]);
+        return true;
     }
 
     /**
@@ -204,16 +262,16 @@ export class Phone extends EventEmitter {
         }
 
         // Apply options
-        this._options = Object.assign(options, phoneOptions);
+        this._options = Object.assign({}, options, phoneOptions);
 
         this._initToneGenerator();
 
         // Unpack provisioning token if specified
         if (this._options.provisionToken) {
-            let pt = null;
+            let pt;
             try {
                 pt = JSON.parse(atob(this._options.provisionToken));
-            } catch (err) {
+            } catch {
                 throw new Exceptions.InvalidOptions('provisionToken', 'Invalid token');
             }
 
@@ -289,7 +347,7 @@ export class Phone extends EventEmitter {
             );
         }
 
-        let wsSocket = null;
+        let wsSocket;
         try {
             wsSocket = new JsSIP.WebSocketInterface(this._options.wssServer);
         } catch (err) {
@@ -367,8 +425,11 @@ export class Phone extends EventEmitter {
             self._setConnectionState('UNREGISTERED');
         });
 
-        this._UA.on('registrationFailed', function (/* data */) {
-            self._setConnectionState('REGISTRATION_FAILED');
+        this._UA.on('registrationFailed', function (data) {
+            self._setConnectionState('REGISTRATION_FAILED', {
+                cause: data?.cause,
+                statusCode: data?.response?.status_code,
+            });
         });
 
         this._UA.start();
@@ -393,6 +454,11 @@ export class Phone extends EventEmitter {
         this._UA.stop();
         delete this._UA;
 
+        // Always mark the phone stopped from here on, even if there is no event client to
+        // disconnect below - otherwise isStarted stays true and a later start() would try to
+        // stop() this same (already torn down) instance again.
+        this._isStarted = false;
+
         // Disconnect event client if needed
         if (!this._eventClient) {
             this.log.debug('Event client not running, not stopping');
@@ -401,14 +467,26 @@ export class Phone extends EventEmitter {
         try {
             this._eventClient.disconnect();
             delete this._eventClient;
-        } catch (e) {
+        } catch {
             this.log.warning('Unable to disconnect event client');
         }
-
-        this._isStarted = false;
         this.log.info('Phone client successfully stopped');
     }
 
+    /**
+     * Re-send REGISTER without tearing down the websocket connection or any active calls.
+     * Use this to recover from a REGISTER refresh that failed for a reason other than bad
+     * credentials (e.g. a timeout or a 5xx from the registrar) while the transport itself stayed
+     * up - JsSIP does not retry those on its own. Safe to call during an active call.
+     * @throws NotReady - If phone is not started
+     */
+    register() {
+        if (!this._isStarted) {
+            throw new Exceptions.NotReady('Phone is not started');
+        }
+        this._UA.register();
+    }
+
     /**
      * Start a new call
      * If you have other active calls they will be set on hold
@@ -492,7 +570,7 @@ export class Phone extends EventEmitter {
      */
     getSessionByUUID(uuid) {
         for (let key in this._activeSessions) {
-            if (this._activeSessions.hasOwnProperty(key)) {
+            if (Object.hasOwn(this._activeSessions, key)) {
                 if (this._activeSessions[key].uuid === uuid) {
                     return this._activeSessions[key];
                 }
@@ -510,6 +588,27 @@ export class Phone extends EventEmitter {
         return this._options;
     }
 
+    /**
+     * Replace the call token used by subsequent calls and answers.
+     * Call tokens expire (30 min); renew via the API and pass the new token here.
+     *
+     * With useCallDataInfoEvent, the callDataInfo subscription keeps the token from start();
+     * call start() again to move it to the new token.
+     *
+     * @param {string} token New call token
+     * @throws NotReady - If phone is not started
+     * @throws InvalidOptions - If token is empty
+     */
+    setCallToken(token) {
+        if (!this._isStarted) {
+            throw new Exceptions.NotReady('Phone is not started');
+        }
+        if (!token) {
+            throw new Exceptions.InvalidOptions('callToken', 'Missing call token');
+        }
+        this._options.callToken = token;
+    }
+
     /**
      * Return list of current sessions
      * @returns [Session]
@@ -517,7 +616,7 @@ export class Phone extends EventEmitter {
     get sessions() {
         let s = [];
         for (let key in this._activeSessions) {
-            if (this._activeSessions.hasOwnProperty(key)) {
+            if (Object.hasOwn(this._activeSessions, key)) {
                 s.push(this._activeSessions[key]);
             }
         }
@@ -575,6 +674,7 @@ export class Phone extends EventEmitter {
      */
     playTone(duration, freq1, freq2 = 0, callback = null) {
         this.log.debug(`Playing tone ${freq1} / ${freq2} for ${duration} ms`);
+        this._resumeToneContext();
 
         this._oscillator1.frequency.value = freq1;
         this._oscillator2.frequency.value = freq2;
@@ -641,8 +741,35 @@ export class Phone extends EventEmitter {
         }
     }
 
-    // Initialize tone generator
+    /**
+     * Resume the Web Audio context behind signal tones (ringing, ringback, busy, DTMF feedback).
+     * Browsers create an AudioContext "suspended" when it is not created during a user gesture
+     * (e.g. a phone started on page load); call this from a user-gesture handler (click, keydown)
+     * so tones are audible. Safe to call before {@link start} and any number of times.
+     * @return {Promise&lt;boolean>} false when the browser has no Web Audio API or resuming failed
+     */
+    async resumeAudio() {
+        try {
+            this._initToneGenerator();
+        } catch {
+            return false;
+        }
+        try {
+            await this._toneContext.resume();
+            return this._toneContext.state === 'running';
+        } catch (err) {
+            this.log.warning('Unable to resume audio context: ' + err);
+            return false;
+        }
+    }
+
+    // Initialize tone generator. One AudioContext per Phone, reused across start()/stop() -
+    // browsers cap the number of live contexts and a new one per start() would leak.
     _initToneGenerator() {
+        if (this._toneContext &amp;&amp; this._toneContext.state !== 'closed') {
+            return;
+        }
+
         // Create audio context
         const AudioContext = window.AudioContext || window.webkitAudioContext || false;
         if (!AudioContext) {
@@ -650,6 +777,7 @@ export class Phone extends EventEmitter {
         }
 
         const ctx = new AudioContext();
+        this._toneContext = ctx;
         this._toneStreamNode = ctx.createMediaStreamDestination();
         this._toneAudioElement.srcObject = this._toneStreamNode.stream;
 
@@ -669,6 +797,14 @@ export class Phone extends EventEmitter {
         this._oscillator2.start();
     }
 
+    // Best effort: a context created outside a user gesture is suspended until resumed.
+    _resumeToneContext() {
+        const ctx = this._toneContext;
+        if (ctx &amp;&amp; ctx.state === 'suspended' &amp;&amp; typeof ctx.resume === 'function') {
+            ctx.resume().catch((err) => this.log.debug('Audio context resume refused: ' + err));
+        }
+    }
+
     /**
      * Hold all active calls
      * @throws NotAllowed If there are connection calls
@@ -682,7 +818,7 @@ export class Phone extends EventEmitter {
 
         // Iterate through all active calls and hold them
         for (let key in this._activeSessions) {
-            if (this._activeSessions.hasOwnProperty(key)) {
+            if (Object.hasOwn(this._activeSessions, key)) {
                 let session = this._activeSessions[key];
                 if (session.state === 'ACTIVE') {
                     session.hold();
@@ -756,7 +892,7 @@ export class Phone extends EventEmitter {
     // Return true if there are calls currently connecting
     _checkForConnectingCalls() {
         for (let key in this._activeSessions) {
-            if (this._activeSessions.hasOwnProperty(key)) {
+            if (Object.hasOwn(this._activeSessions, key)) {
                 let session = this._activeSessions[key];
                 if (
                     session.state === 'INITIALIZING' ||
@@ -781,17 +917,23 @@ export class Phone extends EventEmitter {
      * @property {string} REGISTRATION_FAILED Registration failed
      */
     // Set connection state and emit event
-    _setConnectionState(state) {
+    _setConnectionState(state, extra = {}) {
         /**
          * @event connectionStateChange
          * @type {object}
          * @param {CONNECTION_STATE} state - The current connection state
+         * @param {string} [cause] - For REGISTRATION_FAILED only: JsSIP's registrationFailed
+         *   cause, e.g. 'Connection Error', 'Request Timeout' (network/transport issues, JsSIP
+         *   will keep retrying on its own), 'Authentication Error' (401), or 'Rejected' (403 -
+         *   account disabled or credentials rejected by the registrar)
+         * @param {number} [statusCode] - For REGISTRATION_FAILED only: the SIP status code of
+         *   the failed REGISTER response, when JsSIP received one (e.g. 401, 403)
          */
 
         this.log.info('Connection state: ' + state);
         this._connectionState = state;
         try {
-            this.emit('connectionStateChange', { state: state });
+            this.emit('connectionStateChange', { state: state, ...extra });
         } catch (e) {
             this.log.error('Exception in connectionStateChange event: ' + e);
         }
@@ -839,18 +981,15 @@ export class Phone extends EventEmitter {
          * @param {string} effectiveCidNameStr - Phone number name used as a-number for call
          * @param {boolean} callPrivacy - Call privacy used for call (number hidden)
          * @param {number} hangupCauseQ850 - Q.850 hangup cause code
-         * @param {Object[]} recordings - List of recordings done for this call
-         * @param {number} recordings[].startTime - Time recording was started
-         * @param {number} recordings[].length - Recording length in milliseconds
-         * @param {number} recordings[].size - Recording size (bytes)
-         * @param {number} recordings[].urlPlayer - URL for recording with player
-         * @param {number} recordings[].url - URL for recording without player
-         * @param {number} recordings[].retentionDate - Date recording will be automatically deleted
          */
 
         let e;
         e = camelcaseKeys(eventData);
-        e.recordings = camelcaseKeys(eventData.recordings);
+        // The call data event no longer carries recordings. Uploads are
+        // asynchronous, so the array was almost always empty by the time the CDR
+        // was processed, and the event cannot be re-fired once a recording lands
+        // because call_token is never persisted on the CDR. A dedicated
+        // "recording ready" event will replace it.
 
         // Event all duration fields are in seconds, convert to millisecs
         e.duration = e.duration * 1000;
@@ -943,7 +1082,7 @@ export class Session extends EventEmitter {
         this.destinationNumber = number;
 
         let options = {
-            mediaConstraints: { audio: true, video: false },
+            mediaConstraints: { audio: this._phone.audioConstraints, video: false },
             pcConfig: {
                 iceServers: [{ urls: ['stun:stun.l.google.com:19302'] }],
             },
@@ -1140,7 +1279,7 @@ export class Session extends EventEmitter {
                         self.log.info(`Answer call timeout after ${self._answerCallTimeout} seconds`);
                         try {
                             self.hangup();
-                        } catch (e) {
+                        } catch {
                             self.log.info('No active session, ignoring answer call timeout');
                         }
                     }, self._answerCallTimeout * 1000);
@@ -1297,7 +1436,7 @@ export class Session extends EventEmitter {
      */
     answer(metaInfo = null) {
         let options = {
-            mediaConstraints: { audio: true, video: false },
+            mediaConstraints: { audio: this._phone.audioConstraints, video: false },
             pcConfig: {
                 iceServers: [{ urls: ['stun:stun.l.google.com:19302'] }],
             },

package/docs/requestor.js.html

@@ -1,10 +1,10 @@
 <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: requestor.js</title><!--[if lt IE 9]>
       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="EventClient.html">EventClient</a></div><div class="sidebar-section-children"><a href="EventServiceNotConnected.html">EventServiceNotConnected</a></div><div class="sidebar-section-children"><a href="InvalidMediaDevice.html">InvalidMediaDevice</a></div><div class="sidebar-section-children"><a href="InvalidOptions.html">InvalidOptions</a></div><div class="sidebar-section-children"><a href="InvalidParameter.html">InvalidParameter</a></div><div class="sidebar-section-children"><a href="LogHandler.html">LogHandler</a></div><div class="sidebar-section-children"><a href="MediaNotPrepared.html">MediaNotPrepared</a></div><div class="sidebar-section-children"><a href="NoActiveSession.html">NoActiveSession</a></div><div class="sidebar-section-children"><a href="NotAllowed.html">NotAllowed</a></div><div class="sidebar-section-children"><a href="NotReady.html">NotReady</a></div><div class="sidebar-section-children"><a href="Phone.html">Phone</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Requestor.html">Requestor</a></div><div class="sidebar-section-children"><a href="Session.html">Session</a></div><div class="sidebar-section-children"><a href="UnableToConnect.html">UnableToConnect</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-events"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#event:callDataInfo">callDataInfo</a></div><div class="sidebar-section-children"><a href="global.html#event:callDurationUpdate">callDurationUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:callEnded">callEnded</a></div><div class="sidebar-section-children"><a href="global.html#event:callQualityReportUpdate">callQualityReportUpdate</a></div><div class="sidebar-section-children"><a href="global.html#event:connectionStateChange">connectionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:holdStateChange">holdStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:incomingCall">incomingCall</a></div><div class="sidebar-section-children"><a href="global.html#event:muteStateChange">muteStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:recordingStateChange">recordingStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionCreated">sessionCreated</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionRemoved">sessionRemoved</a></div><div class="sidebar-section-children"><a href="global.html#event:sessionStateChange">sessionStateChange</a></div><div class="sidebar-section-children"><a href="global.html#event:whisperModeChange">whisperModeChange</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#CALL_DIRECTION">CALL_DIRECTION</a></div><div class="sidebar-section-children"><a href="global.html#CALL_DISPOSITION">CALL_DISPOSITION</a></div><div class="sidebar-section-children"><a href="global.html#CONNECTION_STATE">CONNECTION_STATE</a></div><div class="sidebar-section-children"><a href="global.html#LOGLVL">LOGLVL</a></div><div class="sidebar-section-children"><a href="global.html#SESSION_STATE">SESSION_STATE</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">requestor.js</h1></header><article><pre class="prettyprint source lang-js"><code>import EventEmitter from "events";
-import * as Logger from "./logger";
-import * as Exceptions from "./exceptions";
-import { createUUID } from "./tools";
-import { NotAllowed } from "./exceptions";
+import * as Logger from "./logger.js";
+import * as Exceptions from "./exceptions.js";
+import { createUUID } from "./tools.js";
+import { NotAllowed } from "./exceptions.js";
 
 // Request timeout after 10 sec
 const REQUEST_TIMEOUT = 10000;
@@ -78,13 +78,13 @@ export class Requestor extends EventEmitter {
         let msg;
         try {
             msg = JSON.parse(message);
-        } catch (err) {
+        } catch {
             this.log.warning("Unable to parse message: " + message);
             return;
         }
 
         // Validate msg fields
-        if (!msg.hasOwnProperty("type") || !msg.hasOwnProperty("id")) {
+        if (!Object.hasOwn(msg, "type") || !Object.hasOwn(msg, "id")) {
             this.log.warning(`Invalid message received: ${msg} - missing type or id`);
             return;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telegenta/webclient",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "type": "module",
   "description": "Webphone and event client library",
   "main": "dist/telegenta.js",
@@ -9,11 +9,18 @@
     "watch-docs": "rimraf docs && watch 'npm run build-docs'",
     "build-docs": "rimraf docs && npx jsdoc -c jsdoc.conf.json",
     "deploy-docs": "aws s3 cp docs/ s3://www.telegenta.com/docs/client-lib/$npm_package_version --recursive --profile telegenta && aws cloudfront --profile telegenta create-invalidation --distribution-id E1A9LQ3WGY7RF9 --paths /docs/*",
-    "test": "node --test",
+    "test": "node --test test/*.test.js",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "deploy-demos": "aws s3 cp demos/ s3://www.telegenta.com/demos/ --recursive --profile telegenta && aws cloudfront --profile telegenta create-invalidation --distribution-id E1A9LQ3WGY7RF9 --paths /demos/* ",
     "build": "rimraf dist && rollup -c",
     "dev": "rollup -c -w"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/akantodevs/telegenta.git",
+    "directory": "client-lib"
+  },
   "author": "Allan Kristensen",
   "license": "MIT",
   "dependencies": {
@@ -22,12 +29,14 @@
     "jssip": "^3.10.1"
   },
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^0.4.4",
     "clean-jsdoc-theme": "^4.3.0",
-    "eslint": "^4.19.1",
+    "eslint": "^10.9.1",
+    "globals": "^17.11.0",
     "jsdoc": "^4.0.5",
     "rimraf": "^6.1.2",
     "rollup": "^2.79.2"