livekit-client 2.18.8 → 2.18.10

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

@@ -148,6 +148,8 @@ export default class LocalParticipant extends Participant {
     private waitUntilEngineConnected;
     private hasPermissionsToPublish;
     private publish;
+    private canPublishPacketTrailer;
+    private normalizeRequestedPacketTrailerOptions;
     get isLocal(): boolean;
     /** @internal
      * publish additional codec to existing track
@@ -163,7 +165,7 @@ export default class LocalParticipant extends Participant {
      * @param data Uint8Array of the payload. To send string data, use TextEncoder.encode
      * @param options optionally specify a `reliable`, `topic` and `destination`
      */
-    publishData(data: Uint8Array, options?: DataPublishOptions): Promise<void>;
+    publishData(data: NonSharedUint8Array, options?: DataPublishOptions): Promise<void>;
     /**
      * Publish SIP DTMF message to the room.
      *

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

@@ -124,7 +124,7 @@ export type ParticipantEventCallbacks = {
     localSenderCreated: (sender: RTCRtpSender, track: Track) => void;
     participantMetadataChanged: (prevMetadata: string | undefined, participant?: any) => void;
     participantNameChanged: (name: string) => void;
-    dataReceived: (payload: Uint8Array, kind: DataPacket_Kind, encryptionType?: Encryption_Type) => void;
+    dataReceived: (payload: NonSharedUint8Array, kind: DataPacket_Kind, encryptionType?: Encryption_Type) => void;
     sipDTMFReceived: (dtmf: SipDTMF) => void;
     transcriptionReceived: (transcription: TranscriptionSegment[], publication?: TrackPublication) => void;
     isSpeakingChanged: (speaking: boolean) => void;

package/dist/ts4.2/room/track/PacketTrailerExtractor.d.ts

@@ -0,0 +1,19 @@
+import type { PacketTrailerMetadata } from '../../packetTrailer/types';
+/**
+ * Caches packet trailer metadata extracted from received video frames,
+ * keyed by RTP timestamp so it can be looked up when the frame is displayed.
+ *
+ * Metadata is populated either by the packet trailer worker managed by
+ * `PacketTrailerManager` (non-E2EE) or by the E2EE FrameCryptor worker
+ * after decryption (E2EE).
+ *
+ * @experimental
+ */
+export declare class PacketTrailerExtractor {
+    private metadataMap;
+    private activeSsrc;
+    storeMetadata(rtpTimestamp: number, ssrc: number, metadata: PacketTrailerMetadata): void;
+    lookupMetadata(rtpTimestamp: number): PacketTrailerMetadata | undefined;
+    dispose(): void;
+}
+//# sourceMappingURL=PacketTrailerExtractor.d.ts.map

package/dist/ts4.2/room/track/RemoteVideoTrack.d.ts

@@ -1,5 +1,7 @@
+import type { PacketTrailerMetadata } from '../../packetTrailer/types';
 import type { VideoReceiverStats } from '../stats';
 import type { LoggerOptions } from '../types';
+import type { PacketTrailerExtractor } from './PacketTrailerExtractor';
 import RemoteTrack from './RemoteTrack';
 import { Track } from './Track';
 import type { AdaptiveStreamSettings } from './types';
@@ -9,8 +11,22 @@ export default class RemoteVideoTrack extends RemoteTrack<Track.Kind.Video> {
     private adaptiveStreamSettings?;
     private lastVisible?;
     private lastDimensions?;
+    /** @internal */
+    packetTrailerExtractor?: PacketTrailerExtractor;
     constructor(mediaTrack: MediaStreamTrack, sid: string, receiver: RTCRtpReceiver, adaptiveStreamSettings?: AdaptiveStreamSettings, loggerOptions?: LoggerOptions);
     get isAdaptiveStream(): boolean;
+    /**
+     * Look up frame-level metadata for a given RTP timestamp.
+     * Use with the `TrackEvent.TimeSyncUpdate` event to correlate displayed frames
+     * with their capture-time metadata.
+     *
+     * Requires the room to be configured with the `packetTrailer` worker option
+     * and the publishing track to have packet trailer features enabled.
+     *
+     */
+    lookupFrameMetadata({ rtpTimestamp, }: {
+        rtpTimestamp: number;
+    }): PacketTrailerMetadata | undefined;
     setStreamState(value: Track.StreamState): void;
     /**
      * Note: When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start

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

@@ -148,7 +148,7 @@ export type TrackEventCallbacks = {
         timestamp: number;
         rtpTimestamp: number;
     }) => void;
-    preConnectBufferFlushed: (buffer: Uint8Array[]) => void;
+    preConnectBufferFlushed: (buffer: NonSharedUint8Array[]) => void;
     cpuConstrained: () => void;
 };
 export {};

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

@@ -1,3 +1,4 @@
+import type { PacketTrailerPublishOptions } from '../../packetTrailer/types';
 import type { Track } from './Track';
 import type { AudioProcessorOptions, TrackProcessor, VideoProcessorOptions } from './processor/types';
 export interface TrackPublishDefaults {
@@ -111,6 +112,15 @@ export interface TrackPublishDefaults {
      * Defaults to false.
      */
     preConnectBuffer?: boolean;
+    /**
+     * Packet trailer metadata to append to published video frames.
+     *
+     * Requires either room-level packet trailer worker configuration or E2EE,
+     * because encoded frame transforms are used to write the trailer.
+     *
+     * @experimental
+     */
+    packetTrailer?: PacketTrailerPublishOptions;
 }
 /**
  * Options when publishing tracks

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

@@ -1,4 +1,4 @@
-import { ChatMessage as ChatMessageModel, ClientInfo, DisconnectReason, Transcription as TranscriptionModel } from '@livekit/protocol';
+import { ChatMessage as ChatMessageModel, ClientInfo, ClientInfo_Capability, DisconnectReason, Transcription as TranscriptionModel } from '@livekit/protocol';
 import type { Throws } from '@livekit/throws-transformer/throws';
 import TypedPromise from '../utils/TypedPromise';
 import type { BrowserDetails } from '../utils/browserParser';
@@ -40,6 +40,7 @@ export declare function supportsAudioOutputSelection(): boolean;
 export declare function isBrowserSupported(): boolean;
 export declare function isFireFox(): boolean;
 export declare function isChromiumBased(): boolean;
+export declare function isScriptTransformSupportedForWorker(): boolean;
 export declare function isSafari(): boolean;
 export declare function isSafariBased(): boolean;
 export declare function isSafari17Based(): boolean;
@@ -67,7 +68,7 @@ export interface ObservableMediaElement extends HTMLMediaElement {
     handleResize: (entry: ResizeObserverEntry) => void;
     handleVisibilityChanged: (entry: IntersectionObserverEntry) => void;
 }
-export declare function getClientInfo(): ClientInfo;
+export declare function getClientInfo(capabilities?: ClientInfo_Capability[]): ClientInfo;
 export declare function getEmptyVideoStreamTrack(): MediaStreamTrack;
 export declare function createDummyVideoStreamTrack(width?: number, height?: number, enabled?: boolean, paintContent?: boolean): MediaStreamTrack;
 export declare function getEmptyAudioStreamTrack(): MediaStreamTrack;
@@ -143,7 +144,7 @@ export declare function isLocalPub(pub: TrackPublication | undefined): pub is Lo
 export declare function isRemoteVideoTrack(track: Track | undefined): track is RemoteVideoTrack;
 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): Uint8Array[];
+export declare function splitUtf8(s: string, n: number): NonSharedUint8Array[];
 export declare function extractMaxAgeFromRequestHeaders(headers: Headers): number | undefined;
 export declare function isCompressionStreamSupported(): boolean;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -1,5 +1,5 @@
 export interface DataPacketItem {
-    data: Uint8Array;
+    data: NonSharedUint8Array;
     sequence: number;
 }
 export declare class DataPacketBuffer {

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

@@ -1,3 +1,3 @@
 export declare const version: string;
-export declare const protocolVersion = 16;
+export declare const protocolVersion = 17;
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "2.18.8",
+  "version": "2.18.10",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -15,6 +15,11 @@
       "types": "./dist/src/e2ee/worker/e2ee.worker.d.ts",
       "import": "./dist/livekit-client.e2ee.worker.mjs",
       "require": "./dist/livekit-client.e2ee.worker.js"
+    },
+    "./packet-trailer-worker": {
+      "types": "./dist/src/packetTrailer/worker/packetTrailer.worker.d.ts",
+      "import": "./dist/livekit-client.pt.worker.mjs",
+      "require": "./dist/livekit-client.pt.worker.js"
     }
   },
   "files": [
@@ -29,6 +34,9 @@
       ],
       "./dist/src/e2ee/worker/e2ee.worker.d.ts": [
         "./dist/ts4.2/e2ee/worker/e2ee.worker.d.ts"
+      ],
+      "./dist/src/packetTrailer/worker/packetTrailer.worker.d.ts": [
+        "./dist/ts4.2/packetTrailer/worker/packetTrailer.worker.d.ts"
       ]
     }
   },
@@ -37,7 +45,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@livekit/mutex": "1.1.1",
-    "@livekit/protocol": "1.45.3",
+    "@livekit/protocol": "1.45.8",
     "events": "^3.3.0",
     "jose": "^6.1.0",
     "loglevel": "^1.9.2",
@@ -51,28 +59,28 @@
   },
   "devDependencies": {
     "@babel/core": "7.29.0",
-    "@babel/preset-env": "7.29.0",
+    "@babel/preset-env": "7.29.2",
     "@bufbuild/protoc-gen-es": "^1.10.0",
-    "@changesets/cli": "2.29.8",
-    "@eslint/js": "9.39.2",
+    "@changesets/cli": "2.31.0",
+    "@eslint/js": "10.0.1",
     "@livekit/changesets-changelog-github": "^0.0.4",
     "@livekit/throws-transformer": "^0.1.3",
     "@rollup/plugin-babel": "7.0.0",
-    "@rollup/plugin-commonjs": "28.0.9",
+    "@rollup/plugin-commonjs": "29.0.2",
     "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "16.0.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@size-limit/file": "^11.2.0",
     "@size-limit/webpack": "^11.2.0",
-    "@stylistic/eslint-plugin": "^3.1.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
     "@trivago/prettier-plugin-sort-imports": "^5.0.0",
     "@types/events": "^3.0.3",
     "@types/sdp-transform": "2.15.0",
     "@types/ua-parser-js": "0.7.39",
-    "@typescript-eslint/eslint-plugin": "7.18.0",
-    "@typescript-eslint/parser": "7.18.0",
+    "@typescript-eslint/eslint-plugin": "8.59.2",
+    "@typescript-eslint/parser": "8.59.2",
     "downlevel-dts": "^0.11.0",
-    "eslint": "9.39.2",
+    "eslint": "10.2.1",
     "eslint-config-airbnb-extended": "^2.3.2",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-compat": "^6.0.2",
@@ -83,20 +91,20 @@
     "happy-dom": "^20.0.0",
     "jsdom": "^26.1.0",
     "prettier": "^3.4.2",
-    "rollup": "4.59.0",
+    "rollup": "4.60.2",
     "rollup-plugin-delete": "^2.1.0",
-    "rollup-plugin-typescript2": "0.36.0",
+    "rollup-plugin-typescript2": "0.37.0",
     "size-limit": "^11.2.0",
     "tsx": "^4.21.0",
-    "typedoc": "0.28.16",
+    "typedoc": "0.28.19",
     "typedoc-plugin-no-inherit": "1.6.1",
-    "typescript": "5.8.3",
+    "typescript": "5.9.3",
     "typescript-eslint": "^8.47.0",
-    "vite": "7.3.1",
+    "vite": "7.3.2",
     "vitest": "^3.0.0"
   },
   "scripts": {
-    "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs && pnpm downlevel-dts",
+    "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs && rollup --config rollup.config.pt-worker.js --bundleConfigAsCjs && pnpm downlevel-dts",
     "build:clean": "rm -rf ./dist && pnpm build",
     "build:watch": "rollup --watch --config --bundleConfigAsCjs",
     "build:worker:watch": "rollup --watch --config rollup.config.worker.js --bundleConfigAsCjs",

package/src/api/SignalClient.test.ts

@@ -1,10 +1,14 @@
 import {
+  ClientInfo_Capability,
   DisconnectReason,
+  JoinRequest,
   JoinResponse,
   LeaveRequest,
   ReconnectResponse,
   SignalRequest,
   SignalResponse,
+  WrappedJoinRequest,
+  WrappedJoinRequest_Compression,
 } from '@livekit/protocol';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { ConnectionError, ConnectionErrorReason } from '../room/errors';
@@ -60,6 +64,7 @@ interface MockWebSocketStreamOptions {
   connection?: WebSocketConnection;
   opened?: Promise<WebSocketConnection>;
   closed?: Promise<WebSocketCloseInfo>;
+  onUrl?: (url: string) => void;
   readyState?: number;
 }
 
@@ -69,18 +74,19 @@ function mockWebSocketStream(options: MockWebSocketStreamOptions = {}) {
     opened = connection ? Promise.resolve(connection) : new Promise(() => {}),
     closed = new Promise(() => {}),
     readyState = 1,
+    onUrl,
   } = options;
 
-  return vi.mocked(WebSocketStream).mockImplementationOnce(
-    () =>
-      ({
-        url: 'wss://test.livekit.io',
-        opened,
-        closed,
-        close: vi.fn(),
-        readyState,
-      }) as any,
-  );
+  return vi.mocked(WebSocketStream).mockImplementationOnce((url) => {
+    onUrl?.(url);
+    return {
+      url: 'wss://test.livekit.io',
+      opened,
+      closed,
+      close: vi.fn(),
+      readyState,
+    } as any;
+  });
 }
 
 describe('SignalClient.connect', () => {
@@ -99,6 +105,47 @@ describe('SignalClient.connect', () => {
     signalClient = new SignalClient(false);
   });
 
+  async function decodeJoinRequestFromUrl(url: string): Promise<JoinRequest> {
+    const joinRequestParam = new URL(url).searchParams.get('join_request');
+    expect(joinRequestParam).toBeTruthy();
+
+    const paddedBase64Url = joinRequestParam!.padEnd(
+      joinRequestParam!.length + ((4 - (joinRequestParam!.length % 4)) % 4),
+      '=',
+    );
+    const binaryString = atob(paddedBase64Url.replace(/-/g, '+').replace(/_/g, '/'));
+    const wrappedBytes = new Uint8Array(binaryString.length);
+    for (let i = 0; i < binaryString.length; i += 1) {
+      wrappedBytes[i] = binaryString.charCodeAt(i);
+    }
+
+    const wrappedJoinRequest = WrappedJoinRequest.fromBinary(wrappedBytes);
+    if (wrappedJoinRequest.compression === WrappedJoinRequest_Compression.NONE) {
+      return JoinRequest.fromBinary(wrappedJoinRequest.joinRequest);
+    }
+
+    const stream = new DecompressionStream('gzip');
+    const writer = stream.writable.getWriter();
+    writer.write(wrappedJoinRequest.joinRequest);
+    writer.close();
+
+    const chunks: Uint8Array[] = [];
+    const reader = stream.readable.getReader();
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) break;
+      chunks.push(value);
+    }
+    const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+    const bytes = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+      bytes.set(chunk, offset);
+      offset += chunk.length;
+    }
+    return JoinRequest.fromBinary(bytes);
+  }
+
   describe('Happy Path - Initial Join', () => {
     it('should successfully connect and receive join response', async () => {
       const joinResponse = createJoinResponse();
@@ -113,6 +160,51 @@ describe('SignalClient.connect', () => {
       expect(result).toEqual(joinResponse);
       expect(signalClient.currentState).toBe(SignalConnectionState.CONNECTED);
     });
+
+    it('does not advertise packet trailer capability by default', async () => {
+      const joinResponse = createJoinResponse();
+      const signalResponse = createSignalResponse('join', joinResponse);
+      const mockReadable = createMockReadableStream([signalResponse]);
+      const mockConnection = createMockConnection(mockReadable);
+      let capturedUrl = '';
+
+      mockWebSocketStream({
+        connection: mockConnection,
+        onUrl: (url) => {
+          capturedUrl = url;
+        },
+      });
+
+      await signalClient.join('wss://test.livekit.io', 'test-token', defaultOptions);
+
+      const joinRequest = await decodeJoinRequestFromUrl(capturedUrl);
+      expect(joinRequest.clientInfo?.capabilities).toEqual([]);
+    });
+
+    it('advertises packet trailer capability when provided', async () => {
+      const joinResponse = createJoinResponse();
+      const signalResponse = createSignalResponse('join', joinResponse);
+      const mockReadable = createMockReadableStream([signalResponse]);
+      const mockConnection = createMockConnection(mockReadable);
+      let capturedUrl = '';
+
+      mockWebSocketStream({
+        connection: mockConnection,
+        onUrl: (url) => {
+          capturedUrl = url;
+        },
+      });
+
+      await signalClient.join('wss://test.livekit.io', 'test-token', {
+        ...defaultOptions,
+        clientInfoCapabilities: [ClientInfo_Capability.CAP_PACKET_TRAILER],
+      });
+
+      const joinRequest = await decodeJoinRequestFromUrl(capturedUrl);
+      expect(joinRequest.clientInfo?.capabilities).toEqual([
+        ClientInfo_Capability.CAP_PACKET_TRAILER,
+      ]);
+    });
   });
 
   describe('Happy Path - Reconnect', () => {

package/src/api/SignalClient.ts

@@ -3,6 +3,7 @@ import {
   AddTrackRequest,
   AudioTrackFeature,
   ClientInfo,
+  ClientInfo_Capability,
   ConnectionQualityUpdate,
   ConnectionSettings,
   DataTrackSubscriberHandles,
@@ -83,6 +84,7 @@ interface ConnectOpts extends SignalOptions {
 export interface SignalOptions {
   autoSubscribe: boolean;
   adaptiveStream?: boolean;
+  clientInfoCapabilities?: ClientInfo_Capability[];
   maxRetries: number;
   e2eeEnabled: boolean;
   websocketTimeout: number;
@@ -320,7 +322,7 @@ export class SignalClient {
     this.connectOptions = opts;
     this.useV0SignalPath = useV0Path;
 
-    const clientInfo = getClientInfo();
+    const clientInfo = getClientInfo(opts.clientInfoCapabilities);
     const params = useV0Path
       ? createConnectionParams(token, clientInfo, opts)
       : await createJoinRequestConnectionParams(token, clientInfo, opts, publisherOffer);
@@ -771,7 +773,7 @@ export class SignalClient {
       if (this.useJSON) {
         await this.streamWriter.write(req.toJsonString());
       } else {
-        await this.streamWriter.write(req.toBinary());
+        await this.streamWriter.write((req.toBinary() as NonSharedUint8Array).buffer);
       }
     } catch (e) {
       this.log.error('error sending signal message', { error: e });

package/src/api/WebSocketStream.test.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { WebSocketStream } from './WebSocketStream';