livekit-client 1.8.0 → 1.9.0

package/dist/ts4.2/src/room/track/LocalTrackPublication.d.ts

@@ -2,9 +2,9 @@ import type { TrackInfo } from '../../proto/livekit_models';
 import type LocalAudioTrack from './LocalAudioTrack';
 import type LocalTrack from './LocalTrack';
 import type LocalVideoTrack from './LocalVideoTrack';
-import type { TrackPublishOptions } from './options';
 import type { Track } from './Track';
 import { TrackPublication } from './TrackPublication';
+import type { TrackPublishOptions } from './options';
 export default class LocalTrackPublication extends TrackPublication {
     track?: LocalTrack;
     options?: TrackPublishOptions;

package/dist/ts4.2/src/room/track/RemoteAudioTrack.d.ts

@@ -1,6 +1,6 @@
 import { AudioReceiverStats } from '../stats';
-import type { AudioOutputOptions } from './options';
 import RemoteTrack from './RemoteTrack';
+import type { AudioOutputOptions } from './options';
 export default class RemoteAudioTrack extends RemoteTrack {
     private prevStats?;
     private elementVolume;

package/dist/ts4.2/src/room/types.d.ts

@@ -22,4 +22,5 @@ export type LiveKitReactNativeInfo = {
     platform: 'ios' | 'android' | 'windows' | 'macos' | 'web' | 'native';
     devicePixelRatio: number;
 };
+export type SimulationScenario = 'signal-reconnect' | 'speaker' | 'node-failure' | 'server-leave' | 'migration' | 'resume-reconnect' | 'force-tcp' | 'force-tls' | 'full-reconnect';
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -53,13 +53,14 @@
   "devDependencies": {
     "@babel/core": "7.21.4",
     "@babel/preset-env": "7.21.4",
-    "@changesets/changelog-github": "0.4.8",
     "@changesets/cli": "2.26.1",
+    "@livekit/changesets-changelog-github": "^0.0.4",
     "@rollup/plugin-babel": "6.0.3",
     "@rollup/plugin-commonjs": "24.1.0",
     "@rollup/plugin-json": "6.0.0",
     "@rollup/plugin-node-resolve": "15.0.2",
     "@rollup/plugin-terser": "^0.4.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/jest": "29.5.0",
     "@types/sdp-transform": "2.4.6",
     "@types/ua-parser-js": "0.7.36",
@@ -73,7 +74,7 @@
     "eslint-plugin-import": "2.27.5",
     "gh-pages": "5.0.0",
     "jest": "29.5.0",
-    "prettier": "2.8.7",
+    "prettier": "^2.8.8",
     "rollup": "3.20.2",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-filesize": "10.0.0",

package/src/api/SignalClient.ts

@@ -33,7 +33,7 @@ import {
 } from '../proto/livekit_rtc';
 import { ConnectionError, ConnectionErrorReason } from '../room/errors';
 import CriticalTimers from '../room/timers';
-import { getClientInfo, isReactNative, Mutex, sleep } from '../room/utils';
+import { Mutex, getClientInfo, isReactNative, sleep } from '../room/utils';
 
 // internal options
 interface ConnectOpts {
@@ -374,7 +374,7 @@ export class SignalClient {
   // answer a server-initiated offer
   sendAnswer(answer: RTCSessionDescriptionInit) {
     log.debug('sending answer');
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'answer',
       answer: toProtoSessionDescription(answer),
     });
@@ -382,7 +382,7 @@ export class SignalClient {
 
   sendIceCandidate(candidate: RTCIceCandidateInit, target: SignalTarget) {
     log.trace('sending ice candidate', candidate);
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'trickle',
       trickle: {
         candidateInit: JSON.stringify(candidate),
@@ -392,7 +392,7 @@ export class SignalClient {
   }
 
   sendMuteTrack(trackSid: string, muted: boolean) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'mute',
       mute: {
         sid: trackSid,
@@ -401,13 +401,23 @@ export class SignalClient {
     });
   }
 
-  sendAddTrack(req: AddTrackRequest): void {
-    this.sendRequest({
+  sendAddTrack(req: AddTrackRequest) {
+    return this.sendRequest({
       $case: 'addTrack',
       addTrack: AddTrackRequest.fromPartial(req),
     });
   }
 
+  sendUpdateLocalMetadata(metadata: string, name: string) {
+    return this.sendRequest({
+      $case: 'updateMetadata',
+      updateMetadata: {
+        metadata,
+        name,
+      },
+    });
+  }
+
   sendUpdateTrackSettings(settings: UpdateTrackSettings) {
     this.sendRequest({
       $case: 'trackSetting',
@@ -416,21 +426,21 @@ export class SignalClient {
   }
 
   sendUpdateSubscription(sub: UpdateSubscription) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'subscription',
       subscription: sub,
     });
   }
 
   sendSyncState(sync: SyncState) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'syncState',
       syncState: sync,
     });
   }
 
   sendUpdateVideoLayers(trackSid: string, layers: VideoLayer[]) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'updateLayers',
       updateLayers: {
         trackSid,
@@ -440,7 +450,7 @@ export class SignalClient {
   }
 
   sendUpdateSubscriptionPermissions(allParticipants: boolean, trackPermissions: TrackPermission[]) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'subscriptionPermission',
       subscriptionPermission: {
         allParticipants,
@@ -450,7 +460,7 @@ export class SignalClient {
   }
 
   sendSimulateScenario(scenario: SimulateScenario) {
-    this.sendRequest({
+    return this.sendRequest({
       $case: 'simulate',
       simulate: scenario,
     });
@@ -458,21 +468,23 @@ export class SignalClient {
 
   sendPing() {
     /** send both of ping and pingReq for compatibility to old and new server */
-    this.sendRequest({
-      $case: 'ping',
-      ping: Date.now(),
-    });
-    this.sendRequest({
-      $case: 'pingReq',
-      pingReq: {
-        timestamp: Date.now(),
-        rtt: this.rtt,
-      },
-    });
-  }
-
-  async sendLeave() {
-    await this.sendRequest({
+    return Promise.all([
+      this.sendRequest({
+        $case: 'ping',
+        ping: Date.now(),
+      }),
+      this.sendRequest({
+        $case: 'pingReq',
+        pingReq: {
+          timestamp: Date.now(),
+          rtt: this.rtt,
+        },
+      }),
+    ]);
+  }
+
+  sendLeave() {
+    return this.sendRequest({
       $case: 'leave',
       leave: {
         canReconnect: false,

package/src/connectionHelper/ConnectionCheck.ts

@@ -1,7 +1,6 @@
 import EventEmitter from 'events';
 import type TypedEmitter from 'typed-emitter';
-
-import { Checker, CheckInfo, CheckStatus, InstantiableCheck } from './checks/Checker';
+import { CheckInfo, CheckStatus, Checker, InstantiableCheck } from './checks/Checker';
 import { PublishAudioCheck } from './checks/publishAudio';
 import { PublishVideoCheck } from './checks/publishVideo';
 import { ReconnectCheck } from './checks/reconnect';

package/src/connectionHelper/checks/Checker.ts

@@ -1,8 +1,8 @@
 import { EventEmitter } from 'events';
 import type TypedEmitter from 'typed-emitter';
 import type { RoomConnectOptions, RoomOptions } from '../../options';
-import Room, { ConnectionState } from '../../room/Room';
 import type RTCEngine from '../../room/RTCEngine';
+import Room, { ConnectionState } from '../../room/Room';
 
 type LogMessage = {
   level: 'info' | 'warning' | 'error';

package/src/connectionHelper/checks/reconnect.ts

@@ -1,5 +1,5 @@
-import { RoomEvent } from '../../room/events';
 import { ConnectionState } from '../../room/Room';
+import { RoomEvent } from '../../room/events';
 import { Checker } from './Checker';
 
 export class ReconnectCheck extends Checker {

package/src/index.ts

@@ -1,11 +1,12 @@
 import { LogLevel, setLogExtension, setLogLevel } from './logger';
 import { DataPacket_Kind, DisconnectReason, VideoQuality } from './proto/livekit_models';
 import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
+import Room, { ConnectionState, RoomState } from './room/Room';
 import LocalParticipant from './room/participant/LocalParticipant';
 import Participant, { ConnectionQuality } from './room/participant/Participant';
 import type { ParticipantTrackPermission } from './room/participant/ParticipantTrackPermission';
 import RemoteParticipant from './room/participant/RemoteParticipant';
-import Room, { ConnectionState, RoomState } from './room/Room';
+import CriticalTimers from './room/timers';
 import LocalAudioTrack from './room/track/LocalAudioTrack';
 import LocalTrack from './room/track/LocalTrack';
 import LocalTrackPublication from './room/track/LocalTrackPublication';
@@ -13,27 +14,24 @@ import LocalVideoTrack from './room/track/LocalVideoTrack';
 import RemoteAudioTrack from './room/track/RemoteAudioTrack';
 import RemoteTrack from './room/track/RemoteTrack';
 import RemoteTrackPublication from './room/track/RemoteTrackPublication';
-import RemoteVideoTrack from './room/track/RemoteVideoTrack';
-import type { ElementInfo } from './room/track/RemoteVideoTrack';
+import RemoteVideoTrack, { type ElementInfo } from './room/track/RemoteVideoTrack';
 import { TrackPublication } from './room/track/TrackPublication';
-import CriticalTimers from './room/timers';
+import type { LiveKitReactNativeInfo } from './room/types';
 import {
+  type AudioAnalyserOptions,
+  createAudioAnalyser,
   getEmptyAudioStreamTrack,
   getEmptyVideoStreamTrack,
   isBrowserSupported,
-  supportsAdaptiveStream,
   supportsAV1,
+  supportsAdaptiveStream,
   supportsDynacast,
-  createAudioAnalyser,
 } from './room/utils';
 
-import type { AudioAnalyserOptions } from './room/utils';
-import type { LiveKitReactNativeInfo } from './room/types';
-
 export * from './options';
 export * from './room/errors';
 export * from './room/events';
-export type { DataPublishOptions } from './room/types';
+export type { DataPublishOptions, SimulationScenario } from './room/types';
 export * from './room/track/create';
 export * from './room/track/options';
 export * from './room/track/Track';

package/src/proto/livekit_models.ts

@@ -438,6 +438,7 @@ export interface Room {
   enabledCodecs: Codec[];
   metadata: string;
   numParticipants: number;
+  numPublishers: number;
   activeRecording: boolean;
 }
 
@@ -904,6 +905,7 @@ function createBaseRoom(): Room {
     enabledCodecs: [],
     metadata: "",
     numParticipants: 0,
+    numPublishers: 0,
     activeRecording: false,
   };
 }
@@ -937,6 +939,9 @@ export const Room = {
     if (message.numParticipants !== 0) {
       writer.uint32(72).uint32(message.numParticipants);
     }
+    if (message.numPublishers !== 0) {
+      writer.uint32(88).uint32(message.numPublishers);
+    }
     if (message.activeRecording === true) {
       writer.uint32(80).bool(message.activeRecording);
     }
@@ -1013,6 +1018,13 @@ export const Room = {
 
           message.numParticipants = reader.uint32();
           continue;
+        case 11:
+          if (tag != 88) {
+            break;
+          }
+
+          message.numPublishers = reader.uint32();
+          continue;
         case 10:
           if (tag != 80) {
             break;
@@ -1042,6 +1054,7 @@ export const Room = {
         : [],
       metadata: isSet(object.metadata) ? String(object.metadata) : "",
       numParticipants: isSet(object.numParticipants) ? Number(object.numParticipants) : 0,
+      numPublishers: isSet(object.numPublishers) ? Number(object.numPublishers) : 0,
       activeRecording: isSet(object.activeRecording) ? Boolean(object.activeRecording) : false,
     };
   },
@@ -1061,6 +1074,7 @@ export const Room = {
     }
     message.metadata !== undefined && (obj.metadata = message.metadata);
     message.numParticipants !== undefined && (obj.numParticipants = Math.round(message.numParticipants));
+    message.numPublishers !== undefined && (obj.numPublishers = Math.round(message.numPublishers));
     message.activeRecording !== undefined && (obj.activeRecording = message.activeRecording);
     return obj;
   },
@@ -1080,6 +1094,7 @@ export const Room = {
     message.enabledCodecs = object.enabledCodecs?.map((e) => Codec.fromPartial(e)) || [];
     message.metadata = object.metadata ?? "";
     message.numParticipants = object.numParticipants ?? 0;
+    message.numPublishers = object.numPublishers ?? 0;
     message.activeRecording = object.activeRecording ?? false;
     return message;
   },

package/src/room/RTCEngine.ts

@@ -22,6 +22,9 @@ import {
   SignalTarget,
   TrackPublishedResponse,
 } from '../proto/livekit_rtc';
+import PCTransport, { PCEvents } from './PCTransport';
+import type { ReconnectContext, ReconnectPolicy } from './ReconnectPolicy';
+import { RegionUrlProvider } from './RegionUrlProvider';
 import { roomConnectOptionDefaults } from './defaults';
 import {
   ConnectionError,
@@ -31,24 +34,21 @@ import {
   UnexpectedConnectionState,
 } from './errors';
 import { EngineEvent } from './events';
-import PCTransport, { PCEvents } from './PCTransport';
-import type { ReconnectContext, ReconnectPolicy } from './ReconnectPolicy';
 import CriticalTimers from './timers';
 import type LocalTrack from './track/LocalTrack';
 import type LocalVideoTrack from './track/LocalVideoTrack';
 import type { SimulcastTrackInfo } from './track/LocalVideoTrack';
-import type { TrackPublishOptions, VideoCodec } from './track/options';
 import { Track } from './track/Track';
+import type { TrackPublishOptions, VideoCodec } from './track/options';
 import {
+  Mutex,
   isCloud,
   isWeb,
-  Mutex,
   sleep,
   supportsAddTrack,
   supportsSetCodecPreferences,
   supportsTransceiver,
 } from './utils';
-import { RegionUrlProvider } from './RegionUrlProvider';
 
 const lossyDataChannel = '_lossy';
 const reliableDataChannel = '_reliable';
@@ -75,6 +75,8 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
   peerConnectionTimeout: number = roomConnectOptionDefaults.peerConnectionTimeout;
 
+  fullReconnectOnNext: boolean = false;
+
   get isClosed() {
     return this._isClosed;
   }
@@ -118,8 +120,6 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
   private reconnectStart: number = 0;
 
-  private fullReconnectOnNext: boolean = false;
-
   private clientConfiguration?: ClientConfiguration;
 
   private attemptingReconnect: boolean = false;
@@ -879,11 +879,13 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         throw new Error('simulated failure');
       }
 
-      await this.waitForPCReconnected();
       this.client.setReconnected();
+      this.emit(EngineEvent.SignalRestarted, joinResponse);
+
+      await this.waitForPCReconnected();
       this.regionUrlProvider?.resetAttempts();
       // reconnect success
-      this.emit(EngineEvent.Restarted, joinResponse);
+      this.emit(EngineEvent.Restarted);
     } catch (error) {
       const nextRegionUrl = await this.regionUrlProvider?.getNextBestRegionUrl();
       if (nextRegionUrl) {
@@ -992,7 +994,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     });
   }
 
-  async waitForPCReconnected() {
+  private async waitForPCReconnected() {
     const startTime = Date.now();
     let now = startTime;
     this.pcState = PCState.Reconnecting;
@@ -1022,6 +1024,24 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     throw new ConnectionError('could not establish PC connection');
   }
 
+  waitForRestarted = () => {
+    return new Promise<void>((resolve, reject) => {
+      if (this.pcState === PCState.Connected) {
+        resolve();
+      }
+      const onRestarted = () => {
+        this.off(EngineEvent.Disconnected, onDisconnected);
+        resolve();
+      };
+      const onDisconnected = () => {
+        this.off(EngineEvent.Restarted, onRestarted);
+        reject();
+      };
+      this.once(EngineEvent.Restarted, onRestarted);
+      this.once(EngineEvent.Disconnected, onDisconnected);
+    });
+  };
+
   /* @internal */
   async sendDataPacket(packet: DataPacket, kind: DataPacket_Kind) {
     const msg = DataPacket.encode(packet).finish();
@@ -1246,8 +1266,9 @@ export type EngineEventCallbacks = {
   resuming: () => void;
   resumed: () => void;
   restarting: () => void;
-  restarted: (joinResp: JoinResponse) => void;
+  restarted: () => void;
   signalResumed: () => void;
+  signalRestarted: (joinResp: JoinResponse) => void;
   closing: () => void;
   mediaTrackAdded: (
     track: MediaStreamTrack,

package/src/room/RegionUrlProvider.ts

@@ -1,6 +1,6 @@
+import log from '../logger';
 import type { RegionInfo, RegionSettings } from '../proto/livekit_rtc';
 import { ConnectionError, ConnectionErrorReason } from './errors';
-import log from '../logger';
 import { isCloud } from './utils';
 
 export class RegionUrlProvider {