livekit-client 2.10.0 → 2.11.0

package/dist/livekit-client.esm.mjs

@@ -11027,6 +11027,7 @@ var EngineEvent;
   EngineEvent["LocalTrackSubscribed"] = "localTrackSubscribed";
   EngineEvent["Offline"] = "offline";
   EngineEvent["SignalRequestResponse"] = "signalRequestResponse";
+  EngineEvent["SignalConnected"] = "signalConnected";
 })(EngineEvent || (EngineEvent = {}));
 var TrackEvent;
 (function (TrackEvent) {
@@ -11185,7 +11186,7 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.10.0";
+var version$1 = "2.11.0";
 
 const version = version$1;
 const protocolVersion = 15;
@@ -12201,14 +12202,18 @@ function mergeDefaultOptions(options, audioDefaults, videoDefaults) {
   // use defaults
   if (clonedOptions.audio) {
     mergeObjectWithoutOverwriting(clonedOptions.audio, audioDefaults);
-    (_b = (_d = clonedOptions.audio).deviceId) !== null && _b !== void 0 ? _b : _d.deviceId = 'default';
+    (_b = (_d = clonedOptions.audio).deviceId) !== null && _b !== void 0 ? _b : _d.deviceId = {
+      ideal: 'default'
+    };
     if (audioProcessor || defaultAudioProcessor) {
       clonedOptions.audio.processor = audioProcessor !== null && audioProcessor !== void 0 ? audioProcessor : defaultAudioProcessor;
     }
   }
   if (clonedOptions.video) {
     mergeObjectWithoutOverwriting(clonedOptions.video, videoDefaults);
-    (_c = (_e = clonedOptions.video).deviceId) !== null && _c !== void 0 ? _c : _e.deviceId = 'default';
+    (_c = (_e = clonedOptions.video).deviceId) !== null && _c !== void 0 ? _c : _e.deviceId = {
+      ideal: 'default'
+    };
     if (videoProcessor || defaultVideoProcessor) {
       clonedOptions.video.processor = videoProcessor !== null && videoProcessor !== void 0 ? videoProcessor : defaultVideoProcessor;
     }
@@ -12242,10 +12247,14 @@ function constraintsForOptions(options) {
         }
       });
       constraints.video = videoOptions;
-      (_a = (_c = constraints.video).deviceId) !== null && _a !== void 0 ? _a : _c.deviceId = 'default';
+      (_a = (_c = constraints.video).deviceId) !== null && _a !== void 0 ? _a : _c.deviceId = {
+        ideal: 'default'
+      };
     } else {
       constraints.video = options.video ? {
-        deviceId: 'default'
+        deviceId: {
+          ideal: 'default'
+        }
       } : false;
     }
   } else {
@@ -12254,10 +12263,14 @@ function constraintsForOptions(options) {
   if (options.audio) {
     if (typeof options.audio === 'object') {
       constraints.audio = options.audio;
-      (_b = (_d = constraints.audio).deviceId) !== null && _b !== void 0 ? _b : _d.deviceId = 'default';
+      (_b = (_d = constraints.audio).deviceId) !== null && _b !== void 0 ? _b : _d.deviceId = {
+        ideal: 'default'
+      };
     } else {
       constraints.audio = {
-        deviceId: 'default'
+        deviceId: {
+          ideal: 'default'
+        }
       };
     }
   } else {
@@ -12862,7 +12875,9 @@ class DeviceManager {
             const permissionsToAcquire = {
               video: kind !== 'audioinput' && kind !== 'audiooutput',
               audio: kind !== 'videoinput' && {
-                deviceId: 'default'
+                deviceId: {
+                  ideal: 'default'
+                }
               }
             };
             const stream = yield navigator.mediaDevices.getUserMedia(permissionsToAcquire);
@@ -12961,15 +12976,12 @@ function createValidateUrl(rtcWsUrl) {
   const urlObj = new URL(toHttpUrl(rtcWsUrl));
   return appendUrlPath(urlObj, 'validate');
 }
-function ensureTrailingSlash(url) {
-  return url.endsWith('/') ? url : "".concat(url, "/");
+function ensureTrailingSlash(path) {
+  return path.endsWith('/') ? path : "".concat(path, "/");
 }
 function appendUrlPath(urlObj, path) {
-  const result = "".concat(urlObj.protocol, "//").concat(urlObj.host).concat(ensureTrailingSlash(urlObj.pathname)).concat(path);
-  if (urlObj.searchParams.size > 0) {
-    return "".concat(result, "?").concat(urlObj.searchParams.toString());
-  }
-  return result;
+  urlObj.pathname = "".concat(ensureTrailingSlash(urlObj.pathname)).concat(path);
+  return urlObj.toString();
 }
 
 const passThroughQueueSignals = ['syncState', 'trickle', 'offer', 'answer', 'simulate', 'leave'];
@@ -14959,14 +14971,18 @@ const publishDefaults = {
   backupCodec: true
 };
 const audioDefaults = {
-  deviceId: 'default',
+  deviceId: {
+    ideal: 'default'
+  },
   autoGainControl: true,
   echoCancellation: true,
   noiseSuppression: true,
   voiceIsolation: true
 };
 const videoDefaults = {
-  deviceId: 'default',
+  deviceId: {
+    ideal: 'default'
+  },
   resolution: VideoPresets.h720.resolution
 };
 const roomOptionDefaults = {
@@ -17360,6 +17376,10 @@ class RTCEngine extends eventsExports.EventEmitter {
           this.negotiate();
         }
         this.clientConfiguration = joinResponse.clientConfiguration;
+        // emit signal connected event after a short delay to allow for join response to be processed on room
+        setTimeout(() => {
+          this.emit(EngineEvent.SignalConnected);
+        }, 10);
         return joinResponse;
       } catch (e) {
         if (e instanceof ConnectionError) {
@@ -18553,6 +18573,7 @@ class BaseStreamWriter {
   }
 }
 class TextStreamWriter extends BaseStreamWriter {}
+class ByteStreamWriter extends BaseStreamWriter {}
 
 class RemoteTrack extends Track {
   constructor(mediaTrack, sid, kind, receiver, loggerOptions) {
@@ -20393,7 +20414,41 @@ class LocalParticipant extends Participant {
         if (opts.source) {
           track.source = opts.source;
         }
-        const publishPromise = _this2.publish(track, opts, isStereo);
+        const publishPromise = new Promise((resolve, reject) => __awaiter(_this2, void 0, void 0, function* () {
+          try {
+            if (this.engine.client.currentState !== SignalConnectionState.CONNECTED) {
+              this.log.debug('deferring track publication until signal is connected', Object.assign(Object.assign({}, this.logContext), {
+                track: getLogContextFromTrack(track)
+              }));
+              const onSignalConnected = () => __awaiter(this, void 0, void 0, function* () {
+                try {
+                  const publication = yield this.publish(track, opts, isStereo);
+                  resolve(publication);
+                } catch (e) {
+                  reject(e);
+                }
+              });
+              setTimeout(() => {
+                this.engine.off(EngineEvent.SignalConnected, onSignalConnected);
+                reject(new PublishTrackError('publishing rejected as engine not connected within timeout', 408));
+              }, 15000);
+              this.engine.once(EngineEvent.SignalConnected, onSignalConnected);
+              this.engine.on(EngineEvent.Closing, () => {
+                this.engine.off(EngineEvent.SignalConnected, onSignalConnected);
+                reject(new PublishTrackError('publishing rejected as engine closed', 499));
+              });
+            } else {
+              try {
+                const publication = yield this.publish(track, opts, isStereo);
+                resolve(publication);
+              } catch (e) {
+                reject(e);
+              }
+            }
+          } catch (e) {
+            reject(e);
+          }
+        }));
         _this2.pendingPublishPromises.set(track, publishPromise);
         try {
           const publication = yield publishPromise;
@@ -21090,23 +21145,57 @@ class LocalParticipant extends Participant {
   }
   _sendFile(streamId, file, options) {
     return __awaiter(this, void 0, void 0, function* () {
-      var _a, _b;
-      const totalLength = file.size;
-      const header = new DataStream_Header({
-        totalLength: numberToBigInt(totalLength),
-        mimeType: (_a = options === null || options === void 0 ? void 0 : options.mimeType) !== null && _a !== void 0 ? _a : file.type,
+      var _a;
+      const writer = yield this.streamBytes({
         streamId,
+        totalSize: file.size,
+        name: file.name,
+        mimeType: (_a = options === null || options === void 0 ? void 0 : options.mimeType) !== null && _a !== void 0 ? _a : file.type,
         topic: options === null || options === void 0 ? void 0 : options.topic,
-        encryptionType: options === null || options === void 0 ? void 0 : options.encryptionType,
+        destinationIdentities: options === null || options === void 0 ? void 0 : options.destinationIdentities
+      });
+      const reader = file.stream().getReader();
+      while (true) {
+        const {
+          done,
+          value
+        } = yield reader.read();
+        if (done) {
+          break;
+        }
+        yield writer.write(value);
+      }
+      yield writer.close();
+      return writer.info;
+    });
+  }
+  streamBytes(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+      var _a, _b, _c, _d, _e;
+      const streamId = (_a = options === null || options === void 0 ? void 0 : options.streamId) !== null && _a !== void 0 ? _a : crypto.randomUUID();
+      const destinationIdentities = options === null || options === void 0 ? void 0 : options.destinationIdentities;
+      const info = {
+        id: streamId,
+        mimeType: (_b = options === null || options === void 0 ? void 0 : options.mimeType) !== null && _b !== void 0 ? _b : 'application/octet-stream',
+        topic: (_c = options === null || options === void 0 ? void 0 : options.topic) !== null && _c !== void 0 ? _c : '',
+        timestamp: Date.now(),
+        attributes: options === null || options === void 0 ? void 0 : options.attributes,
+        size: options === null || options === void 0 ? void 0 : options.totalSize,
+        name: (_d = options === null || options === void 0 ? void 0 : options.name) !== null && _d !== void 0 ? _d : 'unknown'
+      };
+      const header = new DataStream_Header({
+        totalLength: numberToBigInt((_e = info.size) !== null && _e !== void 0 ? _e : 0),
+        mimeType: info.mimeType,
+        streamId,
+        topic: info.topic,
         timestamp: numberToBigInt(Date.now()),
         contentHeader: {
           case: 'byteHeader',
           value: new DataStream_ByteHeader({
-            name: file.name
+            name: info.name
           })
         }
       });
-      const destinationIdentities = options === null || options === void 0 ? void 0 : options.destinationIdentities;
       const packet = new DataPacket({
         destinationIdentities,
         value: {
@@ -21115,45 +21204,60 @@ class LocalParticipant extends Participant {
         }
       });
       yield this.engine.sendDataPacket(packet, DataPacket_Kind.RELIABLE);
-      function read(b) {
-        return new Promise(resolve => {
-          const fr = new FileReader();
-          fr.onload = () => {
-            resolve(new Uint8Array(fr.result));
-          };
-          fr.readAsArrayBuffer(b);
-        });
-      }
-      const totalChunks = Math.ceil(totalLength / STREAM_CHUNK_SIZE);
-      for (let i = 0; i < totalChunks; i++) {
-        const chunkData = yield read(file.slice(i * STREAM_CHUNK_SIZE, Math.min((i + 1) * STREAM_CHUNK_SIZE, totalLength)));
-        yield this.engine.waitForBufferStatusLow(DataPacket_Kind.RELIABLE);
-        const chunk = new DataStream_Chunk({
-          content: chunkData,
-          streamId,
-          chunkIndex: numberToBigInt(i)
-        });
-        const chunkPacket = new DataPacket({
-          destinationIdentities,
-          value: {
-            case: 'streamChunk',
-            value: chunk
-          }
-        });
-        yield this.engine.sendDataPacket(chunkPacket, DataPacket_Kind.RELIABLE);
-        (_b = options === null || options === void 0 ? void 0 : options.onProgress) === null || _b === void 0 ? void 0 : _b.call(options, (i + 1) / totalChunks);
-      }
-      const trailer = new DataStream_Trailer({
-        streamId
-      });
-      const trailerPacket = new DataPacket({
-        destinationIdentities,
-        value: {
-          case: 'streamTrailer',
-          value: trailer
+      let chunkId = 0;
+      const writeMutex = new _();
+      const engine = this.engine;
+      const log = this.log;
+      const writableStream = new WritableStream({
+        write(chunk) {
+          return __awaiter(this, void 0, void 0, function* () {
+            const unlock = yield writeMutex.lock();
+            let byteOffset = 0;
+            try {
+              while (byteOffset < chunk.byteLength) {
+                const subChunk = chunk.slice(byteOffset, byteOffset + STREAM_CHUNK_SIZE);
+                yield engine.waitForBufferStatusLow(DataPacket_Kind.RELIABLE);
+                const chunkPacket = new DataPacket({
+                  destinationIdentities,
+                  value: {
+                    case: 'streamChunk',
+                    value: new DataStream_Chunk({
+                      content: subChunk,
+                      streamId,
+                      chunkIndex: numberToBigInt(chunkId)
+                    })
+                  }
+                });
+                yield engine.sendDataPacket(chunkPacket, DataPacket_Kind.RELIABLE);
+                chunkId += 1;
+                byteOffset += subChunk.byteLength;
+              }
+            } finally {
+              unlock();
+            }
+          });
+        },
+        close() {
+          return __awaiter(this, void 0, void 0, function* () {
+            const trailer = new DataStream_Trailer({
+              streamId
+            });
+            const trailerPacket = new DataPacket({
+              destinationIdentities,
+              value: {
+                case: 'streamTrailer',
+                value: trailer
+              }
+            });
+            yield engine.sendDataPacket(trailerPacket, DataPacket_Kind.RELIABLE);
+          });
+        },
+        abort(err) {
+          log.error('Sink error:', err);
         }
       });
-      yield this.engine.sendDataPacket(trailerPacket, DataPacket_Kind.RELIABLE);
+      const byteWriter = new ByteStreamWriter(writableStream, info);
+      return byteWriter;
     });
   }
   /**
@@ -23169,7 +23273,7 @@ class Room extends eventsExports.EventEmitter {
   switchActiveDevice(kind_1, deviceId_1) {
     return __awaiter(this, arguments, void 0, function (kind, deviceId) {
       var _this3 = this;
-      let exact = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+      let exact = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
       return function* () {
         var _a, _b, _c, _d, _e, _f, _g;
         var _h;
@@ -24172,63 +24276,104 @@ function createLocalTracks(options) {
   return __awaiter(this, void 0, void 0, function* () {
     var _a, _b;
     // set default options to true
-    options !== null && options !== void 0 ? options : options = {};
-    (_a = options.audio) !== null && _a !== void 0 ? _a : options.audio = {
+    const internalOptions = Object.assign({}, options !== null && options !== void 0 ? options : {});
+    let attemptExactMatch = false;
+    let retryAudioOptions = options === null || options === void 0 ? void 0 : options.audio;
+    let retryVideoOptions = options === null || options === void 0 ? void 0 : options.video;
+    // if the user passes a device id as a string, we default to exact match
+    if (internalOptions.audio && typeof internalOptions.audio === 'object' && typeof internalOptions.audio.deviceId === 'string') {
+      const deviceId = internalOptions.audio.deviceId;
+      internalOptions.audio.deviceId = {
+        exact: deviceId
+      };
+      attemptExactMatch = true;
+      retryAudioOptions = Object.assign(Object.assign({}, internalOptions.audio), {
+        deviceId: {
+          ideal: deviceId
+        }
+      });
+    }
+    if (internalOptions.video && typeof internalOptions.video === 'object' && typeof internalOptions.video.deviceId === 'string') {
+      const deviceId = internalOptions.video.deviceId;
+      internalOptions.video.deviceId = {
+        exact: deviceId
+      };
+      attemptExactMatch = true;
+      retryVideoOptions = Object.assign(Object.assign({}, internalOptions.video), {
+        deviceId: {
+          ideal: deviceId
+        }
+      });
+    }
+    (_a = internalOptions.audio) !== null && _a !== void 0 ? _a : internalOptions.audio = {
       deviceId: 'default'
     };
-    (_b = options.video) !== null && _b !== void 0 ? _b : options.video = {
+    (_b = internalOptions.video) !== null && _b !== void 0 ? _b : internalOptions.video = {
       deviceId: 'default'
     };
     const {
       audioProcessor,
       videoProcessor
-    } = extractProcessorsFromOptions(options);
-    const opts = mergeDefaultOptions(options, audioDefaults, videoDefaults);
+    } = extractProcessorsFromOptions(internalOptions);
+    const opts = mergeDefaultOptions(internalOptions, audioDefaults, videoDefaults);
     const constraints = constraintsForOptions(opts);
     // Keep a reference to the promise on DeviceManager and await it in getLocalDevices()
     // works around iOS Safari Bug https://bugs.webkit.org/show_bug.cgi?id=179363
     const mediaPromise = navigator.mediaDevices.getUserMedia(constraints);
-    if (options.audio) {
+    if (internalOptions.audio) {
       DeviceManager.userMediaPromiseMap.set('audioinput', mediaPromise);
       mediaPromise.catch(() => DeviceManager.userMediaPromiseMap.delete('audioinput'));
     }
-    if (options.video) {
+    if (internalOptions.video) {
       DeviceManager.userMediaPromiseMap.set('videoinput', mediaPromise);
       mediaPromise.catch(() => DeviceManager.userMediaPromiseMap.delete('videoinput'));
     }
-    const stream = yield mediaPromise;
-    return Promise.all(stream.getTracks().map(mediaStreamTrack => __awaiter(this, void 0, void 0, function* () {
-      const isAudio = mediaStreamTrack.kind === 'audio';
-      isAudio ? opts.audio : opts.video;
-      let trackConstraints;
-      const conOrBool = isAudio ? constraints.audio : constraints.video;
-      if (typeof conOrBool !== 'boolean') {
-        trackConstraints = conOrBool;
-      }
-      // update the constraints with the device id the user gave permissions to in the permission prompt
-      // otherwise each track restart (e.g. mute - unmute) will try to initialize the device again -> causing additional permission prompts
-      const newDeviceId = mediaStreamTrack.getSettings().deviceId;
-      if ((trackConstraints === null || trackConstraints === void 0 ? void 0 : trackConstraints.deviceId) && unwrapConstraint(trackConstraints.deviceId) !== newDeviceId) {
-        trackConstraints.deviceId = newDeviceId;
-      } else if (!trackConstraints) {
-        trackConstraints = {
-          deviceId: newDeviceId
-        };
-      }
-      const track = mediaTrackToLocalTrack(mediaStreamTrack, trackConstraints);
-      if (track.kind === Track.Kind.Video) {
-        track.source = Track.Source.Camera;
-      } else if (track.kind === Track.Kind.Audio) {
-        track.source = Track.Source.Microphone;
-      }
-      track.mediaStream = stream;
-      if (isAudioTrack(track) && audioProcessor) {
-        yield track.setProcessor(audioProcessor);
-      } else if (isVideoTrack(track) && videoProcessor) {
-        yield track.setProcessor(videoProcessor);
+    try {
+      const stream = yield mediaPromise;
+      return yield Promise.all(stream.getTracks().map(mediaStreamTrack => __awaiter(this, void 0, void 0, function* () {
+        const isAudio = mediaStreamTrack.kind === 'audio';
+        let trackOptions = isAudio ? opts.audio : opts.video;
+        if (typeof trackOptions === 'boolean' || !trackOptions) {
+          trackOptions = {};
+        }
+        let trackConstraints;
+        const conOrBool = isAudio ? constraints.audio : constraints.video;
+        if (typeof conOrBool !== 'boolean') {
+          trackConstraints = conOrBool;
+        }
+        // update the constraints with the device id the user gave permissions to in the permission prompt
+        // otherwise each track restart (e.g. mute - unmute) will try to initialize the device again -> causing additional permission prompts
+        const newDeviceId = mediaStreamTrack.getSettings().deviceId;
+        if ((trackConstraints === null || trackConstraints === void 0 ? void 0 : trackConstraints.deviceId) && unwrapConstraint(trackConstraints.deviceId) !== newDeviceId) {
+          trackConstraints.deviceId = newDeviceId;
+        } else if (!trackConstraints) {
+          trackConstraints = {
+            deviceId: newDeviceId
+          };
+        }
+        const track = mediaTrackToLocalTrack(mediaStreamTrack, trackConstraints);
+        if (track.kind === Track.Kind.Video) {
+          track.source = Track.Source.Camera;
+        } else if (track.kind === Track.Kind.Audio) {
+          track.source = Track.Source.Microphone;
+        }
+        track.mediaStream = stream;
+        if (isAudioTrack(track) && audioProcessor) {
+          yield track.setProcessor(audioProcessor);
+        } else if (isVideoTrack(track) && videoProcessor) {
+          yield track.setProcessor(videoProcessor);
+        }
+        return track;
+      })));
+    } catch (e) {
+      if (!attemptExactMatch) {
+        throw e;
       }
-      return track;
-    })));
+      return createLocalTracks(Object.assign(Object.assign({}, options), {
+        audio: retryAudioOptions,
+        video: retryVideoOptions
+      }));
+    }
   });
 }
 /**