livekit-client 1.6.3 → 1.6.5

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/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.3",
+  "version": "1.6.5",
   "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

@@ -5,6 +5,7 @@ import {
   ClientInfo,
   DisconnectReason,
   ParticipantInfo,
+  ReconnectReason,
   Room,
   SpeakerInfo,
   VideoLayer,
@@ -40,6 +41,9 @@ interface ConnectOpts {
   /** internal */
   reconnect?: boolean;
 
+  /** internal */
+  reconnectReason?: number;
+
   /** internal */
   sid?: string;
 
@@ -89,6 +93,9 @@ export class SignalClient {
 
   useJSON: boolean;
 
+  /** signal rtt in milliseconds */
+  rtt: number = 0;
+
   /** simulate signaling latency by delaying messages */
   signalLatency?: number;
 
@@ -166,7 +173,12 @@ export class SignalClient {
     return res as JoinResponse;
   }
 
-  async reconnect(url: string, token: string, sid?: string): Promise<ReconnectResponse | void> {
+  async reconnect(
+    url: string,
+    token: string,
+    sid?: string,
+    reason?: ReconnectReason,
+  ): Promise<ReconnectResponse | void> {
     if (!this.options) {
       log.warn('attempted to reconnect without signal options being set, ignoring');
       return;
@@ -175,7 +187,12 @@ export class SignalClient {
     // clear ping interval and restart it once reconnected
     this.clearPingInterval();
 
-    const res = await this.connect(url, token, { ...this.options, reconnect: true, sid });
+    const res = await this.connect(url, token, {
+      ...this.options,
+      reconnect: true,
+      sid,
+      reconnectReason: reason,
+    });
     return res;
   }
 
@@ -440,10 +457,18 @@ 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() {
@@ -493,7 +518,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) {
@@ -559,6 +588,9 @@ export class SignalClient {
       }
     } else if (msg.$case === 'pong') {
       this.resetPingTimeout();
+    } else if (msg.$case === 'pongResp') {
+      this.rtt = Date.now() - msg.pongResp.lastPingTimestamp;
+      this.resetPingTimeout();
     } else {
       log.debug('unsupported message', msg);
     }
@@ -578,6 +610,10 @@ export class SignalClient {
     log.error('websocket error', ev);
   }
 
+  /**
+   * Resets the ping timeout and starts a new timeout.
+   * Call this after receiving a pong message
+   */
   private resetPingTimeout() {
     this.clearPingTimeout();
     if (!this.pingTimeoutDuration) {
@@ -596,6 +632,9 @@ export class SignalClient {
     }, this.pingTimeoutDuration * 1000);
   }
 
+  /**
+   * Clears ping timeout (does not start a new timeout)
+   */
   private clearPingTimeout() {
     if (this.pingTimeout) {
       CriticalTimers.clearTimeout(this.pingTimeout);
@@ -694,6 +733,10 @@ function createConnectionParams(token: string, info: ClientInfo, opts: ConnectOp
     params.set('adaptive_stream', '1');
   }
 
+  if (opts.reconnectReason) {
+    params.set('reconnect_reason', opts.reconnectReason.toString());
+  }
+
   // @ts-ignore
   if (navigator.connection?.type) {
     // @ts-ignore

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/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();
 }

package/src/proto/livekit_models.ts

@@ -287,6 +287,57 @@ export function disconnectReasonToJSON(object: DisconnectReason): string {
   }
 }
 
+export enum ReconnectReason {
+  REASON_UNKOWN = 0,
+  REASON_SIGNAL_DISCONNECTED = 1,
+  REASON_PUBLISHER_FAILED = 2,
+  REASON_SUBSCRIBER_FAILED = 3,
+  REASON_SWITCH_CANDIDATE = 4,
+  UNRECOGNIZED = -1,
+}
+
+export function reconnectReasonFromJSON(object: any): ReconnectReason {
+  switch (object) {
+    case 0:
+    case "REASON_UNKOWN":
+      return ReconnectReason.REASON_UNKOWN;
+    case 1:
+    case "REASON_SIGNAL_DISCONNECTED":
+      return ReconnectReason.REASON_SIGNAL_DISCONNECTED;
+    case 2:
+    case "REASON_PUBLISHER_FAILED":
+      return ReconnectReason.REASON_PUBLISHER_FAILED;
+    case 3:
+    case "REASON_SUBSCRIBER_FAILED":
+      return ReconnectReason.REASON_SUBSCRIBER_FAILED;
+    case 4:
+    case "REASON_SWITCH_CANDIDATE":
+      return ReconnectReason.REASON_SWITCH_CANDIDATE;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return ReconnectReason.UNRECOGNIZED;
+  }
+}
+
+export function reconnectReasonToJSON(object: ReconnectReason): string {
+  switch (object) {
+    case ReconnectReason.REASON_UNKOWN:
+      return "REASON_UNKOWN";
+    case ReconnectReason.REASON_SIGNAL_DISCONNECTED:
+      return "REASON_SIGNAL_DISCONNECTED";
+    case ReconnectReason.REASON_PUBLISHER_FAILED:
+      return "REASON_PUBLISHER_FAILED";
+    case ReconnectReason.REASON_SUBSCRIBER_FAILED:
+      return "REASON_SUBSCRIBER_FAILED";
+    case ReconnectReason.REASON_SWITCH_CANDIDATE:
+      return "REASON_SWITCH_CANDIDATE";
+    case ReconnectReason.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
 export interface Room {
   sid: string;
   name: string;
@@ -312,6 +363,8 @@ export interface ParticipantPermission {
   canPublish: boolean;
   /** allow participant to publish data */
   canPublishData: boolean;
+  /** sources that are allowed to be published */
+  canPublishSources: TrackSource[];
   /** indicates that it's hidden to others */
   hidden: boolean;
   /** indicates it's a recorder instance */
@@ -940,7 +993,14 @@ export const Codec = {
 };
 
 function createBaseParticipantPermission(): ParticipantPermission {
-  return { canSubscribe: false, canPublish: false, canPublishData: false, hidden: false, recorder: false };
+  return {
+    canSubscribe: false,
+    canPublish: false,
+    canPublishData: false,
+    canPublishSources: [],
+    hidden: false,
+    recorder: false,
+  };
 }
 
 export const ParticipantPermission = {
@@ -954,6 +1014,11 @@ export const ParticipantPermission = {
     if (message.canPublishData === true) {
       writer.uint32(24).bool(message.canPublishData);
     }
+    writer.uint32(74).fork();
+    for (const v of message.canPublishSources) {
+      writer.int32(v);
+    }
+    writer.ldelim();
     if (message.hidden === true) {
       writer.uint32(56).bool(message.hidden);
     }
@@ -979,6 +1044,16 @@ export const ParticipantPermission = {
         case 3:
           message.canPublishData = reader.bool();
           break;
+        case 9:
+          if ((tag & 7) === 2) {
+            const end2 = reader.uint32() + reader.pos;
+            while (reader.pos < end2) {
+              message.canPublishSources.push(reader.int32() as any);
+            }
+          } else {
+            message.canPublishSources.push(reader.int32() as any);
+          }
+          break;
         case 7:
           message.hidden = reader.bool();
           break;
@@ -998,6 +1073,9 @@ export const ParticipantPermission = {
       canSubscribe: isSet(object.canSubscribe) ? Boolean(object.canSubscribe) : false,
       canPublish: isSet(object.canPublish) ? Boolean(object.canPublish) : false,
       canPublishData: isSet(object.canPublishData) ? Boolean(object.canPublishData) : false,
+      canPublishSources: Array.isArray(object?.canPublishSources)
+        ? object.canPublishSources.map((e: any) => trackSourceFromJSON(e))
+        : [],
       hidden: isSet(object.hidden) ? Boolean(object.hidden) : false,
       recorder: isSet(object.recorder) ? Boolean(object.recorder) : false,
     };
@@ -1008,6 +1086,11 @@ export const ParticipantPermission = {
     message.canSubscribe !== undefined && (obj.canSubscribe = message.canSubscribe);
     message.canPublish !== undefined && (obj.canPublish = message.canPublish);
     message.canPublishData !== undefined && (obj.canPublishData = message.canPublishData);
+    if (message.canPublishSources) {
+      obj.canPublishSources = message.canPublishSources.map((e) => trackSourceToJSON(e));
+    } else {
+      obj.canPublishSources = [];
+    }
     message.hidden !== undefined && (obj.hidden = message.hidden);
     message.recorder !== undefined && (obj.recorder = message.recorder);
     return obj;
@@ -1018,6 +1101,7 @@ export const ParticipantPermission = {
     message.canSubscribe = object.canSubscribe ?? false;
     message.canPublish = object.canPublish ?? false;
     message.canPublishData = object.canPublishData ?? false;
+    message.canPublishSources = object.canPublishSources?.map((e) => e) || [];
     message.hidden = object.hidden ?? false;
     message.recorder = object.recorder ?? false;
     return message;
@@ -2940,7 +3024,7 @@ export const TimedVersion = {
 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;
   }
@@ -2957,10 +3041,10 @@ var globalThis: any = (() => {
 })();
 
 function bytesFromBase64(b64: string): Uint8Array {
-  if (globalThis.Buffer) {
-    return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
+  if (tsProtoGlobalThis.Buffer) {
+    return Uint8Array.from(tsProtoGlobalThis.Buffer.from(b64, "base64"));
   } else {
-    const bin = globalThis.atob(b64);
+    const bin = tsProtoGlobalThis.atob(b64);
     const arr = new Uint8Array(bin.length);
     for (let i = 0; i < bin.length; ++i) {
       arr[i] = bin.charCodeAt(i);
@@ -2970,14 +3054,14 @@ function bytesFromBase64(b64: string): Uint8Array {
 }
 
 function base64FromBytes(arr: Uint8Array): string {
-  if (globalThis.Buffer) {
-    return globalThis.Buffer.from(arr).toString("base64");
+  if (tsProtoGlobalThis.Buffer) {
+    return tsProtoGlobalThis.Buffer.from(arr).toString("base64");
   } else {
     const bin: string[] = [];
     arr.forEach((byte) => {
       bin.push(String.fromCharCode(byte));
     });
-    return globalThis.btoa(bin.join(""));
+    return tsProtoGlobalThis.btoa(bin.join(""));
   }
 }
 
@@ -3017,7 +3101,7 @@ function fromJsonTimestamp(o: any): Date {
 
 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();
 }