livekit-client 1.15.1 → 1.15.3

package/dist/livekit-client.esm.mjs

@@ -324,7 +324,6 @@ function setLogExtension(extension) {
   };
   livekitLogger.setLevel(livekitLogger.getLevel()); // Be sure to call setLevel method in order to apply plugin
 }
-
 loglevelExports.getLogger('lk-e2ee');
 
 // Copyright 2021-2023 Buf Technologies, Inc.
@@ -2113,7 +2112,6 @@ function makeBinaryFormatProto3() {
           if (oneof.case !== localName) {
             continue; // field is not selected, skip
           }
-
           value = oneof.value;
         } else {
           value = message[localName];
@@ -2660,7 +2658,6 @@ function writeEnum(type, value, emitIntrinsicDefault, enumAsInteger) {
   const val = type.findNumber(value);
   return (_a = val === null || val === void 0 ? void 0 : val.name) !== null && _a !== void 0 ? _a : value; // if we don't know the enum value, just return the number
 }
-
 function writeScalar(type, value, emitIntrinsicDefault) {
   if (value === undefined) {
     return undefined;
@@ -2738,7 +2735,6 @@ function makeJsonFormatProto3() {
               assert(val !== undefined);
               jsonObj[entryKey.toString()] = val; // JSON standard allows only (double quoted) string as property key
             }
-
             break;
           case "message":
             for (const [entryKey, entryValue] of Object.entries(value)) {
@@ -2754,7 +2750,6 @@ function makeJsonFormatProto3() {
               assert(val !== undefined);
               jsonObj[entryKey.toString()] = val; // JSON standard allows only (double quoted) string as property key
             }
-
             break;
         }
         return options.emitDefaultValues || Object.keys(jsonObj).length > 0 ? jsonObj : undefined;
@@ -6245,7 +6240,6 @@ EventEmitter.prototype.emit = function emit(type) {
     err.context = er;
     throw err; // Unhandled 'error' event
   }
-
   var handler = events[type];
   if (handler === undefined) return false;
   if (typeof handler === 'function') {
@@ -6878,7 +6872,6 @@ function shimGetUserMedia$2(window, browserDetails) {
             if (!dev && devices.length && matches.includes('back')) {
               dev = devices[devices.length - 1]; // more likely the back cam
             }
-
             if (dev) {
               constraints.video.deviceId = face.exact ? {
                 exact: dev.deviceId
@@ -7112,7 +7105,6 @@ function shimGetSendersWithDtmf(window) {
         this._senders = this._senders || [];
         return this._senders.slice(); // return a copy of the internal state.
       };
-
       const origAddTrack = window.RTCPeerConnection.prototype.addTrack;
       window.RTCPeerConnection.prototype.addTrack = function addTrack(track, stream) {
         let sender = origAddTrack.apply(this, arguments);
@@ -7736,7 +7728,6 @@ function shimPeerConnection(window, browserDetails) {
   if (typeof window !== 'object' || !(window.RTCPeerConnection || window.mozRTCPeerConnection)) {
     return; // probably media.peerconnection.enabled=false in about:config
   }
-
   if (!window.RTCPeerConnection && window.mozRTCPeerConnection) {
     // very basic support for old versions.
     window.RTCPeerConnection = window.mozRTCPeerConnection;
@@ -8475,7 +8466,6 @@ var sdp$1 = {exports: {}};
     const parsed = {
       payloadType: parseInt(parts.shift(), 10) // was: id
     };
-
     parts = parts[0].split('/');
     parsed.name = parts[0];
     parsed.clockRate = parseInt(parts[1], 10); // was: clockrate
@@ -9013,7 +9003,6 @@ var sdp$1 = {exports: {}};
         // FIXME: What should happen here?
       }
     }
-
     if (sessionpart) {
       return SDPUtils.getDirection(sessionpart);
     }
@@ -9062,7 +9051,6 @@ var sdp$1 = {exports: {}};
       }
       // TODO: check the modifier a bit more.
     }
-
     return true;
   };
 
@@ -10577,7 +10565,7 @@ function getMatch(exp, ua) {
   return match && match.length >= id && match[id] || '';
 }
 
-var version$1 = "1.15.1";
+var version$1 = "1.15.3";
 
 const version = version$1;
 const protocolVersion = 10;
@@ -13495,6 +13483,10 @@ function supportsAV1() {
   if (!('getCapabilities' in RTCRtpSender)) {
     return false;
   }
+  if (isSafari()) {
+    // Safari 17 on iPhone14 reports AV1 capability, but does not actually support it
+    return false;
+  }
   const capabilities = RTCRtpSender.getCapabilities('video');
   let hasAV1 = false;
   if (capabilities) {
@@ -13516,6 +13508,13 @@ function supportsVP9() {
     // https://bugzilla.mozilla.org/show_bug.cgi?id=1633876
     return false;
   }
+  if (isSafari()) {
+    const browser = getBrowser();
+    if ((browser === null || browser === void 0 ? void 0 : browser.version) && compareVersions(browser.version, '16') < 0) {
+      // Safari 16 and below does not support VP9
+      return false;
+    }
+  }
   const capabilities = RTCRtpSender.getCapabilities('video');
   let hasVP9 = false;
   if (capabilities) {
@@ -14733,12 +14732,27 @@ function canPassThroughQueue(req) {
   });
   return canPass;
 }
+var SignalConnectionState;
+(function (SignalConnectionState) {
+  SignalConnectionState[SignalConnectionState["CONNECTING"] = 0] = "CONNECTING";
+  SignalConnectionState[SignalConnectionState["CONNECTED"] = 1] = "CONNECTED";
+  SignalConnectionState[SignalConnectionState["RECONNECTING"] = 2] = "RECONNECTING";
+  SignalConnectionState[SignalConnectionState["DISCONNECTING"] = 3] = "DISCONNECTING";
+  SignalConnectionState[SignalConnectionState["DISCONNECTED"] = 4] = "DISCONNECTED";
+})(SignalConnectionState || (SignalConnectionState = {}));
 /** @internal */
 class SignalClient {
+  get currentState() {
+    return this.state;
+  }
+  get isDisconnected() {
+    return this.state === SignalConnectionState.DISCONNECTING || this.state === SignalConnectionState.DISCONNECTED;
+  }
   constructor() {
     let useJSON = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     /** signal rtt in milliseconds */
     this.rtt = 0;
+    this.state = SignalConnectionState.DISCONNECTED;
     /** @internal */
     this.resetCallbacks = () => {
       this.onAnswer = undefined;
@@ -14753,18 +14767,18 @@ class SignalClient {
       this.onTrickle = undefined;
       this.onClose = undefined;
     };
-    this.isConnected = false;
-    this.isReconnecting = false;
     this.useJSON = useJSON;
     this.requestQueue = new AsyncQueue();
     this.queuedRequests = [];
     this.closingLock = new Mutex();
+    this.connectionLock = new Mutex();
+    this.state = SignalConnectionState.DISCONNECTED;
   }
   join(url, token, opts, abortSignal) {
     return __awaiter(this, void 0, void 0, function* () {
       // during a full reconnect, we'd want to start the sequence even if currently
       // connected
-      this.isConnected = false;
+      this.state = SignalConnectionState.CONNECTING;
       this.options = opts;
       const res = yield this.connect(url, token, opts, abortSignal);
       return res;
@@ -14776,7 +14790,7 @@ class SignalClient {
         livekitLogger.warn('attempted to reconnect without signal options being set, ignoring');
         return;
       }
-      this.isReconnecting = true;
+      this.state = SignalConnectionState.RECONNECTING;
       // clear ping interval and restart it once reconnected
       this.clearPingInterval();
       const res = yield this.connect(url, token, Object.assign(Object.assign({}, this.options), {
@@ -14796,114 +14810,118 @@ class SignalClient {
     const clientInfo = getClientInfo();
     const params = createConnectionParams(token, clientInfo, opts);
     return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-      const abortHandler = () => __awaiter(this, void 0, void 0, function* () {
-        this.close();
-        clearTimeout(wsTimeout);
-        reject(new ConnectionError('room connection has been cancelled (signal)'));
-      });
-      const wsTimeout = setTimeout(() => {
-        this.close();
-        reject(new ConnectionError('room connection has timed out (signal)'));
-      }, opts.websocketTimeout);
-      if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
-        abortHandler();
-      }
-      abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.addEventListener('abort', abortHandler);
-      livekitLogger.debug("connecting to ".concat(url + params));
-      if (this.ws) {
-        yield this.close();
-      }
-      this.ws = new WebSocket(url + params);
-      this.ws.binaryType = 'arraybuffer';
-      this.ws.onopen = () => {
-        clearTimeout(wsTimeout);
-      };
-      this.ws.onerror = ev => __awaiter(this, void 0, void 0, function* () {
-        if (!this.isConnected) {
+      const unlock = yield this.connectionLock.lock();
+      try {
+        const abortHandler = () => __awaiter(this, void 0, void 0, function* () {
+          this.close();
           clearTimeout(wsTimeout);
-          try {
-            const resp = yield fetch("http".concat(url.substring(2), "/validate").concat(params));
-            if (resp.status.toFixed(0).startsWith('4')) {
-              const msg = yield resp.text();
-              reject(new ConnectionError(msg, 0 /* ConnectionErrorReason.NotAllowed */, resp.status));
-            } else {
-              reject(new ConnectionError('Internal error', 2 /* ConnectionErrorReason.InternalError */, resp.status));
-            }
-          } catch (e) {
-            reject(new ConnectionError('server was not reachable', 1 /* ConnectionErrorReason.ServerUnreachable */));
-          }
-
-          return;
+          reject(new ConnectionError('room connection has been cancelled (signal)'));
+        });
+        const wsTimeout = setTimeout(() => {
+          this.close();
+          reject(new ConnectionError('room connection has timed out (signal)'));
+        }, opts.websocketTimeout);
+        if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+          abortHandler();
         }
-        // other errors, handle
-        this.handleWSError(ev);
-      });
-      this.ws.onmessage = ev => __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c, _d;
-        // not considered connected until JoinResponse is received
-        let resp;
-        if (typeof ev.data === 'string') {
-          const json = JSON.parse(ev.data);
-          resp = SignalResponse.fromJson(json);
-        } else if (ev.data instanceof ArrayBuffer) {
-          resp = SignalResponse.fromBinary(new Uint8Array(ev.data));
-        } else {
-          livekitLogger.error("could not decode websocket message: ".concat(typeof ev.data));
-          return;
+        abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.addEventListener('abort', abortHandler);
+        livekitLogger.debug("connecting to ".concat(url + params));
+        if (this.ws) {
+          yield this.close();
         }
-        if (!this.isConnected) {
-          let shouldProcessMessage = false;
-          // handle join message only
-          if (((_a = resp.message) === null || _a === void 0 ? void 0 : _a.case) === 'join') {
-            this.isConnected = true;
-            abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.removeEventListener('abort', abortHandler);
-            this.pingTimeoutDuration = resp.message.value.pingTimeout;
-            this.pingIntervalDuration = resp.message.value.pingInterval;
-            if (this.pingTimeoutDuration && this.pingTimeoutDuration > 0) {
-              livekitLogger.debug('ping config', {
-                timeout: this.pingTimeoutDuration,
-                interval: this.pingIntervalDuration
-              });
+        this.ws = new WebSocket(url + params);
+        this.ws.binaryType = 'arraybuffer';
+        this.ws.onopen = () => {
+          clearTimeout(wsTimeout);
+        };
+        this.ws.onerror = ev => __awaiter(this, void 0, void 0, function* () {
+          if (this.state !== SignalConnectionState.CONNECTED) {
+            clearTimeout(wsTimeout);
+            try {
+              const resp = yield fetch("http".concat(url.substring(2), "/validate").concat(params));
+              if (resp.status.toFixed(0).startsWith('4')) {
+                const msg = yield resp.text();
+                reject(new ConnectionError(msg, 0 /* ConnectionErrorReason.NotAllowed */, resp.status));
+              } else {
+                reject(new ConnectionError('Internal error', 2 /* ConnectionErrorReason.InternalError */, resp.status));
+              }
+            } catch (e) {
+              reject(new ConnectionError('server was not reachable', 1 /* ConnectionErrorReason.ServerUnreachable */));
+            }
+            return;
+          }
+          // other errors, handle
+          this.handleWSError(ev);
+        });
+        this.ws.onmessage = ev => __awaiter(this, void 0, void 0, function* () {
+          var _a, _b, _c, _d;
+          // not considered connected until JoinResponse is received
+          let resp;
+          if (typeof ev.data === 'string') {
+            const json = JSON.parse(ev.data);
+            resp = SignalResponse.fromJson(json);
+          } else if (ev.data instanceof ArrayBuffer) {
+            resp = SignalResponse.fromBinary(new Uint8Array(ev.data));
+          } else {
+            livekitLogger.error("could not decode websocket message: ".concat(typeof ev.data));
+            return;
+          }
+          if (this.state !== SignalConnectionState.CONNECTED) {
+            let shouldProcessMessage = false;
+            // handle join message only
+            if (((_a = resp.message) === null || _a === void 0 ? void 0 : _a.case) === 'join') {
+              this.state = SignalConnectionState.CONNECTED;
+              abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.removeEventListener('abort', abortHandler);
+              this.pingTimeoutDuration = resp.message.value.pingTimeout;
+              this.pingIntervalDuration = resp.message.value.pingInterval;
+              if (this.pingTimeoutDuration && this.pingTimeoutDuration > 0) {
+                livekitLogger.debug('ping config', {
+                  timeout: this.pingTimeoutDuration,
+                  interval: this.pingIntervalDuration
+                });
+                this.startPingInterval();
+              }
+              resolve(resp.message.value);
+            } else if (this.state === SignalConnectionState.RECONNECTING) {
+              // in reconnecting, any message received means signal reconnected
+              this.state = SignalConnectionState.CONNECTED;
+              abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.removeEventListener('abort', abortHandler);
               this.startPingInterval();
+              if (((_b = resp.message) === null || _b === void 0 ? void 0 : _b.case) === 'reconnect') {
+                resolve((_c = resp.message) === null || _c === void 0 ? void 0 : _c.value);
+              } else {
+                resolve();
+                shouldProcessMessage = true;
+              }
+            } else if (!opts.reconnect) {
+              // non-reconnect case, should receive join response first
+              reject(new ConnectionError("did not receive join response, got ".concat((_d = resp.message) === null || _d === void 0 ? void 0 : _d.case, " instead")));
             }
-            resolve(resp.message.value);
-          } else if (opts.reconnect) {
-            // in reconnecting, any message received means signal reconnected
-            this.isConnected = true;
-            abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.removeEventListener('abort', abortHandler);
-            this.startPingInterval();
-            if (((_b = resp.message) === null || _b === void 0 ? void 0 : _b.case) === 'reconnect') {
-              resolve((_c = resp.message) === null || _c === void 0 ? void 0 : _c.value);
-            } else {
-              resolve();
-              shouldProcessMessage = true;
+            if (!shouldProcessMessage) {
+              return;
             }
-          } else if (!opts.reconnect) {
-            // non-reconnect case, should receive join response first
-            reject(new ConnectionError("did not receive join response, got ".concat((_d = resp.message) === null || _d === void 0 ? void 0 : _d.case, " instead")));
           }
-          if (!shouldProcessMessage) {
-            return;
+          if (this.signalLatency) {
+            yield sleep(this.signalLatency);
           }
-        }
-        if (this.signalLatency) {
-          yield sleep(this.signalLatency);
-        }
-        this.handleSignalResponse(resp);
-      });
-      this.ws.onclose = ev => {
-        livekitLogger.warn("websocket closed", {
-          ev
+          this.handleSignalResponse(resp);
         });
-        this.handleOnClose(ev.reason);
-      };
+        this.ws.onclose = ev => {
+          livekitLogger.warn("websocket closed", {
+            ev
+          });
+          this.handleOnClose(ev.reason);
+        };
+      } finally {
+        unlock();
+      }
     }));
   }
   close() {
     return __awaiter(this, void 0, void 0, function* () {
       const unlock = yield this.closingLock.lock();
       try {
-        this.isConnected = false;
+        this.state = SignalConnectionState.DISCONNECTING;
         if (this.ws) {
           this.ws.onmessage = null;
           this.ws.onopen = null;
@@ -14926,6 +14944,7 @@ class SignalClient {
           this.ws = undefined;
         }
       } finally {
+        this.state = SignalConnectionState.DISCONNECTED;
         this.clearPingInterval();
         unlock();
       }
@@ -15051,7 +15070,7 @@ class SignalClient {
       // capture all requests while reconnecting and put them in a queue
       // unless the request originates from the queue, then don't enqueue again
       const canQueue = !fromQueue && !canPassThroughQueue(message);
-      if (canQueue && this.isReconnecting) {
+      if (canQueue && this.state === SignalConnectionState.RECONNECTING) {
         this.queuedRequests.push(() => __awaiter(this, void 0, void 0, function* () {
           yield this.sendRequest(message, true);
         }));
@@ -15177,11 +15196,10 @@ class SignalClient {
         this.requestQueue.run(req);
       }
     }
-    this.isReconnecting = false;
   }
   handleOnClose(reason) {
     return __awaiter(this, void 0, void 0, function* () {
-      if (!this.isConnected) return;
+      if (this.state === SignalConnectionState.DISCONNECTED) return;
       const onCloseCallback = this.onClose;
       yield this.close();
       livekitLogger.debug("websocket connection closed: ".concat(reason));
@@ -15797,7 +15815,6 @@ var grammarExports = grammar$2.exports;
         });
         location = media[media.length - 1]; // point at latest media line
       }
-
       for (var j = 0; j < (grammar[type] || []).length; j += 1) {
         var obj = grammar[type][j];
         if (obj.reg.test(content)) {
@@ -15875,7 +15892,6 @@ var format = function (formatStr) {
     if (i >= len) {
       return x; // missing argument
     }
-
     var arg = args[i];
     i += 1;
     switch (x) {
@@ -15891,7 +15907,6 @@ var format = function (formatStr) {
   });
   // NB: we discard excess arguments - they are typically undefined from makeLine
 };
-
 var makeLine = function (type, obj, location) {
   var str = obj.format instanceof Function ? obj.format(obj.push ? location : location[obj.name]) : obj.format;
   var args = [type + '=' + str];
@@ -15921,11 +15936,9 @@ var writer$1 = function (session, opts) {
   if (session.version == null) {
     session.version = 0; // 'v=0' must be there (only defined version atm)
   }
-
   if (session.name == null) {
     session.name = ' '; // 's= ' must be there if no meaningful name set
   }
-
   session.media.forEach(function (mLine) {
     if (mLine.payloads == null) {
       mLine.payloads = '';
@@ -16782,7 +16795,6 @@ class PCTransportManager {
           CriticalTimers.clearTimeout(connectTimeout);
           reject(new ConnectionError('room connection has been cancelled', 3 /* ConnectionErrorReason.Cancelled */));
         };
-
         if (abortController === null || abortController === void 0 ? void 0 : abortController.signal.aborted) {
           abortHandler();
         }
@@ -16973,7 +16985,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     };
     this.handleBrowserOnLine = () => {
       // in case the engine is currently reconnecting, attempt a reconnect immediately after the browser state has changed to 'onLine'
-      if (this.client.isReconnecting) {
+      if (this.client.currentState === SignalConnectionState.RECONNECTING) {
         this.clearReconnectTimeout();
         this.attemptReconnect(ReconnectReason.RR_SIGNAL_DISCONNECTED);
       }
@@ -17504,7 +17516,7 @@ class RTCEngine extends eventsExports.EventEmitter {
         }
         livekitLogger.info("reconnecting, attempt: ".concat(this.reconnectAttempts));
         this.emit(EngineEvent.Restarting);
-        if (this.client.isConnected) {
+        if (!this.client.isDisconnected) {
           yield this.client.sendLeave();
         }
         yield this.cleanupPeerConnections();
@@ -21074,7 +21086,9 @@ class LocalParticipant extends Participant {
               codec: defaultVideoCodec
             };
           }
-          if (opts.backupCodec && videoCodec !== opts.backupCodec.codec) {
+          if (opts.backupCodec && videoCodec !== opts.backupCodec.codec &&
+          // TODO remove this once e2ee is supported for backup codecs
+          req.encryption === Encryption_Type.NONE) {
             // multi-codec simulcast requires dynacast
             if (!this.roomOptions.dynacast) {
               this.roomOptions.dynacast = true;
@@ -21182,6 +21196,10 @@ class LocalParticipant extends Participant {
   publishAdditionalCodecForTrack(track, videoCodec, options) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
+      // TODO remove once e2ee is supported for backup tracks
+      if (this.encryptionType !== Encryption_Type.NONE) {
+        return;
+      }
       // is it not published? if so skip
       let existingPublication;
       this.tracks.forEach(publication => {
@@ -21395,7 +21413,7 @@ class LocalParticipant extends Participant {
     let participantTrackPermissions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
     this.participantTrackPermissions = participantTrackPermissions;
     this.allParticipantsAllowedToSubscribe = allParticipantsAllowed;
-    if (this.engine.client.isConnected) {
+    if (!this.engine.client.isDisconnected) {
       this.updateTrackSubscriptionPermissions();
     }
   }
@@ -21707,7 +21725,7 @@ class Room extends eventsExports.EventEmitter {
             this.connectFuture = undefined;
           }
           // send leave
-          if ((_j = this.engine) === null || _j === void 0 ? void 0 : _j.client.isConnected) {
+          if (!((_j = this.engine) === null || _j === void 0 ? void 0 : _j.client.isDisconnected)) {
             yield this.engine.client.sendLeave();
           }
           // close engine (also closes client)