livekit-client 2.22.2 → 2.22.4

package/dist/ts4.2/api/utils.d.ts

@@ -1,8 +1,9 @@
-import { SignalResponse } from '@livekit/protocol';
-export declare function createRtcUrl(url: string, searchParams: URLSearchParams, useV0Path?: boolean): URL;
-export declare function createV0RtcUrl(url: string, searchParams: URLSearchParams): URL;
-export declare function createValidateUrl(rtcWsUrl: string): URL;
-export declare function ensureTrailingSlash(path: string): string;
-export declare function parseSignalResponse(value: ArrayBuffer | string): SignalResponse;
-export declare function getAbortReasonAsString(signal: AbortSignal | Error | unknown, defaultMessage?: string): any;
-//# sourceMappingURL=utils.d.ts.map
+import { SignalResponse } from '@livekit/protocol';
+export declare function createRtcUrl(url: string, searchParams: URLSearchParams, useV0Path?: boolean): URL;
+export declare function createV0RtcUrl(url: string, searchParams: URLSearchParams): URL;
+export declare function createValidateUrl(rtcWsUrl: string): URL;
+export declare function ensureTrailingSlash(path: string): string;
+export declare function parseSignalResponse(value: ArrayBuffer | string): SignalResponse;
+export declare function getAbortReasonAsString(signal: AbortSignal | Error | unknown, defaultMessage?: string): any;
+export declare function getErrorDescription(error: unknown, errorCategory: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/ts4.2/connectionHelper/ConnectionCheck.d.ts

@@ -1,30 +1,30 @@
-import type TypedEmitter from 'typed-emitter';
-import type { CheckInfo, CheckerOptions, InstantiableCheck } from './checks/Checker';
-import { CheckStatus, Checker } from './checks/Checker';
-export type { CheckInfo };
-export { CheckStatus };
-declare const ConnectionCheck_base: new () => TypedEmitter<ConnectionCheckCallbacks>;
-export declare class ConnectionCheck extends ConnectionCheck_base {
-    token: string;
-    url: string;
-    options: CheckerOptions;
-    private checkResults;
-    constructor(url: string, token: string, options?: CheckerOptions);
-    private getNextCheckId;
-    private updateCheck;
-    isSuccess(): boolean;
-    getResults(): CheckInfo[];
-    createAndRunCheck<T extends Checker>(check: InstantiableCheck<T>): Promise<CheckInfo>;
-    checkWebsocket(): Promise<CheckInfo>;
-    checkWebRTC(): Promise<CheckInfo>;
-    checkTURN(): Promise<CheckInfo>;
-    checkReconnect(): Promise<CheckInfo>;
-    checkPublishAudio(): Promise<CheckInfo>;
-    checkPublishVideo(): Promise<CheckInfo>;
-    checkConnectionProtocol(): Promise<CheckInfo>;
-    checkCloudRegion(): Promise<CheckInfo>;
-}
-type ConnectionCheckCallbacks = {
-    checkUpdate: (id: number, info: CheckInfo) => void;
-};
-//# sourceMappingURL=ConnectionCheck.d.ts.map
+import type TypedEmitter from 'typed-emitter';
+import type { CheckInfo, CheckerOptions, InstantiableCheck } from './checks/Checker';
+import { CheckStatus, Checker } from './checks/Checker';
+export type { CheckInfo };
+export { CheckStatus };
+declare const ConnectionCheck_base: new () => TypedEmitter<ConnectionCheckCallbacks>;
+export declare class ConnectionCheck extends ConnectionCheck_base {
+    token: string;
+    url: string;
+    options: CheckerOptions;
+    private checkResults;
+    constructor(url: string, token: string, options?: CheckerOptions);
+    private getNextCheckId;
+    private updateCheck;
+    isSuccess(): boolean;
+    getResults(): CheckInfo[];
+    createAndRunCheck<T extends Checker>(check: InstantiableCheck<T>): Promise<CheckInfo>;
+    checkWebsocket(): Promise<CheckInfo>;
+    checkWebRTC(): Promise<CheckInfo>;
+    checkTURN(): Promise<CheckInfo>;
+    checkReconnect(): Promise<CheckInfo>;
+    checkPublishAudio(): Promise<CheckInfo>;
+    checkPublishVideo(): Promise<CheckInfo>;
+    checkConnectionProtocol(): Promise<CheckInfo>;
+    checkCloudRegion(): Promise<CheckInfo>;
+}
+type ConnectionCheckCallbacks = {
+    checkUpdate: (id: number, info: CheckInfo) => void;
+};
+//# sourceMappingURL=ConnectionCheck.d.ts.map

package/dist/ts4.2/connectionHelper/checks/Checker.d.ts

@@ -1,62 +1,62 @@
-import type TypedEmitter from 'typed-emitter';
-import type { RoomConnectOptions, RoomOptions } from '../../options';
-import type RTCEngine from '../../room/RTCEngine';
-import Room from '../../room/Room';
-type LogMessage = {
-    level: 'info' | 'warning' | 'error';
-    message: string;
-};
-export declare enum CheckStatus {
-    IDLE = 0,
-    RUNNING = 1,
-    SKIPPED = 2,
-    SUCCESS = 3,
-    FAILED = 4
-}
-export type CheckInfo = {
-    name: string;
-    logs: Array<LogMessage>;
-    status: CheckStatus;
-    description: string;
-    data?: any;
-};
-export interface CheckerOptions {
-    errorsAsWarnings?: boolean;
-    roomOptions?: RoomOptions;
-    connectOptions?: RoomConnectOptions;
-    protocol?: 'udp' | 'tcp';
-}
-declare const Checker_base: new () => TypedEmitter<CheckerCallbacks>;
-export declare abstract class Checker extends Checker_base {
-    protected url: string;
-    protected token: string;
-    room: Room;
-    connectOptions?: RoomConnectOptions;
-    status: CheckStatus;
-    logs: Array<LogMessage>;
-    name: string;
-    options: CheckerOptions;
-    constructor(url: string, token: string, options?: CheckerOptions);
-    abstract get description(): string;
-    protected abstract perform(): Promise<void>;
-    run(onComplete?: () => void): Promise<CheckInfo>;
-    protected isSuccess(): boolean;
-    protected connect(url?: string): Promise<Room>;
-    protected disconnect(): Promise<void>;
-    protected skip(): void;
-    protected switchProtocol(protocol: 'udp' | 'tcp' | 'tls'): Promise<void>;
-    protected appendMessage(message: string): void;
-    protected appendWarning(message: string): void;
-    protected appendError(message: string): void;
-    protected setStatus(status: CheckStatus): void;
-    protected get engine(): RTCEngine | undefined;
-    getInfo(): CheckInfo;
-}
-export type InstantiableCheck<T extends Checker> = {
-    new (url: string, token: string, options?: CheckerOptions): T;
-};
-type CheckerCallbacks = {
-    update: (info: CheckInfo) => void;
-};
-export {};
-//# sourceMappingURL=Checker.d.ts.map
+import type TypedEmitter from 'typed-emitter';
+import type { RoomConnectOptions, RoomOptions } from '../../options';
+import type RTCEngine from '../../room/RTCEngine';
+import Room from '../../room/Room';
+type LogMessage = {
+    level: 'info' | 'warning' | 'error';
+    message: string;
+};
+export declare enum CheckStatus {
+    IDLE = 0,
+    RUNNING = 1,
+    SKIPPED = 2,
+    SUCCESS = 3,
+    FAILED = 4
+}
+export type CheckInfo = {
+    name: string;
+    logs: Array<LogMessage>;
+    status: CheckStatus;
+    description: string;
+    data?: any;
+};
+export interface CheckerOptions {
+    errorsAsWarnings?: boolean;
+    roomOptions?: RoomOptions;
+    connectOptions?: RoomConnectOptions;
+    protocol?: 'udp' | 'tcp';
+}
+declare const Checker_base: new () => TypedEmitter<CheckerCallbacks>;
+export declare abstract class Checker extends Checker_base {
+    protected url: string;
+    protected token: string;
+    room: Room;
+    connectOptions?: RoomConnectOptions;
+    status: CheckStatus;
+    logs: Array<LogMessage>;
+    name: string;
+    options: CheckerOptions;
+    constructor(url: string, token: string, options?: CheckerOptions);
+    abstract get description(): string;
+    protected abstract perform(): Promise<void>;
+    run(onComplete?: () => void): Promise<CheckInfo>;
+    protected isSuccess(): boolean;
+    protected connect(url?: string): Promise<Room>;
+    protected disconnect(): Promise<void>;
+    protected skip(): void;
+    protected switchProtocol(protocol: 'udp' | 'tcp' | 'tls'): Promise<void>;
+    protected appendMessage(message: string): void;
+    protected appendWarning(message: string): void;
+    protected appendError(message: string): void;
+    protected setStatus(status: CheckStatus): void;
+    protected get engine(): (RTCEngine | undefined);
+    getInfo(): CheckInfo;
+}
+export type InstantiableCheck<T extends Checker> = {
+    new (url: string, token: string, options?: CheckerOptions): T;
+};
+type CheckerCallbacks = {
+    update: (info: CheckInfo) => void;
+};
+export {};
+//# sourceMappingURL=Checker.d.ts.map

package/dist/ts4.2/connectionHelper/checks/cloudRegion.d.ts

@@ -1,18 +1,18 @@
-import type { CheckInfo } from './Checker';
-import { Checker } from './Checker';
-export interface RegionStats {
-    region: string;
-    rtt: number;
-    duration: number;
-}
-/**
- * Checks for connections quality to closests Cloud regions and determining the best quality
- */
-export declare class CloudRegionCheck extends Checker {
-    private bestStats?;
-    get description(): string;
-    perform(): Promise<void>;
-    getInfo(): CheckInfo;
-    private checkCloudRegion;
-}
-//# sourceMappingURL=cloudRegion.d.ts.map
+import type { CheckInfo } from './Checker';
+import { Checker } from './Checker';
+export interface RegionStats {
+    region: string;
+    rtt: number;
+    duration: number;
+}
+/**
+ * Checks for connections quality to closests Cloud regions and determining the best quality
+ */
+export declare class CloudRegionCheck extends Checker {
+    private bestStats?;
+    get description(): string;
+    perform(): Promise<void>;
+    getInfo(): CheckInfo;
+    private checkCloudRegion;
+}
+//# sourceMappingURL=cloudRegion.d.ts.map

package/dist/ts4.2/connectionHelper/checks/connectionProtocol.d.ts

@@ -1,20 +1,20 @@
-import type { CheckInfo } from './Checker';
-import { Checker } from './Checker';
-export interface ProtocolStats {
-    protocol: 'udp' | 'tcp';
-    packetsLost: number;
-    packetsSent: number;
-    qualityLimitationDurations: Record<string, number>;
-    rttTotal: number;
-    jitterTotal: number;
-    bitrateTotal: number;
-    count: number;
-}
-export declare class ConnectionProtocolCheck extends Checker {
-    private bestStats?;
-    get description(): string;
-    perform(): Promise<void>;
-    getInfo(): CheckInfo;
-    private checkConnectionProtocol;
-}
-//# sourceMappingURL=connectionProtocol.d.ts.map
+import type { CheckInfo } from './Checker';
+import { Checker } from './Checker';
+export interface ProtocolStats {
+    protocol: 'udp' | 'tcp';
+    packetsLost: number;
+    packetsSent: number;
+    qualityLimitationDurations: Record<string, number>;
+    rttTotal: number;
+    jitterTotal: number;
+    bitrateTotal: number;
+    count: number;
+}
+export declare class ConnectionProtocolCheck extends Checker {
+    private bestStats?;
+    get description(): string;
+    perform(): Promise<void>;
+    getInfo(): CheckInfo;
+    private checkConnectionProtocol;
+}
+//# sourceMappingURL=connectionProtocol.d.ts.map

package/dist/ts4.2/connectionHelper/checks/publishAudio.d.ts

@@ -1,6 +1,6 @@
-import { Checker } from './Checker';
-export declare class PublishAudioCheck extends Checker {
-    get description(): string;
-    perform(): Promise<void>;
-}
-//# sourceMappingURL=publishAudio.d.ts.map
+import { Checker } from './Checker';
+export declare class PublishAudioCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=publishAudio.d.ts.map

package/dist/ts4.2/connectionHelper/checks/publishVideo.d.ts

@@ -1,7 +1,7 @@
-import { Checker } from './Checker';
-export declare class PublishVideoCheck extends Checker {
-    get description(): string;
-    perform(): Promise<void>;
-    checkForVideo(track: MediaStreamTrack): Promise<void>;
-}
-//# sourceMappingURL=publishVideo.d.ts.map
+import { Checker } from './Checker';
+export declare class PublishVideoCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+    checkForVideo(track: MediaStreamTrack): Promise<void>;
+}
+//# sourceMappingURL=publishVideo.d.ts.map

package/dist/ts4.2/connectionHelper/checks/reconnect.d.ts

@@ -1,6 +1,6 @@
-import { Checker } from './Checker';
-export declare class ReconnectCheck extends Checker {
-    get description(): string;
-    perform(): Promise<void>;
-}
-//# sourceMappingURL=reconnect.d.ts.map
+import { Checker } from './Checker';
+export declare class ReconnectCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=reconnect.d.ts.map

package/dist/ts4.2/connectionHelper/checks/turn.d.ts

@@ -1,6 +1,6 @@
-import { Checker } from './Checker';
-export declare class TURNCheck extends Checker {
-    get description(): string;
-    perform(): Promise<void>;
-}
-//# sourceMappingURL=turn.d.ts.map
+import { Checker } from './Checker';
+export declare class TURNCheck extends Checker {
+    get description(): string;
+    perform(): Promise<void>;
+}
+//# sourceMappingURL=turn.d.ts.map

package/dist/ts4.2/connectionHelper/checks/webrtc.d.ts

@@ -1,6 +1,6 @@
-import { Checker } from './Checker';
-export declare class WebRTCCheck extends Checker {
-    get description(): string;
-    protected perform(): Promise<void>;
-}
-//# sourceMappingURL=webrtc.d.ts.map
+import { Checker } from './Checker';
+export declare class WebRTCCheck extends Checker {
+    get description(): string;
+    protected perform(): Promise<void>;
+}
+//# sourceMappingURL=webrtc.d.ts.map

package/dist/ts4.2/connectionHelper/checks/websocket.d.ts

@@ -1,6 +1,6 @@
-import { Checker } from './Checker';
-export declare class WebSocketCheck extends Checker {
-    get description(): string;
-    protected perform(): Promise<void>;
-}
-//# sourceMappingURL=websocket.d.ts.map
+import { Checker } from './Checker';
+export declare class WebSocketCheck extends Checker {
+    get description(): string;
+    protected perform(): Promise<void>;
+}
+//# sourceMappingURL=websocket.d.ts.map

package/dist/ts4.2/e2ee/E2eeManager.d.ts

@@ -1,85 +1,111 @@
-import type TypedEventEmitter from 'typed-emitter';
-import type RTCEngine from '../room/RTCEngine';
-import type Room from '../room/Room';
-import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
-import type { E2EEManagerCallbacks } from './events';
-import type { DecryptDataResponseMessage, E2EEManagerOptions, EncryptDataResponseMessage } from './types';
-export interface BaseE2EEManager {
-    setup(room: Room): void;
-    setupEngine(engine: RTCEngine): void;
-    isEnabled: boolean;
-    isDataChannelEncryptionEnabled: boolean;
-    setParticipantCryptorEnabled(enabled: boolean, participantIdentity: string): void;
-    setSifTrailer(trailer: NonSharedUint8Array): void;
-    encryptData(data: NonSharedUint8Array): Promise<EncryptDataResponseMessage['data']>;
-    handleEncryptedData(payload: NonSharedUint8Array, iv: NonSharedUint8Array, participantIdentity: string, keyIndex: number): Promise<DecryptDataResponseMessage['data']>;
-    on<E extends keyof E2EEManagerCallbacks>(event: E, listener: E2EEManagerCallbacks[E]): this;
-}
-declare const E2EEManager_base: new () => TypedEventEmitter<E2EEManagerCallbacks>;
-/**
- * @experimental
- */
-export declare class E2EEManager extends E2EEManager_base implements BaseE2EEManager {
-    protected worker: Worker;
-    protected room?: Room;
-    private encryptionEnabled;
-    private keyProvider;
-    private decryptDataRequests;
-    private encryptDataRequests;
-    private dataChannelEncryptionEnabled;
-    constructor(options: E2EEManagerOptions, dcEncryptionEnabled: boolean);
-    get isEnabled(): boolean;
-    get isDataChannelEncryptionEnabled(): boolean;
-    /**
-     * @internal
-     */
-    setup(room: Room): void;
-    /**
-     * @internal
-     */
-    setParticipantCryptorEnabled(enabled: boolean, participantIdentity: string): void;
-    /**
-     * @internal
-     */
-    setSifTrailer(trailer: NonSharedUint8Array): void;
-    private onWorkerMessage;
-    private onWorkerError;
-    private handleFrameMetadata;
-    setupEngine(engine: RTCEngine): void;
-    private setupEventListeners;
-    encryptData(data: NonSharedUint8Array): Promise<EncryptDataResponseMessage['data']>;
-    handleEncryptedData(payload: NonSharedUint8Array, iv: NonSharedUint8Array, participantIdentity: string, keyIndex: number): Promise<{
-        uuid: string;
-        payload: NonSharedUint8Array;
-    } & {
-        readonly __throws?: Error | undefined;
-    }>;
-    private postRatchetRequest;
-    private postKey;
-    private postEnable;
-    private postRTPMap;
-    private postSifTrailer;
-    /**
-     * Derive the participant's encryption state from one of its publications.
-     * Publications without trackInfo are skipped rather than thrown on: throwing
-     * inside the forEach above would leave every remaining participant without an
-     * encryption state, and a cryptor with unknown state can no longer decrypt.
-     */
-    private setParticipantCryptorEnabledForPublication;
-    private setupE2EEReceiver;
-    private setupE2EESender;
-    /**
-     * Handles the given {@code RTCRtpReceiver} by creating a {@code TransformStream} which will inject
-     * a frame decoder.
-     *
-     */
-    private handleReceiver;
-    /**
-     * Handles the given {@code RTCRtpSender} by creating a {@code TransformStream} which will inject
-     * a frame encoder.
-     *
-     */
-    private handleSender;
-}
-export {};
-//# sourceMappingURL=E2eeManager.d.ts.map
+import type TypedEventEmitter from 'typed-emitter';
+import type RTCEngine from '../room/RTCEngine';
+import type Room from '../room/Room';
+import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
+import type { E2EEManagerCallbacks } from './events';
+import type { DecryptDataResponseMessage, E2EEManagerOptions, EncryptDataResponseMessage } from './types';
+export interface BaseE2EEManager {
+    setup(room: Room): void;
+    setupEngine(engine: RTCEngine): void;
+    isEnabled: boolean;
+    isDataChannelEncryptionEnabled: boolean;
+    setParticipantCryptorEnabled(enabled: boolean, participantIdentity: string): void;
+    setSifTrailer(trailer: NonSharedUint8Array): void;
+    encryptData(data: NonSharedUint8Array): Promise<EncryptDataResponseMessage['data']>;
+    handleEncryptedData(payload: NonSharedUint8Array, iv: NonSharedUint8Array, participantIdentity: string, keyIndex: number): Promise<DecryptDataResponseMessage['data']>;
+    on<E extends keyof E2EEManagerCallbacks>(event: E, listener: E2EEManagerCallbacks[E]): this;
+    dispose?(): void;
+}
+declare const E2EEManager_base: new () => TypedEventEmitter<E2EEManagerCallbacks>;
+/**
+ * @experimental
+ */
+export declare class E2EEManager extends E2EEManager_base implements BaseE2EEManager {
+    protected worker: Worker;
+    protected room?: Room;
+    private encryptionEnabled;
+    private keyProvider;
+    private decryptDataRequests;
+    private encryptDataRequests;
+    private dataChannelEncryptionEnabled;
+    private unsubscribeLogLevel?;
+    private log;
+    get logContext(): {
+        room: string | undefined;
+        participant: string | undefined;
+    };
+    /**
+     * Runs a cleanup callback once this manager is garbage collected. Lets the
+     * log-level listener (held in a module-global Set on the main-thread logger)
+     * fall out of scope even when the consumer forgets to call `dispose()`.
+     */
+    private static disposeRegistry;
+    constructor(options: E2EEManagerOptions, dcEncryptionEnabled: boolean);
+    get isEnabled(): boolean;
+    get isDataChannelEncryptionEnabled(): boolean;
+    /**
+     * @internal
+     */
+    setup(room: Room): void;
+    /**
+     * Subscribe the current worker to main-thread `workerLogger` level changes,
+     * without strongly retaining `this` or `this.worker` from the module-global
+     * listener Set on the logger. See {@link disposeRegistry}.
+     */
+    private subscribeToLogLevelChanges;
+    /**
+     * @internal
+     * Release the log-level subscription, reject any pending encrypt/decrypt
+     * futures, and detach the worker message handlers. The worker itself is
+     * caller-owned and is not terminated. Idempotent.
+     */
+    dispose(): void;
+    /**
+     * @internal
+     */
+    setParticipantCryptorEnabled(enabled: boolean, participantIdentity: string): void;
+    /**
+     * @internal
+     */
+    setSifTrailer(trailer: NonSharedUint8Array): void;
+    private onWorkerMessage;
+    private onWorkerError;
+    private handleFrameMetadata;
+    setupEngine(engine: RTCEngine): void;
+    private setupEventListeners;
+    encryptData(data: NonSharedUint8Array): Promise<EncryptDataResponseMessage['data']>;
+    handleEncryptedData(payload: NonSharedUint8Array, iv: NonSharedUint8Array, participantIdentity: string, keyIndex: number): Promise<{
+        uuid: string;
+        payload: NonSharedUint8Array;
+    } & {
+        readonly __throws?: Error | undefined;
+    }>;
+    private postRatchetRequest;
+    private postKey;
+    private postEnable;
+    private postRTPMap;
+    private postSifTrailer;
+    /**
+     * Derive the participant's encryption state from one of its publications.
+     * Publications without trackInfo are skipped rather than thrown on: throwing
+     * inside the forEach above would leave every remaining participant without an
+     * encryption state, and a cryptor with unknown state can no longer decrypt.
+     */
+    private setParticipantCryptorEnabledForPublication;
+    private setupE2EEReceiver;
+    private setupE2EESender;
+    /**
+     * Handles the given {@code RTCRtpReceiver} by creating a {@code TransformStream} which will inject
+     * a frame decoder.
+     *
+     */
+    private handleReceiver;
+    /**
+     * Handles the given {@code RTCRtpSender} by creating a {@code TransformStream} which will inject
+     * a frame encoder.
+     *
+     */
+    private handleSender;
+}
+export {};
+//# sourceMappingURL=E2eeManager.d.ts.map