livekit-client 1.12.1 → 1.12.2

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

@@ -1,4 +1,5 @@
-import EventEmitter from 'eventemitter3';
+/// <reference types="node" />
+import { EventEmitter } from 'events';
 /** @internal */
 interface TrackBitrateInfo {
     cid?: string;

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

@@ -1,17 +1,19 @@
-import EventEmitter from 'eventemitter3';
-import { SignalClient } from '../api/SignalClient';
+import type TypedEventEmitter from 'typed-emitter';
 import type { SignalOptions } from '../api/SignalClient';
+import { SignalClient } from '../api/SignalClient';
 import type { InternalRoomOptions } from '../options';
-import { DataPacket, DataPacket_Kind, DisconnectReason, ParticipantInfo, Room as RoomModel, SpeakerInfo, TrackInfo, UserPacket } from '../proto/livekit_models';
-import { AddTrackRequest, ConnectionQualityUpdate, JoinResponse, StreamStateUpdate, SubscriptionPermissionUpdate, SubscriptionResponse } from '../proto/livekit_rtc';
+import { DataPacket, DataPacket_Kind, DisconnectReason, ParticipantInfo, Room as RoomModel, SpeakerInfo, TrackInfo, UserPacket } from '../proto/livekit_models_pb';
+import { AddTrackRequest, ConnectionQualityUpdate, JoinResponse, StreamStateUpdate, SubscriptionPermissionUpdate, SubscriptionResponse } from '../proto/livekit_rtc_pb';
 import PCTransport from './PCTransport';
+import type { RegionUrlProvider } from './RegionUrlProvider';
 import type LocalTrack from './track/LocalTrack';
 import type LocalVideoTrack from './track/LocalVideoTrack';
 import type { SimulcastTrackInfo } from './track/LocalVideoTrack';
 import { Track } from './track/Track';
 import type { TrackPublishOptions, VideoCodec } from './track/options';
+declare const RTCEngine_base: new () => TypedEventEmitter<EngineEventCallbacks>;
 /** @internal */
-export default class RTCEngine extends EventEmitter<EngineEventCallbacks> {
+export default class RTCEngine extends RTCEngine_base {
     private options;
     publisher?: PCTransport;
     subscriber?: PCTransport;
@@ -69,6 +71,7 @@ export default class RTCEngine extends EventEmitter<EngineEventCallbacks> {
     updateMuteStatus(trackSid: string, muted: boolean): void;
     get dataSubscriberReadyState(): string | undefined;
     getConnectedServerAddress(): Promise<string | undefined>;
+    setRegionUrlProvider(provider: RegionUrlProvider): void;
     private configure;
     private setupSignalClientCallbacks;
     private makeRTCConfiguration;
@@ -136,4 +139,5 @@ export type EngineEventCallbacks = {
     subscriptionError: (resp: SubscriptionResponse) => void;
     subscriptionPermissionUpdate: (update: SubscriptionPermissionUpdate) => void;
 };
+export {};
 //# sourceMappingURL=RTCEngine.d.ts.map

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

@@ -1,3 +1,4 @@
+import type { RegionSettings } from '../proto/livekit_rtc_pb';
 export declare class RegionUrlProvider {
     private serverUrl;
     private token;
@@ -6,9 +7,11 @@ export declare class RegionUrlProvider {
     private settingsCacheTime;
     private attemptedRegions;
     constructor(url: string, token: string);
+    updateToken(token: string): void;
     isCloud(): boolean;
+    getServerUrl(): URL;
     getNextBestRegionUrl(abortSignal?: AbortSignal): Promise<string | null>;
     resetAttempts(): void;
-    private fetchRegionSettings;
+    fetchRegionSettings(signal?: AbortSignal): Promise<RegionSettings>;
 }
 //# sourceMappingURL=RegionUrlProvider.d.ts.map

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

@@ -1,7 +1,7 @@
-import EventEmitter from 'eventemitter3';
+import type TypedEmitter from 'typed-emitter';
 import 'webrtc-adapter';
 import type { InternalRoomOptions, RoomConnectOptions, RoomOptions } from '../options';
-import { DataPacket_Kind, DisconnectReason, ParticipantPermission, SubscriptionError } from '../proto/livekit_models';
+import { DataPacket_Kind, DisconnectReason, ParticipantPermission, SubscriptionError } from '../proto/livekit_models_pb';
 import RTCEngine from './RTCEngine';
 import LocalParticipant from './participant/LocalParticipant';
 import type Participant from './participant/Participant';
@@ -21,6 +21,7 @@ export declare enum ConnectionState {
 }
 /** @deprecated RoomState has been renamed to [[ConnectionState]] */
 export declare const RoomState: typeof ConnectionState;
+declare const Room_base: new () => TypedEmitter<RoomEventCallbacks>;
 /**
  * In LiveKit, a room is the logical grouping for a list of participants.
  * Participants in a room can publish tracks, and subscribe to others' tracks.
@@ -29,7 +30,7 @@ export declare const RoomState: typeof ConnectionState;
  *
  * @noInheritDoc
  */
-declare class Room extends EventEmitter<RoomEventCallbacks> {
+declare class Room extends Room_base {
     state: ConnectionState;
     /** map of sid: [[RemoteParticipant]] */
     participants: Map<string, RemoteParticipant>;
@@ -60,6 +61,8 @@ declare class Room extends EventEmitter<RoomEventCallbacks> {
     private e2eeManager;
     private cachedParticipantSids;
     private connectionReconcileInterval?;
+    private regionUrlProvider?;
+    private regionUrl?;
     /**
      * Creates a new Room, the primary construct for a LiveKit session.
      * @param options
@@ -93,14 +96,15 @@ declare class Room extends EventEmitter<RoomEventCallbacks> {
      */
     static getLocalDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
     /**
-     * prepares the connection to the livekit server by sending a HEAD request in order to
-     * 1. speed up DNS resolution
-     * 2. speed up TLS setup
-     * on the actual connection request
-     * throws an error if server is not reachable after the request timeout
-     * @experimental
+     * prepareConnection should be called as soon as the page is loaded, in order
+     * to speed up the connection attempt. This function will
+     * - perform DNS resolution and pre-warm the DNS cache
+     * - establish TLS connection and cache TLS keys
+     *
+     * With LiveKit Cloud, it will also determine the best edge data center for
+     * the current client to connect to if a token is provided.
      */
-    prepareConnection(url: string): Promise<void>;
+    prepareConnection(url: string, token?: string): Promise<void>;
     connect: (url: string, token: string, opts?: RoomConnectOptions) => Promise<void>;
     private connectSignal;
     private applyJoinResponse;
@@ -198,7 +202,7 @@ declare class Room extends EventEmitter<RoomEventCallbacks> {
      * @experimental
      */
     simulateParticipants(options: SimulationOptions): Promise<void>;
-    emit<T extends EventEmitter.EventNames<RoomEventCallbacks>>(event: T, ...args: EventEmitter.EventArgs<RoomEventCallbacks, T>): boolean;
+    emit<E extends keyof RoomEventCallbacks>(event: E, ...args: Parameters<RoomEventCallbacks[E]>): boolean;
 }
 export default Room;
 export type RoomEventCallbacks = {

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

@@ -1,6 +1,6 @@
 import type { InternalRoomOptions } from '../../options';
-import { DataPacket_Kind, ParticipantInfo, ParticipantPermission } from '../../proto/livekit_models';
-import { DataChannelInfo, TrackPublishedResponse } from '../../proto/livekit_rtc';
+import { DataPacket_Kind, ParticipantInfo, ParticipantPermission } from '../../proto/livekit_models_pb';
+import { DataChannelInfo, TrackPublishedResponse } from '../../proto/livekit_rtc_pb';
 import type RTCEngine from '../RTCEngine';
 import LocalTrack from '../track/LocalTrack';
 import LocalTrackPublication from '../track/LocalTrackPublication';

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

@@ -1,5 +1,5 @@
-import EventEmitter from 'eventemitter3';
-import { DataPacket_Kind, ParticipantInfo, ParticipantPermission, ConnectionQuality as ProtoQuality, SubscriptionError } from '../../proto/livekit_models';
+import type TypedEmitter from 'typed-emitter';
+import { DataPacket_Kind, ParticipantInfo, ParticipantPermission, ConnectionQuality as ProtoQuality, SubscriptionError } from '../../proto/livekit_models_pb';
 import type LocalTrackPublication from '../track/LocalTrackPublication';
 import type RemoteTrack from '../track/RemoteTrack';
 import type RemoteTrackPublication from '../track/RemoteTrackPublication';
@@ -11,7 +11,8 @@ export declare enum ConnectionQuality {
     Poor = "poor",
     Unknown = "unknown"
 }
-export default class Participant extends EventEmitter<ParticipantEventCallbacks> {
+declare const Participant_base: new () => TypedEmitter<ParticipantEventCallbacks>;
+export default class Participant extends Participant_base {
     protected participantInfo?: ParticipantInfo;
     audioTracks: Map<string, TrackPublication>;
     videoTracks: Map<string, TrackPublication>;
@@ -90,4 +91,5 @@ export type ParticipantEventCallbacks = {
     participantPermissionsChanged: (prevPermissions?: ParticipantPermission) => void;
     trackSubscriptionStatusChanged: (publication: RemoteTrackPublication, status: TrackPublication.SubscriptionStatus) => void;
 };
+export {};
 //# sourceMappingURL=Participant.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { TrackPermission } from '../../proto/livekit_rtc';
+import { TrackPermission } from '../../proto/livekit_rtc_pb';
 export interface ParticipantTrackPermission {
     /**
      * The participant identity this permission applies to.

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

@@ -1,6 +1,5 @@
-import type EventEmitter from 'eventemitter3';
 import type { SignalClient } from '../../api/SignalClient';
-import type { ParticipantInfo } from '../../proto/livekit_models';
+import type { ParticipantInfo } from '../../proto/livekit_models_pb';
 import RemoteTrackPublication from '../track/RemoteTrackPublication';
 import { Track } from '../track/Track';
 import type { AudioOutputOptions } from '../track/options';
@@ -51,6 +50,6 @@ export default class RemoteParticipant extends Participant {
      */
     setAudioOutput(output: AudioOutputOptions): Promise<void>;
     /** @internal */
-    emit<T extends EventEmitter.EventNames<ParticipantEventCallbacks>>(event: T, ...args: EventEmitter.EventArgs<ParticipantEventCallbacks, T>): boolean;
+    emit<E extends keyof ParticipantEventCallbacks>(event: E, ...args: Parameters<ParticipantEventCallbacks[E]>): boolean;
 }
 //# sourceMappingURL=RemoteParticipant.d.ts.map

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

@@ -1,12 +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: (handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]) => number;
-    static setInterval: (handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]) => number;
-    static clearTimeout: (id: number | undefined) => void;
-    static clearInterval: (id: number | undefined) => void;
+    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/LocalTrack.d.ts

@@ -43,6 +43,9 @@ export default abstract class LocalTrack extends Track {
     protected setTrackMuted(muted: boolean): void;
     protected get needsReAcquisition(): boolean;
     protected handleAppVisibilityChanged(): Promise<void>;
+    private handleTrackMuteEvent;
+    private debouncedTrackMuteHandler;
+    private handleTrackUnmuteEvent;
     private handleEnded;
     stop(): void;
     /**

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

@@ -1,4 +1,4 @@
-import type { TrackInfo } from '../../proto/livekit_models';
+import type { TrackInfo } from '../../proto/livekit_models_pb';
 import type LocalAudioTrack from './LocalAudioTrack';
 import type LocalTrack from './LocalTrack';
 import type LocalVideoTrack from './LocalVideoTrack';

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

@@ -1,6 +1,6 @@
 import type { SignalClient } from '../../api/SignalClient';
-import { VideoLayer, VideoQuality } from '../../proto/livekit_models';
-import type { SubscribedCodec, SubscribedQuality } from '../../proto/livekit_rtc';
+import { VideoLayer, VideoQuality } from '../../proto/livekit_models_pb';
+import { SubscribedCodec, SubscribedQuality } from '../../proto/livekit_rtc_pb';
 import type { VideoSenderStats } from '../stats';
 import LocalTrack from './LocalTrack';
 import type { VideoCaptureOptions, VideoCodec } from './options';

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

@@ -1,4 +1,4 @@
-import { SubscriptionError, TrackInfo, VideoQuality } from '../../proto/livekit_models';
+import { SubscriptionError, TrackInfo, VideoQuality } from '../../proto/livekit_models_pb';
 import type RemoteTrack from './RemoteTrack';
 import { Track } from './Track';
 import { TrackPublication } from './TrackPublication';

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

@@ -1,8 +1,9 @@
-import EventEmitter from 'eventemitter3';
+import type TypedEventEmitter from 'typed-emitter';
 import type { SignalClient } from '../../api/SignalClient';
-import { TrackSource, TrackType } from '../../proto/livekit_models';
-import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc';
-export declare abstract class Track extends EventEmitter<TrackEventCallbacks> {
+import { TrackSource, TrackType } from '../../proto/livekit_models_pb';
+import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc_pb';
+declare const Track_base: new () => TypedEventEmitter<TrackEventCallbacks>;
+export declare abstract class Track extends Track_base {
     kind: Track.Kind;
     attachedElements: HTMLMediaElement[];
     isMuted: boolean;
@@ -120,4 +121,5 @@ export type TrackEventCallbacks = {
     upstreamPaused: (track: any) => void;
     upstreamResumed: (track: any) => void;
 };
+export {};
 //# sourceMappingURL=Track.d.ts.map

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

@@ -1,14 +1,15 @@
-import EventEmitter from 'eventemitter3';
-import { Encryption_Type } from '../../proto/livekit_models';
-import type { SubscriptionError, TrackInfo } from '../../proto/livekit_models';
-import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc';
+import type TypedEventEmitter from 'typed-emitter';
+import { Encryption_Type } from '../../proto/livekit_models_pb';
+import type { SubscriptionError, TrackInfo } from '../../proto/livekit_models_pb';
+import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc_pb';
 import LocalAudioTrack from './LocalAudioTrack';
 import LocalVideoTrack from './LocalVideoTrack';
 import RemoteAudioTrack from './RemoteAudioTrack';
 import type RemoteTrack from './RemoteTrack';
 import RemoteVideoTrack from './RemoteVideoTrack';
 import { Track } from './Track';
-export declare class TrackPublication extends EventEmitter<PublicationEventCallbacks> {
+declare const TrackPublication_base: new () => TypedEventEmitter<PublicationEventCallbacks>;
+export declare class TrackPublication extends TrackPublication_base {
     kind: Track.Kind;
     trackName: string;
     trackSid: Track.SID;
@@ -67,4 +68,5 @@ export type PublicationEventCallbacks = {
     subscriptionStatusChanged: (status: TrackPublication.SubscriptionStatus, prevStatus: TrackPublication.SubscriptionStatus) => void;
     subscriptionFailed: (error: SubscriptionError) => void;
 };
+export {};
 //# sourceMappingURL=TrackPublication.d.ts.map

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

@@ -127,6 +127,13 @@ export interface ScreenShareCaptureOptions {
      * screenshare is limited: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#browser_compatibility
      */
     audio?: boolean | AudioCaptureOptions;
+    /**
+     * only allows for 'true' and chrome allows for additional options to be passed in
+     * https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface
+     */
+    video?: true | {
+        displaySurface?: 'window' | 'browser' | 'monitor';
+    };
     /** capture resolution, defaults to full HD */
     resolution?: VideoResolution;
     /** a CaptureController object instance containing methods that can be used to further manipulate the capture session if included. */

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

@@ -1,5 +1,5 @@
 import { Track } from './Track';
-import type { AudioCaptureOptions, CreateLocalTracksOptions, VideoCaptureOptions } from './options';
+import type { AudioCaptureOptions, CreateLocalTracksOptions, ScreenShareCaptureOptions, VideoCaptureOptions } from './options';
 import type { AudioTrack } from './types';
 export declare function mergeDefaultOptions(options?: CreateLocalTracksOptions, audioDefaults?: AudioCaptureOptions, videoDefaults?: VideoCaptureOptions): CreateLocalTracksOptions;
 export declare function constraintsForOptions(options: CreateLocalTracksOptions): MediaStreamConstraints;
@@ -20,4 +20,8 @@ export declare function kindToSource(kind: MediaDeviceKind): Track.Source.Camera
  * @internal
  */
 export declare function sourceToKind(source: Track.Source): MediaDeviceKind | undefined;
+/**
+ * @internal
+ */
+export declare function screenCaptureToDisplayMediaStreamOptions(options: ScreenShareCaptureOptions): DisplayMediaStreamOptions;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -1,4 +1,4 @@
-import { ClientInfo } from '../proto/livekit_models';
+import { ClientInfo } from '../proto/livekit_models_pb';
 import type LocalAudioTrack from './track/LocalAudioTrack';
 import type RemoteAudioTrack from './track/RemoteAudioTrack';
 import { VideoCodec } from './track/options';
@@ -87,4 +87,6 @@ export declare class Mutex {
 }
 export declare function isVideoCodec(maybeCodec: string): maybeCodec is VideoCodec;
 export declare function unwrapConstraint(constraint: ConstrainDOMString): string;
+export declare function toWebsocketUrl(url: string): string;
+export declare function toHttpUrl(url: string): string;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -1,10 +1,11 @@
+import { MockedClass } from 'vitest';
 import { SignalClient } from '../api/SignalClient';
 import RTCEngine from '../room/RTCEngine';
 declare const mocks: {
-    SignalClient: jest.MockedClass<typeof SignalClient>;
-    RTCEngine: jest.MockedClass<typeof RTCEngine>;
+    SignalClient: MockedClass<typeof SignalClient>;
+    RTCEngine: MockedClass<typeof RTCEngine>;
     MockLocalVideoTrack: {
-        stop: jest.Mock<any, any, any>;
+        stop: import("@vitest/spy").Mock<any, any>;
     };
 };
 export default mocks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.12.1",
+  "version": "1.12.2",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -39,10 +39,10 @@
     "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs  && yarn downlevel-dts",
     "build:watch": "rollup --watch --config rollup.config.js",
     "build-docs": "typedoc",
-    "proto": "protoc --plugin=node_modules/ts-proto/protoc-gen-ts_proto --ts_proto_opt=esModuleInterop=true --ts_proto_out=./src/proto --ts_proto_opt=outputClientImpl=false,useOptionals=messages,oneof=unions -I./protocol ./protocol/livekit_rtc.proto ./protocol/livekit_models.proto",
+    "proto": "protoc --es_out src/proto --es_opt target=ts -I./protocol ./protocol/livekit_rtc.proto ./protocol/livekit_models.proto",
     "sample": "vite example -c vite.config.js",
     "lint": "eslint src",
-    "test": "jest",
+    "test": "vitest run src",
     "deploy": "gh-pages -d example/dist",
     "format": "prettier --write src example/sample.ts",
     "format:check": "prettier --check src",
@@ -52,16 +52,18 @@
     "size-limit": "size-limit"
   },
   "dependencies": {
-    "eventemitter3": "^5.0.1",
+    "@bufbuild/protobuf": "^1.3.0",
+    "events": "^3.3.0",
     "loglevel": "^1.8.0",
-    "protobufjs": "^7.0.0",
     "sdp-transform": "^2.14.1",
     "ts-debounce": "^4.0.0",
+    "typed-emitter": "^2.1.0",
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
     "@babel/core": "7.22.1",
     "@babel/preset-env": "7.22.4",
+    "@bufbuild/protoc-gen-es": "^1.3.0",
     "@changesets/cli": "2.26.1",
     "@livekit/changesets-changelog-github": "^0.0.4",
     "@rollup/plugin-babel": "6.0.3",
@@ -73,7 +75,6 @@
     "@size-limit/webpack": "^8.2.4",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/events": "^3.0.0",
-    "@types/jest": "29.5.2",
     "@types/sdp-transform": "2.4.6",
     "@types/ua-parser-js": "0.7.36",
     "@typescript-eslint/eslint-plugin": "5.59.8",
@@ -85,19 +86,18 @@
     "eslint-plugin-ecmascript-compat": "^3.0.0",
     "eslint-plugin-import": "2.27.5",
     "gh-pages": "5.0.0",
-    "jest": "29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
+    "jsdom": "^22.1.0",
     "prettier": "^2.8.8",
     "rollup": "3.23.1",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-re": "1.0.7",
     "rollup-plugin-typescript2": "0.34.1",
     "size-limit": "^8.2.4",
-    "ts-jest": "29.1.0",
     "ts-proto": "1.148.2",
     "typedoc": "0.24.8",
     "typedoc-plugin-no-inherit": "1.4.0",
     "typescript": "5.1.3",
-    "vite": "4.3.9"
+    "vite": "4.3.9",
+    "vitest": "^0.32.0"
   }
 }