@mux/ai 0.12.1 → 0.13.0

package/README.md

@@ -5,7 +5,7 @@
 
 Easy to use, purpose-driven, cost effective, configurable **_workflow functions_** in a TypeScript SDK for building AI-powered video and audio workflows on the server, powered by [Mux](https://www.mux.com), with support for popular AI/LLM providers (OpenAI, Anthropic, Google).
 
-- **Examples:** [`getSummaryAndTags`](#video-summarization), [`getModerationScores`](#content-moderation), [`hasBurnedInCaptions`](#burned-in-caption-detection), [`generateChapters`](#chapter-generation), [`generateEmbeddings`](#search-with-embeddings), [`translateCaptions`](#caption-translation), [`editCaptions`](#caption-editing), [`translateAudio`](#audio-dubbing)
+- **Examples:** [`getSummaryAndTags`](#video-summarization), [`getModerationScores`](#content-moderation), [`hasBurnedInCaptions`](#burned-in-caption-detection), [`generateChapters`](#chapter-generation), [`generateEmbeddings`](#search-with-embeddings), [`generateEngagementInsights`](#engagement-insights), [`translateCaptions`](#caption-translation), [`editCaptions`](#caption-editing), [`translateAudio`](#audio-dubbing)
 - Workflows automatically ship with `"use workflow"` [compatability with Workflow DevKit](#compatability-with-workflow-devkit)
 
 Turn your Mux video and audio assets into structured, actionable data — summaries, chapters, moderation scores, translations, embeddings, and more — with a single function call. `@mux/ai` handles fetching media data from Mux, formatting it for AI providers, and returning typed results so you can focus on building your product instead of wrangling prompts and media pipelines.

package/dist/{index-B6IY5dhq.d.ts → index-BeX_4DL7.d.ts}

@@ -2,7 +2,7 @@ import { z } from 'zod';
 import { createAnthropic } from '@ai-sdk/anthropic';
 import { createGoogleGenerativeAI } from '@ai-sdk/google';
 import { createOpenAI } from '@ai-sdk/openai';
-import { M as MuxAIOptions, I as ImageSubmissionMode, h as TokenUsage, b as ChunkingStrategy, j as VideoEmbeddingsResult, i as ToneType, f as StorageAdapter } from './types-BRbaGW3t.js';
+import { M as MuxAIOptions, I as ImageSubmissionMode, h as TokenUsage, b as ChunkingStrategy, j as VideoEmbeddingsResult, H as Hotspot, t as Shot, i as ToneType, f as StorageAdapter } from './shots-BFYOfBgN.js';
 
 interface ImageDownloadOptions {
     /** Request timeout in milliseconds (default: 10000) */
@@ -492,6 +492,104 @@ declare function generateEmbeddings(assetId: string, options?: EmbeddingsOptions
  */
 declare function generateVideoEmbeddings(assetId: string, options?: EmbeddingsOptions): Promise<EmbeddingsResult>;
 
+/**
+ * Sections of the engagement insights user prompt that can be overridden.
+ */
+/** Configuration options for engagement insights workflow. */
+interface EngagementInsightsOptions extends MuxAIOptions {
+    /** AI provider to run (defaults to 'openai'). */
+    provider?: SupportedProvider;
+    /** Provider-specific chat model identifier. */
+    model?: ModelIdByProvider[SupportedProvider];
+    /**
+     * Number of engagement moments to analyze per direction (default: 5, max: 10).
+     * Note: actual moment count may be up to 2x this value since both peaks and valleys are fetched.
+     */
+    hotspotLimit?: number;
+    /** Timeframe for engagement data (default: '7:days') */
+    timeframe?: string;
+    /**
+     * Skip shots integration and use basic thumbnails instead (default: false).
+     * Recommended for latency-sensitive use cases.
+     */
+    skipShots?: boolean;
+}
+/** A single moment insight for a specific engagement hotspot */
+interface MomentInsight {
+    /** Start time in milliseconds */
+    startMs: number;
+    /** End time in milliseconds */
+    endMs: number;
+    /** Human-readable timestamp (e.g., "2:15") */
+    timestamp: string;
+    /** Normalized engagement score (0-1) */
+    engagementScore: number;
+    /** Primary insight explaining the engagement pattern */
+    insight: string;
+}
+/** Overall engagement analysis across the entire video */
+interface OverallInsight {
+    /** Summary of overall engagement patterns */
+    summary: string;
+    /** Key trends identified across the video */
+    trends: string[];
+}
+/** Transcript segment aligned with a hotspot */
+interface TranscriptSegment {
+    startMs: number;
+    endMs: number;
+    text: string;
+    timestamp: string;
+}
+/** Structured return payload for engagement insights workflow. */
+interface EngagementInsightsResult {
+    /** Asset ID passed into the workflow. */
+    assetId: string;
+    /** Per-moment insights for each hotspot */
+    momentInsights: MomentInsight[];
+    /** Overall engagement analysis */
+    overallInsight: OverallInsight;
+    /** Token usage from the AI provider (for efficiency/cost analysis). */
+    usage?: TokenUsage;
+}
+/**
+ * Extracts transcript segments that align with hotspot time ranges.
+ */
+declare function extractTranscriptSegmentsForHotspots(vttContent: string, hotspots: Hotspot[]): TranscriptSegment[];
+/**
+ * Maps each hotspot to its nearest shot image.
+ *
+ * Algorithm: for each hotspot, find all shots whose startTime falls within
+ * [hotspot.startMs/1000, hotspot.endMs/1000]. If any exist, pick the one
+ * closest to the midpoint. Otherwise, pick the shot with the nearest
+ * startTime to hotspot.startMs/1000.
+ */
+declare function mapShotsToHotspots(shots: Shot[], hotspots: Hotspot[]): string[];
+/**
+ * Generate engagement insights for a Mux video asset.
+ *
+ * This workflow analyzes viewer engagement patterns to explain why certain moments
+ * are engaging or disengaging. It combines hotspot data, heatmap statistics, visual
+ * frames (from shots or thumbnails), and transcript analysis to generate AI-powered insights.
+ *
+ * @param assetId - The Mux asset ID to analyze
+ * @param options - Configuration options for the workflow
+ * @returns Structured insights with moment-by-moment and overall analysis
+ *
+ * @example
+ * ```typescript
+ * const result = await generateEngagementInsights("abc123", {
+ *   insightType: 'both',
+ *   hotspotLimit: 5,
+ * });
+ *
+ * result.momentInsights.forEach(m => {
+ *   console.log(`${m.timestamp}: ${m.insight}`);
+ * });
+ * ```
+ */
+declare function generateEngagementInsights(assetId: string, options?: EngagementInsightsOptions): Promise<EngagementInsightsResult>;
+
 /** Per-thumbnail moderation result returned from `getModerationScores`. */
 interface ThumbnailModerationScore {
     url: string;
@@ -919,6 +1017,8 @@ type index_EditCaptionsOptions<P extends SupportedProvider = SupportedProvider>
 type index_EditCaptionsResult = EditCaptionsResult;
 type index_EmbeddingsOptions = EmbeddingsOptions;
 type index_EmbeddingsResult = EmbeddingsResult;
+type index_EngagementInsightsOptions = EngagementInsightsOptions;
+type index_EngagementInsightsResult = EngagementInsightsResult;
 declare const index_HIVE_SEXUAL_CATEGORIES: typeof HIVE_SEXUAL_CATEGORIES;
 declare const index_HIVE_VIOLENCE_CATEGORIES: typeof HIVE_VIOLENCE_CATEGORIES;
 type index_HiveModerationOutput = HiveModerationOutput;
@@ -926,6 +1026,8 @@ type index_HiveModerationSource = HiveModerationSource;
 type index_ModerationOptions = ModerationOptions;
 type index_ModerationProvider = ModerationProvider;
 type index_ModerationResult = ModerationResult;
+type index_MomentInsight = MomentInsight;
+type index_OverallInsight = OverallInsight;
 type index_ProfanityDetectionPayload = ProfanityDetectionPayload;
 type index_Question = Question;
 type index_QuestionAnswer = QuestionAnswer;
@@ -952,12 +1054,15 @@ declare const index_chapterSchema: typeof chapterSchema;
 declare const index_chaptersSchema: typeof chaptersSchema;
 declare const index_createReplacer: typeof createReplacer;
 declare const index_editCaptions: typeof editCaptions;
+declare const index_extractTranscriptSegmentsForHotspots: typeof extractTranscriptSegmentsForHotspots;
 declare const index_generateChapters: typeof generateChapters;
 declare const index_generateEmbeddings: typeof generateEmbeddings;
+declare const index_generateEngagementInsights: typeof generateEngagementInsights;
 declare const index_generateVideoEmbeddings: typeof generateVideoEmbeddings;
 declare const index_getModerationScores: typeof getModerationScores;
 declare const index_getSummaryAndTags: typeof getSummaryAndTags;
 declare const index_hasBurnedInCaptions: typeof hasBurnedInCaptions;
+declare const index_mapShotsToHotspots: typeof mapShotsToHotspots;
 declare const index_profanityDetectionSchema: typeof profanityDetectionSchema;
 declare const index_questionAnswerSchema: typeof questionAnswerSchema;
 declare const index_shouldSplitChunkTranslationError: typeof shouldSplitChunkTranslationError;
@@ -967,7 +1072,7 @@ declare const index_translateAudio: typeof translateAudio;
 declare const index_translateCaptions: typeof translateCaptions;
 declare const index_translationSchema: typeof translationSchema;
 declare namespace index {
-  export { type index_AskQuestionsOptions as AskQuestionsOptions, type index_AskQuestionsResult as AskQuestionsResult, type index_AskQuestionsType as AskQuestionsType, type index_AudioTranslationOptions as AudioTranslationOptions, type index_AudioTranslationResult as AudioTranslationResult, type index_AutoCensorProfanityOptions as AutoCensorProfanityOptions, type index_BurnedInCaptionsAnalysis as BurnedInCaptionsAnalysis, type index_BurnedInCaptionsOptions as BurnedInCaptionsOptions, type index_BurnedInCaptionsPromptOverrides as BurnedInCaptionsPromptOverrides, type index_BurnedInCaptionsPromptSections as BurnedInCaptionsPromptSections, type index_BurnedInCaptionsResult as BurnedInCaptionsResult, type index_CaptionReplacement as CaptionReplacement, type index_CensorMode as CensorMode, type index_Chapter as Chapter, type index_ChapterSystemPromptSections as ChapterSystemPromptSections, type index_ChaptersOptions as ChaptersOptions, type index_ChaptersPromptOverrides as ChaptersPromptOverrides, type index_ChaptersPromptSections as ChaptersPromptSections, type index_ChaptersResult as ChaptersResult, type index_ChaptersType as ChaptersType, index_DEFAULT_DESCRIPTION_LENGTH as DEFAULT_DESCRIPTION_LENGTH, index_DEFAULT_SUMMARY_KEYWORD_LIMIT as DEFAULT_SUMMARY_KEYWORD_LIMIT, index_DEFAULT_TITLE_LENGTH as DEFAULT_TITLE_LENGTH, type index_EditCaptionsOptions as EditCaptionsOptions, type index_EditCaptionsResult as EditCaptionsResult, type index_EmbeddingsOptions as EmbeddingsOptions, type index_EmbeddingsResult as EmbeddingsResult, index_HIVE_SEXUAL_CATEGORIES as HIVE_SEXUAL_CATEGORIES, index_HIVE_VIOLENCE_CATEGORIES as HIVE_VIOLENCE_CATEGORIES, type index_HiveModerationOutput as HiveModerationOutput, type index_HiveModerationSource as HiveModerationSource, type index_ModerationOptions as ModerationOptions, type index_ModerationProvider as ModerationProvider, type index_ModerationResult as ModerationResult, type index_ProfanityDetectionPayload as ProfanityDetectionPayload, type index_Question as Question, type index_QuestionAnswer as QuestionAnswer, type index_QuestionAnswerType as QuestionAnswerType, type index_ReplacementRecord as ReplacementRecord, type index_SummarizationOptions as SummarizationOptions, type index_SummarizationPromptOverrides as SummarizationPromptOverrides, type index_SummarizationPromptSections as SummarizationPromptSections, type index_SummaryAndTagsResult as SummaryAndTagsResult, type index_SummaryType as SummaryType, type index_ThumbnailModerationScore as ThumbnailModerationScore, type index_TranslationChunkingOptions as TranslationChunkingOptions, type index_TranslationOptions as TranslationOptions, type index_TranslationPayload as TranslationPayload, type index_TranslationResult as TranslationResult, index_aggregateTokenUsage as aggregateTokenUsage, index_applyOverrideLists as applyOverrideLists, index_applyReplacements as applyReplacements, index_askQuestions as askQuestions, index_buildReplacementRegex as buildReplacementRegex, index_burnedInCaptionsSchema as burnedInCaptionsSchema, index_censorVttContent as censorVttContent, index_chapterSchema as chapterSchema, index_chaptersSchema as chaptersSchema, index_createReplacer as createReplacer, index_editCaptions as editCaptions, index_generateChapters as generateChapters, index_generateEmbeddings as generateEmbeddings, index_generateVideoEmbeddings as generateVideoEmbeddings, index_getModerationScores as getModerationScores, index_getSummaryAndTags as getSummaryAndTags, index_hasBurnedInCaptions as hasBurnedInCaptions, index_profanityDetectionSchema as profanityDetectionSchema, index_questionAnswerSchema as questionAnswerSchema, index_shouldSplitChunkTranslationError as shouldSplitChunkTranslationError, index_summarySchema as summarySchema, index_transformCueText as transformCueText, index_translateAudio as translateAudio, index_translateCaptions as translateCaptions, index_translationSchema as translationSchema };
+  export { type index_AskQuestionsOptions as AskQuestionsOptions, type index_AskQuestionsResult as AskQuestionsResult, type index_AskQuestionsType as AskQuestionsType, type index_AudioTranslationOptions as AudioTranslationOptions, type index_AudioTranslationResult as AudioTranslationResult, type index_AutoCensorProfanityOptions as AutoCensorProfanityOptions, type index_BurnedInCaptionsAnalysis as BurnedInCaptionsAnalysis, type index_BurnedInCaptionsOptions as BurnedInCaptionsOptions, type index_BurnedInCaptionsPromptOverrides as BurnedInCaptionsPromptOverrides, type index_BurnedInCaptionsPromptSections as BurnedInCaptionsPromptSections, type index_BurnedInCaptionsResult as BurnedInCaptionsResult, type index_CaptionReplacement as CaptionReplacement, type index_CensorMode as CensorMode, type index_Chapter as Chapter, type index_ChapterSystemPromptSections as ChapterSystemPromptSections, type index_ChaptersOptions as ChaptersOptions, type index_ChaptersPromptOverrides as ChaptersPromptOverrides, type index_ChaptersPromptSections as ChaptersPromptSections, type index_ChaptersResult as ChaptersResult, type index_ChaptersType as ChaptersType, index_DEFAULT_DESCRIPTION_LENGTH as DEFAULT_DESCRIPTION_LENGTH, index_DEFAULT_SUMMARY_KEYWORD_LIMIT as DEFAULT_SUMMARY_KEYWORD_LIMIT, index_DEFAULT_TITLE_LENGTH as DEFAULT_TITLE_LENGTH, type index_EditCaptionsOptions as EditCaptionsOptions, type index_EditCaptionsResult as EditCaptionsResult, type index_EmbeddingsOptions as EmbeddingsOptions, type index_EmbeddingsResult as EmbeddingsResult, type index_EngagementInsightsOptions as EngagementInsightsOptions, type index_EngagementInsightsResult as EngagementInsightsResult, index_HIVE_SEXUAL_CATEGORIES as HIVE_SEXUAL_CATEGORIES, index_HIVE_VIOLENCE_CATEGORIES as HIVE_VIOLENCE_CATEGORIES, type index_HiveModerationOutput as HiveModerationOutput, type index_HiveModerationSource as HiveModerationSource, type index_ModerationOptions as ModerationOptions, type index_ModerationProvider as ModerationProvider, type index_ModerationResult as ModerationResult, type index_MomentInsight as MomentInsight, type index_OverallInsight as OverallInsight, type index_ProfanityDetectionPayload as ProfanityDetectionPayload, type index_Question as Question, type index_QuestionAnswer as QuestionAnswer, type index_QuestionAnswerType as QuestionAnswerType, type index_ReplacementRecord as ReplacementRecord, type index_SummarizationOptions as SummarizationOptions, type index_SummarizationPromptOverrides as SummarizationPromptOverrides, type index_SummarizationPromptSections as SummarizationPromptSections, type index_SummaryAndTagsResult as SummaryAndTagsResult, type index_SummaryType as SummaryType, type index_ThumbnailModerationScore as ThumbnailModerationScore, type index_TranslationChunkingOptions as TranslationChunkingOptions, type index_TranslationOptions as TranslationOptions, type index_TranslationPayload as TranslationPayload, type index_TranslationResult as TranslationResult, index_aggregateTokenUsage as aggregateTokenUsage, index_applyOverrideLists as applyOverrideLists, index_applyReplacements as applyReplacements, index_askQuestions as askQuestions, index_buildReplacementRegex as buildReplacementRegex, index_burnedInCaptionsSchema as burnedInCaptionsSchema, index_censorVttContent as censorVttContent, index_chapterSchema as chapterSchema, index_chaptersSchema as chaptersSchema, index_createReplacer as createReplacer, index_editCaptions as editCaptions, index_extractTranscriptSegmentsForHotspots as extractTranscriptSegmentsForHotspots, index_generateChapters as generateChapters, index_generateEmbeddings as generateEmbeddings, index_generateEngagementInsights as generateEngagementInsights, index_generateVideoEmbeddings as generateVideoEmbeddings, index_getModerationScores as getModerationScores, index_getSummaryAndTags as getSummaryAndTags, index_hasBurnedInCaptions as hasBurnedInCaptions, index_mapShotsToHotspots as mapShotsToHotspots, index_profanityDetectionSchema as profanityDetectionSchema, index_questionAnswerSchema as questionAnswerSchema, index_shouldSplitChunkTranslationError as shouldSplitChunkTranslationError, index_summarySchema as summarySchema, index_transformCueText as transformCueText, index_translateAudio as translateAudio, index_translateCaptions as translateCaptions, index_translationSchema as translationSchema };
 }
 
-export { askQuestions as $, type AskQuestionsOptions as A, type BurnedInCaptionsAnalysis as B, type CaptionReplacement as C, DEFAULT_DESCRIPTION_LENGTH as D, type EditCaptionsOptions as E, type ModerationProvider as F, type ModerationResult as G, HIVE_SEXUAL_CATEGORIES as H, type QuestionAnswer as I, type QuestionAnswerType as J, type SummarizationPromptOverrides as K, type SummarizationPromptSections as L, type ModerationOptions as M, type SummaryAndTagsResult as N, type SummaryType as O, type ProfanityDetectionPayload as P, type Question as Q, type ReplacementRecord as R, type SummarizationOptions as S, type ThumbnailModerationScore as T, type TranslationChunkingOptions as U, type TranslationOptions as V, type TranslationPayload as W, type TranslationResult as X, aggregateTokenUsage as Y, applyOverrideLists as Z, applyReplacements as _, type AskQuestionsResult as a, buildReplacementRegex as a0, burnedInCaptionsSchema as a1, censorVttContent as a2, chapterSchema as a3, chaptersSchema as a4, createReplacer as a5, editCaptions as a6, generateChapters as a7, generateEmbeddings as a8, generateVideoEmbeddings as a9, getModerationScores as aa, getSummaryAndTags as ab, hasBurnedInCaptions as ac, profanityDetectionSchema as ad, questionAnswerSchema as ae, shouldSplitChunkTranslationError as af, summarySchema as ag, transformCueText as ah, translateAudio as ai, translateCaptions as aj, translationSchema as ak, type AskQuestionsType as b, type AudioTranslationOptions as c, type AudioTranslationResult as d, type AutoCensorProfanityOptions as e, type BurnedInCaptionsOptions as f, type BurnedInCaptionsPromptOverrides as g, type BurnedInCaptionsPromptSections as h, index as i, type BurnedInCaptionsResult as j, type CensorMode as k, type Chapter as l, type ChapterSystemPromptSections as m, type ChaptersOptions as n, type ChaptersPromptOverrides as o, type ChaptersPromptSections as p, type ChaptersResult as q, type ChaptersType as r, DEFAULT_SUMMARY_KEYWORD_LIMIT as s, DEFAULT_TITLE_LENGTH as t, type EditCaptionsResult as u, type EmbeddingsOptions as v, type EmbeddingsResult as w, HIVE_VIOLENCE_CATEGORIES as x, type HiveModerationOutput as y, type HiveModerationSource as z };
+export { type TranslationResult as $, type AskQuestionsOptions as A, type BurnedInCaptionsAnalysis as B, type CaptionReplacement as C, DEFAULT_DESCRIPTION_LENGTH as D, type EditCaptionsOptions as E, type HiveModerationOutput as F, type HiveModerationSource as G, HIVE_SEXUAL_CATEGORIES as H, type ModerationProvider as I, type ModerationResult as J, type MomentInsight as K, type QuestionAnswer as L, type ModerationOptions as M, type QuestionAnswerType as N, type OverallInsight as O, type ProfanityDetectionPayload as P, type Question as Q, type ReplacementRecord as R, type SummarizationOptions as S, type SummarizationPromptOverrides as T, type SummarizationPromptSections as U, type SummaryAndTagsResult as V, type SummaryType as W, type ThumbnailModerationScore as X, type TranslationChunkingOptions as Y, type TranslationOptions as Z, type TranslationPayload as _, type AskQuestionsResult as a, aggregateTokenUsage as a0, applyOverrideLists as a1, applyReplacements as a2, askQuestions as a3, buildReplacementRegex as a4, burnedInCaptionsSchema as a5, censorVttContent as a6, chapterSchema as a7, chaptersSchema as a8, createReplacer as a9, editCaptions as aa, extractTranscriptSegmentsForHotspots as ab, generateChapters as ac, generateEmbeddings as ad, generateEngagementInsights as ae, generateVideoEmbeddings as af, getModerationScores as ag, getSummaryAndTags as ah, hasBurnedInCaptions as ai, mapShotsToHotspots as aj, profanityDetectionSchema as ak, questionAnswerSchema as al, shouldSplitChunkTranslationError as am, summarySchema as an, transformCueText as ao, translateAudio as ap, translateCaptions as aq, translationSchema as ar, type AskQuestionsType as b, type AudioTranslationOptions as c, type AudioTranslationResult as d, type AutoCensorProfanityOptions as e, type BurnedInCaptionsOptions as f, type BurnedInCaptionsPromptOverrides as g, type BurnedInCaptionsPromptSections as h, index as i, type BurnedInCaptionsResult as j, type CensorMode as k, type Chapter as l, type ChapterSystemPromptSections as m, type ChaptersOptions as n, type ChaptersPromptOverrides as o, type ChaptersPromptSections as p, type ChaptersResult as q, type ChaptersType as r, DEFAULT_SUMMARY_KEYWORD_LIMIT as s, DEFAULT_TITLE_LENGTH as t, type EditCaptionsResult as u, type EmbeddingsOptions as v, type EmbeddingsResult as w, type EngagementInsightsOptions as x, type EngagementInsightsResult as y, HIVE_VIOLENCE_CATEGORIES as z };

package/dist/{index-DLhfJsOd.d.ts → index-CuBu_u5-.d.ts}

@@ -1,7 +1,7 @@
-import { k as WorkflowCredentialsInput, A as AssetTextTrack, d as MuxAsset, T as TextChunk, b as ChunkingStrategy } from './types-BRbaGW3t.js';
+import { k as WorkflowCredentialsInput, A as AssetTextTrack, d as MuxAsset, T as TextChunk, b as ChunkingStrategy, o as CompletedShotsResult, p as ErroredShotsResult, H as Hotspot, q as HotspotOptions, r as HotspotResponse, s as PendingShotsResult, t as Shot, u as ShotRequestOptions, v as ShotsResult, w as WaitForShotsOptions, x as getHotspotsForAsset, y as getHotspotsForPlaybackId, z as getHotspotsForVideo, B as getShotsForAsset, D as requestShotsForAsset, F as waitForShotsForAsset } from './shots-BFYOfBgN.js';
 
 interface HeatmapOptions {
-    /** Time window for results, e.g., ['7:days'] (default: ['7:days']) */
+    /** Time window for results, e.g., '7:days' (default: '7:days') */
     timeframe?: string;
     /** Optional workflow credentials */
     credentials?: WorkflowCredentialsInput;
@@ -45,121 +45,6 @@ declare function getHeatmapForVideo(videoId: string, options?: HeatmapOptions):
  */
 declare function getHeatmapForPlaybackId(playbackId: string, options?: HeatmapOptions): Promise<HeatmapResponse>;
 
-interface Hotspot {
-    /** Inclusive start time in milliseconds */
-    startMs: number;
-    /** Exclusive end time in milliseconds */
-    endMs: number;
-    /** Hotspot score using distribution-based normalization (0-1) */
-    score: number;
-}
-interface HotspotOptions {
-    /** Maximum number of hotspots to return (default: 5) */
-    limit?: number;
-    /** Sort order: 'asc' or 'desc' (default: 'desc') */
-    orderDirection?: "asc" | "desc";
-    /** Order by field (default: 'score') */
-    orderBy?: "score";
-    /** Time window for results, e.g., ['7:days'] (default: ['7:days']) */
-    timeframe?: string;
-    /** Optional workflow credentials */
-    credentials?: WorkflowCredentialsInput;
-}
-interface HotspotResponse {
-    assetId?: string;
-    videoId?: string;
-    playbackId?: string;
-    hotspots: Hotspot[];
-}
-/**
- * Fetches engagement hotspots for a Mux asset.
- * Returns the top N "hot" time ranges based on engagement data.
- *
- * @param assetId - The Mux asset ID
- * @param options - Hotspot query options
- * @returns Array of hotspots with time ranges and scores
- */
-declare function getHotspotsForAsset(assetId: string, options?: HotspotOptions): Promise<Hotspot[]>;
-/**
- * Fetches engagement hotspots for a Mux video ID.
- * Returns the top N "hot" time ranges based on engagement data.
- *
- * @param videoId - The Mux video ID
- * @param options - Hotspot query options
- * @returns Array of hotspots with time ranges and scores
- */
-declare function getHotspotsForVideo(videoId: string, options?: HotspotOptions): Promise<Hotspot[]>;
-/**
- * Fetches engagement hotspots for a Mux playback ID.
- * Returns the top N "hot" time ranges based on engagement data.
- *
- * @param playbackId - The Mux playback ID
- * @param options - Hotspot query options
- * @returns Array of hotspots with time ranges and scores
- */
-declare function getHotspotsForPlaybackId(playbackId: string, options?: HotspotOptions): Promise<Hotspot[]>;
-
-interface Shot {
-    /** Start time of the shot in seconds from the beginning of the asset. */
-    startTime: number;
-    /** Signed URL for a representative image of the shot. */
-    imageUrl: string;
-}
-interface PendingShotsResult {
-    status: "pending";
-    createdAt: string;
-}
-interface ErroredShotsResult {
-    status: "errored";
-    createdAt: string;
-    error: {
-        type: string;
-        messages: string[];
-    };
-}
-interface CompletedShotsResult {
-    status: "completed";
-    createdAt: string;
-    shots: Shot[];
-}
-type ShotsResult = PendingShotsResult | ErroredShotsResult | CompletedShotsResult;
-interface ShotRequestOptions {
-    /** Optional workflow credentials */
-    credentials?: WorkflowCredentialsInput;
-}
-interface WaitForShotsOptions extends ShotRequestOptions {
-    /** Polling interval in milliseconds (default: 2000, minimum enforced: 1000) */
-    pollIntervalMs?: number;
-    /** Maximum number of polling attempts (default: 60) */
-    maxAttempts?: number;
-    /** When true, request shot generation before polling (default: true) */
-    createIfMissing?: boolean;
-}
-/**
- * Starts generating shots for an asset.
- *
- * @param assetId - The Mux asset ID
- * @param options - Request options
- * @returns Pending shot generation state
- */
-declare function requestShotsForAsset(assetId: string, options?: ShotRequestOptions): Promise<PendingShotsResult>;
-/**
- * Gets the current shot generation status for an asset.
- *
- * @param assetId - The Mux asset ID
- * @param options - Request options
- * @returns Pending, errored, or completed shot result
- */
-declare function getShotsForAsset(assetId: string, options?: ShotRequestOptions): Promise<ShotsResult>;
-/**
- * Requests shot generation if needed and polls until shots are completed.
- *
- * @param assetId - The Mux asset ID
- * @param options - Polling options
- * @returns Completed shot result
- */
-declare function waitForShotsForAsset(assetId: string, options?: WaitForShotsOptions): Promise<CompletedShotsResult>;
-
 declare const DEFAULT_STORYBOARD_WIDTH = 640;
 /**
  * Generates a storyboard URL for the given playback ID.
@@ -331,18 +216,18 @@ declare function getThumbnailUrls(playbackId: string, duration: number, options?
     time: number;
 }>>;
 
-type index_CompletedShotsResult = CompletedShotsResult;
+declare const index_CompletedShotsResult: typeof CompletedShotsResult;
 declare const index_DEFAULT_STORYBOARD_WIDTH: typeof DEFAULT_STORYBOARD_WIDTH;
-type index_ErroredShotsResult = ErroredShotsResult;
+declare const index_ErroredShotsResult: typeof ErroredShotsResult;
 type index_HeatmapOptions = HeatmapOptions;
 type index_HeatmapResponse = HeatmapResponse;
-type index_Hotspot = Hotspot;
-type index_HotspotOptions = HotspotOptions;
-type index_HotspotResponse = HotspotResponse;
-type index_PendingShotsResult = PendingShotsResult;
-type index_Shot = Shot;
-type index_ShotRequestOptions = ShotRequestOptions;
-type index_ShotsResult = ShotsResult;
+declare const index_Hotspot: typeof Hotspot;
+declare const index_HotspotOptions: typeof HotspotOptions;
+declare const index_HotspotResponse: typeof HotspotResponse;
+declare const index_PendingShotsResult: typeof PendingShotsResult;
+declare const index_Shot: typeof Shot;
+declare const index_ShotRequestOptions: typeof ShotRequestOptions;
+declare const index_ShotsResult: typeof ShotsResult;
 type index_ThumbnailOptions = ThumbnailOptions;
 type index_TranscriptFetchOptions = TranscriptFetchOptions;
 type index_TranscriptResult = TranscriptResult;
@@ -350,7 +235,7 @@ type index_VTTCue = VTTCue;
 type index_VTTCueBudgetChunkingOptions = VTTCueBudgetChunkingOptions;
 type index_VTTDurationChunk = VTTDurationChunk;
 type index_VTTDurationChunkingOptions = VTTDurationChunkingOptions;
-type index_WaitForShotsOptions = WaitForShotsOptions;
+declare const index_WaitForShotsOptions: typeof WaitForShotsOptions;
 declare const index_buildTranscriptUrl: typeof buildTranscriptUrl;
 declare const index_buildVttFromCueBlocks: typeof buildVttFromCueBlocks;
 declare const index_buildVttFromTranslatedCueBlocks: typeof buildVttFromTranslatedCueBlocks;
@@ -383,7 +268,7 @@ declare const index_splitVttPreambleAndCueBlocks: typeof splitVttPreambleAndCueB
 declare const index_vttTimestampToSeconds: typeof vttTimestampToSeconds;
 declare const index_waitForShotsForAsset: typeof waitForShotsForAsset;
 declare namespace index {
-  export { type index_CompletedShotsResult as CompletedShotsResult, index_DEFAULT_STORYBOARD_WIDTH as DEFAULT_STORYBOARD_WIDTH, type index_ErroredShotsResult as ErroredShotsResult, type index_HeatmapOptions as HeatmapOptions, type index_HeatmapResponse as HeatmapResponse, type index_Hotspot as Hotspot, type index_HotspotOptions as HotspotOptions, type index_HotspotResponse as HotspotResponse, type index_PendingShotsResult as PendingShotsResult, type index_Shot as Shot, type index_ShotRequestOptions as ShotRequestOptions, type index_ShotsResult as ShotsResult, type index_ThumbnailOptions as ThumbnailOptions, type index_TranscriptFetchOptions as TranscriptFetchOptions, type index_TranscriptResult as TranscriptResult, type index_VTTCue as VTTCue, type index_VTTCueBudgetChunkingOptions as VTTCueBudgetChunkingOptions, type index_VTTDurationChunk as VTTDurationChunk, type index_VTTDurationChunkingOptions as VTTDurationChunkingOptions, type index_WaitForShotsOptions as WaitForShotsOptions, index_buildTranscriptUrl as buildTranscriptUrl, index_buildVttFromCueBlocks as buildVttFromCueBlocks, index_buildVttFromTranslatedCueBlocks as buildVttFromTranslatedCueBlocks, index_chunkByTokens as chunkByTokens, index_chunkText as chunkText, index_chunkVTTCues as chunkVTTCues, index_chunkVTTCuesByBudget as chunkVTTCuesByBudget, index_chunkVTTCuesByDuration as chunkVTTCuesByDuration, index_concatenateVttSegments as concatenateVttSegments, index_estimateTokenCount as estimateTokenCount, index_extractTextFromVTT as extractTextFromVTT, index_extractTimestampedTranscript as extractTimestampedTranscript, index_fetchTranscriptForAsset as fetchTranscriptForAsset, index_findCaptionTrack as findCaptionTrack, index_getHeatmapForAsset as getHeatmapForAsset, index_getHeatmapForPlaybackId as getHeatmapForPlaybackId, index_getHeatmapForVideo as getHeatmapForVideo, index_getHotspotsForAsset as getHotspotsForAsset, index_getHotspotsForPlaybackId as getHotspotsForPlaybackId, index_getHotspotsForVideo as getHotspotsForVideo, index_getReadyTextTracks as getReadyTextTracks, index_getShotsForAsset as getShotsForAsset, index_getStoryboardUrl as getStoryboardUrl, index_getThumbnailUrls as getThumbnailUrls, index_parseVTTCues as parseVTTCues, index_replaceCueText as replaceCueText, index_requestShotsForAsset as requestShotsForAsset, index_secondsToTimestamp as secondsToTimestamp, index_splitVttPreambleAndCueBlocks as splitVttPreambleAndCueBlocks, index_vttTimestampToSeconds as vttTimestampToSeconds, index_waitForShotsForAsset as waitForShotsForAsset };
+  export { index_CompletedShotsResult as CompletedShotsResult, index_DEFAULT_STORYBOARD_WIDTH as DEFAULT_STORYBOARD_WIDTH, index_ErroredShotsResult as ErroredShotsResult, type index_HeatmapOptions as HeatmapOptions, type index_HeatmapResponse as HeatmapResponse, index_Hotspot as Hotspot, index_HotspotOptions as HotspotOptions, index_HotspotResponse as HotspotResponse, index_PendingShotsResult as PendingShotsResult, index_Shot as Shot, index_ShotRequestOptions as ShotRequestOptions, index_ShotsResult as ShotsResult, type index_ThumbnailOptions as ThumbnailOptions, type index_TranscriptFetchOptions as TranscriptFetchOptions, type index_TranscriptResult as TranscriptResult, type index_VTTCue as VTTCue, type index_VTTCueBudgetChunkingOptions as VTTCueBudgetChunkingOptions, type index_VTTDurationChunk as VTTDurationChunk, type index_VTTDurationChunkingOptions as VTTDurationChunkingOptions, index_WaitForShotsOptions as WaitForShotsOptions, index_buildTranscriptUrl as buildTranscriptUrl, index_buildVttFromCueBlocks as buildVttFromCueBlocks, index_buildVttFromTranslatedCueBlocks as buildVttFromTranslatedCueBlocks, index_chunkByTokens as chunkByTokens, index_chunkText as chunkText, index_chunkVTTCues as chunkVTTCues, index_chunkVTTCuesByBudget as chunkVTTCuesByBudget, index_chunkVTTCuesByDuration as chunkVTTCuesByDuration, index_concatenateVttSegments as concatenateVttSegments, index_estimateTokenCount as estimateTokenCount, index_extractTextFromVTT as extractTextFromVTT, index_extractTimestampedTranscript as extractTimestampedTranscript, index_fetchTranscriptForAsset as fetchTranscriptForAsset, index_findCaptionTrack as findCaptionTrack, index_getHeatmapForAsset as getHeatmapForAsset, index_getHeatmapForPlaybackId as getHeatmapForPlaybackId, index_getHeatmapForVideo as getHeatmapForVideo, index_getHotspotsForAsset as getHotspotsForAsset, index_getHotspotsForPlaybackId as getHotspotsForPlaybackId, index_getHotspotsForVideo as getHotspotsForVideo, index_getReadyTextTracks as getReadyTextTracks, index_getShotsForAsset as getShotsForAsset, index_getStoryboardUrl as getStoryboardUrl, index_getThumbnailUrls as getThumbnailUrls, index_parseVTTCues as parseVTTCues, index_replaceCueText as replaceCueText, index_requestShotsForAsset as requestShotsForAsset, index_secondsToTimestamp as secondsToTimestamp, index_splitVttPreambleAndCueBlocks as splitVttPreambleAndCueBlocks, index_vttTimestampToSeconds as vttTimestampToSeconds, index_waitForShotsForAsset as waitForShotsForAsset };
 }
 
-export { getHeatmapForAsset as A, getHeatmapForPlaybackId as B, type CompletedShotsResult as C, DEFAULT_STORYBOARD_WIDTH as D, type ErroredShotsResult as E, getHeatmapForVideo as F, getHotspotsForAsset as G, type HeatmapOptions as H, getHotspotsForPlaybackId as I, getHotspotsForVideo as J, getReadyTextTracks as K, getShotsForAsset as L, getStoryboardUrl as M, getThumbnailUrls as N, parseVTTCues as O, type PendingShotsResult as P, replaceCueText as Q, requestShotsForAsset as R, type Shot as S, type ThumbnailOptions as T, secondsToTimestamp as U, type VTTCue as V, type WaitForShotsOptions as W, splitVttPreambleAndCueBlocks as X, vttTimestampToSeconds as Y, waitForShotsForAsset as Z, type HeatmapResponse as a, type Hotspot as b, type HotspotOptions as c, type HotspotResponse as d, type ShotRequestOptions as e, type ShotsResult as f, type TranscriptFetchOptions as g, type TranscriptResult as h, index as i, type VTTCueBudgetChunkingOptions as j, type VTTDurationChunk as k, type VTTDurationChunkingOptions as l, buildTranscriptUrl as m, buildVttFromCueBlocks as n, buildVttFromTranslatedCueBlocks as o, chunkByTokens as p, chunkText as q, chunkVTTCues as r, chunkVTTCuesByBudget as s, chunkVTTCuesByDuration as t, concatenateVttSegments as u, estimateTokenCount as v, extractTextFromVTT as w, extractTimestampedTranscript as x, fetchTranscriptForAsset as y, findCaptionTrack as z };
+export { getThumbnailUrls as A, parseVTTCues as B, replaceCueText as C, DEFAULT_STORYBOARD_WIDTH as D, secondsToTimestamp as E, splitVttPreambleAndCueBlocks as F, vttTimestampToSeconds as G, type HeatmapOptions as H, type ThumbnailOptions as T, type VTTCue as V, type HeatmapResponse as a, type TranscriptFetchOptions as b, type TranscriptResult as c, type VTTCueBudgetChunkingOptions as d, type VTTDurationChunk as e, type VTTDurationChunkingOptions as f, buildTranscriptUrl as g, buildVttFromCueBlocks as h, index as i, buildVttFromTranslatedCueBlocks as j, chunkByTokens as k, chunkText as l, chunkVTTCues as m, chunkVTTCuesByBudget as n, chunkVTTCuesByDuration as o, concatenateVttSegments as p, estimateTokenCount as q, extractTextFromVTT as r, extractTimestampedTranscript as s, fetchTranscriptForAsset as t, findCaptionTrack as u, getHeatmapForAsset as v, getHeatmapForPlaybackId as w, getHeatmapForVideo as x, getReadyTextTracks as y, getStoryboardUrl as z };

package/dist/index.d.ts

@@ -1,15 +1,15 @@
-import { W as WorkflowCredentials, S as StoragePutObjectInput, a as StoragePresignGetObjectInput } from './types-BRbaGW3t.js';
-export { A as AssetTextTrack, C as ChunkEmbedding, b as ChunkingStrategy, E as Encrypted, c as EncryptedPayload, I as ImageSubmissionMode, M as MuxAIOptions, d as MuxAsset, P as PlaybackAsset, e as PlaybackPolicy, f as StorageAdapter, T as TextChunk, g as TokenChunkingConfig, h as TokenUsage, i as ToneType, U as UsageMetadata, V as VTTChunkingConfig, j as VideoEmbeddingsResult, k as WorkflowCredentialsInput, l as WorkflowMuxClient, m as decryptFromWorkflow, n as encryptForWorkflow } from './types-BRbaGW3t.js';
+import { W as WorkflowCredentials, S as StoragePutObjectInput, a as StoragePresignGetObjectInput } from './shots-BFYOfBgN.js';
+export { A as AssetTextTrack, C as ChunkEmbedding, b as ChunkingStrategy, E as Encrypted, c as EncryptedPayload, I as ImageSubmissionMode, M as MuxAIOptions, d as MuxAsset, P as PlaybackAsset, e as PlaybackPolicy, f as StorageAdapter, T as TextChunk, g as TokenChunkingConfig, h as TokenUsage, i as ToneType, U as UsageMetadata, V as VTTChunkingConfig, j as VideoEmbeddingsResult, k as WorkflowCredentialsInput, l as WorkflowMuxClient, m as decryptFromWorkflow, n as encryptForWorkflow } from './shots-BFYOfBgN.js';
 import { WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@workflow/serde';
-export { i as primitives } from './index-DLhfJsOd.js';
-export { i as workflows } from './index-B6IY5dhq.js';
+export { i as primitives } from './index-CuBu_u5-.js';
+export { i as workflows } from './index-BeX_4DL7.js';
 import '@mux/mux-node';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
 
-var version = "0.12.1";
+var version = "0.13.0";
 
 /**
  * A function that returns workflow credentials, either synchronously or asynchronously.