@boldvideo/bold-js 1.10.0 → 1.11.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @boldvideo/bold-js
 
+## 1.11.1
+
+### Patch Changes
+
+- 0428b78: Add `cited` boolean field to Segment type for stable citation ordering
+
+## 1.11.0
+
+### Minor Changes
+
+- 88c5d1c: Remove deprecated SSE event types and add Segment type
+
+  **Breaking changes to `AIEvent` type:**
+
+  - Remove deprecated event types: `token`, `clarification`, `answer`, `complete`
+  - Remove `AnswerMetadata` interface
+  - Change `message_complete` event: `sources` field renamed to `citations`, added `responseType: "answer" | "clarification"`
+
+  **New exports:**
+
+  - `Segment` - Primary type for video segments (replaces Source)
+  - `Citation` - Semantic alias for Segment (for cited chunks)
+  - `Source` - Now a deprecated alias for Segment (kept for backwards compatibility)
+
+  This aligns the SDK with the simplified backend SSE event structure.
+
 ## 1.10.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -269,7 +269,7 @@ async function* parseSSE(response) {
           const raw = JSON.parse(json);
           const event = camelizeKeys(raw);
           yield event;
-          if (event.type === "message_complete" || event.type === "complete" || event.type === "error") {
+          if (event.type === "message_complete" || event.type === "error") {
             await reader.cancel();
             return;
           }

package/dist/index.d.ts

@@ -179,9 +179,9 @@ type Settings = {
     version: string;
 };
 /**
- * Source citation from AI responses
+ * Video segment from AI responses (used for both sources and citations)
  */
-interface Source {
+interface Segment {
     id: string;
     videoId: string;
     title: string;
@@ -190,7 +190,16 @@ interface Source {
     timestampEnd: number;
     playbackId: string;
     speaker?: string;
+    cited?: boolean;
 }
+/**
+ * @deprecated Use Segment instead
+ */
+type Source = Segment;
+/**
+ * Alias for Segment - represents chunks the LLM actually cited
+ */
+type Citation = Segment;
 /**
  * Token usage statistics
  */
@@ -198,14 +207,6 @@ interface AIUsage {
     inputTokens: number;
     outputTokens: number;
 }
-/**
- * Metadata included with answer events
- */
-interface AnswerMetadata {
-    topScore: number;
-    chunksFound: number;
-    videosSearched: number;
-}
 /**
  * SSE event types for AI streaming responses
  */
@@ -215,39 +216,23 @@ type AIEvent = {
     videoId?: string;
 } | {
     type: "sources";
-    sources: Source[];
+    sources: Segment[];
 } | {
     type: "text_delta";
     delta: string;
-} | {
-    type: "token";
-    content: string;
-} | {
-    type: "clarification";
-    content: string;
-    questions: string[];
 } | {
     type: "recommendations";
     recommendations: Recommendation[];
-} | {
-    type: "answer";
-    content: string;
-    metadata: AnswerMetadata;
-    usage?: AIUsage;
-    confidence?: string;
-    responseStrategy?: string;
-    citations?: Source[];
 } | {
     type: "message_complete";
     conversationId?: string;
     content: string;
-    sources: Source[];
+    citations: Segment[];
+    responseType: "answer" | "clarification";
     usage?: AIUsage;
     context?: AIContextMessage[];
     recommendations?: Recommendation[];
     guidance?: string;
-} | {
-    type: "complete";
 } | {
     type: "error";
     code: string;
@@ -505,4 +490,4 @@ declare const DEFAULT_API_BASE_URL = "https://app.boldvideo.io/api/v1/";
  */
 declare const DEFAULT_INTERNAL_API_BASE_URL = "https://app.boldvideo.io/i/v1/";
 
-export { AIContextMessage, AIEvent, AIResponse, AIUsage, Account, AccountAI, AskOptions, AssistantConfig, ChatOptions, ClientOptions, DEFAULT_API_BASE_URL, DEFAULT_INTERNAL_API_BASE_URL, MenuItem, Playlist, Portal, PortalDisplay, PortalLayout, PortalNavigation, PortalTheme, RecommendOptions, RecommendResponse, Recommendation, RecommendationVideo, RecommendationsOptions, RecommendationsResponse, SearchOptions, Settings, Source, ThemeColors, ThemeConfig, Video, VideoAttachment, VideoDownloadUrls, VideoMetadata, VideoSubtitles, VideoTranscript, createClient };
+export { AIContextMessage, AIEvent, AIResponse, AIUsage, Account, AccountAI, AskOptions, AssistantConfig, ChatOptions, Citation, ClientOptions, DEFAULT_API_BASE_URL, DEFAULT_INTERNAL_API_BASE_URL, MenuItem, Playlist, Portal, PortalDisplay, PortalLayout, PortalNavigation, PortalTheme, RecommendOptions, RecommendResponse, Recommendation, RecommendationVideo, RecommendationsOptions, RecommendationsResponse, SearchOptions, Segment, Settings, Source, ThemeColors, ThemeConfig, Video, VideoAttachment, VideoDownloadUrls, VideoMetadata, VideoSubtitles, VideoTranscript, createClient };

package/dist/index.js

@@ -231,7 +231,7 @@ async function* parseSSE(response) {
           const raw = JSON.parse(json);
           const event = camelizeKeys(raw);
           yield event;
-          if (event.type === "message_complete" || event.type === "complete" || event.type === "error") {
+          if (event.type === "message_complete" || event.type === "error") {
             await reader.cancel();
             return;
           }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@boldvideo/bold-js",
   "license": "MIT",
-  "version": "1.10.0",
+  "version": "1.11.1",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",