@estuary-ai/sdk 0.1.22 → 0.1.23

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

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/@estuary-ai/sdk)](https://www.npmjs.com/package/@estuary-ai/sdk)
 
-TypeScript SDK for the [Estuary](https://www.estuary-ai.com) real-time AI conversation platform. Build applications with persistent AI characters that remember, hear, and see.
+Web SDK for the [Estuary](https://www.estuary-ai.com) real-time AI conversation platform. Build applications with persistent AI characters that remember, hear, and see.
 
 ## Installation
 
@@ -242,7 +242,7 @@ interface EstuaryConfig {
 
 ## Exports
 
-Key exports for TypeScript users:
+Key exports:
 
 ```typescript
 // Client

package/dist/{chunk-6M5LSBMK.mjs → chunk-W5QYPYX3.mjs}

@@ -26,5 +26,5 @@ var EstuaryError = class extends Error {
 };
 
 export { ErrorCode, EstuaryError };
-//# sourceMappingURL=chunk-6M5LSBMK.mjs.map
-//# sourceMappingURL=chunk-6M5LSBMK.mjs.map
+//# sourceMappingURL=chunk-W5QYPYX3.mjs.map
+//# sourceMappingURL=chunk-W5QYPYX3.mjs.map

package/dist/chunk-W5QYPYX3.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"names":["ErrorCode"],"mappings":";AAAO,IAAK,SAAA,qBAAAA,UAAAA,KAAL;AACL,EAAAA,WAAA,mBAAA,CAAA,GAAoB,mBAAA;AACpB,EAAAA,WAAA,aAAA,CAAA,GAAc,aAAA;AACd,EAAAA,WAAA,oBAAA,CAAA,GAAqB,oBAAA;AACrB,EAAAA,WAAA,gBAAA,CAAA,GAAiB,gBAAA;AACjB,EAAAA,WAAA,qBAAA,CAAA,GAAsB,qBAAA;AACtB,EAAAA,WAAA,sBAAA,CAAA,GAAuB,sBAAA;AACvB,EAAAA,WAAA,kBAAA,CAAA,GAAmB,kBAAA;AACnB,EAAAA,WAAA,qBAAA,CAAA,GAAsB,qBAAA;AACtB,EAAAA,WAAA,mBAAA,CAAA,GAAoB,mBAAA;AACpB,EAAAA,WAAA,eAAA,CAAA,GAAgB,eAAA;AAChB,EAAAA,WAAA,YAAA,CAAA,GAAa,YAAA;AACb,EAAAA,WAAA,SAAA,CAAA,GAAU,SAAA;AAZA,EAAA,OAAAA,UAAAA;AAAA,CAAA,EAAA,SAAA,IAAA,EAAA;AAeL,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EAC7B,IAAA;AAAA,EACA,OAAA;AAAA,EAET,WAAA,CAAY,IAAA,EAAiB,OAAA,EAAiB,OAAA,EAAmB;AAC/D,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAAA,EACjB;AACF","file":"chunk-W5QYPYX3.mjs","sourcesContent":["export enum ErrorCode {\n  CONNECTION_FAILED = 'CONNECTION_FAILED',\n  AUTH_FAILED = 'AUTH_FAILED',\n  CONNECTION_TIMEOUT = 'CONNECTION_TIMEOUT',\n  QUOTA_EXCEEDED = 'QUOTA_EXCEEDED',\n  VOICE_NOT_SUPPORTED = 'VOICE_NOT_SUPPORTED',\n  VOICE_ALREADY_ACTIVE = 'VOICE_ALREADY_ACTIVE',\n  VOICE_NOT_ACTIVE = 'VOICE_NOT_ACTIVE',\n  LIVEKIT_UNAVAILABLE = 'LIVEKIT_UNAVAILABLE',\n  MICROPHONE_DENIED = 'MICROPHONE_DENIED',\n  NOT_CONNECTED = 'NOT_CONNECTED',\n  REST_ERROR = 'REST_ERROR',\n  UNKNOWN = 'UNKNOWN',\n}\n\nexport class EstuaryError extends Error {\n  readonly code: ErrorCode;\n  readonly details?: unknown;\n\n  constructor(code: ErrorCode, message: string, details?: unknown) {\n    super(message);\n    this.name = 'EstuaryError';\n    this.code = code;\n    this.details = details;\n  }\n}\n"]}

package/dist/index.d.mts

@@ -109,6 +109,16 @@ interface MemoryUpdatedEvent {
     newMemories: MemoryData[];
     timestamp: string;
 }
+interface CharacterInfo {
+    id: string;
+    name: string;
+    tagline: string | null;
+    avatar: string | null;
+    modelUrl: string | null;
+    modelPreviewUrl: string | null;
+    modelStatus: string | null;
+    sourceImageUrl: string | null;
+}
 interface CharacterAction {
     /** Action name (e.g., "follow_user", "sit", "look_at") */
     name: string;
@@ -309,6 +319,7 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     private voiceManager;
     private audioPlayer;
     private _memory;
+    private _character;
     private _sessionInfo;
     private actionParsers;
     private _hasAutoInterrupted;
@@ -316,6 +327,8 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     constructor(config: EstuaryConfig);
     /** Memory API client for querying memories, graphs, and facts */
     get memory(): MemoryClient;
+    /** Fetch character details including 3D model and avatar URLs. */
+    getCharacter(characterId?: string): Promise<CharacterInfo>;
     /** Current session info (null if not connected) */
     get session(): SessionInfo | null;
     /** Current connection state */
@@ -346,6 +359,9 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     toggleMute(): void;
     /** Whether the microphone is muted */
     get isMuted(): boolean;
+    /** Get/set suppressMicDuringPlayback at runtime (no reconnect needed) */
+    get suppressMicDuringPlayback(): boolean;
+    set suppressMicDuringPlayback(enabled: boolean);
     /** Whether voice is currently active */
     get isVoiceActive(): boolean;
     private ensureConnected;
@@ -394,4 +410,12 @@ declare function parseActions(text: string): {
     cleanText: string;
 };
 
-export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, 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 };
+declare class CharacterClient {
+    private rest;
+    constructor(rest: RestClient);
+    /** Fetch character details including 3D model and avatar URLs. */
+    getCharacter(characterId: string): Promise<CharacterInfo>;
+    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 };

package/dist/index.d.ts

@@ -109,6 +109,16 @@ interface MemoryUpdatedEvent {
     newMemories: MemoryData[];
     timestamp: string;
 }
+interface CharacterInfo {
+    id: string;
+    name: string;
+    tagline: string | null;
+    avatar: string | null;
+    modelUrl: string | null;
+    modelPreviewUrl: string | null;
+    modelStatus: string | null;
+    sourceImageUrl: string | null;
+}
 interface CharacterAction {
     /** Action name (e.g., "follow_user", "sit", "look_at") */
     name: string;
@@ -309,6 +319,7 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     private voiceManager;
     private audioPlayer;
     private _memory;
+    private _character;
     private _sessionInfo;
     private actionParsers;
     private _hasAutoInterrupted;
@@ -316,6 +327,8 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     constructor(config: EstuaryConfig);
     /** Memory API client for querying memories, graphs, and facts */
     get memory(): MemoryClient;
+    /** Fetch character details including 3D model and avatar URLs. */
+    getCharacter(characterId?: string): Promise<CharacterInfo>;
     /** Current session info (null if not connected) */
     get session(): SessionInfo | null;
     /** Current connection state */
@@ -346,6 +359,9 @@ declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
     toggleMute(): void;
     /** Whether the microphone is muted */
     get isMuted(): boolean;
+    /** Get/set suppressMicDuringPlayback at runtime (no reconnect needed) */
+    get suppressMicDuringPlayback(): boolean;
+    set suppressMicDuringPlayback(enabled: boolean);
     /** Whether voice is currently active */
     get isVoiceActive(): boolean;
     private ensureConnected;
@@ -394,4 +410,12 @@ declare function parseActions(text: string): {
     cleanText: string;
 };
 
-export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, 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 };
+declare class CharacterClient {
+    private rest;
+    constructor(rest: RestClient);
+    /** Fetch character details including 3D model and avatar URLs. */
+    getCharacter(characterId: string): Promise<CharacterInfo>;
+    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 };

package/dist/index.js

@@ -880,6 +880,30 @@ var MemoryClient = class {
   }
 };
 
+// src/rest/character-client.ts
+var CharacterClient = class {
+  rest;
+  constructor(rest) {
+    this.rest = rest;
+  }
+  /** Fetch character details including 3D model and avatar URLs. */
+  async getCharacter(characterId) {
+    const raw = await this.rest.get(`/api/agents/${characterId}`);
+    return {
+      id: raw.id,
+      name: raw.name,
+      tagline: raw.tagline ?? null,
+      avatar: raw.avatar ?? null,
+      modelUrl: raw.modelUrl ?? null,
+      modelPreviewUrl: raw.modelPreviewUrl ?? null,
+      modelStatus: raw.modelStatus ?? null,
+      sourceImageUrl: raw.sourceImageUrl ?? null
+    };
+  }
+  dispose() {
+  }
+};
+
 // src/audio/audio-player.ts
 var AudioPlayer = class {
   sampleRate;
@@ -1130,6 +1154,7 @@ var EstuaryClient = class extends TypedEventEmitter {
   voiceManager = null;
   audioPlayer = null;
   _memory;
+  _character;
   _sessionInfo = null;
   actionParsers = /* @__PURE__ */ new Map();
   _hasAutoInterrupted = false;
@@ -1142,11 +1167,16 @@ var EstuaryClient = class extends TypedEventEmitter {
     this.forwardSocketEvents();
     const restClient = new RestClient(config.serverUrl, config.apiKey);
     this._memory = new MemoryClient(restClient, config.characterId, config.playerId);
+    this._character = new CharacterClient(restClient);
   }
   /** Memory API client for querying memories, graphs, and facts */
   get memory() {
     return this._memory;
   }
+  /** Fetch character details including 3D model and avatar URLs. */
+  async getCharacter(characterId) {
+    return this._character.getCharacter(characterId ?? this.config.characterId);
+  }
   /** Current session info (null if not connected) */
   get session() {
     return this._sessionInfo;
@@ -1277,6 +1307,13 @@ var EstuaryClient = class extends TypedEventEmitter {
   get isMuted() {
     return this.voiceManager?.isMuted ?? false;
   }
+  /** Get/set suppressMicDuringPlayback at runtime (no reconnect needed) */
+  get suppressMicDuringPlayback() {
+    return this.config.suppressMicDuringPlayback ?? false;
+  }
+  set suppressMicDuringPlayback(enabled) {
+    this.config.suppressMicDuringPlayback = enabled;
+  }
   /** Whether voice is currently active */
   get isVoiceActive() {
     return this.voiceManager?.isActive ?? false;