@convai/web-sdk 1.5.0 → 1.6.0-beta.0

package/README.md

@@ -2,7 +2,7 @@
 
 **Real-time conversational AI characters for the web.**
 
-[![npm](https://img.shields.io/badge/npm-1.5.0-blue)](https://www.npmjs.com/package/@convai/web-sdk)
+[![npm](https://img.shields.io/badge/npm-1.6.0--beta.0-blue)](https://www.npmjs.com/package/@convai/web-sdk)
 [![TypeScript](https://img.shields.io/badge/TypeScript-first-3178C6)](https://www.typescriptlang.org/)
 [![License](https://img.shields.io/badge/license-Apache--2.0-green)](./LICENSE)
 
@@ -16,7 +16,7 @@ TypeScript-first SDK for embedding Convai AI characters into React and vanilla J
 - **Real-time audio/video** — full-duplex WebRTC with echo cancellation, camera, and screen share
 - **Lipsync** — ARKit and MetaHuman blendshape streams for facial animation
 - **Emotions** — per-turn emotion detection with intensity scale
-- **Dynamic context** — inject game state, user preferences, or scene data mid-session
+- **Dynamic context & vision** — inject text state, scene metadata, and LiveKit video frames mid-session
 - **Long-term memory** — persistent cross-session memories scoped to each end user
 - **File upload** — send images to the character during a live session
 - **WebSocket transport** — opt-in alternative to WebRTC for constrained networks
@@ -135,13 +135,72 @@ See the <a href="https://docs.convai.com/api-docs/plugins-and-integrations/web-p
 
 ---
 
+## Vision dynamic context beta
+
+Vision dynamic context is the default WebRTC/LiveKit vision path when `enableVideo: true`. Camera, screen, canvas, and custom video tracks can feed unified vision context; set `visionInputConfig.enabled: false` only when you need to keep the video channel while opting out.
+
+```tsx
+import { useConvaiClient } from '@convai/web-sdk';
+
+const client = useConvaiClient({
+  apiKey: import.meta.env.VITE_CONVAI_API_KEY,
+  characterId: import.meta.env.VITE_CONVAI_CHARACTER_ID,
+  enableVideo: true,
+  visionInputConfig: {
+    framesPerTurn: 12,
+    bufferFrames: 30,
+    samplingWindows: [
+      { count: 6, intervalMs: 300 },
+      { count: 6, intervalMs: 1000 },
+    ],
+    stalenessSeconds: 10,
+    replacePreviousVisionContext: true,
+  },
+  respondModes: {
+    vision: 'silent',
+    contextUpdate: 'auto',
+    sceneMetadata: 'silent',
+    trigger: 'must_respond',
+  },
+});
+```
+
+Publish visual sources with semantic labels so acknowledgments can distinguish webcam, canvas, screen, and custom feeds:
+
+```ts
+await client.videoControls.enableVideo(); // webcam source
+
+const handle = await client.videoControls.publishCanvas(canvas, {
+  source: 'canvas',
+  name: 'canvas-pov',
+  fps: 1,
+});
+
+const statusId = client.visionStatus();
+const triggerId = client.visionTrigger({
+  respondMode: 'silent',
+  frameIndices: [-1, -1],
+});
+
+await client.videoControls.unpublishVisionSource(handle);
+```
+
+`visionStatus()` and `visionTrigger()` return an update id. Match it against `serverResponse` events for outcomes such as `frames_available`, `buffer_empty`, `attached`, or `no_active_video`.
+
+After the beta package is published, install it with:
+
+```bash
+npm install @convai/web-sdk@beta
+```
+
+---
+
 ## Example app
 
-A full React Three Fiber integration demo is in [`examples/react-three-fiber`](./examples/react-three-fiber/). It demonstrates lipsync on a 3D character, emotion display, dynamic context, and file upload.
+A full React Three Fiber integration demo is in [`examples/react-three-fiber`](./examples/react-three-fiber/). It demonstrates lipsync on a 3D character, emotion display, dynamic context, vision validation, and file upload.
 
 ---
 
 ## License
 
 Licensed under the [Apache License 2.0](./LICENSE). Copyright 2025 Convai.
-

package/dist/core/BlendshapeQueue.d.ts

@@ -27,8 +27,19 @@ export interface TurnStats {
     total_blendshapes: number;
     total_turn_duration_ms: number;
 }
+export interface BlendshapeChunkMetadata {
+    fps?: number;
+    startFrameIndex?: number;
+    responseId?: string;
+    neurosyncTurnId?: number;
+    epoch?: number;
+}
 export declare class BlendshapeQueue {
     private queue;
+    private pendingTimelineFrames;
+    private activeTimelineAliases;
+    private retiredTimelineAliases;
+    private retiredOwnerlessTimelineAliases;
     private conversationActive;
     private botSpeaking;
     private conversationEnded;
@@ -39,17 +50,61 @@ export declare class BlendshapeQueue {
     private interruptedAtFrame;
     private needsNormalization;
     private _awaitingBotSpeak;
+    private playbackFps;
+    private ownerReplacementStoppedSpeaking;
+    private missingExpectedFramesSinceMs;
+    private readonly now;
     private static readonly TARGET_FPS;
+    private static readonly MAX_RETIRED_TIMELINE_ALIASES;
+    private static readonly MISSING_INDEXED_FRAME_GRACE_MS;
     /**
      * Create a new BlendshapeQueue
      * @param mapper - Optional function to map/transform blendshape data as it's added
      */
-    constructor(mapper?: (input: number[] | Float32Array) => Float32Array);
+    constructor(mapper?: (input: number[] | Float32Array) => Float32Array, now?: () => number);
     /**
      * Add a chunk of blendshapes to the queue
      * @param blendshapes - Array of blendshape frames (each frame is an array of numbers)
+     * @param metadata - Optional timeline metadata for ahead-delivered chunks
+     */
+    addChunk(blendshapes: number[][], metadata?: BlendshapeChunkMetadata): void;
+    private mapFrame;
+    private addTimelineChunk;
+    private flushContiguousTimelineFrames;
+    private timelineAliases;
+    private hasActiveTimelineOwner;
+    private responseAlias;
+    private turnEpochAlias;
+    private turnAlias;
+    private activeHasResponseAlias;
+    private activeHasTurnEpochAlias;
+    private matchesActiveTimelineOwner;
+    private matchesActiveTimelineChunkOwner;
+    private mergeActiveTimelineAliases;
+    private isRetiredTimelineOwner;
+    private rememberRetiredTimelineAliases;
+    private rememberRetiredOwnerlessTimelineAliases;
+    private rememberBoundedAliases;
+    private adoptTimelineOwner;
+    private clearTimelineOwner;
+    /**
+     * True when a lifecycle event belongs to an owner that has already been
+     * interrupted/cancelled or does not match the active indexed timeline.
+     * Ownerless events are treated as current for backward compatibility.
+     */
+    isStaleOwner(metadata?: BlendshapeChunkMetadata): boolean;
+    /**
+     * True when an owner was explicitly interrupted/cancelled/completed.
+     * Chunk messages use this narrower predicate so a newer owner can still
+     * reach addChunk() and atomically replace the active owner there.
+     */
+    isRetiredOwner(metadata?: BlendshapeChunkMetadata): boolean;
+    /**
+     * Drop buffered ahead-delivered frames for a server-cancelled owner.
+     * Returns true when the active owner was flushed.
      */
-    addChunk(blendshapes: number[][]): void;
+    cancelOwner(metadata?: BlendshapeChunkMetadata): boolean;
+    hasBufferedFrames(): boolean;
     /**
      * Set or update the mapper function
      * @param mapper - Function to map/transform blendshape data
@@ -112,7 +167,11 @@ export declare class BlendshapeQueue {
      */
     isConversationEnded(): boolean;
     /**
-     * Check if server has signaled conversation end (blendshape-turn-stats received)
+     * Check if the server end signal is safe to expose to playback consumers.
+     *
+     * Ahead-delivery can deliver blendshape-turn-stats before bot-started-speaking.
+     * Keep those early stats internally for expected-frame accounting, but do not
+     * expose a public drain signal until audio playback has actually started.
      * This does NOT check if all frames have been consumed - use isConversationEnded() for that.
      */
     hasReceivedEndSignal(): boolean;
@@ -135,12 +194,17 @@ export declare class BlendshapeQueue {
      * Lipsync player should only play frames when this is true
      */
     isBotSpeaking(): boolean;
+    /**
+     * Consume the signal that a newer ahead-delivered owner replaced an active
+     * speaking owner before the old bot-stopped-speaking event arrived.
+     */
+    consumeOwnerReplacementStoppedSpeaking(): boolean;
     /**
      * Mark conversation end with turn stats
      * Called when blendshape-turn-stats received
      * Stops accepting new frames and marks conversation as ended
      */
-    endConversation(stats?: TurnStats): void;
+    endConversation(stats?: TurnStats, metadata?: BlendshapeChunkMetadata): void;
     /**
      * Handle interruption - mark for fade out
      * Keeps last 10 frames in queue and fades them out
@@ -161,6 +225,10 @@ export declare class BlendshapeQueue {
      * Get number of frames consumed
      */
     getFramesConsumed(): number;
+    /**
+     * Get playback FPS from chunk metadata, falling back to 60fps.
+     */
+    getPlaybackFps(): number;
     /**
      * Calculate time left in milliseconds based on turn stats
      * Returns null if stats not available
@@ -170,6 +238,7 @@ export declare class BlendshapeQueue {
      * Check if all frames have been consumed based on turn stats
      */
     isAllFramesConsumed(): boolean;
+    private hasUnconsumedExpectedFrames;
     /**
      * Reset queue for new conversation
      * Should be called after all frames have been consumed
@@ -197,6 +266,8 @@ export declare class BlendshapeQueue {
         framesConsumed: number;
         turnStats: TurnStats | null;
         timeLeftMs: number | null;
+        pendingTimelineFrames: number;
+        playbackFps: number;
     };
 }
 //# sourceMappingURL=BlendshapeQueue.d.ts.map

package/dist/core/BlendshapeQueue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlendshapeQueue.d.ts","sourceRoot":"","sources":["../../src/core/BlendshapeQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,KAAK,CAAsB;IACnC,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,MAAM,CAAC,CAAmD;IAClE,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,iBAAiB,CAAkB;IAG3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAM;IAExC;;;OAGG;gBACS,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,KAAK,YAAY;IAIrE;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI;IA+BvC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,KAAK,YAAY,GAAG,IAAI;IAIzE;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,SAAS,IAAI,YAAY,EAAE;IAI3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAO5C;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IA+CrD;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOlC;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;;;;;;;OAUG;IACH,mBAAmB,IAAI,OAAO;IAyB9B;;;OAGG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;OAGG;IACH,iBAAiB,IAAI,IAAI;IAazB;;;OAGG;IACH,gBAAgB,IAAI,OAAO;IAY3B;;OAEG;IACH,eAAe,IAAI,IAAI;IAIvB;;;OAGG;IACH,aAAa,IAAI,OAAO;IAIxB;;;;OAIG;IACH,eAAe,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI;IAexC;;;OAGG;IACH,SAAS,IAAI,IAAI;IAcjB;;;;;OAKG;IACH,0BAA0B,IAAI,OAAO;IAMrC;;OAEG;IACH,YAAY,IAAI,SAAS,GAAG,IAAI;IAIhC;;OAEG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;;OAGG;IACH,aAAa,IAAI,MAAM,GAAG,IAAI;IAiB9B;;OAEG;IACH,mBAAmB,IAAI,OAAO;IAK9B;;;OAGG;IACH,KAAK,IAAI,IAAI;IAWb;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG;QACnC,KAAK,EAAE,YAAY,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAiBR;;OAEG;IACH,YAAY,IAAI;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,WAAW,EAAE,OAAO,CAAC;QACrB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;QAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CAaF"}
+{"version":3,"file":"BlendshapeQueue.d.ts","sourceRoot":"","sources":["../../src/core/BlendshapeQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,KAAK,CAAsB;IACnC,OAAO,CAAC,qBAAqB,CAAmC;IAChE,OAAO,CAAC,qBAAqB,CAAqB;IAClD,OAAO,CAAC,sBAAsB,CAAqB;IACnD,OAAO,CAAC,+BAA+B,CAAqB;IAC5D,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,MAAM,CAAC,CAAmD;IAClE,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,+BAA+B,CAAkB;IACzD,OAAO,CAAC,4BAA4B,CAAuB;IAC3D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IAGnC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAM;IACxC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAAM;IAC1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CACX;IAE3C;;;OAGG;gBAED,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,KAAK,YAAY,EACzD,GAAG,GAAE,MAAM,MAAyB;IAMtC;;;;OAIG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EAAE,EAAE,EACvB,QAAQ,GAAE,uBAA4B,GACrC,IAAI;IA2EP,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,gBAAgB;IAyBxB,OAAO,CAAC,6BAA6B;IAarC,OAAO,CAAC,eAAe;IAevB,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,0BAA0B;IAqBlC,OAAO,CAAC,+BAA+B;IA0BvC,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,sBAAsB;IA0C9B,OAAO,CAAC,8BAA8B;IAWtC,OAAO,CAAC,uCAAuC;IAW/C,OAAO,CAAC,sBAAsB;IAyB9B,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,kBAAkB;IAI1B;;;;OAIG;IACH,YAAY,CAAC,QAAQ,GAAE,uBAA4B,GAAG,OAAO;IAc7D;;;;OAIG;IACH,cAAc,CAAC,QAAQ,GAAE,uBAA4B,GAAG,OAAO;IAI/D;;;OAGG;IACH,WAAW,CAAC,QAAQ,GAAE,uBAA4B,GAAG,OAAO;IA0C5D,iBAAiB,IAAI,OAAO;IAI5B;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,KAAK,YAAY,GAAG,IAAI;IAIzE;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;OAGG;IACH,SAAS,IAAI,YAAY,EAAE;IAI3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAO5C;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IA+CrD;;;OAGG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQlC;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;;;;;;;OAUG;IACH,mBAAmB,IAAI,OAAO;IA4C9B;;;;;;;OAOG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;OAGG;IACH,iBAAiB,IAAI,IAAI;IA+BzB;;;OAGG;IACH,gBAAgB,IAAI,OAAO;IAiB3B;;OAEG;IACH,eAAe,IAAI,IAAI;IAIvB;;;OAGG;IACH,aAAa,IAAI,OAAO;IAIxB;;;OAGG;IACH,sCAAsC,IAAI,OAAO;IAMjD;;;;OAIG;IACH,eAAe,CACb,KAAK,CAAC,EAAE,SAAS,EACjB,QAAQ,GAAE,uBAA4B,GACrC,IAAI;IAoCP;;;OAGG;IACH,SAAS,IAAI,IAAI;IAkBjB;;;;;OAKG;IACH,0BAA0B,IAAI,OAAO;IAMrC;;OAEG;IACH,YAAY,IAAI,SAAS,GAAG,IAAI;IAIhC;;OAEG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;;OAGG;IACH,aAAa,IAAI,MAAM,GAAG,IAAI;IAiB9B;;OAEG;IACH,mBAAmB,IAAI,OAAO;IAK9B,OAAO,CAAC,2BAA2B;IAOnC;;;OAGG;IACH,KAAK,IAAI,IAAI;IAiBb;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG;QACnC,KAAK,EAAE,YAAY,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAiBR;;OAEG;IACH,YAAY,IAAI;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,WAAW,EAAE,OAAO,CAAC;QACrB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;QAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,qBAAqB,EAAE,MAAM,CAAC;QAC9B,WAAW,EAAE,MAAM,CAAC;KACrB;CAeF"}