@layercode/js-sdk 2.8.5 → 2.8.6

package/dist/layercode-js-sdk.esm.js

@@ -5283,7 +5283,7 @@ class WavRecorder {
           .join(',');
       const cb = async () => {
         let id = ++lastId;
-        const devices = await this.listDevices();
+        const devices = await this.listDevices({ requestPermission: false });
         if (id === lastId) {
           if (serializeDevices(lastDevices) !== serializeDevices(devices)) {
             lastDevices = devices;
@@ -5336,14 +5336,22 @@ class WavRecorder {
   }
 
   /**
-   * List all eligible devices for recording, will request permission to use microphone
+   * List all eligible devices for recording.
+   *
+   * By default this will *not* request mic permission; labels may be empty until
+   * the user has granted permission via begin()/getUserMedia.
+   * Pass { requestPermission: true } to explicitly trigger a permission prompt.
+   *
+   * @param {{ requestPermission?: boolean }} [options]
    * @returns {Promise<Array<MediaDeviceInfo & {default: boolean}>>}
    */
-  async listDevices() {
+  async listDevices({ requestPermission = false } = {}) {
     if (!navigator.mediaDevices || !('enumerateDevices' in navigator.mediaDevices)) {
       throw new Error('Could not request user devices');
     }
-    await this.requestPermission();
+    if (requestPermission) {
+      await this.requestPermission();
+    }
 
     const devices = await navigator.mediaDevices.enumerateDevices();
     const audioDevices = devices.filter((device) => device.kind === 'audioinput');
@@ -5393,7 +5401,7 @@ class WavRecorder {
         config.audio.deviceId = { exact: deviceId };
       }
       this.stream = await navigator.mediaDevices.getUserMedia(config);
-      // Mark permission as granted so listDevices() won't call requestPermission() again
+      // Mark permission as granted so requestPermission() can skip expensive redundant getUserMedia calls
       this._hasPermission = true;
     } catch (err) {
       throw err;
@@ -5746,6 +5754,29 @@ function arrayBufferToBase64(arrayBuffer) {
 /* eslint-env browser */
 // import { env as ortEnv } from 'onnxruntime-web';
 // @ts-ignore - VAD package does not provide TypeScript types
+/**
+ * Layercode Web SDK notes / gotchas
+ *
+ * Modes:
+ * - audioInput=false => text-only mode. Do NOT touch getUserMedia or request mic permissions.
+ * - audioInput=true  => capture/send mic audio (may trigger permission prompt).
+ * - audioOutput=false => do not play audio, but MUST still send
+ *   `trigger.response.audio.replay_finished` once per assistant turn so the server can advance.
+ *
+ * Transcription:
+ * - trigger='push_to_talk' => no VAD; only send audio between triggerUserTurnStarted/Finished.
+ * - trigger='automatic'   => VAD drives userSpeaking + optional audio gating.
+ *
+ * Performance:
+ * - Mobile browsers e.g. iOS Safari media APIs can be slow; avoid multiple sequential getUserMedia calls.
+ *   This file starts the recorder first, then sets up device listeners.
+ *
+ * Compatibility:
+ * - This is consumed by the Layercode React SDK; treat public API/event shape changes as breaking.
+ *
+ * Assets:
+ * - VAD/ORT assets are loaded from assets.layercode.com (Cloudflare).
+ */
 const NOOP = () => { };
 const DEFAULT_WS_URL = 'wss://api.layercode.com/v1/agents/web/websocket';
 // SDK version - updated when publishing
@@ -5763,12 +5794,12 @@ const toLayercodeAudioInputDevice = (device) => {
     }
     return cloned;
 };
-const listAudioInputDevices = async () => {
+const listAudioInputDevices = async (options = {}) => {
     if (!hasMediaDevicesSupport()) {
         throw new Error('Media devices are not available in this environment');
     }
     const recorder = new WavRecorder({ sampleRate: DEFAULT_RECORDER_SAMPLE_RATE });
-    const devices = (await recorder.listDevices());
+    const devices = (await recorder.listDevices({ requestPermission: Boolean(options.requestPermission) }));
     return devices.map(toLayercodeAudioInputDevice);
 };
 const watchAudioInputDevices = (callback) => {
@@ -6711,8 +6742,8 @@ class LayercodeClient {
      * List all available audio input devices
      * @returns {Promise<Array<MediaDeviceInfo & {default: boolean}>>}
      */
-    async listDevices() {
-        return this.wavRecorder.listDevices();
+    async listDevices(options) {
+        return this.wavRecorder.listDevices(options);
     }
     /**
      * Switches the input device for the microphone and restarts recording