@estuary-ai/sdk 0.3.0 → 0.4.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 estuary.ai
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 estuary.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -247,7 +247,32 @@ interface EstuaryConfig {
   realtimeMemory?: boolean;    // Enable real-time memory extraction events. Default: false
   suppressMicDuringPlayback?: boolean; // Mute mic while bot audio plays (software AEC). Default: false
   autoInterruptOnSpeech?: boolean;     // Interrupt bot audio when user speaks. Default: true
+  capabilities?: SessionCapabilities;  // Per-session device capability declaration
 }
+
+interface SessionCapabilities {
+  version?: string;     // Schema version, defaults to "1"
+  camera?: boolean;     // Device has a usable camera
+  microphone?: boolean; // Device has a usable microphone
+  speaker?: boolean;    // Device has a usable speaker
+}
+```
+
+### Capability Declaration
+
+Tell the server what the device can physically do. The server hides tools that require a missing capability — e.g. `request_camera_image` is suppressed when `camera: false`, so the LLM won't ask to see the camera on text-only clients.
+
+When `capabilities` is omitted, the server defaults every field to `true` for backward compatibility — existing clients keep working unchanged.
+
+```typescript
+const client = new EstuaryClient({
+  serverUrl, apiKey, characterId, playerId,
+  capabilities: {
+    camera: false,    // No camera on this client (e.g. share link, text-only widget)
+    microphone: true,
+    speaker: true,
+  },
+});
 ```
 
 ## Runtime Properties

package/dist/index.d.mts

@@ -27,8 +27,25 @@ interface EstuaryConfig {
     suppressMicDuringPlayback?: boolean;
     /** Proactively interrupt bot audio when user starts speaking (default: true) */
     autoInterruptOnSpeech?: boolean;
+    /** Per-session client capability declaration. Tells the server what the device
+     *  can physically do (camera, microphone, speaker). When omitted, the server
+     *  defaults all fields to true for backward compatibility. Tools requiring a
+     *  capability are hidden from the LLM when that capability is false (e.g.
+     *  `request_camera_image` is suppressed when `camera: false`). */
+    capabilities?: SessionCapabilities;
 }
 type VoiceTransport = 'websocket' | 'livekit' | 'auto';
+/** Per-session client capability declaration. Pass on `EstuaryConfig.capabilities`. */
+interface SessionCapabilities {
+    /** Schema version. Defaults to "1" when omitted. */
+    version?: string;
+    /** Device has a camera the SDK can call `sendCameraImage()` against. */
+    camera?: boolean;
+    /** Device has a microphone usable for voice capture. */
+    microphone?: boolean;
+    /** Device has a speaker usable for TTS playback. */
+    speaker?: boolean;
+}
 declare enum ConnectionState {
     Disconnected = "disconnected",
     Connecting = "connecting",
@@ -453,4 +470,4 @@ declare class CharacterClient {
     dispose(): void;
 }
 
-export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, CharacterClient, type CharacterInfo, ConnectionState, type CoreFact, type CoreFactsResponse, ErrorCode, EstuaryClient, type EstuaryConfig, EstuaryError, type EstuaryEventMap, type InterruptData, type LiveKitTokenResponse, MemoryClient, type MemoryData, type MemoryGraphEdge, type MemoryGraphNode, type MemoryGraphOptions, type MemoryGraphResponse, type MemoryListOptions, type MemoryListResponse, type MemorySearchOptions, type MemorySearchResponse, type MemoryStatsResponse, type MemoryTimelineOptions, type MemoryTimelineResponse, type MemoryUpdatedEvent, type ParsedAction, type QuotaExceededData, type SessionInfo, type ShareOpenResponse, type SttResponse, type VoiceManager, type VoiceTransport, parseActions };
+export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, CharacterClient, type CharacterInfo, ConnectionState, type CoreFact, type CoreFactsResponse, ErrorCode, EstuaryClient, type EstuaryConfig, EstuaryError, type EstuaryEventMap, type InterruptData, type LiveKitTokenResponse, MemoryClient, type MemoryData, type MemoryGraphEdge, type MemoryGraphNode, type MemoryGraphOptions, type MemoryGraphResponse, type MemoryListOptions, type MemoryListResponse, type MemorySearchOptions, type MemorySearchResponse, type MemoryStatsResponse, type MemoryTimelineOptions, type MemoryTimelineResponse, type MemoryUpdatedEvent, type ParsedAction, type QuotaExceededData, type SessionCapabilities, type SessionInfo, type ShareOpenResponse, type SttResponse, type VoiceManager, type VoiceTransport, parseActions };

package/dist/index.d.ts

@@ -27,8 +27,25 @@ interface EstuaryConfig {
     suppressMicDuringPlayback?: boolean;
     /** Proactively interrupt bot audio when user starts speaking (default: true) */
     autoInterruptOnSpeech?: boolean;
+    /** Per-session client capability declaration. Tells the server what the device
+     *  can physically do (camera, microphone, speaker). When omitted, the server
+     *  defaults all fields to true for backward compatibility. Tools requiring a
+     *  capability are hidden from the LLM when that capability is false (e.g.
+     *  `request_camera_image` is suppressed when `camera: false`). */
+    capabilities?: SessionCapabilities;
 }
 type VoiceTransport = 'websocket' | 'livekit' | 'auto';
+/** Per-session client capability declaration. Pass on `EstuaryConfig.capabilities`. */
+interface SessionCapabilities {
+    /** Schema version. Defaults to "1" when omitted. */
+    version?: string;
+    /** Device has a camera the SDK can call `sendCameraImage()` against. */
+    camera?: boolean;
+    /** Device has a microphone usable for voice capture. */
+    microphone?: boolean;
+    /** Device has a speaker usable for TTS playback. */
+    speaker?: boolean;
+}
 declare enum ConnectionState {
     Disconnected = "disconnected",
     Connecting = "connecting",
@@ -453,4 +470,4 @@ declare class CharacterClient {
     dispose(): void;
 }
 
-export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, CharacterClient, type CharacterInfo, ConnectionState, type CoreFact, type CoreFactsResponse, ErrorCode, EstuaryClient, type EstuaryConfig, EstuaryError, type EstuaryEventMap, type InterruptData, type LiveKitTokenResponse, MemoryClient, type MemoryData, type MemoryGraphEdge, type MemoryGraphNode, type MemoryGraphOptions, type MemoryGraphResponse, type MemoryListOptions, type MemoryListResponse, type MemorySearchOptions, type MemorySearchResponse, type MemoryStatsResponse, type MemoryTimelineOptions, type MemoryTimelineResponse, type MemoryUpdatedEvent, type ParsedAction, type QuotaExceededData, type SessionInfo, type ShareOpenResponse, type SttResponse, type VoiceManager, type VoiceTransport, parseActions };
+export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, CharacterClient, type CharacterInfo, ConnectionState, type CoreFact, type CoreFactsResponse, ErrorCode, EstuaryClient, type EstuaryConfig, EstuaryError, type EstuaryEventMap, type InterruptData, type LiveKitTokenResponse, MemoryClient, type MemoryData, type MemoryGraphEdge, type MemoryGraphNode, type MemoryGraphOptions, type MemoryGraphResponse, type MemoryListOptions, type MemoryListResponse, type MemorySearchOptions, type MemorySearchResponse, type MemoryStatsResponse, type MemoryTimelineOptions, type MemoryTimelineResponse, type MemoryUpdatedEvent, type ParsedAction, type QuotaExceededData, type SessionCapabilities, type SessionInfo, type ShareOpenResponse, type SttResponse, type VoiceManager, type VoiceTransport, parseActions };

package/dist/index.js

@@ -9038,6 +9038,9 @@ var SocketManager = class extends TypedEventEmitter {
         } else if (this.config.apiKey) {
           authPayload.api_key = this.config.apiKey;
         }
+        if (this.config.capabilities) {
+          authPayload.capabilities = { version: "1", ...this.config.capabilities };
+        }
         this.socket.emit("authenticate", authPayload);
       };
       const onSessionInfo = (data) => {