@boldvideo/bold-js 1.7.0 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @boldvideo/bold-js
 
+## 1.9.0
+
+### Minor Changes
+
+- ff2f021: Transform all API responses to use camelCase (TypeScript/JavaScript convention)
+
+  **Breaking Changes:**
+
+  All response types now use camelCase consistently across the entire SDK:
+
+  - **Videos**: `playback_id` → `playbackId`, `published_at` → `publishedAt`, `stream_url` → `streamUrl`, `meta_data` → `metaData`, `captions_label` → `captionsLabel`, `download_urls` → `downloadUrls`, etc.
+  - **Playlists**: `is_private` → `isPrivate`
+  - **Settings**: `featured_playlists` → `featuredPlaylists`, `menu_items` → `menuItems`, `theme_config` → `themeConfig`, `ai_avatar` → `aiAvatar`, `logo_url` → `logoUrl`, etc.
+  - **Portal/Theme**: `show_chapters` → `showChapters`, `font_body` → `fontBody`, `color_scheme` → `colorScheme`, `css_overrides` → `cssOverrides`, etc.
+  - **AI responses**: (already camelCase in v1.8.0)
+
+  **Internal:**
+
+  - Applied `camelizeKeys()` transformation in `fetchers.ts` at the transport boundary
+  - Updated all type definitions in `types.ts` to use camelCase
+
+## 1.8.0
+
+### Minor Changes
+
+- 065d7ea: Transform all API responses to use camelCase (TypeScript/JavaScript convention)
+
+  **Breaking Changes:**
+
+  - **All response types now use camelCase** (was snake_case). API responses are transformed at the SDK boundary.
+    - `video_id` → `videoId`
+    - `timestamp_end` → `timestampEnd`
+    - `playback_id` → `playbackId`
+    - `input_tokens` → `inputTokens`
+    - `conversation_id` → `conversationId`
+
+  **Internal:**
+
+  - Added `camelizeKeys` utility for deep snake_case → camelCase transformation
+  - Applied transformation in `jsonRequest()` and `parseSSE()` at the transport boundary
+
 ## 1.7.0
 
 ### Minor Changes

package/README.md

@@ -269,7 +269,33 @@ import type {
 
 ---
 
-## Migration from v1.6.x
+## Migration from v1.7.x
+
+### Breaking: All response types now use camelCase
+
+**All API responses** (videos, playlists, settings, AI) are now transformed to use idiomatic TypeScript/JavaScript naming:
+
+```typescript
+// Before (v1.7.x and earlier)
+video.playback_id
+video.published_at
+video.stream_url
+video.meta_data
+settings.featured_playlists
+settings.menu_items
+settings.theme_config
+playlist.is_private
+
+// After (v1.8.0)
+video.playbackId
+video.publishedAt
+video.streamUrl
+video.metaData
+settings.featuredPlaylists
+settings.menuItems
+settings.themeConfig
+playlist.isPrivate
+```
 
 ### Method Changes
 

package/dist/index.cjs

@@ -39,6 +39,24 @@ module.exports = __toCommonJS(src_exports);
 // src/lib/client.ts
 var import_axios = __toESM(require("axios"), 1);
 
+// src/util/camelize.ts
+var isPlainObject = (value) => value !== null && typeof value === "object" && (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
+var snakeToCamel = (key) => key.replace(/_([a-z0-9])/g, (_, c) => c.toUpperCase());
+function camelizeKeys(input) {
+  if (Array.isArray(input)) {
+    return input.map((item) => camelizeKeys(item));
+  }
+  if (!isPlainObject(input)) {
+    return input;
+  }
+  const out = {};
+  for (const [rawKey, value] of Object.entries(input)) {
+    const key = snakeToCamel(rawKey);
+    out[key] = camelizeKeys(value);
+  }
+  return out;
+}
+
 // src/lib/fetchers.ts
 async function get(client, url) {
   try {
@@ -46,7 +64,7 @@ async function get(client, url) {
     if (res.status !== 200) {
       throw new Error(`Unexpected response status: ${res.status}`);
     }
-    return res.data;
+    return camelizeKeys(res.data);
   } catch (error) {
     console.error(`Error fetching data from URL: ${url}`, error);
     throw error;
@@ -248,7 +266,8 @@ async function* parseSSE(response) {
         if (!json)
           continue;
         try {
-          const event = JSON.parse(json);
+          const raw = JSON.parse(json);
+          const event = camelizeKeys(raw);
           yield event;
           if (event.type === "message_complete" || event.type === "error") {
             await reader.cancel();
@@ -298,7 +317,8 @@ async function jsonRequest(path, body, config) {
   if (!response.ok) {
     throw new Error(`AI request failed: ${response.status} ${response.statusText}`);
   }
-  return response.json();
+  const raw = await response.json();
+  return camelizeKeys(raw);
 }
 function createAI(config) {
   async function chat(options) {

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 type VideoAttachment = {
     id: string;
     title: string;
-    file_url: string;
-    file_size?: number;
-    file_type?: string;
+    fileUrl: string;
+    fileSize?: number;
+    fileType?: string;
 };
 type VideoDownloadUrls = {
     mp4?: string;
     audio?: string;
-    legacy_mp4?: string;
+    legacyMp4?: string;
 };
 type VideoSubtitles = {
     label: string;
@@ -27,27 +27,27 @@ type VideoMetadata = {
 };
 type Video = {
     captions: string;
-    captions_label: string;
-    captions_lang: string;
+    captionsLabel: string;
+    captionsLang: string;
     description: string | null;
     duration: number;
     id: string;
-    imported_from: string | null;
-    legacy_video_url: string | null;
-    playback_id: string;
-    published_at: string;
-    stream_url: string;
+    importedFrom: string | null;
+    legacyVideoUrl: string | null;
+    playbackId: string;
+    publishedAt: string;
+    streamUrl: string;
     teaser: string | null;
     thumbnail: string;
     title: string;
     type: string;
-    meta_data: VideoMetadata;
+    metaData: VideoMetadata;
     chapters?: string;
     attachments?: VideoAttachment[];
     cta?: any | null;
-    download_urls?: VideoDownloadUrls;
-    internal_id: string;
-    playback_speed?: number;
+    downloadUrls?: VideoDownloadUrls;
+    internalId: string;
+    playbackSpeed?: number;
     subtitles?: VideoSubtitles;
     tags?: string[];
     transcript?: VideoTranscript;
@@ -55,20 +55,20 @@ type Video = {
 type Playlist = {
     description?: string;
     id: string;
-    is_private: boolean;
+    isPrivate: boolean;
     title: string;
     type: string;
     videos: Video[];
 };
 type MenuItem = {
     icon: string;
-    is_ext: boolean;
+    isExt: boolean;
     label: string;
     url: string;
 };
 type PortalDisplay = {
-    show_chapters: boolean;
-    show_transcripts: boolean;
+    showChapters: boolean;
+    showTranscripts: boolean;
 };
 type AssistantConfig = {
     headline: string;
@@ -76,36 +76,36 @@ type AssistantConfig = {
     suggestions: string[];
 };
 type PortalLayout = {
-    assistant_config: AssistantConfig | null;
-    show_playlists: boolean;
+    assistantConfig: AssistantConfig | null;
+    showPlaylists: boolean;
     type: string;
-    videos_limit: number;
+    videosLimit: number;
 };
 type PortalNavigation = {
-    show_ai_search: boolean;
-    show_header: boolean;
-    show_search: boolean;
+    showAiSearch: boolean;
+    showHeader: boolean;
+    showSearch: boolean;
 };
 type PortalTheme = {
     background: string;
     foreground: string;
     primary: string;
-    font_body: string;
-    font_header: string;
-    logo_url: string;
-    logo_dark_url: string;
-    logo_width: number;
-    logo_height: number;
-    header_size: string;
+    fontBody: string;
+    fontHeader: string;
+    logoUrl: string;
+    logoDarkUrl: string;
+    logoWidth: number;
+    logoHeight: number;
+    headerSize: string;
     layout: string;
     radius: string;
-    color_scheme: "toggle" | "light" | "dark";
+    colorScheme: "toggle" | "light" | "dark";
     light: ThemeColors;
     dark: ThemeColors;
-    css_overrides: string | null;
+    cssOverrides: string | null;
 };
 type Portal = {
-    color_scheme?: 'toggle' | 'light' | 'dark';
+    colorScheme?: 'toggle' | 'light' | 'dark';
     display: PortalDisplay;
     layout: PortalLayout;
     navigation: PortalNavigation;
@@ -115,21 +115,21 @@ type ThemeColors = {
     accent: string;
     background: string;
     foreground: string;
-    accent_foreground: string;
+    accentForeground: string;
     muted: string;
-    muted_foreground: string;
+    mutedForeground: string;
     border: string;
     ring: string;
     surface: string;
 };
 type ThemeConfig = {
     radius: string;
-    color_scheme: "toggle" | "light" | "dark";
+    colorScheme: "toggle" | "light" | "dark";
     light: ThemeColors;
     dark: ThemeColors;
 };
 type AccountAI = {
-    avatar_url: string;
+    avatarUrl: string;
     enabled: boolean;
     greeting: string;
     name: string;
@@ -141,7 +141,7 @@ type PersonaEnabled = {
     enabled: true;
     name: string;
     greeting: string;
-    conversation_starters: string[];
+    conversationStarters: string[];
 };
 type PersonaDisabled = {
     enabled: false;
@@ -149,33 +149,33 @@ type PersonaDisabled = {
 type Persona = PersonaEnabled | PersonaDisabled;
 type Account = {
     ai: AccountAI;
-    ai_search: AccountAISearch;
+    aiSearch: AccountAISearch;
     name: string;
     persona: Persona;
     slug: string;
 };
 type Settings = {
-    featured_playlists: Playlist[];
-    menu_items: MenuItem[];
-    ai_avatar: string;
-    ai_name: string;
-    ai_greeting?: string;
-    has_ai: boolean;
+    featuredPlaylists: Playlist[];
+    menuItems: MenuItem[];
+    aiAvatar: string;
+    aiName: string;
+    aiGreeting?: string;
+    hasAi: boolean;
     account: Account;
-    favicon_url?: string;
-    logo_dark_url?: string;
-    logo_url?: string;
-    meta_data: {
-        channel_name: string;
+    faviconUrl?: string;
+    logoDarkUrl?: string;
+    logoUrl?: string;
+    metaData: {
+        channelName: string;
         description: string;
         image: string | null;
-        no_seo: boolean;
-        social_graph_image_url?: string;
+        noSeo: boolean;
+        socialGraphImageUrl?: string;
         title: string;
-        title_suffix: string;
+        titleSuffix: string;
     };
     portal: Portal;
-    theme_config: ThemeConfig;
+    themeConfig: ThemeConfig;
     version: string;
 };
 /**
@@ -183,29 +183,28 @@ type Settings = {
  */
 interface Source {
     id: string;
-    video_id: string;
+    videoId: string;
     title: string;
     text: string;
     timestamp: number;
-    timestamp_end: number;
-    playback_id: string;
+    timestampEnd: number;
+    playbackId: string;
     speaker?: string;
 }
 /**
  * Token usage statistics
  */
 interface AIUsage {
-    input_tokens: number;
-    output_tokens: number;
+    inputTokens: number;
+    outputTokens: number;
 }
 /**
  * SSE event types for AI streaming responses
  */
 type AIEvent = {
     type: "message_start";
-    id: string;
-    conversation_id?: string;
-    video_id?: string;
+    conversationId?: string;
+    videoId?: string;
 } | {
     type: "sources";
     sources: Source[];
@@ -221,8 +220,7 @@ type AIEvent = {
     recommendations: Recommendation[];
 } | {
     type: "message_complete";
-    id: string;
-    conversation_id?: string;
+    conversationId?: string;
     content: string;
     sources: Source[];
     usage?: AIUsage;
@@ -236,10 +234,13 @@ type AIEvent = {
     retryable: boolean;
 };
 /**
- * Non-streaming AI response
+ * Non-streaming AI response for /ai/chat, /ai/videos/:id/chat, and /ai/search
  */
 interface AIResponse {
-    id: string;
+    conversationId?: string;
+    videoId?: string;
+    /** @deprecated Use conversationId instead. Will be removed in v2. */
+    id?: string;
     content: string;
     sources: Source[];
     usage: AIUsage;
@@ -295,9 +296,9 @@ interface SearchOptions {
  * A recommended video with relevance score
  */
 interface RecommendationVideo {
-    video_id: string;
+    videoId: string;
     title: string;
-    playback_id: string;
+    playbackId: string;
     relevance: number;
     reason: string;
 }
@@ -328,7 +329,6 @@ type RecommendOptions = RecommendationsOptions;
  * Non-streaming response for recommendations endpoint
  */
 interface RecommendationsResponse {
-    id: string;
     recommendations: Recommendation[];
     guidance: string;
     sources: Source[];

package/dist/index.js

@@ -1,6 +1,24 @@
 // src/lib/client.ts
 import axios from "axios";
 
+// src/util/camelize.ts
+var isPlainObject = (value) => value !== null && typeof value === "object" && (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
+var snakeToCamel = (key) => key.replace(/_([a-z0-9])/g, (_, c) => c.toUpperCase());
+function camelizeKeys(input) {
+  if (Array.isArray(input)) {
+    return input.map((item) => camelizeKeys(item));
+  }
+  if (!isPlainObject(input)) {
+    return input;
+  }
+  const out = {};
+  for (const [rawKey, value] of Object.entries(input)) {
+    const key = snakeToCamel(rawKey);
+    out[key] = camelizeKeys(value);
+  }
+  return out;
+}
+
 // src/lib/fetchers.ts
 async function get(client, url) {
   try {
@@ -8,7 +26,7 @@ async function get(client, url) {
     if (res.status !== 200) {
       throw new Error(`Unexpected response status: ${res.status}`);
     }
-    return res.data;
+    return camelizeKeys(res.data);
   } catch (error) {
     console.error(`Error fetching data from URL: ${url}`, error);
     throw error;
@@ -210,7 +228,8 @@ async function* parseSSE(response) {
         if (!json)
           continue;
         try {
-          const event = JSON.parse(json);
+          const raw = JSON.parse(json);
+          const event = camelizeKeys(raw);
           yield event;
           if (event.type === "message_complete" || event.type === "error") {
             await reader.cancel();
@@ -260,7 +279,8 @@ async function jsonRequest(path, body, config) {
   if (!response.ok) {
     throw new Error(`AI request failed: ${response.status} ${response.statusText}`);
   }
-  return response.json();
+  const raw = await response.json();
+  return camelizeKeys(raw);
 }
 function createAI(config) {
   async function chat(options) {

package/llms.txt

@@ -110,6 +110,8 @@ Key types exported:
 - `ChatOptions`, `SearchOptions`
 - `RecommendationsOptions`, `RecommendationsResponse`, `Recommendation`, `RecommendationVideo`
 
+All response types use camelCase (e.g., `video.playbackId`, `video.publishedAt`, `settings.featuredPlaylists`, `source.videoId`).
+
 ## Links
 
 - [GitHub](https://github.com/boldvideo/bold-js)

package/package.json

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