@estuary-ai/sdk 0.2.1 → 0.4.0

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",
@@ -122,6 +139,15 @@ interface CharacterInfo {
     modelStatus: string | null;
     sourceImageUrl: string | null;
 }
+interface ShareOpenResponse {
+    sessionToken: string;
+    characterId: string;
+    playerId: string;
+    serverUrl: string;
+    character: CharacterInfo & {
+        personality?: string | null;
+    };
+}
 interface CharacterAction {
     /** Action name (e.g., "follow_user", "sit", "look_at") */
     name: string;
@@ -339,6 +365,12 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     get memory(): MemoryClient;
     /** Fetch character details including 3D model and avatar URLs. */
     getCharacter(characterId?: string): Promise<CharacterInfo>;
+    /**
+     * Open a permanent share link. Calls the backend's /open endpoint to mint a
+     * fresh session token and resolve character metadata (including modelUrl).
+     * Use the returned fields to construct an EstuaryClient with sessionToken auth.
+     */
+    static openShare(serverUrl: string, shareId: string): Promise<ShareOpenResponse>;
     /** Current session info (null if not connected) */
     get session(): SessionInfo | null;
     /** Current connection state */
@@ -438,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 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 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",
@@ -122,6 +139,15 @@ interface CharacterInfo {
     modelStatus: string | null;
     sourceImageUrl: string | null;
 }
+interface ShareOpenResponse {
+    sessionToken: string;
+    characterId: string;
+    playerId: string;
+    serverUrl: string;
+    character: CharacterInfo & {
+        personality?: string | null;
+    };
+}
 interface CharacterAction {
     /** Action name (e.g., "follow_user", "sit", "look_at") */
     name: string;
@@ -339,6 +365,12 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     get memory(): MemoryClient;
     /** Fetch character details including 3D model and avatar URLs. */
     getCharacter(characterId?: string): Promise<CharacterInfo>;
+    /**
+     * Open a permanent share link. Calls the backend's /open endpoint to mint a
+     * fresh session token and resolve character metadata (including modelUrl).
+     * Use the returned fields to construct an EstuaryClient with sessionToken auth.
+     */
+    static openShare(serverUrl: string, shareId: string): Promise<ShareOpenResponse>;
     /** Current session info (null if not connected) */
     get session(): SessionInfo | null;
     /** Current connection state */
@@ -438,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 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 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) => {
@@ -9669,6 +9672,26 @@ var EstuaryClient = class extends TypedEventEmitter {
     }
     return this._character.getCharacter(characterId ?? this.config.characterId);
   }
+  /**
+   * Open a permanent share link. Calls the backend's /open endpoint to mint a
+   * fresh session token and resolve character metadata (including modelUrl).
+   * Use the returned fields to construct an EstuaryClient with sessionToken auth.
+   */
+  static async openShare(serverUrl, shareId) {
+    const url2 = `${serverUrl.replace(/\/+$/, "")}/api/v1/share/${shareId}/open`;
+    const res = await fetch(url2, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" }
+    });
+    if (!res.ok) {
+      const detail = await res.text().catch(() => "");
+      throw new exports.EstuaryError(
+        "REST_ERROR" /* REST_ERROR */,
+        `Share open failed (${res.status}): ${detail}`
+      );
+    }
+    return res.json();
+  }
   /** Current session info (null if not connected) */
   get session() {
     return this._sessionInfo;