livekit-client 2.22.2 → 2.22.4

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

@@ -1,217 +1,231 @@
-import type { FrameMetadataPayload } from '../frameMetadata/frameMetadata';
-import type { FrameMetadataPublishOptions } from '../frameMetadata/types';
-import type { LogLevel } from '../logger';
-import type { VideoCodec } from '../room/track/options';
-import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
-import type { BaseE2EEManager } from './E2eeManager';
-import type { BaseKeyProvider } from './KeyProvider';
-export interface BaseMessage {
-    kind: string;
-    data?: unknown;
-}
-export interface InitMessage extends BaseMessage {
-    kind: 'init';
-    data: {
-        keyProviderOptions: KeyProviderOptions;
-        loglevel: LogLevel;
-    };
-}
-export interface SetKeyMessage extends BaseMessage {
-    kind: 'setKey';
-    data: {
-        participantIdentity?: string;
-        isPublisher: boolean;
-        key: CryptoKey;
-        keyIndex?: number;
-        updateCurrentKeyIndex: boolean;
-    };
-}
-export interface RTPVideoMapMessage extends BaseMessage {
-    kind: 'setRTPMap';
-    data: {
-        map: Map<number, VideoCodec>;
-        participantIdentity: string;
-    };
-}
-export interface SifTrailerMessage extends BaseMessage {
-    kind: 'setSifTrailer';
-    data: {
-        trailer: NonSharedUint8Array;
-    };
-}
-export interface EncodeMessage extends BaseMessage {
-    kind: 'decode' | 'encode';
-    data: {
-        participantIdentity: string;
-        readableStream: ReadableStream;
-        writableStream: WritableStream;
-        trackId: string;
-        codec?: VideoCodec;
-        /**
-         * Whether the published track advertises packet trailer features.
-         * When false, the cryptor skips the per-frame trailer extraction path
-         * entirely on decode.
-         */
-        hasPacketTrailer: boolean;
-        /**
-         * Packet trailer metadata to append on published video frames.
-         */
-        packetTrailer?: FrameMetadataPublishOptions;
-    };
-}
-export interface RemoveTransformMessage extends BaseMessage {
-    kind: 'removeTransform';
-    data: {
-        participantIdentity: string;
-        trackId: string;
-    };
-}
-export interface UpdateCodecMessage extends BaseMessage {
-    kind: 'updateCodec';
-    data: {
-        participantIdentity: string;
-        trackId: string;
-        /** undefined for audio tracks */
-        codec?: VideoCodec;
-        /**
-         * trackId this receiver's pipeline was previously set up for, set when a
-         * transceiver gets reused for a new track. Lets the worker find the cryptor
-         * that still owns the (already transferred) encoded streams and re-point it,
-         * rather than creating a fresh cryptor with no pipeline at all.
-         */
-        previousTrackId?: string;
-        hasPacketTrailer: boolean;
-    };
-}
-export interface RatchetRequestMessage extends BaseMessage {
-    kind: 'ratchetRequest';
-    data: {
-        participantIdentity?: string;
-        keyIndex?: number;
-    };
-}
-export interface RatchetMessage extends BaseMessage {
-    kind: 'ratchetKey';
-    data: {
-        participantIdentity: string;
-        keyIndex?: number;
-        ratchetResult: RatchetResult;
-    };
-}
-export interface ErrorMessage extends BaseMessage {
-    kind: 'error';
-    data: {
-        error: Error;
-        participantIdentity?: string;
-        uuid?: string;
-    };
-}
-export interface EnableMessage extends BaseMessage {
-    kind: 'enable';
-    data: {
-        participantIdentity: string;
-        enabled: boolean;
-    };
-}
-export interface InitAck extends BaseMessage {
-    kind: 'initAck';
-    data: {
-        enabled: boolean;
-    };
-}
-export interface DecryptDataRequestMessage extends BaseMessage {
-    kind: 'decryptDataRequest';
-    data: {
-        uuid: string;
-        payload: NonSharedUint8Array;
-        iv: NonSharedUint8Array;
-        participantIdentity: string;
-        keyIndex: number;
-    };
-}
-export interface DecryptDataResponseMessage extends BaseMessage {
-    kind: 'decryptDataResponse';
-    data: {
-        uuid: string;
-        payload: NonSharedUint8Array;
-    };
-}
-export interface EncryptDataRequestMessage extends BaseMessage {
-    kind: 'encryptDataRequest';
-    data: {
-        uuid: string;
-        payload: NonSharedUint8Array;
-        participantIdentity: string;
-    };
-}
-export interface EncryptDataResponseMessage extends BaseMessage {
-    kind: 'encryptDataResponse';
-    data: {
-        uuid: string;
-        payload: NonSharedUint8Array;
-        iv: NonSharedUint8Array;
-        keyIndex: number;
-    };
-}
-export interface PTMetadataFromE2EEMessage extends BaseMessage {
-    kind: 'packetTrailerMetadata';
-    data: FrameMetadataPayload;
-}
-export type E2EEWorkerMessage = InitMessage | SetKeyMessage | EncodeMessage | ErrorMessage | EnableMessage | RemoveTransformMessage | RTPVideoMapMessage | UpdateCodecMessage | RatchetRequestMessage | RatchetMessage | SifTrailerMessage | InitAck | DecryptDataRequestMessage | DecryptDataResponseMessage | EncryptDataRequestMessage | EncryptDataResponseMessage | PTMetadataFromE2EEMessage;
-export type KeySet = {
-    material: CryptoKey;
-    encryptionKey: CryptoKey;
-};
-export type RatchetResult = {
-    chainKey: ArrayBuffer;
-    cryptoKey: CryptoKey;
-};
-export type KeyProviderOptions = {
-    sharedKey: boolean;
-    ratchetSalt: string;
-    ratchetWindowSize: number;
-    failureTolerance: number;
-    keyringSize: number;
-    /**
-     * Size of the encryption key in bits.
-     * Defaults to 128. Note that 128 is currently the only value
-     * supported by non-web SDKs.
-     */
-    keySize: 128 | 256;
-};
-export type KeyInfo = {
-    key: CryptoKey;
-    participantIdentity?: string;
-    keyIndex?: number;
-};
-export type E2EEManagerOptions = {
-    keyProvider: BaseKeyProvider;
-    worker: Worker;
-};
-export type E2EEOptions = E2EEManagerOptions | {
-    /** For react-native usage. */
-    e2eeManager: BaseE2EEManager;
-};
-export type DecodeRatchetOptions = {
-    /** attempts  */
-    ratchetCount: number;
-    /** ratcheted key to try */
-    encryptionKey?: CryptoKey;
-};
-export type ScriptTransformOptions = {
-    kind: 'decode' | 'encode';
-    participantIdentity: string;
-    trackId: string;
-    codec?: VideoCodec;
-    /**
-     * Whether the published track advertises packet trailer features.
-     * When false, the cryptor skips the per-frame trailer extraction path
-     * entirely on decode.
-     */
-    hasPacketTrailer: boolean;
-    /**
-     * Packet trailer metadata to append on published video frames.
-     */
-    packetTrailer?: FrameMetadataPublishOptions;
-};
-//# sourceMappingURL=types.d.ts.map
+import type { FrameMetadataPayload } from '../frameMetadata/frameMetadata';
+import type { FrameMetadataPublishOptions } from '../frameMetadata/types';
+import type { LogLevel } from '../logger';
+import type { VideoCodec } from '../room/track/options';
+import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
+import type { BaseE2EEManager } from './E2eeManager';
+import type { BaseKeyProvider } from './KeyProvider';
+export interface BaseMessage {
+    kind: string;
+    data?: unknown;
+}
+export interface InitMessage extends BaseMessage {
+    kind: 'init';
+    data: {
+        keyProviderOptions: KeyProviderOptions;
+        loglevel: LogLevel;
+    };
+}
+export interface SetKeyMessage extends BaseMessage {
+    kind: 'setKey';
+    data: {
+        participantIdentity?: string;
+        isPublisher: boolean;
+        key: CryptoKey;
+        keyIndex?: number;
+        updateCurrentKeyIndex: boolean;
+    };
+}
+export interface RTPVideoMapMessage extends BaseMessage {
+    kind: 'setRTPMap';
+    data: {
+        map: Map<number, VideoCodec>;
+        participantIdentity: string;
+    };
+}
+export interface SifTrailerMessage extends BaseMessage {
+    kind: 'setSifTrailer';
+    data: {
+        trailer: NonSharedUint8Array;
+    };
+}
+export interface EncodeMessage extends BaseMessage {
+    kind: 'decode' | 'encode';
+    data: {
+        participantIdentity: string;
+        readableStream: ReadableStream;
+        writableStream: WritableStream;
+        trackId: string;
+        codec?: VideoCodec;
+        /**
+         * Whether the published track advertises packet trailer features.
+         * When false, the cryptor skips the per-frame trailer extraction path
+         * entirely on decode.
+         */
+        hasPacketTrailer: boolean;
+        /**
+         * Packet trailer metadata to append on published video frames.
+         */
+        packetTrailer?: FrameMetadataPublishOptions;
+    };
+}
+export interface RemoveTransformMessage extends BaseMessage {
+    kind: 'removeTransform';
+    data: {
+        participantIdentity: string;
+        trackId: string;
+    };
+}
+export interface UpdateCodecMessage extends BaseMessage {
+    kind: 'updateCodec';
+    data: {
+        participantIdentity: string;
+        trackId: string;
+        /** undefined for audio tracks */
+        codec?: VideoCodec;
+        /**
+         * trackId this receiver's pipeline was previously set up for, set when a
+         * transceiver gets reused for a new track. Lets the worker find the cryptor
+         * that still owns the (already transferred) encoded streams and re-point it,
+         * rather than creating a fresh cryptor with no pipeline at all.
+         */
+        previousTrackId?: string;
+        hasPacketTrailer: boolean;
+    };
+}
+export interface RatchetRequestMessage extends BaseMessage {
+    kind: 'ratchetRequest';
+    data: {
+        participantIdentity?: string;
+        keyIndex?: number;
+    };
+}
+export interface RatchetMessage extends BaseMessage {
+    kind: 'ratchetKey';
+    data: {
+        participantIdentity: string;
+        keyIndex?: number;
+        ratchetResult: RatchetResult;
+    };
+}
+export interface ErrorMessage extends BaseMessage {
+    kind: 'error';
+    data: {
+        error: Error;
+        participantIdentity?: string;
+        uuid?: string;
+    };
+}
+export interface EnableMessage extends BaseMessage {
+    kind: 'enable';
+    data: {
+        participantIdentity: string;
+        enabled: boolean;
+    };
+}
+export interface InitAck extends BaseMessage {
+    kind: 'initAck';
+    data: {
+        enabled: boolean;
+    };
+}
+export interface DecryptDataRequestMessage extends BaseMessage {
+    kind: 'decryptDataRequest';
+    data: {
+        uuid: string;
+        payload: NonSharedUint8Array;
+        iv: NonSharedUint8Array;
+        participantIdentity: string;
+        keyIndex: number;
+    };
+}
+export interface DecryptDataResponseMessage extends BaseMessage {
+    kind: 'decryptDataResponse';
+    data: {
+        uuid: string;
+        payload: NonSharedUint8Array;
+    };
+}
+export interface EncryptDataRequestMessage extends BaseMessage {
+    kind: 'encryptDataRequest';
+    data: {
+        uuid: string;
+        payload: NonSharedUint8Array;
+        participantIdentity: string;
+    };
+}
+export interface EncryptDataResponseMessage extends BaseMessage {
+    kind: 'encryptDataResponse';
+    data: {
+        uuid: string;
+        payload: NonSharedUint8Array;
+        iv: NonSharedUint8Array;
+        keyIndex: number;
+    };
+}
+export interface PTMetadataFromE2EEMessage extends BaseMessage {
+    kind: 'packetTrailerMetadata';
+    data: FrameMetadataPayload;
+}
+export interface LogMessage extends BaseMessage {
+    kind: 'log';
+    data: {
+        level: 'trace' | 'debug' | 'info' | 'warn' | 'error';
+        msg: string;
+        context?: object;
+    };
+}
+export interface SetLogLevelMessage extends BaseMessage {
+    kind: 'setLogLevel';
+    data: {
+        level: LogLevel;
+    };
+}
+export type E2EEWorkerMessage = InitMessage | SetKeyMessage | EncodeMessage | ErrorMessage | EnableMessage | RemoveTransformMessage | RTPVideoMapMessage | UpdateCodecMessage | RatchetRequestMessage | RatchetMessage | SifTrailerMessage | InitAck | DecryptDataRequestMessage | DecryptDataResponseMessage | EncryptDataRequestMessage | EncryptDataResponseMessage | PTMetadataFromE2EEMessage | LogMessage | SetLogLevelMessage;
+export type KeySet = {
+    material: CryptoKey;
+    encryptionKey: CryptoKey;
+};
+export type RatchetResult = {
+    chainKey: ArrayBuffer;
+    cryptoKey: CryptoKey;
+};
+export type KeyProviderOptions = {
+    sharedKey: boolean;
+    ratchetSalt: string;
+    ratchetWindowSize: number;
+    failureTolerance: number;
+    keyringSize: number;
+    /**
+     * Size of the encryption key in bits.
+     * Defaults to 128. Note that 128 is currently the only value
+     * supported by non-web SDKs.
+     */
+    keySize: 128 | 256;
+};
+export type KeyInfo = {
+    key: CryptoKey;
+    participantIdentity?: string;
+    keyIndex?: number;
+};
+export type E2EEManagerOptions = {
+    keyProvider: BaseKeyProvider;
+    worker: Worker;
+};
+export type E2EEOptions = E2EEManagerOptions | {
+    /** For react-native usage. */
+    e2eeManager: BaseE2EEManager;
+};
+export type DecodeRatchetOptions = {
+    /** attempts  */
+    ratchetCount: number;
+    /** ratcheted key to try */
+    encryptionKey?: CryptoKey;
+};
+export type ScriptTransformOptions = {
+    kind: 'decode' | 'encode';
+    participantIdentity: string;
+    trackId: string;
+    codec?: VideoCodec;
+    /**
+     * Whether the published track advertises packet trailer features.
+     * When false, the cryptor skips the per-frame trailer extraction path
+     * entirely on decode.
+     */
+    hasPacketTrailer: boolean;
+    /**
+     * Packet trailer metadata to append on published video frames.
+     */
+    packetTrailer?: FrameMetadataPublishOptions;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -1,32 +1,32 @@
-import type { DataPacket } from '@livekit/protocol';
-import { EncryptedPacketPayload } from '@livekit/protocol';
-import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
-import type { KeyProviderOptions } from './types';
-export declare function isE2EESupported(): boolean;
-export declare function isScriptTransformSupported(): boolean;
-export declare function isInsertableStreamSupported(): boolean;
-export declare function isVideoFrame(frame: RTCEncodedAudioFrame | RTCEncodedVideoFrame): frame is RTCEncodedVideoFrame;
-export declare function importKey(keyBytes: NonSharedUint8Array | ArrayBuffer, algorithm?: string | {
-    name: string;
-}, usage?: 'derive' | 'encrypt'): Promise<CryptoKey>;
-export declare function createKeyMaterialFromString(password: string): Promise<CryptoKey>;
-export declare function createKeyMaterialFromBuffer(cryptoBuffer: ArrayBuffer): Promise<CryptoKey>;
-/**
- * Derives a set of keys from the master key.
- * See https://tools.ietf.org/html/draft-omara-sframe-00#section-4.3.1
- */
-export declare function deriveKeys(material: CryptoKey, options: KeyProviderOptions): Promise<{
-    material: CryptoKey;
-    encryptionKey: CryptoKey;
-}>;
-export declare function createE2EEKey(): NonSharedUint8Array;
-/**
- * Ratchets a key. See
- * https://tools.ietf.org/html/draft-omara-sframe-00#section-4.3.5.1
- */
-export declare function ratchet(material: CryptoKey, salt: string): Promise<ArrayBuffer>;
-export declare function needsRbspUnescaping(frameData: NonSharedUint8Array): boolean;
-export declare function parseRbsp(stream: NonSharedUint8Array): NonSharedUint8Array;
-export declare function writeRbsp(data_in: NonSharedUint8Array): NonSharedUint8Array;
-export declare function asEncryptablePacket(packet: DataPacket): EncryptedPacketPayload | undefined;
-//# sourceMappingURL=utils.d.ts.map
+import type { DataPacket } from '@livekit/protocol';
+import { EncryptedPacketPayload } from '@livekit/protocol';
+import type { NonSharedUint8Array } from '../type-polyfills/non-shared-typed-arrays';
+import type { KeyProviderOptions } from './types';
+export declare function isE2EESupported(): boolean;
+export declare function isScriptTransformSupported(): boolean;
+export declare function isInsertableStreamSupported(): boolean;
+export declare function isVideoFrame(frame: RTCEncodedAudioFrame | RTCEncodedVideoFrame): frame is RTCEncodedVideoFrame;
+export declare function importKey(keyBytes: NonSharedUint8Array | ArrayBuffer, algorithm?: string | {
+    name: string;
+}, usage?: 'derive' | 'encrypt'): Promise<CryptoKey>;
+export declare function createKeyMaterialFromString(password: string): Promise<CryptoKey>;
+export declare function createKeyMaterialFromBuffer(cryptoBuffer: ArrayBuffer): Promise<CryptoKey>;
+/**
+ * Derives a set of keys from the master key.
+ * See https://tools.ietf.org/html/draft-omara-sframe-00#section-4.3.1
+ */
+export declare function deriveKeys(material: CryptoKey, options: KeyProviderOptions): Promise<{
+    material: CryptoKey;
+    encryptionKey: CryptoKey;
+}>;
+export declare function createE2EEKey(): NonSharedUint8Array;
+/**
+ * Ratchets a key. See
+ * https://tools.ietf.org/html/draft-omara-sframe-00#section-4.3.5.1
+ */
+export declare function ratchet(material: CryptoKey, salt: string): Promise<ArrayBuffer>;
+export declare function needsRbspUnescaping(frameData: NonSharedUint8Array): boolean;
+export declare function parseRbsp(stream: NonSharedUint8Array): NonSharedUint8Array;
+export declare function writeRbsp(data_in: NonSharedUint8Array): NonSharedUint8Array;
+export declare function asEncryptablePacket(packet: DataPacket): EncryptedPacketPayload | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/ts4.2/e2ee/worker/DataCryptor.d.ts

@@ -1,16 +1,16 @@
-import type { NonSharedUint8Array } from '../../type-polyfills/non-shared-typed-arrays';
-import type { DecodeRatchetOptions, KeySet } from '../types';
-import type { ParticipantKeyHandler } from './ParticipantKeyHandler';
-export declare class DataCryptor {
-    private static sendCount;
-    private static makeIV;
-    static encrypt(data: NonSharedUint8Array, keys: ParticipantKeyHandler): Promise<{
-        payload: NonSharedUint8Array;
-        iv: NonSharedUint8Array;
-        keyIndex: number;
-    }>;
-    static decrypt(data: NonSharedUint8Array, iv: NonSharedUint8Array, keys: ParticipantKeyHandler, keyIndex?: number, initialMaterial?: KeySet, ratchetOpts?: DecodeRatchetOptions): Promise<{
-        payload: NonSharedUint8Array;
-    }>;
-}
-//# sourceMappingURL=DataCryptor.d.ts.map
+import type { NonSharedUint8Array } from '../../type-polyfills/non-shared-typed-arrays';
+import type { DecodeRatchetOptions, KeySet } from '../types';
+import type { ParticipantKeyHandler } from './ParticipantKeyHandler';
+export declare class DataCryptor {
+    private static sendCount;
+    private static makeIV;
+    static encrypt(data: NonSharedUint8Array, keys: ParticipantKeyHandler): Promise<{
+        payload: NonSharedUint8Array;
+        iv: NonSharedUint8Array;
+        keyIndex: number;
+    }>;
+    static decrypt(data: NonSharedUint8Array, iv: NonSharedUint8Array, keys: ParticipantKeyHandler, keyIndex?: number, initialMaterial?: KeySet, ratchetOpts?: DecodeRatchetOptions): Promise<{
+        payload: NonSharedUint8Array;
+    }>;
+}
+//# sourceMappingURL=DataCryptor.d.ts.map

package/dist/ts4.2/e2ee/worker/ErrorRateLimiter.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Per-key rate limiter for repeated errors. Prevents log/emit floods and the
+ * unbounded map growth that a per-event log would cause when a broken key
+ * keeps producing failures.
+ */
+export declare class ErrorRateLimiter {
+    private readonly throttleMs;
+    private readonly windowMs;
+    private readonly maxPerWindow;
+    private lastAt;
+    private counts;
+    constructor(throttleMs?: number, windowMs?: number, maxPerWindow?: number);
+    reset(): void;
+    countFor(key: string): number;
+    /**
+     * Returns true if the caller should emit for this key. Invokes `onSuppress`
+     * exactly once per window when the per-window limit is first crossed.
+     */
+    shouldEmit(key: string, onSuppress?: () => void): boolean;
+}
+//# sourceMappingURL=ErrorRateLimiter.d.ts.map