livekit-client 2.20.2 → 2.21.0

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

@@ -268,7 +268,11 @@ declare class Room extends Room_base {
      */
     private updateSubscriptions;
     private getRemoteParticipantBySid;
+    /** The client capabilities this SDK advertises to other participants in its `ClientInfo`. */
+    private getClientInfoCapabilities;
     private getRemoteParticipantClientProtocol;
+    private getRemoteParticipantCapabilities;
+    private getAllRemoteParticipantIdentities;
     private registerRpcDataStreamHandler;
     private registerConnectionReconcile;
     private clearConnectionReconcile;

package/dist/ts4.2/room/data-channel/DataChannelManager.d.ts

@@ -0,0 +1,62 @@
+import type { PCTransportManager } from '../PCTransportManager';
+import { FlowControlledDataChannel } from './FlowControlledDataChannel';
+import { LossyDataChannel } from './LossyDataChannel';
+import { ReliableDataChannel } from './ReliableDataChannel';
+import { DataChannelKind } from './types';
+export interface DataChannelManagerOptions {
+    /** Whether the owning engine has been closed — a closed engine rejects headroom waiters. */
+    isEngineClosed: () => boolean;
+    /**
+     * Whether a reconnect attempt is underway: reliable sends defer to the resume replay and lossy
+     * sends are skipped while this is true.
+     */
+    isReconnecting: () => boolean;
+    onDataMessage: (message: MessageEvent) => void;
+    onDataTrackMessage: (message: MessageEvent) => void;
+    onDataError: (event: Event) => void;
+    onChannelClose: (kind: DataChannelKind) => void;
+    /** A channel's buffer crossed its low-water mark (debounced). Drives DCBufferStatusChanged. */
+    onBufferStatusChanged: (kind: DataChannelKind, isLow: boolean) => void;
+}
+/**
+ * Owns the engine's data channels: the three flow-controlled publisher channel wrappers (which
+ * live for the engine's lifetime and have RTCDataChannel handles attached/detached as peer
+ * connections come and go) plus the subscriber-side receive handles adopted by label.
+ *
+ * Handle turnover goes through {@link FlowControlledDataChannel.attach}/`detach`, which reject
+ * parked headroom waiters as a built-in — there is no separate invalidation step to forget.
+ */
+export declare class DataChannelManager {
+    readonly reliable: ReliableDataChannel;
+    readonly lossy: LossyDataChannel;
+    readonly dataTrack: LossyDataChannel;
+    private reliableSub?;
+    private lossySub?;
+    private dataTrackSub?;
+    private opts;
+    constructor(opts: DataChannelManagerOptions);
+    /** The flow-control wrapper for `kind`. */
+    channelFor(kind: DataChannelKind): FlowControlledDataChannel;
+    /** The raw RTCDataChannel handle for `kind`, publisher side by default. */
+    getHandle(kind: DataChannelKind, subscriber?: boolean): RTCDataChannel | undefined;
+    get hasPublisherChannels(): boolean;
+    /**
+     * Creates the three publisher data channels on the given transport, wires their handlers, and
+     * attaches them to the wrappers — attaching rejects any waiters still parked on replaced
+     * channel objects.
+     */
+    createPublisherChannels(pcManager: PCTransportManager): void;
+    /**
+     * Adopts a subscriber-side data channel by label, wiring the matching receive handler.
+     * Returns false for labels this manager doesn't own.
+     */
+    adoptSubscriberChannel(channel: RTCDataChannel): boolean;
+    /**
+     * Tears down all channels for a peer-connection cleanup: rejects parked waiters (detach — the
+     * spec allows `pc.close()` to transition channels to 'closed' without firing events, so waiting
+     * for browser close events is not an option), strips handlers, closes the handles, and resets
+     * the reliable session state.
+     */
+    teardown(): void;
+}
+//# sourceMappingURL=DataChannelManager.d.ts.map

package/dist/ts4.2/room/data-channel/FlowControlledDataChannel.d.ts

@@ -0,0 +1,95 @@
+import type { DataChannelKind } from './types';
+export interface FlowControlledDataChannelOptions {
+    kind: DataChannelKind;
+    /** Buffer level (bytes) at which blocked senders resume; armed as `bufferedAmountLowThreshold`. */
+    lowWaterMark: number;
+    /** Buffer level (bytes) above which senders block until the buffer drains to the low mark. */
+    highWaterMark: number;
+    /** Whether the owning engine has been closed — a closed engine rejects waiters immediately. */
+    isEngineClosed: () => boolean;
+    /**
+     * Notified when the buffer crosses the low-water mark in either direction (debounced: fires only
+     * on an actual change). Drives the engine's public DCBufferStatusChanged event.
+     */
+    onBufferStatusChanged?: (isLow: boolean) => void;
+}
+/**
+ * Two-watermark flow control for one data channel kind.
+ *
+ * Owns the per-kind headroom gate: senders proceed freely while the buffer is at or below the
+ * high-water mark and otherwise block — serialized FIFO through a mutex — until the browser's
+ * `bufferedamountlow` event (armed at the low-water mark) signals the buffer has drained. The
+ * serialization prevents woken senders from all refilling at once and overflowing the SCTP send
+ * buffer (see livekit/client-sdk-js#1995).
+ *
+ * Waiters are parked on the channel object captured at wait entry. If that object stops being
+ * current — replaced or torn down — its events may never fire again, so the owner must call
+ * {@link invalidateWaiters}, which aborts parked waiters (releasing the gate); the next waiter
+ * gets a fresh controller.
+ */
+export declare class FlowControlledDataChannel {
+    readonly kind: DataChannelKind;
+    readonly lowWaterMark: number;
+    readonly highWaterMark: number;
+    protected isEngineClosed: () => boolean;
+    private onBufferStatusChanged?;
+    /** Last emitted low-water status; starts true (an empty buffer is below the mark). */
+    private bufferStatusLow;
+    private handle?;
+    private headroomLock;
+    /** Cancels parked headroom waiters when the handle is replaced or torn down. */
+    private waiterAbortController;
+    constructor(opts: FlowControlledDataChannelOptions);
+    /** The currently attached RTCDataChannel handle, if any. */
+    get channelHandle(): RTCDataChannel | undefined;
+    /**
+     * Attaches the channel handle this wrapper controls. Replacing an existing handle rejects
+     * parked waiters — their events would never fire again on the abandoned object — and installs a
+     * fresh controller, so queued senders re-check against the new channel. Wrappers outlive their
+     * handles: this is the one place handle turnover happens, which is what makes stranding a
+     * waiter structurally impossible.
+     */
+    attach(dc: RTCDataChannel): void;
+    /** Detaches the handle on teardown, rejecting parked waiters. */
+    detach(reason?: string): void;
+    protected getChannel(): RTCDataChannel | undefined;
+    /**
+     * Whether the send buffer has room to accept more data (the send gate). Senders proceed while
+     * this is true and block once it goes false. Callers resolve the handle (and decide what an
+     * absent one means) before asking.
+     */
+    isBelowHighWaterMark(dc: RTCDataChannel): boolean;
+    /**
+     * Whether the send buffer has drained to its low-water mark. Drives the engine's public
+     * DCBufferStatusChanged event.
+     */
+    isBelowLowWaterMark(dc: RTCDataChannel): boolean;
+    /**
+     * Acquires the headroom lock, resolving with the unlock function. Batch senders (the resume
+     * replay) hold it across all of their sends so no other sender can interleave, calling
+     * {@link waitForHeadroomWithoutLock} per message to respect flow control within the batch.
+     */
+    lockHeadroom(): Promise<() => void>;
+    /**
+     * Resolves once the caller may send on this channel: immediately while the send buffer is at or
+     * below its high-water mark, otherwise once the buffer has drained to the low-water mark (the
+     * `bufferedamountlow` event). Callers are serialized through the headroom lock so that, when
+     * the buffer drains, they refill it one at a time (up to the high-water mark) rather than all
+     * sending at once and overflowing the SCTP send buffer (see livekit/client-sdk-js#1995). The
+     * closed/buffer checks run inside the lock so queued callers proceed in FIFO order.
+     */
+    waitForHeadroomWithLock(): Promise<void>;
+    /** Core wait of {@link waitForHeadroomWithLock}. The caller must hold the headroom lock. */
+    waitForHeadroomWithoutLock(): Promise<void>;
+    /** Rejects all parked headroom waiters; the next waiter gets a fresh controller. */
+    invalidateWaiters(reason: string): void;
+    /**
+     * Recomputes whether the buffer has drained to the low-water mark and, if that changed since the
+     * last check, notifies the status listener. Two independent triggers land here: a send (which
+     * raises the buffer) and the `bufferedamountlow` drain event (which lowers it) — the latter has
+     * no send to hang the work off, which is why this is a shared entry point rather than a tail of
+     * `send`.
+     */
+    refreshBufferStatus(): void;
+}
+//# sourceMappingURL=FlowControlledDataChannel.d.ts.map

package/dist/ts4.2/room/data-channel/LossyDataChannel.d.ts

@@ -0,0 +1,41 @@
+import type { NonSharedUint8Array } from '../../type-polyfills/non-shared-typed-arrays';
+import type { FlowControlledDataChannelOptions } from './FlowControlledDataChannel';
+import { FlowControlledDataChannel } from './FlowControlledDataChannel';
+export interface LossyDataChannelOptions extends FlowControlledDataChannelOptions {
+    /**
+     * What to do with a send while the buffer is full: `drop` discards it to keep latency bounded
+     * (the classic lossy channel), `wait` backpressures the producer until there is headroom (the
+     * data-track channel, whose producer decides what to skip at frame granularity).
+     */
+    bufferFullBehavior: 'drop' | 'wait';
+    /** Sends are silently discarded while this is true (a reconnect attempt is underway). */
+    shouldSkipSends: () => boolean;
+}
+/**
+ * A lossy channel: flow control plus a per-instance full-buffer policy.
+ *
+ * Each instance owns its own byterate stat, drop counter, and (when tuning is started) the
+ * dynamic `bufferedAmountLowThreshold` adjustment that keeps the drop gate at roughly 100ms of
+ * buffered latency. Keeping these per instance is what prevents one channel's traffic from
+ * steering another channel's policy.
+ */
+export declare class LossyDataChannel extends FlowControlledDataChannel {
+    private bufferFullBehavior;
+    private shouldSkipSends;
+    private statCurrentBytes;
+    private statByterate;
+    private statInterval;
+    private dropCount;
+    constructor(opts: LossyDataChannelOptions);
+    /** Sends prepared bytes with this channel's full-buffer policy (drop or wait). */
+    send(msg: NonSharedUint8Array): Promise<void>;
+    /**
+     * Starts the once-per-second adjustment of the channel's `bufferedAmountLowThreshold` to the
+     * observed byterate, keeping the drop gate at roughly 100ms of buffered latency (clamped to
+     * the watermarks). Restarts cleanly if already running.
+     */
+    startThresholdTuning(): void;
+    /** Stops the threshold tuning and resets the stats and drop counter. */
+    stopThresholdTuning(): void;
+}
+//# sourceMappingURL=LossyDataChannel.d.ts.map

package/dist/ts4.2/room/data-channel/ReliableDataChannel.d.ts

@@ -0,0 +1,57 @@
+import type { NonSharedUint8Array } from '../../type-polyfills/non-shared-typed-arrays';
+import type { FlowControlledDataChannelOptions } from './FlowControlledDataChannel';
+import { FlowControlledDataChannel } from './FlowControlledDataChannel';
+export interface ReliableDataChannelOptions extends FlowControlledDataChannelOptions {
+    /**
+     * Whether sends should currently be deferred to the resume replay instead of hitting the wire
+     * (i.e. a reconnect attempt is underway). Read at send time so the reliable channel matches the
+     * engine's reconnect state without owning it.
+     */
+    isDeferringSends: () => boolean;
+}
+/**
+ * The reliable channel: flow control plus delivery-across-resume semantics.
+ *
+ * Every packet gets a monotonic sequence (stamped into the protobuf by the caller before
+ * serialization, via {@link nextSequence}) and is retained in a replay buffer until the channel's
+ * `bufferedAmount` confirms it has been handed to the transport. Sends that land in a reconnect
+ * window — or whose headroom wait is torn down transiently — are queued unsent and resolve;
+ * {@link replay} delivers them (plus any unacked packets) after a resume. Only an engine close
+ * rejects, because no replay is coming after that.
+ */
+export declare class ReliableDataChannel extends FlowControlledDataChannel {
+    private messageBuffer;
+    private sequence;
+    private isDeferringSends;
+    constructor(opts: ReliableDataChannelOptions);
+    /**
+     * Claims the next packet sequence. The caller stamps it into the packet before serialization,
+     * then passes it back to {@link send} so the replay buffer stays keyed by wire sequence.
+     */
+    nextSequence(): number;
+    /**
+     * Sends prepared bytes with reliable semantics. Resolves once the packet has either been handed
+     * to the channel or queued for the resume replay; throws only when the engine is closed.
+     */
+    send(msg: NonSharedUint8Array, sequence: number): Promise<void>;
+    /**
+     * Replays the buffered backlog after a resume: drops everything the server acked
+     * (`lastMessageSeq`), then re-sends the rest in order. The headroom lock is held across the
+     * whole replay — releasing it between messages would let a concurrent send (whose newer
+     * sequence was already assigned before it queued on the lock) hit the wire mid-replay, and
+     * receivers would then discard the remaining lower-sequence resent messages as duplicates.
+     */
+    replay(lastMessageSeq: number): Promise<void>;
+    /**
+     * Before recomputing status, trim packets the transport has now delivered — a send or a drain
+     * may have acked buffered packets, and the replay buffer is keyed off the channel's buffered
+     * bytes.
+     */
+    refreshBufferStatus(): void;
+    /**
+     * Drops all replay state and restarts sequencing. Only valid on a full reconnect, where the
+     * session (and the receivers' sequence tracking) starts over.
+     */
+    reset(): void;
+}
+//# sourceMappingURL=ReliableDataChannel.d.ts.map

package/dist/ts4.2/room/data-channel/types.d.ts

@@ -0,0 +1,12 @@
+export declare enum DataChannelKind {
+    RELIABLE = 0,
+    LOSSY = 1,
+    DATA_TRACK_LOSSY = 2
+}
+export declare const reliableDataChannelWaterMarkLow: number;
+export declare const reliableDataChannelWaterMarkHigh: number;
+export declare const lossyDataChannelWaterMarkLow: number;
+export declare const lossyDataChannelWaterMarkHigh: number;
+export declare function dataChannelLowWaterMark(kind: DataChannelKind): number;
+export declare function dataChannelHighWaterMark(kind: DataChannelKind): number;
+//# sourceMappingURL=types.d.ts.map

package/dist/ts4.2/room/data-stream/compression.d.ts

@@ -0,0 +1,49 @@
+/*
+* Compression helpers for data streams. The buffered deflate-raw variant ({@link deflateRawCompress})
+* is for the inline (single-packet) case where the payload is small and bounded;
+* {@link deflateRawTransform} / {@link inflateRawTransform} serve the chunked (multi-packet)
+* `sendText`/`sendBytes`/`sendFile` paths, streaming the bytes through without buffering the whole
+* payload.
+*
+* These operate on bytes (not strings) so a single set of helpers serves both text and byte streams;
+* the `TextEncoder`/`TextDecoder` boundary lives at the manager/reader edges.
+*
+* Both streaming variants are exposed as `ReadableWritablePair`s so they drop straight into a
+* `pipeThrough` chain. Each needs one localized cast to bridge a DOM lib-type mismatch: the platform
+* `CompressionStream`/`DecompressionStream` type their `writable` as `WritableStream<BufferSource>`
+* (a wider element type than `Uint8Array`), and `WritableStream<W>` is covariant in `W`, so neither
+* is structurally a `ReadableWritablePair<Uint8Array, Uint8Array>` without help.
+*
+* @internal
+*/
+import type { NonSharedUint8Array } from '../../type-polyfills/non-shared-typed-arrays';
+/**
+ * A `deflate-raw` compression transform (inverse of {@link inflateRawTransform}): pipe a byte stream
+ * through it to get the compressed bytes without buffering the whole payload. Used for the chunked
+ * `sendText`/`sendBytes`/`sendFile` paths, where the full payload is known up front but is streamed
+ * (e.g. from `file.stream()`) rather than held in memory.
+ */
+export declare function deflateRawTransform(): ReadableWritablePair<NonSharedUint8Array, NonSharedUint8Array>;
+/**
+ * A `deflate-raw` decompression transform (inverse of {@link deflateRawTransform}): pipe a
+ * stream of compressed bytes through it to get the decompressed bytes. Inflate emits output greedily,
+ * so as long as the sender flushed at write boundaries each write's content is produced as soon as
+ * its compressed bytes arrive.
+ */
+export declare function inflateRawTransform(): ReadableWritablePair<NonSharedUint8Array, NonSharedUint8Array>;
+/** deflate-raw compresses a byte array in full. Use for inline payloads; prefer the streaming
+ * path for the chunked case. */
+export declare function deflateRawCompress(data: NonSharedUint8Array): Promise<NonSharedUint8Array>;
+/**
+ * Decompresses a raw-deflate byte array in full (inverse of {@link deflateRawCompress}).
+ * `maxByteLength` bounds the decompressed output (decompression-bomb guard); exceeding it rejects
+ * with a `PayloadTooLarge` error.
+ */
+export declare function deflateRawDecompress(data: NonSharedUint8Array, maxByteLength?: number): Promise<NonSharedUint8Array>;
+/**
+ * Drains a byte stream, concatenating all of its chunks into a single array. When
+ * `maxByteLength` is given, drops the stream and throws `PayloadTooLarge` as soon as the
+ * accumulated output exceeds it.
+ */
+export declare function collect(stream: ReadableStream<NonSharedUint8Array>, maxByteLength?: number): Promise<NonSharedUint8Array>;
+//# sourceMappingURL=compression.d.ts.map

package/dist/ts4.2/room/data-stream/constants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Maximum size of a single data-stream chunk in bytes, and the budget used to decide whether a
+ * payload can be sent inline as a single header packet. Kept below the ~16k data-channel MTU to
+ * leave headroom for protocol framing and E2EE overhead.
+ *
+ * @internal
+ */
+export declare const STREAM_CHUNK_SIZE_BYTES = 15000;
+/**
+ * Default cap on the number of decompressed bytes a single incoming compressed data stream may
+ * produce (5 GB). A tiny compressed payload can inflate to an arbitrarily large output
+ * (decompression bomb), so the decompressor's output is bounded rather than trusting the wire
+ * size; streams exceeding the cap error with `PayloadTooLarge`.
+ *
+ * @internal
+ */
+export declare const DEFAULT_MAX_PAYLOAD_BYTE_LENGTH = 5000000000;
+//# sourceMappingURL=constants.d.ts.map

package/dist/ts4.2/room/data-stream/incoming/IncomingDataStreamManager.d.ts

@@ -3,6 +3,10 @@ import { Encryption_Type } from '@livekit/protocol';
 import type { ByteStreamHandler, TextStreamHandler } from './StreamReader';
 export default class IncomingDataStreamManager {
     private log;
+    /** Max number of decompressed bytes an incoming compressed stream may produce before it is
+     * errored (decompression-bomb guard). */
+    private maxPayloadByteLength;
+    constructor(maxPayloadByteLength?: number);
     private byteStreamControllers;
     private textStreamControllers;
     private byteStreamHandlers;

package/dist/ts4.2/room/data-stream/outgoing/OutgoingDataStreamManager.d.ts

@@ -1,6 +1,7 @@
+import { ClientInfo_Capability } from '@livekit/protocol';
 import type { StructuredLogger } from '../../../logger';
 import type RTCEngine from '../../RTCEngine';
-import type { SendFileOptions, SendTextOptions, StreamBytesOptions, StreamTextOptions, TextStreamInfo } from '../../types';
+import type { ByteStreamInfo, SendBytesOptions, SendFileOptions, SendTextOptions, StreamBytesOptions, StreamTextOptions, TextStreamInfo } from '../../types';
 import { ByteStreamWriter, TextStreamWriter } from './StreamWriter';
 /**
  * Manages sending custom user data via data channels.
@@ -9,10 +10,49 @@ import { ByteStreamWriter, TextStreamWriter } from './StreamWriter';
 export default class OutgoingDataStreamManager {
     protected engine: RTCEngine;
     protected log: StructuredLogger;
-    constructor(engine: RTCEngine, log: StructuredLogger);
+    /** Returns the advertised client protocol of a remote participant, used to decide whether a
+     * recipient can receive single-packet (inline) data streams. */
+    protected getRemoteParticipantClientProtocol: (identity: string) => number;
+    /** Returns the client capabilities a remote participant advertises, used to decide whether a
+     * recipient can decompress a deflate-raw compressed stream. */
+    protected getRemoteParticipantCapabilities: (identity: string) => Array<ClientInfo_Capability>;
+    /** Returns the identities of every remote participant currently in the room, used to decide
+     * whether a broadcast (no explicit destinations) can be sent inline. */
+    protected getAllRemoteParticipantIdentities: () => Array<string>;
+    constructor(engine: RTCEngine, log: StructuredLogger, getRemoteParticipantClientProtocol: (identity: string) => number, getRemoteParticipantCapabilities: (identity: string) => Array<ClientInfo_Capability>, getAllRemoteParticipantIdentities: () => Array<string>);
     setupEngine(engine: RTCEngine): void;
     /** {@inheritDoc LocalParticipant.sendText} */
     sendText(text: string, options?: SendTextOptions): Promise<TextStreamInfo>;
+    /**
+     * Sends a complete in-memory byte payload. Mirrors {@link sendText}'s semantics: when every
+     * recipient supports data streams v2 the payload rides inline in a single header packet
+     * (optionally deflate-raw compressed), otherwise it is sent as a (optionally compressed)
+     * chunked byte stream. Unlike {@link sendFile}, the whole payload is already in memory, so the
+     * inline single-packet fast path applies.
+     */
+    sendBytes(bytes: Uint8Array, options?: SendBytesOptions): Promise<ByteStreamInfo>;
+    /**
+     * Returns true only if every recipient is known to support data streams v2 (single-packet inline
+     * streams and compression). For a targeted send this checks the named destination identities; for
+     * a broadcast (no explicit destinations) it checks every remote participant currently in the room.
+     * An empty room (nobody to receive) is considered eligible.
+     */
+    private allRecipientsSupportV2;
+    /**
+     * Returns true only if every recipient advertises the deflate-raw compression capability (so it
+     * can decompress a compressed stream). Resolved the same way as {@link allRecipientsSupportV2}:
+     * named destinations, or every remote participant for a broadcast; an empty room is eligible.
+     */
+    private allRecipientsSupportCompression;
+    /**
+     * Shared chunked-stream send for `sendText`/`sendFile`: sends the prebuilt header packet, then
+     * forwards `source` (optionally deflate-raw compressed) as `streamChunk` packets re-chunked to
+     * the MTU budget with contiguous indices, then sends the trailer. The source is consumed
+     * incrementally, so a `file.stream()` is never buffered in full. The platform compressor can't
+     * flush mid-stream, so compression is only used when the whole payload is available as a stream
+     * up front (not for incremental writers like `streamText`/`streamBytes`).
+     */
+    private sendChunkedByteStream;
     /**
      * @internal
      */
@@ -20,6 +60,13 @@ export default class OutgoingDataStreamManager {
     sendFile(file: File, options?: SendFileOptions): Promise<{
         id: string;
     }>;
+    /**
+     * Streams a file as a chunked byte stream, compressed (deflate-raw) when the runtime supports it
+     * and every recipient is on data streams v2. The file is piped `file.stream()` →
+     * (`CompressionStream`) → chunk packets via {@link sendChunkedByteStream}, so it is never fully
+     * buffered in memory — unlike {@link sendBytes}, there is no inline single-packet fast path for
+     * files (the compressed size can't be known up front without buffering the whole file).
+     */
     private _sendFile;
     streamBytes(options?: StreamBytesOptions): Promise<ByteStreamWriter>;
 }

package/dist/ts4.2/room/data-stream/outgoing/header-utils.d.ts

@@ -0,0 +1,18 @@
+import { DataPacket, DataStream_CompressionType, DataStream_Header } from '@livekit/protocol';
+import type { ByteStreamInfo, StreamTextOptions, TextStreamInfo } from '../../types';
+/** The data-streams-v2 wire signals carried directly on the header: the compression flag and the
+ * inline single-packet payload. Both used to live in reserved header attributes; they are now
+ * first-class protobuf fields on `DataStream.Header`. */
+export interface StreamHeaderV2Fields {
+    /** Compression applied to the inline/chunked payload. Defaults to `NONE` when omitted. */
+    compression?: DataStream_CompressionType;
+    /** The full payload smuggled into the header for single-packet (inline) sends. */
+    inlineContent?: Uint8Array;
+}
+/** Builds the `DataStream_Header` for a text stream from its info and stream options. */
+export declare function buildTextStreamHeader(info: TextStreamInfo, options?: Pick<StreamTextOptions, 'version' | 'replyToStreamId' | 'type'>, v2?: StreamHeaderV2Fields): DataStream_Header;
+/** Builds the `DataStream_Header` for a byte stream from its info. */
+export declare function buildByteStreamHeader(info: ByteStreamInfo, v2?: StreamHeaderV2Fields): DataStream_Header;
+/** Wraps a `DataStream_Header` in a `DataPacket` ready to be sent over a data channel. */
+export declare function createStreamHeaderPacket(header: DataStream_Header, destinationIdentities?: Array<string>): DataPacket;
+//# sourceMappingURL=header-utils.d.ts.map

package/dist/ts4.2/room/errors.d.ts

@@ -135,7 +135,9 @@ export declare enum DataStreamErrorReason {
     LengthExceeded = 3,
     Incomplete = 4,
     HandlerAlreadyRegistered = 7,
-    EncryptionTypeMismatch = 8
+    EncryptionTypeMismatch = 8,
+    HeaderTooLarge = 9,
+    PayloadTooLarge = 10
 }
 export declare class DataStreamError extends LivekitReasonedError<DataStreamErrorReason> {
     readonly name = "DataStreamError";

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

@@ -14,7 +14,7 @@ import LocalTrack from '../track/LocalTrack';
 import LocalTrackPublication from '../track/LocalTrackPublication';
 import { Track } from '../track/Track';
 import type { AudioCaptureOptions, BackupVideoCodec, CreateLocalTracksOptions, ScreenShareCaptureOptions, TrackPublishOptions, VideoCaptureOptions } from '../track/options';
-import type { ChatMessage, DataPublishOptions, SendFileOptions, SendTextOptions, StreamBytesOptions, StreamTextOptions, TextStreamInfo } from '../types';
+import type { ByteStreamInfo, ChatMessage, DataPublishOptions, SendBytesOptions, SendFileOptions, SendTextOptions, StreamBytesOptions, StreamTextOptions, TextStreamInfo } from '../types';
 import Participant from './Participant';
 import type { ParticipantTrackPermission } from './ParticipantTrackPermission';
 import type RemoteParticipant from './RemoteParticipant';
@@ -208,6 +208,14 @@ export default class LocalParticipant extends Participant {
     sendFile(file: File, options?: SendFileOptions): Promise<{
         id: string;
     }>;
+    /**
+     * Sends the given bytes to participants in the room via the data channel.
+     * For files, consider using {@link sendFile}; for longer/incremental payloads, {@link streamBytes}.
+     *
+     * @param bytes The byte payload
+     * @param options.topic Topic identifier used to route the stream to appropriate handlers.
+     */
+    sendBytes(bytes: Uint8Array, options?: SendBytesOptions): Promise<ByteStreamInfo>;
     /**
      * Stream bytes incrementally to participants in the room via the data channel.
      * For sending files, consider using {@link sendFile} instead.

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

@@ -1,4 +1,5 @@
 import type { ParticipantInfo } from '@livekit/protocol';
+import { ClientInfo_Capability } from '@livekit/protocol';
 import type { SignalClient } from '../../api/SignalClient';
 import { DeferrableMap } from '../../utils/deferrable-map';
 import RemoteDataTrack from '../data-track/RemoteDataTrack';
@@ -26,6 +27,15 @@ export default class RemoteParticipant extends Participant {
      * @internal
      **/
     clientProtocol: number;
+    /** The client capabilities the remote participant advertises (e.g. deflate-raw compression
+     * support). Used to decide which peer-to-peer features can be used when sending to them.
+     *
+     * Differs from clientProtocol in that these are truely optional "additions" which can be used
+     * or not depending on client specific attributes rather than protocol level invariants.
+     *
+     * @internal
+     **/
+    capabilities: Array<ClientInfo_Capability>;
     private volumeMap;
     private audioOutput?;
     /** @internal */
@@ -35,7 +45,7 @@ export default class RemoteParticipant extends Participant {
         remoteParticipant: string;
     };
     /** @internal */
-    constructor(signalClient: SignalClient, sid: string, identity?: string, name?: string, metadata?: string, attributes?: Record<string, string>, loggerOptions?: LoggerOptions, kind?: ParticipantKind, remoteDataTracks?: Array<RemoteDataTrack>, clientProtocol?: number);
+    constructor(signalClient: SignalClient, sid: string, identity?: string, name?: string, metadata?: string, attributes?: Record<string, string>, loggerOptions?: LoggerOptions, kind?: ParticipantKind, remoteDataTracks?: Array<RemoteDataTrack>, clientProtocol?: number, capabilities?: Array<ClientInfo_Capability>);
     protected addTrackPublication(publication: RemoteTrackPublication): void;
     getTrackPublication(source: Track.Source): RemoteTrackPublication | undefined;
     getTrackPublicationByName(name: string): RemoteTrackPublication | undefined;

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

@@ -18,6 +18,20 @@ export interface SendTextOptions {
     attachments?: Array<File>;
     onProgress?: (progress: number) => void;
     attributes?: Record<string, string>;
+    /** Whether to compress the payload (deflate-raw). Defaults to true. Compression is only applied
+     * when every recipient supports data streams v2 and the runtime can compress. */
+    compress?: boolean;
+}
+export interface SendBytesOptions {
+    topic?: string;
+    destinationIdentities?: Array<string>;
+    attributes?: Record<string, string>;
+    onProgress?: (progress: number) => void;
+    /** Whether to compress the payload (deflate-raw). Defaults to true. Compression is only applied
+     * when every recipient supports data streams v2 and the runtime can compress. */
+    compress?: boolean;
+    name?: string;
+    mimeType?: string;
 }
 export interface StreamTextOptions {
     topic?: string;
@@ -42,6 +56,9 @@ export type StreamBytesOptions = {
 export type SendFileOptions = Pick<StreamBytesOptions, 'topic' | 'mimeType' | 'destinationIdentities'> & {
     onProgress?: (progress: number) => void;
     encryptionType?: Encryption_Type.NONE;
+    /** Whether to compress the payload (deflate-raw). Defaults to true. Compression is only applied
+     * when every recipient supports data streams v2 and the runtime can compress. */
+    compress?: boolean;
 };
 export type DataPublishOptions = {
     /**

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

@@ -146,6 +146,19 @@ export declare function isRemoteVideoTrack(track: Track | undefined): track is R
 export declare function isLocalParticipant(p: Participant): p is LocalParticipant;
 export declare function isRemoteParticipant(p: Participant): p is RemoteParticipant;
 export declare function splitUtf8(s: string, n: number): NonSharedUint8Array[];
+/** Wraps a byte array in a `ReadableStream` that yields it as a single chunk and then closes. */
+export declare function readableFromBytes(bytes: NonSharedUint8Array): ReadableStream<NonSharedUint8Array>;
+/**
+ * Re-chunks a byte stream into pieces of exactly `chunkSize` bytes (the final piece may be
+ * smaller), coalescing or splitting the source's pieces as needed. Memory use is bounded to roughly
+ * `chunkSize` plus one source read, so it never buffers the whole stream — used to pack
+ * `CompressionStream`/`file.stream()` output into MTU-sized data-stream chunks.
+ */
+export declare function readBytesInChunks(source: ReadableStream<NonSharedUint8Array>, chunkSize: number): AsyncGenerator<NonSharedUint8Array>;
+/** Encodes a byte array as a base64 string (suitable for embedding binary data in a string field). */
+export declare function encodeBase64(bytes: Uint8Array): string;
+/** Decodes a base64 string (as produced by {@link encodeBase64}) back into a byte array. */
+export declare function decodeBase64(base64: string): Uint8Array;
 export declare function extractMaxAgeFromRequestHeaders(headers: Headers): number | undefined;
 export declare function isCompressionStreamSupported(): boolean;
 export declare function isPublisherOfferWithJoinSupported(): boolean;

package/dist/ts4.2/version.d.ts

@@ -5,7 +5,11 @@ export declare const CLIENT_PROTOCOL_DEFAULT = 0;
 /** Replaces RPC v1 protocol with a v2 data streams based one to support unlimited request /
  * response payload length. */
 export declare const CLIENT_PROTOCOL_DATA_STREAM_RPC = 1;
+/** "Data streams v2": the client knows how to receive a single-packet data stream (a stream whose
+ * entire payload is smuggled into the header packet, with no chunk/trailer packets). Senders only
+ * use the single-packet optimization when the recipient advertises at least this protocol. */
+export declare const CLIENT_PROTOCOL_DATA_STREAM_V2 = 2;
 /** The client protocol version indicates what level of support that the client has for
  * client <-> client api interactions. */
-export declare const clientProtocol = 1;
+export declare const clientProtocol = 2;
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "2.20.2",
+  "version": "2.21.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -50,7 +50,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@livekit/mutex": "1.1.1",
-    "@livekit/protocol": "1.46.6",
+    "@livekit/protocol": "1.50.4",
     "events": "^3.3.0",
     "jose": "^6.1.0",
     "loglevel": "^1.9.2",

package/src/index.ts

@@ -104,6 +104,8 @@ export type {
   TranscriptionSegment,
   ChatMessage,
   SendTextOptions,
+  SendBytesOptions,
+  ByteStreamInfo,
 } from './room/types';
 export * from './version';
 export {