@telegenta/webclient 3.0.1 → 3.1.1

package/demos/calldata_available.html

@@ -45,7 +45,7 @@
         eventClient = new Telegenta.EventClient(logger);
 
         // Connect to event server
-        eventClient.connect('wss://api.telegenta.com/es/').then(function () {
+        eventClient.connect('wss://esvc.telegenta.com/').then(function () {
             console.info(`Connected to server`);
         }, function (reason) {
             console.error(`Unable to connect to event service: ${reason}`);

package/demos/event_client.html

@@ -53,7 +53,7 @@
         let eventClient;
         let subscriptionId = null;
         const API_URL = 'https://api.telegenta.com/api';
-        const EVENT_CLIENT_URL = 'wss://api.telegenta.com/es/';
+        const EVENT_CLIENT_URL = 'wss://esvc.telegenta.com/';
 
         // Start when DOM is ready
         window.onload = function () {

package/dist/telegenta.js

@@ -168,10 +168,11 @@ class InvalidParameter extends Error {
 
 /**
  * Exception raised if trying to perform actions that require active session
+ * @property message - Error message
  */
 class NoActiveSession extends Error {
-    constructor() {
-        super();
+    constructor(message) {
+        super(message);
         this.name = 'NoActiveSession';
     }
 }
@@ -291,6 +292,43 @@ function browserIsEdge() {
     return (navigator.userAgent.indexOf("Edge") !== -1)
 }
 
+// SIP header names are RFC 3261 tokens
+const HEADER_NAME_RE = /^[A-Za-z0-9\-.!%*_+`'~]+$/;
+
+const HTML_ENTITIES = {
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    "'": '&#39;',
+    '\r': '&#13;',
+    '\n': '&#10;',
+};
+
+// Build custom SIP header lines from a { name: value } map.
+// Names must be tokens - a bad one is always a programming error, so it throws.
+// Values are HTML encoded rather than rejected: that strips the CR/LF which
+// would otherwise let a value inject further headers, while still letting
+// punctuation through.
+function buildCustomHeaders(setHeader) {
+    if (!setHeader) {
+        return [];
+    }
+
+    if (typeof setHeader !== 'object' || Array.isArray(setHeader)) {
+        throw new TypeError(`Invalid setHeader argument: expected an object, got ${typeof setHeader}`);
+    }
+
+    return Object.entries(setHeader).map(([name, value]) => {
+        if (!HEADER_NAME_RE.test(name)) {
+            throw new TypeError(`Invalid SIP header name: "${name}"`);
+        }
+        // Single pass, so an encoded '&' is not encoded again.
+        const encoded = String(value).replace(/[&<>"'\r\n]/g, (c) => HTML_ENTITIES[c]);
+        return `${name}: ${encoded}`;
+    });
+}
+
 // Request timeout after 10 sec
 const REQUEST_TIMEOUT = 10000;
 
@@ -522,7 +560,7 @@ class Requestor extends EventEmitter {
 // Keep alive in seconds
 const PING_INTERVAL = 50;
 
-const ES_DEFAULT_SERVER_URL = 'wss://api.telegenta.com/es/';
+const ES_DEFAULT_SERVER_URL = 'wss://esvc.telegenta.com/';
 
 // Starting retry interval
 const RETRY_INTERVAL_START = 1 + Math.random();
@@ -1504,7 +1542,7 @@ function camelcaseKeys(input, options) {
 
 const options = {
     wssServer: 'wss://api.telegenta.com/sip/',
-    eventServer: 'wss://api.telegenta.com/es/',
+    eventServer: 'wss://esvc.telegenta.com/',
     provisionToken: null,
     authorizationUsername: null,
     password: null,
@@ -1913,9 +1951,11 @@ class Phone extends EventEmitter {
      * @param {number} [params.answerCallTimeout=0] Hangup call with NO ANSWER if call is not picked up before specified interval (seconds). If 0, timeout is disabled.
      * @param {number} [params.maximumCallCost] Maximum call cost (in customer currency) allowed for call. The call will automatically be stopped when the specified cost has been reached. Setting this to 0 disables checking for maximum cost.
      * @param {string} [params.metaInfo] Add meta info to call, which will be available in server events and inside call complete webhook (max 256 chars)
+     * @param {object} [params.setHeader] Custom SIP headers to add to the INVITE, as {name: value}.
      * @return {Session} object for call
      * @throws NotReady - If phone is not ready to call
      * @throws NotAllowed - If there are calls currently connecting
+     * @throws InvalidParameter - If setHeader contains an invalid header name or container
      *
      */
     call(number, params = {}) {
@@ -1940,6 +1980,7 @@ class Phone extends EventEmitter {
                 explicitCallerId: null,
                 explicitShortCallerId: null,
                 metaInfo: null,
+                setHeader: null,
                 _isListenCall: false,
             },
             params,
@@ -2495,6 +2536,23 @@ class Session extends EventEmitter {
             }
         }
 
+        // Custom headers last, so they cannot displace the built-in ones.
+        // Must be before _UA.call() below: jssip clones extraHeaders synchronously
+        // inside connect(), so anything pushed after that call never reaches the INVITE.
+        let customHeaders;
+        try {
+            customHeaders = buildCustomHeaders(callParams.setHeader);
+        } catch (error) {
+            if (error instanceof TypeError) {
+                throw new InvalidParameter(error.message);
+            }
+            throw error;
+        }
+        for (const header of customHeaders) {
+            this.log.debug('Adding custom header: ' + header);
+            options.extraHeaders.push(header);
+        }
+
         // Prepare invite uri
         const uri = 'sip:' + number + '@telegenta.com';
 
@@ -2867,6 +2925,30 @@ class Session extends EventEmitter {
         }
     }
 
+    /**
+     * Raw WebRTC statistics for this session's peer connection.
+     *
+     * Returns the browser's own `RTCStatsReport` untouched, so callers can read
+     * any statistic the browser exposes - RTP packet and byte counters, the
+     * DTLS/ICE transport state, codec and candidate-pair details.
+     *
+     * @returns {Promise<RTCStatsReport>} The peer connection's statistics
+     * @throws NoActiveSession - If the session has no established peer connection
+     * (thrown synchronously, before the promise is created)
+     *
+     * @example
+     * const report = await session.getRTCStats();
+     * for (const stat of report.values()) {
+     *   if (stat.type === 'inbound-rtp') console.log(stat.packetsReceived);
+     * }
+     */
+    getRTCStats() {
+        if (!this._webRTCSession || !this._webRTCSession.connection) {
+            throw new NoActiveSession('no peer connection for this session');
+        }
+        return this._webRTCSession.connection.getStats();
+    }
+
     // RECORDING
     /**
      * Start recording
@@ -3660,4 +3742,4 @@ class Session extends EventEmitter {
     }
 }
 
-export { EventClient, EventServiceNotConnected, InvalidMediaDevice, InvalidOptions, InvalidParameter, LOGLVL$1 as LOGLVL, LogHandler, MediaNotPrepared, NoActiveSession, NotAllowed, NotReady, Phone, Request, Requestor, Session, UnableToConnect, browserIsChrome, browserIsEdge, browserIsFirefox, browserIsOpera, browserIsSafari, compareObjects, createDurationString, createUUID };
+export { EventClient, EventServiceNotConnected, InvalidMediaDevice, InvalidOptions, InvalidParameter, LOGLVL$1 as LOGLVL, LogHandler, MediaNotPrepared, NoActiveSession, NotAllowed, NotReady, Phone, Request, Requestor, Session, UnableToConnect, browserIsChrome, browserIsEdge, browserIsFirefox, browserIsOpera, browserIsSafari, buildCustomHeaders, compareObjects, createDurationString, createUUID };