livekit-client 1.7.1 → 1.9.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, Mutex, sleep } from '../room/utils';
+import { Mutex, getClientInfo, isReactNative, sleep } from '../room/utils';
 
 // internal options
 interface ConnectOpts {
@@ -216,7 +216,7 @@ export class SignalClient {
     return new Promise<JoinResponse | ReconnectResponse | void>(async (resolve, reject) => {
       const abortHandler = async () => {
         await this.close();
-        reject(new ConnectionError('room connection has been cancelled'));
+        reject(new ConnectionError('room connection has been cancelled (signal)'));
       };
 
       if (abortSignal?.aborted) {
@@ -234,7 +234,7 @@ export class SignalClient {
         if (!this.isConnected) {
           try {
             const resp = await fetch(`http${url.substring(2)}/validate${params}`);
-            if (!resp.ok) {
+            if (resp.status.toFixed(0).startsWith('4')) {
               const msg = await resp.text();
               reject(new ConnectionError(msg, ConnectionErrorReason.NotAllowed, resp.status));
             } else {
@@ -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,
@@ -706,7 +718,7 @@ function createConnectionParams(token: string, info: ClientInfo, opts: ConnectOp
   params.set('auto_subscribe', opts.autoSubscribe ? '1' : '0');
 
   // ClientInfo
-  params.set('sdk', 'js');
+  params.set('sdk', isReactNative() ? 'reactnative' : 'js');
   params.set('version', info.version!);
   params.set('protocol', info.protocol!.toString());
   if (info.deviceModel) {

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,25 +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';
-
 export * from './options';
 export * from './room/errors';
 export * from './room/events';
+export type { DataPublishOptions, SimulationScenario } from './room/types';
 export * from './room/track/create';
 export * from './room/track/options';
 export * from './room/track/Track';
@@ -73,4 +73,5 @@ export {
   ElementInfo,
   DefaultReconnectPolicy,
   CriticalTimers,
+  LiveKitReactNativeInfo,
 };

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

@@ -127,22 +127,31 @@ export const Timestamp = {
   },
 
   decode(input: _m0.Reader | Uint8Array, length?: number): Timestamp {
-    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseTimestamp();
     while (reader.pos < end) {
       const tag = reader.uint32();
       switch (tag >>> 3) {
         case 1:
+          if (tag != 8) {
+            break;
+          }
+
           message.seconds = longToNumber(reader.int64() as Long);
-          break;
+          continue;
         case 2:
+          if (tag != 16) {
+            break;
+          }
+
           message.nanos = reader.int32();
-          break;
-        default:
-          reader.skipType(tag & 7);
-          break;
+          continue;
+      }
+      if ((tag & 7) == 4 || tag == 0) {
+        break;
       }
+      reader.skipType(tag & 7);
     }
     return message;
   },