livekit-client 1.6.2 → 1.6.4

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

@@ -18,6 +18,7 @@ export default class PCTransport extends EventEmitter {
     renegotiate: boolean;
     trackBitrates: TrackBitrateInfo[];
     remoteStereoMids: string[];
+    remoteNackMids: string[];
     onOffer?: (offer: RTCSessionDescriptionInit) => void;
     constructor(config?: RTCConfiguration);
     get isICEConnected(): boolean;

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

@@ -54,6 +54,7 @@ export default class RTCEngine extends RTCEngine_base {
     get dataSubscriberReadyState(): string | undefined;
     get connectedServerAddress(): string | undefined;
     private configure;
+    private makeRTCConfiguration;
     private createDataChannels;
     private handleDataChannel;
     private handleDataMessage;
@@ -79,6 +80,7 @@ export default class RTCEngine extends RTCEngine_base {
     /** @internal */
     negotiate(): Promise<void>;
     dataChannelForKind(kind: DataPacket_Kind, sub?: boolean): RTCDataChannel | undefined;
+    private clearReconnectTimeout;
     private clearPendingReconnect;
     private handleBrowserOnLine;
     private registerOnLineListener;

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

@@ -204,7 +204,7 @@ export type RoomEventCallbacks = {
     localTrackPublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
     localTrackUnpublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
     participantMetadataChanged: (metadata: string | undefined, participant: RemoteParticipant | LocalParticipant) => void;
-    participantPermissionsChanged: (prevPermissions: ParticipantPermission, participant: RemoteParticipant | LocalParticipant) => void;
+    participantPermissionsChanged: (prevPermissions: ParticipantPermission | undefined, participant: RemoteParticipant | LocalParticipant) => void;
     activeSpeakersChanged: (speakers: Array<Participant>) => void;
     roomMetadataChanged: (metadata: string) => void;
     dataReceived: (payload: Uint8Array, participant?: RemoteParticipant, kind?: DataPacket_Kind) => void;

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

@@ -12,6 +12,9 @@ export declare class ConnectionError extends LivekitError {
     reason?: ConnectionErrorReason;
     constructor(message?: string, reason?: ConnectionErrorReason, status?: number);
 }
+export declare class DeviceUnsupportedError extends LivekitError {
+    constructor(message?: string);
+}
 export declare class TrackInvalidError extends LivekitError {
     constructor(message?: string);
 }

package/dist/ts4.2/src/room/participant/LocalParticipant.d.ts

@@ -1,6 +1,6 @@
 import 'webrtc-adapter';
 import type { InternalRoomOptions } from '../../options';
-import { DataPacket_Kind, ParticipantInfo, ParticipantPermission } from '../../proto/livekit_models';
+import { DataPacket_Kind, ParticipantInfo } from '../../proto/livekit_models';
 import { DataChannelInfo, TrackPublishedResponse } from '../../proto/livekit_rtc';
 import type RTCEngine from '../RTCEngine';
 import LocalTrack from '../track/LocalTrack';
@@ -52,8 +52,6 @@ export default class LocalParticipant extends Participant {
      * Resolves with a `LocalTrackPublication` instance if successful and `undefined` otherwise
      */
     setScreenShareEnabled(enabled: boolean, options?: ScreenShareCaptureOptions, publishOptions?: TrackPublishOptions): Promise<LocalTrackPublication | undefined>;
-    /** @internal */
-    setPermissions(permissions: ParticipantPermission): boolean;
     /**
      * Enable or disable publishing for a track by source. This serves as a simple
      * way to manage the common tracks (camera, mic, or screen share).

package/dist/ts4.2/src/room/participant/Participant.d.ts

@@ -85,7 +85,7 @@ export type ParticipantEventCallbacks = {
     trackStreamStateChanged: (publication: RemoteTrackPublication, streamState: Track.StreamState) => void;
     trackSubscriptionPermissionChanged: (publication: RemoteTrackPublication, status: TrackPublication.PermissionStatus) => void;
     mediaDevicesError: (error: Error) => void;
-    participantPermissionsChanged: (prevPermissions: ParticipantPermission) => void;
+    participantPermissionsChanged: (prevPermissions?: ParticipantPermission) => void;
     trackSubscriptionStatusChanged: (publication: RemoteTrackPublication, status: TrackPublication.SubscriptionStatus) => void;
 };
 export {};

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

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+/**
+ * Timers that can be overridden with platform specific implementations
+ * that ensure that they are fired. These should be used when it is critical
+ * that the timer fires on time.
+ */
+export default class CriticalTimers {
+    static setTimeout: (callback: (args: void) => void, ms?: number | undefined) => NodeJS.Timeout;
+    static setInterval: (callback: (args: void) => void, ms?: number | undefined) => NodeJS.Timer;
+    static clearTimeout: (timeoutId: NodeJS.Timeout) => void;
+    static clearInterval: (intervalId: NodeJS.Timeout) => void;
+}
+//# sourceMappingURL=timers.d.ts.map

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

@@ -187,8 +187,8 @@ declare const backupCodecs: readonly [
     "vp8",
     "h264"
 ];
-export type VideoCodec = typeof codecs[number];
-export type BackupVideoCodec = typeof backupCodecs[number];
+export type VideoCodec = (typeof codecs)[number];
+export type BackupVideoCodec = (typeof backupCodecs)[number];
 export declare function isBackupCodec(codec: string): codec is BackupVideoCodec;
 /**
  * scalability modes for svc, only supprot l3t3 now.

package/dist/ts4.2/src/test/mocks.d.ts

@@ -4,7 +4,7 @@ declare const mocks: {
     SignalClient: jest.MockedClass<typeof SignalClient>;
     RTCEngine: jest.MockedClass<typeof RTCEngine>;
     MockLocalVideoTrack: {
-        stop: jest.Mock<any, any>;
+        stop: jest.Mock<any, any, any>;
     };
 };
 export default mocks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -51,40 +51,40 @@
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "7.20.7",
+    "@babel/core": "7.20.12",
     "@babel/preset-env": "7.20.2",
     "@changesets/changelog-github": "0.4.8",
     "@changesets/cli": "2.26.0",
     "@rollup/plugin-babel": "6.0.3",
-    "@rollup/plugin-commonjs": "24.0.0",
+    "@rollup/plugin-commonjs": "24.0.1",
     "@rollup/plugin-json": "6.0.0",
     "@rollup/plugin-node-resolve": "15.0.1",
-    "@types/jest": "29.2.5",
+    "@types/jest": "29.4.0",
     "@types/sdp-transform": "2.4.5",
     "@types/ua-parser-js": "0.7.36",
     "@types/ws": "8.5.4",
-    "@typescript-eslint/eslint-plugin": "5.47.1",
-    "@typescript-eslint/parser": "5.47.1",
+    "@typescript-eslint/eslint-plugin": "5.50.0",
+    "@typescript-eslint/parser": "5.50.0",
     "downlevel-dts": "^0.11.0",
-    "eslint": "8.31.0",
+    "eslint": "8.33.0",
     "eslint-config-airbnb-typescript": "17.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
     "gh-pages": "4.0.0",
-    "jest": "29.3.1",
-    "prettier": "2.8.1",
-    "rollup": "3.9.1",
+    "jest": "29.4.1",
+    "prettier": "2.8.3",
+    "rollup": "3.12.1",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-filesize": "9.1.2",
     "rollup-plugin-re": "1.0.7",
     "rollup-plugin-terser": "7.0.2",
     "rollup-plugin-typescript2": "0.34.1",
-    "ts-jest": "29.0.3",
-    "ts-proto": "1.137.0",
-    "typedoc": "0.23.23",
+    "ts-jest": "29.0.5",
+    "ts-proto": "1.139.0",
+    "typedoc": "0.23.24",
     "typedoc-plugin-no-inherit": "1.4.0",
-    "typescript": "4.9.4",
-    "vite": "4.0.3"
+    "typescript": "4.9.5",
+    "vite": "4.0.4"
   },
   "browserslist": [
     "safari >= 11",

package/src/api/SignalClient.ts

@@ -14,6 +14,7 @@ import {
   ConnectionQualityUpdate,
   JoinResponse,
   LeaveRequest,
+  ReconnectResponse,
   SessionDescription,
   SignalRequest,
   SignalResponse,
@@ -30,6 +31,7 @@ import {
   UpdateTrackSettings,
 } from '../proto/livekit_rtc';
 import { ConnectionError, ConnectionErrorReason } from '../room/errors';
+import CriticalTimers from '../room/timers';
 import { getClientInfo, Mutex, sleep } from '../room/utils';
 
 // internal options
@@ -164,7 +166,7 @@ export class SignalClient {
     return res as JoinResponse;
   }
 
-  async reconnect(url: string, token: string, sid?: string): Promise<void> {
+  async reconnect(url: string, token: string, sid?: string): Promise<ReconnectResponse | void> {
     if (!this.options) {
       log.warn('attempted to reconnect without signal options being set, ignoring');
       return;
@@ -173,7 +175,8 @@ export class SignalClient {
     // clear ping interval and restart it once reconnected
     this.clearPingInterval();
 
-    await this.connect(url, token, { ...this.options, reconnect: true, sid });
+    const res = await this.connect(url, token, { ...this.options, reconnect: true, sid });
+    return res;
   }
 
   connect(
@@ -181,7 +184,7 @@ export class SignalClient {
     token: string,
     opts: ConnectOpts,
     abortSignal?: AbortSignal,
-  ): Promise<JoinResponse | void> {
+  ): Promise<JoinResponse | ReconnectResponse | void> {
     this.connectOptions = opts;
     if (url.startsWith('http')) {
       url = url.replace('http', 'ws');
@@ -193,7 +196,7 @@ export class SignalClient {
     const clientInfo = getClientInfo();
     const params = createConnectionParams(token, clientInfo, opts);
 
-    return new Promise<JoinResponse | void>(async (resolve, reject) => {
+    return new Promise<JoinResponse | ReconnectResponse | void>(async (resolve, reject) => {
       const abortHandler = async () => {
         await this.close();
         reject(new ConnectionError('room connection has been cancelled'));
@@ -240,16 +243,6 @@ export class SignalClient {
         this.handleWSError(ev);
       };
 
-      this.ws.onopen = () => {
-        if (opts.reconnect) {
-          // upon reconnection, there will not be additional handshake
-          this.isConnected = true;
-          // restart ping interval as it's cleared for reconnection
-          this.startPingInterval();
-          resolve();
-        }
-      };
-
       this.ws.onmessage = async (ev: MessageEvent) => {
         // not considered connected until JoinResponse is received
         let resp: SignalResponse;
@@ -264,6 +257,7 @@ export class SignalClient {
         }
 
         if (!this.isConnected) {
+          let shouldProcessMessage = false;
           // handle join message only
           if (resp.message?.$case === 'join') {
             this.isConnected = true;
@@ -279,14 +273,28 @@ export class SignalClient {
               this.startPingInterval();
             }
             resolve(resp.message.join);
-          } else {
+          } else if (opts.reconnect) {
+            // in reconnecting, any message received means signal reconnected
+            this.isConnected = true;
+            abortSignal?.removeEventListener('abort', abortHandler);
+            this.startPingInterval();
+            if (resp.message?.$case === 'reconnect') {
+              resolve(resp.message?.reconnect);
+            } 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 ${resp.message?.$case} instead`,
               ),
             );
           }
-          return;
+          if (!shouldProcessMessage) {
+            return;
+          }
         }
 
         if (this.signalLatency) {
@@ -485,7 +493,11 @@ export class SignalClient {
   }
 
   private handleSignalResponse(res: SignalResponse) {
-    const msg = res.message!;
+    const msg = res.message;
+    if (msg == undefined) {
+      log.debug('received unsupported message');
+      return;
+    }
     if (msg.$case === 'answer') {
       const sd = fromProtoSessionDescription(msg.answer);
       if (this.onAnswer) {
@@ -576,7 +588,7 @@ export class SignalClient {
       log.warn('ping timeout duration not set');
       return;
     }
-    this.pingTimeout = setTimeout(() => {
+    this.pingTimeout = CriticalTimers.setTimeout(() => {
       log.warn(
         `ping timeout triggered. last pong received at: ${new Date(
           Date.now() - this.pingTimeoutDuration! * 1000,
@@ -590,7 +602,7 @@ export class SignalClient {
 
   private clearPingTimeout() {
     if (this.pingTimeout) {
-      clearTimeout(this.pingTimeout);
+      CriticalTimers.clearTimeout(this.pingTimeout);
     }
   }
 
@@ -602,7 +614,7 @@ export class SignalClient {
       return;
     }
     log.debug('start ping interval');
-    this.pingInterval = setInterval(() => {
+    this.pingInterval = CriticalTimers.setInterval(() => {
       this.sendPing();
     }, this.pingIntervalDuration * 1000);
   }
@@ -611,7 +623,7 @@ export class SignalClient {
     log.debug('clearing ping interval');
     this.clearPingTimeout();
     if (this.pingInterval) {
-      clearInterval(this.pingInterval);
+      CriticalTimers.clearInterval(this.pingInterval);
     }
   }
 }

package/src/connectionHelper/ConnectionCheck.ts

@@ -9,7 +9,7 @@ import { TURNCheck } from './checks/turn';
 import { WebRTCCheck } from './checks/webrtc';
 import { WebSocketCheck } from './checks/websocket';
 
-export type { CheckInfo };
+export type { CheckInfo, CheckStatus };
 
 export class ConnectionCheck extends (EventEmitter as new () => TypedEmitter<ConnectionCheckCallbacks>) {
   token: string;

package/src/index.ts

@@ -16,6 +16,7 @@ import RemoteTrackPublication from './room/track/RemoteTrackPublication';
 import RemoteVideoTrack from './room/track/RemoteVideoTrack';
 import type { ElementInfo } from './room/track/RemoteVideoTrack';
 import { TrackPublication } from './room/track/TrackPublication';
+import CriticalTimers from './room/timers';
 import {
   getEmptyAudioStreamTrack,
   getEmptyVideoStreamTrack,
@@ -71,4 +72,5 @@ export {
   ConnectionQuality,
   ElementInfo,
   DefaultReconnectPolicy,
+  CriticalTimers,
 };

package/src/proto/google/protobuf/timestamp.ts

@@ -172,7 +172,7 @@ export const Timestamp = {
 declare var self: any | undefined;
 declare var window: any | undefined;
 declare var global: any | undefined;
-var globalThis: any = (() => {
+var tsProtoGlobalThis: any = (() => {
   if (typeof globalThis !== "undefined") {
     return globalThis;
   }
@@ -202,7 +202,7 @@ export type Exact<P, I extends P> = P extends Builtin ? P
 
 function longToNumber(long: Long): number {
   if (long.gt(Number.MAX_SAFE_INTEGER)) {
-    throw new globalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
+    throw new tsProtoGlobalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
   }
   return long.toNumber();
 }