@mux/ai 0.28.1 → 0.29.0

package/dist/{index-bjQi1ZCj.d.ts → index-CXwsu679.d.ts}

@@ -1,4 +1,4 @@
-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-mGJfYGiO.js';
+import { l as WorkflowCredentialsInput, n as WorkflowScope, A as AssetTextTrack, d as MuxAsset, T as TextChunk, b as ChunkingStrategy, q as CompletedShotsResult, r as ErroredShotsResult, H as Hotspot, s as HotspotOptions, t as HotspotResponse, u as PendingShotsResult, v as Shot, w as ShotRequestOptions, x as ShotsResult, y as WaitForShotsOptions, z as getHotspotsForAsset, B as getHotspotsForPlaybackId, D as getHotspotsForVideo, F as getShotsForAsset, G as requestShotsForAsset, J as waitForShotsForAsset } from './shots-BKd7TMFN.js';
 
 interface HeatmapOptions {
     /** Time window for results, e.g., '7:days' (default: '7:days') */
@@ -53,9 +53,11 @@ declare const DEFAULT_STORYBOARD_WIDTH = 640;
  * @param playbackId - The Mux playback ID
  * @param width - Width of the storyboard in pixels (default: 640)
  * @param shouldSign - Flag for whether or not to use signed playback IDs (default: false)
+ * @param credentials - Optional workflow credentials used for signing
+ * @param scope - Optional asset-relative range for storyboard tiles
  * @returns Storyboard URL (signed if shouldSign is true)
  */
-declare function getStoryboardUrl(playbackId: string, width?: number, shouldSign?: boolean, credentials?: WorkflowCredentialsInput): Promise<string>;
+declare function getStoryboardUrl(playbackId: string, width?: number, shouldSign?: boolean, credentials?: WorkflowCredentialsInput, scope?: WorkflowScope): Promise<string>;
 
 /** A single cue from a VTT file with timing info. */
 interface VTTCue {
@@ -66,6 +68,8 @@ interface VTTCue {
 interface TranscriptFetchOptions {
     languageCode?: string;
     cleanTranscript?: boolean;
+    /** Optional asset-relative time range used to filter transcript cues. */
+    scope?: WorkflowScope;
     /** Optional signing context for signed playback IDs */
     shouldSign?: boolean;
     credentials?: WorkflowCredentialsInput;
@@ -194,6 +198,13 @@ declare function extractTimestampedTranscript(vttContent: string): string;
  * @returns Array of VTT cues with start/end times and text
  */
 declare function parseVTTCues(vttContent: string): VTTCue[];
+/**
+ * Keeps only VTT cues that overlap an asset-relative time range.
+ *
+ * Cue timestamps remain relative to the original asset; they are not rebased
+ * to the start of the scope.
+ */
+declare function filterVttByScope(vttContent: string, scope: WorkflowScope | undefined): string;
 declare function splitVttPreambleAndCueBlocks(vttContent: string): {
     preamble: string;
     cueBlocks: string[];
@@ -293,6 +304,8 @@ interface ThumbnailOptions {
     maxSamples?: number;
     /** Workflow credentials for signing (optional). */
     credentials?: WorkflowCredentialsInput;
+    /** Optional asset-relative range from which thumbnails should be sampled. */
+    scope?: WorkflowScope;
 }
 /**
  * Generates thumbnail URLs at regular intervals based on video duration.
@@ -343,6 +356,7 @@ declare const index_estimateTokenCount: typeof estimateTokenCount;
 declare const index_extractTextFromVTT: typeof extractTextFromVTT;
 declare const index_extractTimestampedTranscript: typeof extractTimestampedTranscript;
 declare const index_fetchTranscriptForAsset: typeof fetchTranscriptForAsset;
+declare const index_filterVttByScope: typeof filterVttByScope;
 declare const index_findCaptionTrack: typeof findCaptionTrack;
 declare const index_getHeatmapForAsset: typeof getHeatmapForAsset;
 declare const index_getHeatmapForPlaybackId: typeof getHeatmapForPlaybackId;
@@ -365,7 +379,7 @@ declare const index_stripVttMetadataBlocks: typeof stripVttMetadataBlocks;
 declare const index_vttTimestampToSeconds: typeof vttTimestampToSeconds;
 declare const index_waitForShotsForAsset: typeof waitForShotsForAsset;
 declare namespace index {
-  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_LOW_CONFIDENCE_THRESHOLD as LOW_CONFIDENCE_THRESHOLD, index_MAX_CUE_TEXT_CHARS as MAX_CUE_TEXT_CHARS, 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_getReliableLanguageCode as getReliableLanguageCode, 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_sanitizeUntrustedText as sanitizeUntrustedText, index_secondsToTimestamp as secondsToTimestamp, index_splitVttPreambleAndCueBlocks as splitVttPreambleAndCueBlocks, index_stripVttMetadataBlocks as stripVttMetadataBlocks, 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_LOW_CONFIDENCE_THRESHOLD as LOW_CONFIDENCE_THRESHOLD, index_MAX_CUE_TEXT_CHARS as MAX_CUE_TEXT_CHARS, 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_filterVttByScope as filterVttByScope, 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_getReliableLanguageCode as getReliableLanguageCode, 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_sanitizeUntrustedText as sanitizeUntrustedText, index_secondsToTimestamp as secondsToTimestamp, index_splitVttPreambleAndCueBlocks as splitVttPreambleAndCueBlocks, index_stripVttMetadataBlocks as stripVttMetadataBlocks, index_vttTimestampToSeconds as vttTimestampToSeconds, index_waitForShotsForAsset as waitForShotsForAsset };
 }
 
-export { getStoryboardUrl as A, getThumbnailUrls as B, parseVTTCues as C, DEFAULT_STORYBOARD_WIDTH as D, replaceCueText as E, sanitizeUntrustedText as F, secondsToTimestamp as G, type HeatmapOptions as H, splitVttPreambleAndCueBlocks as I, stripVttMetadataBlocks as J, vttTimestampToSeconds as K, LOW_CONFIDENCE_THRESHOLD as L, MAX_CUE_TEXT_CHARS as M, 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, getReliableLanguageCode as z };
+export { getReliableLanguageCode as A, getStoryboardUrl as B, getThumbnailUrls as C, DEFAULT_STORYBOARD_WIDTH as D, parseVTTCues as E, replaceCueText as F, sanitizeUntrustedText as G, type HeatmapOptions as H, secondsToTimestamp as I, splitVttPreambleAndCueBlocks as J, stripVttMetadataBlocks as K, LOW_CONFIDENCE_THRESHOLD as L, MAX_CUE_TEXT_CHARS as M, vttTimestampToSeconds as N, 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, filterVttByScope as u, findCaptionTrack as v, getHeatmapForAsset as w, getHeatmapForPlaybackId as x, getHeatmapForVideo as y, getReadyTextTracks as z };

package/dist/{index-DUVBpnj5.d.ts → index-DJirK4fh.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, H as Hotspot, t as Shot, i as ToneType, f as StorageAdapter } from './shots-mGJfYGiO.js';
+import { f as ScopedMuxAIOptions, I as ImageSubmissionMode, i as TokenUsage, M as MuxAIOptions, b as ChunkingStrategy, k as VideoEmbeddingsResult, H as Hotspot, v as Shot, j as ToneType, g as StorageAdapter } from './shots-BKd7TMFN.js';
 
 /**
  * Language Code Conversion Utilities
@@ -278,7 +278,7 @@ interface QuestionAnswer {
     skipped: boolean;
 }
 /** Configuration options for askQuestions workflow. */
-interface AskQuestionsOptions extends MuxAIOptions {
+interface AskQuestionsOptions extends ScopedMuxAIOptions {
     /** AI provider to run (defaults to 'openai'). */
     provider?: SupportedProvider;
     /** Provider-specific chat model identifier. */
@@ -518,7 +518,7 @@ type BurnedInCaptionsPromptSections = "task" | "analysisSteps" | "positiveIndica
  */
 type BurnedInCaptionsPromptOverrides = PromptOverrides<BurnedInCaptionsPromptSections>;
 /** Configuration accepted by `hasBurnedInCaptions`. */
-interface BurnedInCaptionsOptions extends MuxAIOptions {
+interface BurnedInCaptionsOptions extends ScopedMuxAIOptions {
     /** AI provider used for storyboard inspection (defaults to 'openai'). */
     provider?: SupportedProvider;
     /** Provider-specific model identifier. */
@@ -592,11 +592,11 @@ declare const chapterSchema: z.ZodObject<{
     startTime: z.ZodNumber;
     title: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     startTime: number;
-}, {
     title: string;
+}, {
     startTime: number;
+    title: string;
 }>;
 type Chapter = z.infer<typeof chapterSchema>;
 declare const chaptersSchema: z.ZodObject<{
@@ -604,21 +604,21 @@ declare const chaptersSchema: z.ZodObject<{
         startTime: z.ZodNumber;
         title: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         startTime: number;
-    }, {
         title: string;
+    }, {
         startTime: number;
+        title: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     chapters: {
-        title: string;
         startTime: number;
+        title: string;
     }[];
 }, {
     chapters: {
-        title: string;
         startTime: number;
+        title: string;
     }[];
 }>;
 type ChaptersType = z.infer<typeof chaptersSchema>;
@@ -658,7 +658,7 @@ type ChaptersPromptSections = "task" | "outputFormat" | "chapterGuidelines" | "t
  */
 type ChaptersPromptOverrides = PromptOverrides<ChaptersPromptSections>;
 /** Configuration accepted by `generateChapters`. */
-interface ChaptersOptions extends MuxAIOptions {
+interface ChaptersOptions extends ScopedMuxAIOptions {
     /** BCP 47 language code of the caption track to use (e.g. "en", "fr"). When omitted, prefers English if available. */
     languageCode?: string;
     /** AI provider used to interpret the transcript (defaults to 'openai'). */
@@ -850,7 +850,7 @@ declare function applyReplacements(rawVtt: string, replacements: CaptionReplacem
 declare function editCaptions<P extends SupportedProvider = SupportedProvider>(assetId: string, trackId: string, options: EditCaptionsOptions<P>): Promise<EditCaptionsResult>;
 
 /** Configuration accepted by `generateEmbeddings`. */
-interface EmbeddingsOptions extends MuxAIOptions {
+interface EmbeddingsOptions extends ScopedMuxAIOptions {
     /** AI provider used to generate embeddings (defaults to 'openai'). */
     provider?: SupportedEmbeddingProvider;
     /** Provider-specific model identifier (defaults to text-embedding-3-small for OpenAI). */
@@ -1037,7 +1037,7 @@ interface HiveModerationOutput {
     }>;
 }
 /** Configuration accepted by `getModerationScores`. */
-interface ModerationOptions extends MuxAIOptions {
+interface ModerationOptions extends ScopedMuxAIOptions {
     /** Provider used for moderation (defaults to 'openai'). */
     provider?: ModerationProvider;
     /** OpenAI moderation model identifier (defaults to 'omni-moderation-latest'). */
@@ -1176,7 +1176,7 @@ type SummarizationPromptSections = "task" | "title" | "description" | "keywords"
  */
 type SummarizationPromptOverrides = PromptOverrides<SummarizationPromptSections>;
 /** Configuration accepted by `getSummaryAndTags`. */
-interface SummarizationOptions extends MuxAIOptions {
+interface SummarizationOptions extends ScopedMuxAIOptions {
     /** AI provider to run (defaults to 'openai'). */
     provider?: SupportedProvider;
     /** Provider-specific chat model identifier. */

package/dist/index.d.ts

@@ -1,15 +1,15 @@
-export { I as ISO639_1, a as ISO639_3, L as LanguageCodePair, S as SupportedISO639_1, b as SupportedISO639_3, g as getLanguageCodePair, c as getLanguageName, i as isUndeterminedLanguageCode, d as isValidISO639_1, e as isValidISO639_3, t as toISO639_1, f as toISO639_3, h as workflows } from './index-DUVBpnj5.js';
-import { W as WorkflowCredentials, S as StoragePutObjectInput, a as StoragePresignGetObjectInput } from './shots-mGJfYGiO.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-mGJfYGiO.js';
+export { I as ISO639_1, a as ISO639_3, L as LanguageCodePair, S as SupportedISO639_1, b as SupportedISO639_3, g as getLanguageCodePair, c as getLanguageName, i as isUndeterminedLanguageCode, d as isValidISO639_1, e as isValidISO639_3, t as toISO639_1, f as toISO639_3, h as workflows } from './index-DJirK4fh.js';
+import { W as WorkflowCredentials, S as StoragePutObjectInput, a as StoragePresignGetObjectInput } from './shots-BKd7TMFN.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 ScopedMuxAIOptions, g as StorageAdapter, T as TextChunk, h as TokenChunkingConfig, i as TokenUsage, j as ToneType, U as UsageMetadata, V as VTTChunkingConfig, k as VideoEmbeddingsResult, l as WorkflowCredentialsInput, m as WorkflowMuxClient, n as WorkflowScope, o as decryptFromWorkflow, p as encryptForWorkflow } from './shots-BKd7TMFN.js';
 import { WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@workflow/serde';
-export { i as primitives } from './index-bjQi1ZCj.js';
+export { i as primitives } from './index-CXwsu679.js';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
 import '@mux/mux-node';
 
-var version = "0.28.1";
+var version = "0.29.0";
 
 type MuxAiErrorType = "validation_error" | "processing_error" | "timeout_error";
 /**