@boldvideo/bold-js 0.6.0 → 0.7.0

package/CONTRIBUTING.md

@@ -1,103 +0,0 @@
-# Contributing to @boldvideo/bold-js
-
-First off, thank you for considering contributing to Bold JS! It's people like you that make Bold JS such a great tool.
-
-## Code of Conduct
-
-By participating in this project, you are expected to uphold our Code of Conduct:
-- Be respectful and inclusive
-- Welcome newcomers and help them get started
-- Focus on what is best for the community
-- Show empathy towards other community members
-
-## How Can I Contribute?
-
-### Reporting Bugs
-
-Before creating bug reports, please check existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
-
-- Use a clear and descriptive title
-- Describe the exact steps to reproduce the problem
-- Provide specific examples to demonstrate the steps
-- Describe the behavior you observed and what behavior you expected
-- Include your environment details (Node.js version, OS, etc.)
-
-### Suggesting Enhancements
-
-Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:
-
-- Use a clear and descriptive title
-- Provide a step-by-step description of the suggested enhancement
-- Provide specific examples to demonstrate the use case
-- Explain why this enhancement would be useful to most users
-
-### Pull Requests
-
-1. Fork the repo and create your branch from `main`
-2. If you've added code that should be tested, add tests
-3. Ensure the test suite passes (`pnpm run lint && pnpm run build`)
-4. Make sure your code follows the existing code style
-5. Create a changeset for your changes:
-   ```bash
-   pnpm changeset
-   ```
-6. Push your branch and submit a pull request
-
-## Development Setup
-
-1. Fork and clone the repo:
-   ```bash
-   git clone https://github.com/YOUR_USERNAME/bold-js.git
-   cd bold-js
-   ```
-
-2. Install dependencies:
-   ```bash
-   pnpm install
-   ```
-
-3. Make your changes and run the build:
-   ```bash
-   pnpm run build
-   pnpm run lint
-   ```
-
-## Changesets
-
-We use [changesets](https://github.com/changesets/changesets) to manage versions and changelogs. When you make a change:
-
-1. Run `pnpm changeset`
-2. Select the type of change (patch/minor/major)
-3. Describe your changes for the changelog
-4. Commit the generated changeset file along with your changes
-
-## Style Guide
-
-- Use TypeScript for all new code
-- Follow the existing code style (enforced by TypeScript compiler)
-- Write clear, self-documenting code
-- Add comments only when necessary to explain "why" not "what"
-- Keep functions small and focused
-- Use meaningful variable and function names
-
-## Commit Messages
-
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Limit the first line to 72 characters or less
-- Reference issues and pull requests liberally after the first line
-
-## Release Process (Maintainers Only)
-
-Releases are automated through GitHub Actions:
-
-1. When PRs with changesets are merged to main, a "Version Packages" PR is created
-2. Review and merge the version PR to trigger a release
-3. The workflow will automatically:
-   - Publish to npm
-   - Create a GitHub release
-   - Update the changelog
-
-## Questions?
-
-Feel free to open an issue with your question or reach out to the maintainers directly.

package/SECURITY.md

@@ -1,66 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-We release patches for security vulnerabilities for the following versions:
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 0.x.x   | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-If you discover a security vulnerability within Bold JS, please send an email to security@boldvideo.com. All security vulnerabilities will be promptly addressed.
-
-Please do not report security vulnerabilities through public GitHub issues.
-
-When reporting a vulnerability, please include:
-
-- The version of @boldvideo/bold-js you're using
-- A description of the vulnerability
-- Steps to reproduce the issue
-- Potential impact of the vulnerability
-- Any suggested fixes (if applicable)
-
-## Security Measures
-
-### NPM Publishing
-
-- Releases are automated through GitHub Actions
-- NPM tokens are stored as encrypted GitHub secrets
-- Only maintainers with write access can trigger releases
-- All releases include npm provenance for supply chain security
-
-### Dependencies
-
-- Dependencies are regularly updated via Dependabot
-- Security advisories are monitored through GitHub's security features
-- Minimal dependencies to reduce attack surface (only axios as runtime dependency)
-
-### Code Review
-
-- All changes require pull request reviews
-- CI checks must pass before merging
-- Type safety enforced through TypeScript
-
-## Best Practices for Users
-
-When using @boldvideo/bold-js:
-
-1. **Keep your API keys secure**
-   - Never commit API keys to version control
-   - Use environment variables for API keys
-   - Rotate keys regularly
-
-2. **Stay updated**
-   - Regularly update to the latest version
-   - Monitor security advisories
-   - Review the changelog for security updates
-
-3. **Validate input**
-   - Always validate and sanitize user input before passing to the SDK
-   - Be cautious with data from external sources
-
-## Acknowledgments
-
-We appreciate responsible disclosure of security vulnerabilities and will acknowledge researchers who report issues (with their permission).

package/src/index.ts

@@ -1,22 +0,0 @@
-export { createClient } from "lib/client";
-export type {
-  Video,
-  VideoAttachment,
-  VideoDownloadUrls,
-  VideoSubtitles,
-  VideoTranscript,
-  VideoMetadata,
-  Playlist,
-  MenuItem,
-  Settings,
-  Portal,
-  PortalDisplay,
-  PortalLayout,
-  PortalNavigation,
-  PortalTheme,
-  AssistantConfig,
-  ThemeConfig,
-  ThemeColors,
-  Account,
-  AccountAI,
-} from "./lib/types";

package/src/lib/client.ts

@@ -1,53 +0,0 @@
-import axios, { AxiosInstance } from "axios";
-
-import { fetchVideo, fetchVideos, searchVideos, fetchSettings, fetchPlaylist, fetchPlaylists } from './fetchers'
-import { trackEvent, trackPageView } from './tracking'
-
-type ClientOptions = {
-  baseURL?: string
-  debug: boolean
-}
-
-function createClient(apiKey: string, options: ClientOptions = {debug: false}) {
-  if (!apiKey || typeof apiKey !== 'string') {
-    throw new Error('API key is missing or invalid');
-  }
-
-  const { debug } = options;
-  const apiClientOptions = {
-    baseURL: options.baseURL ?? "https://app.boldvideo.io/api/v1/",
-    headers: {
-      Authorization: apiKey,
-    },
-  };
-
-  let apiClient: AxiosInstance;
-
-  try {
-    apiClient = axios.create(apiClientOptions);
-  } catch (error) {
-    console.error("Error creating API client", error);
-    throw error;
-  }
-
-  const userId = [...Array(30)]
-    .map(() => Math.random().toString(36)[2])
-    .join("");
-
-  return {
-    settings: fetchSettings(apiClient),
-    videos: {
-      list: fetchVideos(apiClient),
-      get: fetchVideo(apiClient),
-      search: searchVideos(apiClient),
-    },
-    playlists: {
-      list: fetchPlaylists(apiClient),
-      get: fetchPlaylist(apiClient),
-    },
-    trackEvent: trackEvent(apiClient, userId, { debug }),
-    trackPageView: trackPageView(apiClient, userId, { debug }),
-  };
-}
-
-export { createClient };

package/src/lib/fetchers.ts

@@ -1,96 +0,0 @@
-import { Video, Playlist, Settings } from "./types";
-import { AxiosInstance } from "axios";
-
-type Response<T> = {
-  data: T;
-};
-
-type ApiClient = AxiosInstance;
-
-async function get<TResponse>(
-  client: ApiClient,
-  url: string
-): Promise<TResponse> {
-  try {
-    const res = await client.get(url);
-    if (res.status !== 200) {
-      throw new Error(`Unexpected response status: ${res.status}`);
-    }
-    return res.data as TResponse;
-  } catch (error) {
-    console.error(`Error fetching data from URL: ${url}`, error);
-    throw error;
-  }
-}
-
-export function fetchSettings(client: ApiClient) {
-  return async (videoLimit = 12) => {
-    try {
-      return await get<Response<Settings>>(
-        client,
-        `settings?limit=${videoLimit}`
-      );
-    } catch (error) {
-      console.error(`Error fetching settings with limit: ${videoLimit}`, error);
-      throw error;
-    }
-  };
-}
-
-export function fetchVideos(client: ApiClient) {
-  return async (videoLimit = 12) => {
-    try {
-      return await get<Response<Video[]>>(
-        client,
-        `videos/latest?limit=${videoLimit}`
-      );
-    } catch (error) {
-      console.error(`Error fetching videos with limit: ${videoLimit}`, error);
-      throw error;
-    }
-  };
-}
-
-export function searchVideos(client: ApiClient) {
-  return async (term: string) => {
-    try {
-      return await get<Response<Video[]>>(client, `videos?query=${term}`);
-    } catch (error) {
-      console.error(`Error searching for videos with term: ${term}`, error);
-      throw error;
-    }
-  };
-}
-
-export function fetchVideo(client: ApiClient) {
-  return async (id: string) => {
-    try {
-      return await get<Response<Video>>(client, `videos/${id}`);
-    } catch (error) {
-      console.error(`Error fetching video with ID: ${id}`, error);
-      throw error;
-    }
-  };
-}
-
-export function fetchPlaylists(client: ApiClient) {
-  return async () => {
-    try {
-      return await get<Response<Playlist[]>>(client, "playlists");
-    } catch (error) {
-      console.error("Error fetching playlists", error);
-      throw error;
-    }
-  };
-}
-
-export function fetchPlaylist(client: ApiClient) {
-  return async (id: string) => {
-    try {
-      return await get<Response<Playlist>>(client, `playlists/${id}`);
-    } catch (error) {
-      console.error(`Error fetching playlist with ID: ${id}`, error);
-      throw error;
-    }
-  };
-}

package/src/lib/tracking.ts

@@ -1,117 +0,0 @@
-import { AxiosInstance } from "axios";
-import { throttle } from "util/throttle";
-
-type ApiClient = AxiosInstance;
-
-type Options = {
-  debug: boolean;
-};
-
-type EventData = {
-  url: string;
-  userId: string;
-  domain: string;
-  userAgent: string;
-  deviceWidth: number;
-  videoId?: string;
-  title: string;
-  videoDuration?: number;
-  currentTime?: number;
-};
-
-function sendEvent(
-  client: ApiClient,
-  eventName: string,
-  data: EventData,
-  debug: boolean
-) {
-  const payload = {
-    n: eventName,
-    u: data.url,
-    usr: data.userId,
-    d: data.domain,
-    ua: data.userAgent,
-    w: data.deviceWidth,
-    vid: data?.videoId || undefined,
-    vt: data.title,
-    vdur: data?.videoDuration || undefined,
-    time: data?.currentTime || undefined,
-  };
-
-  if (debug) console.log(`Bold SDK - Logging event '${eventName}'`, payload);
-
-  client.post("/event", payload);
-}
-
-const [throttledSendEvent] = throttle(sendEvent, 5000);
-
-export function trackEvent(
-  client: ApiClient,
-  userId: string,
-  options: Options
-) {
-  // TODO: verify event
-  return (video: any, event: Event) => {
-    const eventDetails = {
-      ...basicInfos(),
-      userId,
-      videoId: video.id,
-      title: video.title,
-      videoDuration: video.duration,
-      currentTime: (event.target as HTMLMediaElement)?.currentTime || 0,
-    };
-    // debounce fast hitting timeupdate event
-    if (event.type == "timeupdate" || event.type == "time-update") {
-      throttledSendEvent(
-        client,
-        getEventName(event),
-        eventDetails,
-        options.debug
-      );
-    } else {
-      sendEvent(client, getEventName(event), eventDetails, options.debug);
-    }
-  };
-}
-
-export function trackPageView(
-  client: ApiClient,
-  userId: string,
-  options: Options
-) {
-  return (title: string) => {
-    const eventDetails = {
-      ...basicInfos(),
-      userId,
-      title,
-    };
-    sendEvent(client, "page_view", eventDetails, options.debug);
-  };
-}
-
-function getEventName(event: { type: string }) {
-  switch (event.type) {
-    case "pause":
-      return "video_pause";
-    case "play":
-      return "video_resume";
-    case "loadedmetadata":
-    case "loaded-metadata":
-      return "video_load";
-    case "time-update":
-    case "timeupdate":
-      return "video_progress";
-    default:
-      return "unknown_event";
-  }
-}
-
-function basicInfos() {
-  return {
-    url: location.href,
-    domain: location.hostname,
-    referrer: document.referrer || null,
-    deviceWidth: window.innerWidth,
-    userAgent: navigator.userAgent,
-  };
-}

package/src/lib/types.ts

@@ -1,217 +0,0 @@
-export type VideoAttachment = {
-  id: string;
-  title: string;
-  file_url: string;
-  file_size?: number;
-  file_type?: string;
-};
-
-export type VideoDownloadUrls = {
-  mp4?: string;
-  audio?: string;
-  legacy_mp4?: string;
-};
-
-export type VideoSubtitles = {
-  label: string;
-  url: string;
-  engine?: string;
-  language: string;
-};
-
-export type VideoTranscript = {
-  text: string;
-  json: any;
-};
-
-export type VideoMetadata = {
-  description: string;
-  title: string;
-  image: string | null;
-};
-
-export type Video = {
-  // Existing fields (kept as-is)
-  captions: string;
-  captions_label: string;
-  captions_lang: 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;
-  teaser: string | null;
-  thumbnail: string;
-  title: string;
-  type: string;
-
-  // Fixed: meta_data should be an object, not array
-  meta_data: VideoMetadata;
-
-  // New: Chapters in WEBVTT format
-  chapters?: string;
-
-  // New: Attachments array
-  attachments?: VideoAttachment[];
-
-  // New: Call-to-action (can be null)
-  cta?: any | null;
-
-  // New: Download URLs object
-  download_urls?: VideoDownloadUrls;
-
-  // New: Internal ID
-  internal_id?: string;
-
-  // New: Playback speed
-  playback_speed?: number;
-
-  // New: Subtitles object
-  subtitles?: VideoSubtitles;
-
-  // New: Tags array
-  tags?: string[];
-
-  // New: Transcript object (replaces transcription)
-  transcript?: VideoTranscript;
-};
-
-export type Playlist = {
-  description?: string;
-  id: string;
-  is_private: boolean;
-  title: string;
-  type: string;
-  videos: Video[];
-};
-
-export type MenuItem = {
-  icon: string;
-  is_ext: boolean;
-  label: string;
-  url: string;
-};
-
-export type PortalDisplay = {
-  show_chapters: boolean;
-  show_transcripts: boolean;
-};
-
-export type AssistantConfig = {
-  headline: string;
-  subheadline: string;
-  suggestions: string[];
-};
-
-export type PortalLayout = {
-  assistant_config: AssistantConfig | null;
-  show_playlists: boolean;
-  type: string;
-  videos_limit: number;
-};
-
-export type PortalNavigation = {
-  show_ai_search: boolean;
-  show_header: boolean;
-  show_search: boolean;
-};
-
-export type PortalTheme = {
-  background: string;
-  font_body: string;
-  font_header: string;
-  foreground: string;
-  logo_height: number;
-  logo_url: string;
-  logo_width: number;
-  primary: string;
-};
-
-export type Portal = {
-  display: PortalDisplay;
-  layout: PortalLayout;
-  navigation: PortalNavigation;
-  theme: PortalTheme;
-};
-
-export type ThemeColors = {
-  background: string;
-  border: string;
-  card: string;
-  "card-foreground": string;
-  destructive: string;
-  "destructive-foreground": string;
-  foreground: string;
-  input: string;
-  muted: string;
-  "muted-foreground": string;
-  popover: string;
-  "popover-foreground": string;
-  primary: string;
-  "primary-foreground": string;
-  ring: string;
-  secondary: string;
-  "secondary-foreground": string;
-};
-
-export type ThemeConfig = {
-  dark: ThemeColors;
-  light: ThemeColors;
-  radius: string;
-};
-
-export type AccountAI = {
-  avatar_url: string;
-  enabled: boolean;
-  greeting: string;
-  name: string;
-};
-
-export type Account = {
-  ai: AccountAI;
-  name: string;
-  slug: string;
-};
-
-export type Settings = {
-  // Existing top-level arrays
-  featured_playlists: Playlist[];
-  menu_items: MenuItem[];
-
-  // Existing flat AI fields (kept for backward compatibility)
-  ai_avatar: string;
-  ai_name: string;
-  ai_greeting?: string;
-  has_ai: boolean;
-
-  // New: Account object with nested AI config
-  account: Account;
-
-  // New: Top-level URL fields
-  favicon_url?: string;
-  logo_dark_url?: string;
-  logo_url?: string;
-
-  // Updated: meta_data with additional fields
-  meta_data: {
-    channel_name: string;
-    description: string;
-    image: string | null;
-    no_seo: boolean;
-    social_graph_image_url?: string;
-    title: string;
-    title_suffix: string;
-  };
-
-  // New: Portal object with all nested structures
-  portal: Portal;
-
-  // New: Theme configuration
-  theme_config: ThemeConfig;
-
-  // New: API version
-  version: string;
-};

package/src/util/throttle.ts

@@ -1,29 +0,0 @@
-export const throttle = <R, A extends any[]>(
-  fn: (...args: A) => R,
-  delay: number
-): [(...args: A) => R | undefined, () => void] => {
-  let wait = false;
-  let timeout: undefined | number;
-  let cancelled = false;
-
-  return [
-    (...args: A) => {
-      if (cancelled) return undefined;
-      if (wait) return undefined;
-
-      const val = fn(...args);
-
-      wait = true;
-
-      timeout = window.setTimeout(() => {
-        wait = false;
-      }, delay);
-
-      return val;
-    },
-    () => {
-      cancelled = true;
-      clearTimeout(timeout);
-    },
-  ];
-};