@livekit/react-native 2.9.1 → 2.9.3

package/lib/typescript/src/index.d.ts

@@ -1,19 +1,30 @@
 import 'well-known-symbols/Symbol.asyncIterator/auto';
 import 'well-known-symbols/Symbol.iterator/auto';
 import './polyfills/MediaRecorderShim';
-import 'react-native-quick-base64';
 import './polyfills/EncoderDecoderTogether.min.js';
 import AudioSession, { AndroidAudioTypePresets, type AndroidAudioTypeOptions, type AppleAudioCategory, type AppleAudioCategoryOption, type AppleAudioConfiguration, type AppleAudioMode, type AudioTrackState, getDefaultAppleAudioConfigurationForMode } from './audio/AudioSession';
 import type { AudioConfiguration } from './audio/AudioSession';
 import type { LogLevel, SetLogLevelOptions } from './logger';
 import RNE2EEManager from './e2ee/RNE2EEManager';
 import RNKeyProvider, { type RNKeyProviderOptions } from './e2ee/RNKeyProvider';
+export interface RegisterGlobalsOptions {
+    /**
+     * Automatically configure audio session before accessing microphone.
+     * When enabled, sets the iOS audio category to 'playAndRecord' before getUserMedia.
+     *
+     * @default true
+     * @platform ios
+     */
+    autoConfigureAudioSession?: boolean;
+}
 /**
  * Registers the required globals needed for LiveKit to work.
  *
  * Must be called before using LiveKit.
+ *
+ * @param options Optional configuration for global registration
  */
-export declare function registerGlobals(): void;
+export declare function registerGlobals(options?: RegisterGlobalsOptions): void;
 export * from './hooks';
 export * from './components/BarVisualizer';
 export * from './components/LiveKitRoom';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/react-native",
-  "version": "2.9.1",
+  "version": "2.9.3",
   "description": "LiveKit for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -43,12 +43,13 @@
   ],
   "dependencies": {
     "@livekit/components-react": "^2.8.1",
+    "@livekit/mutex": "^1.1.1",
     "array.prototype.at": "^1.1.1",
+    "base64-js": "1.5.1",
     "event-target-shim": "6.0.2",
     "events": "^3.3.0",
     "loglevel": "^1.8.0",
     "promise.allsettled": "^1.0.5",
-    "react-native-quick-base64": "2.1.1",
     "react-native-url-polyfill": "^1.3.0",
     "typed-emitter": "^2.1.0",
     "web-streams-polyfill": "^4.1.0",
@@ -59,7 +60,7 @@
     "@babel/preset-env": "^7.20.0",
     "@babel/runtime": "^7.20.0",
     "@commitlint/config-conventional": "^16.2.1",
-    "@livekit/react-native-webrtc": "^137.0.1",
+    "@livekit/react-native-webrtc": "^137.0.2",
     "@react-native/babel-preset": "0.74.84",
     "@react-native/eslint-config": "0.74.84",
     "@react-native/metro-config": "0.74.84",
@@ -75,7 +76,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^7.0.4",
     "jest": "^29.6.3",
-    "livekit-client": "^2.15.4",
+    "livekit-client": "^2.15.8",
     "pod-install": "^0.2.2",
     "prettier": "2.8.8",
     "react": "18.2.0",
@@ -86,8 +87,8 @@
     "typescript": "5.0.4"
   },
   "peerDependencies": {
-    "@livekit/react-native-webrtc": "^137.0.1",
-    "livekit-client": "^2.15.4",
+    "@livekit/react-native-webrtc": "^137.0.2",
+    "livekit-client": "^2.15.8",
     "react": "*",
     "react-native": "*"
   },

package/src/audio/MediaRecorder.ts

@@ -5,7 +5,7 @@ import {
   Event,
   defineEventAttribute,
 } from 'event-target-shim/index';
-import { toByteArray } from 'react-native-quick-base64';
+import { toByteArray } from 'base64-js';
 import LiveKitModule from '../LKNativeModule';
 import { log } from '../logger';
 

package/src/e2ee/RNE2EEManager.ts

@@ -1,7 +1,10 @@
 import {
+  RTCDataPacketCryptor,
+  RTCDataPacketCryptorFactory,
   RTCFrameCryptorAlgorithm,
   RTCFrameCryptorFactory,
   RTCRtpReceiver,
+  type RTCEncryptedPacket,
   type RTCFrameCryptor,
   type RTCRtpSender,
 } from '@livekit/react-native-webrtc';
@@ -16,6 +19,9 @@ import {
   type BaseE2EEManager,
   type E2EEManagerCallbacks,
   EncryptionEvent,
+  type DecryptDataResponseMessage,
+  type EncryptDataResponseMessage,
+  Mutex,
 } from 'livekit-client';
 import type RNKeyProvider from './RNKeyProvider';
 import type RTCEngine from 'livekit-client/dist/src/room/RTCEngine';
@@ -36,11 +42,28 @@ export default class RNE2EEManager
     RTCFrameCryptorAlgorithm.kAesGcm;
 
   private encryptionEnabled: boolean = false;
+  private dataChannelEncryptionEnabled: boolean = false;
 
-  constructor(keyProvider: RNKeyProvider) {
+  private dataPacketCryptorLock = new Mutex();
+  private dataPacketCryptor: RTCDataPacketCryptor | undefined = undefined;
+  constructor(
+    keyProvider: RNKeyProvider,
+    dcEncryptionEnabled: boolean = false
+  ) {
     super();
     this.keyProvider = keyProvider;
     this.encryptionEnabled = false;
+    this.dataChannelEncryptionEnabled = dcEncryptionEnabled;
+  }
+
+  get isEnabled(): boolean {
+    return this.encryptionEnabled;
+  }
+  get isDataChannelEncryptionEnabled(): boolean {
+    return this.isEnabled && this.dataChannelEncryptionEnabled;
+  }
+  set isDataChannelEncryptionEnabled(value: boolean) {
+    this.dataChannelEncryptionEnabled = value;
   }
 
   setup(room: Room) {
@@ -78,7 +101,16 @@ export default class RNE2EEManager
             await frameCryptor.dispose();
           }
         }
-      );
+      )
+      .on(RoomEvent.SignalConnected, () => {
+        if (!this.room) {
+          throw new TypeError(`expected room to be present on signal connect`);
+        }
+        this.setParticipantCryptorEnabled(
+          this.room.localParticipant.isE2EEEnabled,
+          this.room.localParticipant.identity
+        );
+      });
   }
 
   private async setupE2EESender(
@@ -133,6 +165,89 @@ export default class RNE2EEManager
     this.keyProvider.setSifTrailer(trailer);
   }
 
+  private async getDataPacketCryptor(): Promise<RTCDataPacketCryptor> {
+    let dataPacketCryptor = this.dataPacketCryptor;
+    if (dataPacketCryptor) {
+      return dataPacketCryptor;
+    }
+
+    let unlock = await this.dataPacketCryptorLock.lock();
+
+    try {
+      dataPacketCryptor = this.dataPacketCryptor;
+      if (dataPacketCryptor) {
+        return dataPacketCryptor;
+      }
+
+      dataPacketCryptor =
+        await RTCDataPacketCryptorFactory.createDataPacketCryptor(
+          this.algorithm,
+          this.keyProvider.rtcKeyProvider
+        );
+
+      this.dataPacketCryptor = dataPacketCryptor;
+      return dataPacketCryptor;
+    } finally {
+      unlock();
+    }
+  }
+  async encryptData(
+    data: Uint8Array
+  ): Promise<EncryptDataResponseMessage['data']> {
+    let room = this.room;
+    if (!room) {
+      throw new Error("e2eemanager isn't setup with room!");
+    }
+
+    let participantId = room.localParticipant.identity;
+
+    let dataPacketCryptor = await this.getDataPacketCryptor();
+
+    let encryptedPacket = await dataPacketCryptor.encrypt(
+      participantId,
+      this.keyProvider.getLatestKeyIndex(participantId),
+      data
+    );
+
+    if (!encryptedPacket) {
+      throw new Error('encryption for packet failed');
+    }
+    return {
+      uuid: '', //not used
+      payload: encryptedPacket.payload,
+      iv: encryptedPacket.iv,
+      keyIndex: encryptedPacket.keyIndex,
+    };
+  }
+
+  async handleEncryptedData(
+    payload: Uint8Array,
+    iv: Uint8Array,
+    participantIdentity: string,
+    keyIndex: number
+  ): Promise<DecryptDataResponseMessage['data']> {
+    let packet = {
+      payload,
+      iv,
+      keyIndex,
+    } satisfies RTCEncryptedPacket;
+
+    let dataPacketCryptor = await this.getDataPacketCryptor();
+    let decryptedData = await dataPacketCryptor.decrypt(
+      participantIdentity,
+      packet
+    );
+
+    if (!decryptedData) {
+      throw new Error('decryption for packet failed');
+    }
+
+    return {
+      uuid: '', //not used
+      payload: decryptedData,
+    } satisfies DecryptDataResponseMessage['data'];
+  }
+
   // Utility methods
   //////////////////////
 

package/src/hooks/useE2EEManager.ts

@@ -2,6 +2,7 @@ import RNE2EEManager from '../e2ee/RNE2EEManager';
 import { log, RNKeyProvider } from '..';
 import { useEffect, useState } from 'react';
 import type { RNKeyProviderOptions } from '../e2ee/RNKeyProvider';
+import type { BaseE2EEManager } from 'livekit-client';
 
 export type UseRNE2EEManagerOptions = {
   keyProviderOptions?: RNKeyProviderOptions;
@@ -10,7 +11,7 @@ export type UseRNE2EEManagerOptions = {
 
 export interface RNE2EEManagerState {
   keyProvider: RNKeyProvider;
-  e2eeManager: RNE2EEManager;
+  e2eeManager: BaseE2EEManager;
 }
 
 /**
@@ -22,7 +23,7 @@ export function useRNE2EEManager(
   let [keyProvider] = useState(
     () => new RNKeyProvider(options.keyProviderOptions ?? {})
   );
-  let [e2eeManager] = useState(() => new RNE2EEManager(keyProvider));
+  let [e2eeManager] = useState(() => new RNE2EEManager(keyProvider, false));
 
   useEffect(() => {
     let setup = async () => {

package/src/index.tsx

@@ -1,7 +1,6 @@
 import 'well-known-symbols/Symbol.asyncIterator/auto';
 import 'well-known-symbols/Symbol.iterator/auto';
 import './polyfills/MediaRecorderShim';
-import 'react-native-quick-base64';
 import { registerGlobals as webrtcRegisterGlobals } from '@livekit/react-native-webrtc';
 import { setupURLPolyfill } from 'react-native-url-polyfill';
 import './polyfills/EncoderDecoderTogether.min.js';
@@ -24,14 +23,34 @@ import RNKeyProvider, { type RNKeyProviderOptions } from './e2ee/RNKeyProvider';
 import { setupNativeEvents } from './events/EventEmitter';
 import { ReadableStream, WritableStream } from 'web-streams-polyfill';
 
+export interface RegisterGlobalsOptions {
+  /**
+   * Automatically configure audio session before accessing microphone.
+   * When enabled, sets the iOS audio category to 'playAndRecord' before getUserMedia.
+   *
+   * @default true
+   * @platform ios
+   */
+  autoConfigureAudioSession?: boolean;
+}
+
 /**
  * Registers the required globals needed for LiveKit to work.
  *
  * Must be called before using LiveKit.
+ *
+ * @param options Optional configuration for global registration
  */
-export function registerGlobals() {
+export function registerGlobals(options?: RegisterGlobalsOptions) {
+  const opts = {
+    autoConfigureAudioSession: true,
+    ...options,
+  };
+
   webrtcRegisterGlobals();
-  iosCategoryEnforce();
+  if (opts.autoConfigureAudioSession) {
+    iosCategoryEnforce();
+  }
   livekitRegisterGlobals();
   setupURLPolyfill();
   fixWebrtcAdapter();