@convai/web-sdk 1.8.0-beta.3 → 1.8.0-beta.5

package/dist/core/ConvaiClient.js

@@ -1,19 +1,21 @@
 import { Room, RoomEvent, DefaultReconnectPolicy, setLogLevel, } from "livekit-client";
 setLogLevel("warn");
-import { DisconnectReasonEnum, } from "./types";
-import { AudioManager } from "./AudioManager";
-import { VideoManager } from "./VideoManager";
-import { ScreenShareManager } from "./ScreenShareManager";
-import { MessageHandler } from "./MessageHandler";
-import { SDK_VERSION } from "../version";
-import { EventEmitter } from "./EventEmitter";
-import { MemoryManager } from "./MemoryManager";
-import { ConnectionStateHandler } from "./ConnectionStateHandler";
-import { buildActionConnectConfig, buildBlendshapeConnectConfig, buildEmotionConnectConfig, } from "./connectRequest";
-import { shouldPreemptForContextUpdateResponse, shouldPreemptForExplicitRespondMode, } from "./contextUpdateRequest";
-import { resolveVisionInputConfig, serializeVisionInputConfig, } from "./visionRequest";
-import { SSESession } from "./SSESession";
-import { isValidLogicalTurnId } from "./logicalTurn";
+import { DisconnectReasonEnum, } from "./types.js";
+import { AudioManager } from "./AudioManager.js";
+import { VideoManager } from "./VideoManager.js";
+import { ScreenShareManager } from "./ScreenShareManager.js";
+import { MessageHandler } from "./MessageHandler.js";
+import { SDK_VERSION } from "../version.js";
+import { EventEmitter } from "./EventEmitter.js";
+import { MemoryManager } from "./MemoryManager.js";
+import { CharacterVersionManager } from "./CharacterVersionManager.js";
+import { resolveCharacterReference, } from "./characterReference.js";
+import { ConnectionStateHandler } from "./ConnectionStateHandler.js";
+import { buildActionConnectConfig, buildBlendshapeConnectConfig, buildEmotionConnectConfig, } from "./connectRequest.js";
+import { shouldPreemptForContextUpdateResponse, shouldPreemptForExplicitRespondMode, } from "./contextUpdateRequest.js";
+import { resolveVisionInputConfig, serializeVisionInputConfig, } from "./visionRequest.js";
+import { SSESession } from "./SSESession.js";
+import { isValidLogicalTurnId } from "./logicalTurn.js";
 // Module-level registry — populated by importing @convai/web-sdk/vanilla/websocket
 let _wsFactory = null;
 function normalizeStateOfMind(value) {
@@ -81,6 +83,10 @@ export class ConvaiClient extends EventEmitter {
         this._apiKey = null;
         this._authToken = null;
         this._characterId = null;
+        this._characterVersion = null;
+        this._characterReference = null;
+        this._characterVersionManager = null;
+        this._characterVersionManagerKey = null;
         this._characterSessionId = "-1";
         this._isBotReady = false;
         this._participantSid = "";
@@ -169,6 +175,42 @@ export class ConvaiClient extends EventEmitter {
     get characterId() {
         return this._characterId;
     }
+    get characterVersion() {
+        return this._characterVersion;
+    }
+    get characterReference() {
+        return this._characterReference;
+    }
+    /**
+     * Character version manager for the configured character. Built from the
+     * live connection when there is one, otherwise from the stored config, so
+     * versions can be listed and released before connecting. Null without an
+     * API key (the Character REST platform does not accept realtime auth tokens).
+     */
+    get characterVersions() {
+        const apiKey = this._apiKey ?? this._storedConfig?.apiKey ?? null;
+        const rawCharacterId = this._characterId ?? this._storedConfig?.characterId ?? null;
+        if (!apiKey || !rawCharacterId)
+            return null;
+        let characterId = rawCharacterId;
+        try {
+            characterId = resolveCharacterReference(rawCharacterId).characterId;
+        }
+        catch {
+            // A malformed id is reported by connect(); use it verbatim here.
+        }
+        const baseUrl = this._storedConfig?.characterApiUrl ?? undefined;
+        const key = `${apiKey}\u0000${characterId}\u0000${baseUrl ?? ""}`;
+        if (this._characterVersionManagerKey !== key) {
+            this._characterVersionManager = new CharacterVersionManager({
+                apiKey,
+                characterId,
+                baseUrl,
+            });
+            this._characterVersionManagerKey = key;
+        }
+        return this._characterVersionManager;
+    }
     get room() {
         return this._room;
     }
@@ -430,6 +472,8 @@ export class ConvaiClient extends EventEmitter {
             this._apiKey = configWithDefaults.apiKey ?? null;
             this._authToken = configWithDefaults.authToken ?? null;
             this._characterId = configWithDefaults.characterId;
+            this._characterVersion = configWithDefaults.characterVersion ?? null;
+            this._characterReference = configWithDefaults.characterReference;
             // Determine connection type based on enableVideo
             const connType = configWithDefaults.enableVideo ? "video" : "audio";
             this._connectionType = connType;
@@ -453,7 +497,7 @@ export class ConvaiClient extends EventEmitter {
                 this._sseSession = new SSESession({
                     interactionApiUrl: configWithDefaults.interactionApiUrl,
                     authorization: configWithDefaults.authToken ?? configWithDefaults.apiKey,
-                    characterId: configWithDefaults.characterId,
+                    characterId: configWithDefaults.characterReference,
                     getCharacterSessionId: () => this._characterSessionId,
                     takeStateOfMind: () => {
                         const stateOfMind = this._stateOfMind;
@@ -496,7 +540,7 @@ export class ConvaiClient extends EventEmitter {
             // Prepare request body with required parameters
             const characterSessionIdToSend = configWithDefaults.characterSessionId ?? this._characterSessionId;
             const requestBody = {
-                character_id: configWithDefaults.characterId,
+                character_id: configWithDefaults.characterReference,
                 ...(stateOfMind ? { state_of_mind: stateOfMind } : {}),
                 ...(configWithDefaults.endUserId && {
                     end_user_id: configWithDefaults.endUserId,
@@ -686,7 +730,16 @@ export class ConvaiClient extends EventEmitter {
         if (missingCredential || !configWithDefaults.characterId) {
             throw new Error("Either apiKey or authToken is required, and characterId is required");
         }
-        return configWithDefaults;
+        // Split the character id from its version selector. The bare UUID names
+        // the character everywhere inside the SDK (memory, character info); the
+        // joined reference is what the runtime receives.
+        const reference = resolveCharacterReference(configWithDefaults.characterId, configWithDefaults.characterVersion);
+        return {
+            ...configWithDefaults,
+            characterId: reference.characterId,
+            characterVersion: reference.version,
+            characterReference: reference.reference,
+        };
     }
     /**
      * Consume a /connect response and bring up the transport.
@@ -718,6 +771,8 @@ export class ConvaiClient extends EventEmitter {
         this._apiKey = configWithDefaults.apiKey ?? null;
         this._authToken = configWithDefaults.authToken ?? null;
         this._characterId = configWithDefaults.characterId;
+        this._characterVersion = configWithDefaults.characterVersion ?? null;
+        this._characterReference = configWithDefaults.characterReference;
         const connType = configWithDefaults.enableVideo ? "video" : "audio";
         this._connectionType = connType;
         const transportType = configWithDefaults.transport ?? "livekit";
@@ -1016,6 +1071,8 @@ export class ConvaiClient extends EventEmitter {
         this._apiKey = null;
         this._authToken = null;
         this._characterId = null;
+        this._characterVersion = null;
+        this._characterReference = null;
         this._endUserId = null;
         this._endUserMetadata = null;
         this._memoryManager = null; // Clear memory manager on disconnect