@estuary-ai/sdk 0.2.0 → 0.3.0

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

@@ -238,7 +238,7 @@ interface EstuaryConfig {
   apiKey: string;              // API key (est_...)
   characterId: string;         // Character ID
   playerId: string;            // End user ID
-  audioSampleRate?: number;    // Default: 16000
+  audioSampleRate?: number;    // Default: 24000
   autoReconnect?: boolean;     // Default: true
   maxReconnectAttempts?: number; // Default: 5
   reconnectDelayMs?: number;   // Default: 2000

package/dist/index.d.mts

@@ -122,6 +122,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 +348,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 +453,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

@@ -122,6 +122,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 +348,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 +453,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

@@ -9030,7 +9030,7 @@ var SocketManager = class extends TypedEventEmitter {
         const authPayload = {
           character_id: this.config.characterId,
           player_id: this.config.playerId,
-          audio_sample_rate: this.config.audioSampleRate ?? 16e3,
+          audio_sample_rate: this.config.audioSampleRate ?? 24e3,
           realtime_memory: this.config.realtimeMemory ?? false
         };
         if (this.config.sessionToken) {
@@ -9669,6 +9669,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;