@mux/ai 0.5.2 → 0.7.2

package/README.md

@@ -86,6 +86,7 @@ S3_SECRET_ACCESS_KEY=your-secret-key
 | [`getSummaryAndTags`](./docs/WORKFLOWS.md#video-summarization)<br/>[API](./docs/API.md#getsummaryandtagsassetid-options) · [Source](./src/workflows/summarization.ts) | Generate titles, descriptions, and tags for an asset              | OpenAI, Anthropic, Google | `gpt-5.1` (OpenAI), `claude-sonnet-4-5` (Anthropic), `gemini-3-flash-preview` (Google) | Video (required), Captions (optional) | None |
 | [`getModerationScores`](./docs/WORKFLOWS.md#content-moderation)<br/>[API](./docs/API.md#getmoderationscoresassetid-options) · [Source](./src/workflows/moderation.ts) | Detect inappropriate (sexual or violent) content in an asset      | OpenAI, Hive              | `omni-moderation-latest` (OpenAI) or Hive visual moderation task   | Video (required) | None |
 | [`hasBurnedInCaptions`](./docs/WORKFLOWS.md#burned-in-caption-detection)<br/>[API](./docs/API.md#hasburnedincaptionsassetid-options) · [Source](./src/workflows/burned-in-captions.ts) | Detect burned-in captions (hardcoded subtitles) in an asset       | OpenAI, Anthropic, Google | `gpt-5.1` (OpenAI), `claude-sonnet-4-5` (Anthropic), `gemini-3-flash-preview` (Google) | Video (required) | None |
+| [`askQuestions`](./docs/WORKFLOWS.md#ask-questions)<br/>[API](./docs/API.md#askquestionsassetid-questions-options) · [Source](./src/workflows/ask-questions.ts) | Answer yes/no questions about an asset's content                  | OpenAI, Anthropic, Google | `gpt-5.1` (OpenAI), `claude-sonnet-4-5` (Anthropic), `gemini-3-flash-preview` (Google) | Video (required), Captions (optional) | None |
 | [`generateChapters`](./docs/WORKFLOWS.md#chapter-generation)<br/>[API](./docs/API.md#generatechaptersassetid-languagecode-options) · [Source](./src/workflows/chapters.ts) | Generate chapter markers for an asset using the transcript        | OpenAI, Anthropic, Google | `gpt-5.1` (OpenAI), `claude-sonnet-4-5` (Anthropic), `gemini-3-flash-preview` (Google) | Video or audio-only, Captions/Transcripts (required) | None |
 | [`generateEmbeddings`](./docs/WORKFLOWS.md#embeddings)<br/>[API](./docs/API.md#generateembeddingsassetid-options) · [Source](./src/workflows/embeddings.ts) | Generate vector embeddings for an asset's transcript chunks       | OpenAI, Google            | `text-embedding-3-small` (OpenAI), `gemini-embedding-001` (Google) | Video or audio-only, Captions/Transcripts (required) | None |
 | [`translateCaptions`](./docs/WORKFLOWS.md#caption-translation)<br/>[API](./docs/API.md#translatecaptionsassetid-fromlanguagecode-tolanguagecode-options) · [Source](./src/workflows/translate-captions.ts) | Translate an asset's captions into different languages            | OpenAI, Anthropic, Google | `gpt-5.1` (OpenAI), `claude-sonnet-4-5` (Anthropic), `gemini-3-flash-preview` (Google) | Video or audio-only, Captions/Transcripts (required) | AWS S3 (if `uploadToMux=true`) |
@@ -95,6 +96,9 @@ S3_SECRET_ACCESS_KEY=your-secret-key
 
 All workflows are compatible with [Workflow DevKit](https://useworkflow.dev). The workflows in this SDK are exported with `"use workflow"` directives and `"use step"` directives in the code.
 
+Workflow DevKit serializes workflow inputs/outputs for observability. To avoid sending plaintext secrets through `start(...)`, encrypt credentials in the trigger host and decrypt them in workflow steps.
+See the dedicated [Workflow Encryption guide](./docs/WORKFLOW-ENCRYPTION.md) for full setup and patterns.
+
 If you are using Workflow DevKit in your project, then you must call workflow functions like this:
 
 ```ts
@@ -108,18 +112,23 @@ const run = await start(getSummaryAndTags, [assetId]);
 // const result = await run.returnValue
 ```
 
-### Multi-tenant credentials with Workflow Dev Kit (interim encryption pattern)
+### Multi-tenant credentials with Workflow Dev Kit
+
+Set a shared workflow secret key (base64-encoded 32-byte value) in your environment:
+
+```bash
+MUX_AI_WORKFLOW_SECRET_KEY=your_base64_32_byte_key
+```
 
-Workflow Dev Kit serializes workflow inputs and step I/O. Do not pass plaintext secrets through
-`start()`. Instead, encrypt credentials in userland and pass ciphertext only.
-Set `MUX_AI_WORKFLOW_SECRET_KEY` to a base64-encoded 32-byte key on the workflow execution host.
+Then encrypt credentials before calling `start()`:
 
 ```ts
 import { start } from "workflow/api";
-import { encryptForWorkflow, getSummaryAndTags } from "@mux/ai/workflows";
+import { encryptForWorkflow } from "@mux/ai";
+import { getSummaryAndTags } from "@mux/ai/workflows";
 
 const workflowKey = process.env.MUX_AI_WORKFLOW_SECRET_KEY!;
-const encryptedCredentials = encryptForWorkflow(
+const encryptedCredentials = await encryptForWorkflow(
   {
     muxTokenId: "mux-token-id",
     muxTokenSecret: "mux-token-secret",
@@ -130,33 +139,27 @@ const encryptedCredentials = encryptForWorkflow(
 
 const run = await start(getSummaryAndTags, [
   "your-asset-id",
-  { provider: "openai", credentials: encryptedCredentials },
+  {
+    provider: "openai",
+    credentials: encryptedCredentials,
+  },
 ]);
 ```
 
-If you build custom steps, decrypt inside the step using the same workflow key:
-
-```ts
-import { decryptFromWorkflow } from "@mux/ai/workflows";
-
-async function resolveCredentials(encrypted: unknown) {
-  "use step";
-  return decryptFromWorkflow(
-    encrypted as any,
-    process.env.MUX_AI_WORKFLOW_SECRET_KEY!,
-  );
-}
-```
+For Mux tokens specifically, `setWorkflowCredentialsProvider(...)` (or environment variables) is still recommended so raw Mux secrets are never embedded in workflow input payloads.
 
-You can also register a credential provider on the execution host to resolve secrets inside steps:
+You can also register a credential provider on the execution host to resolve secrets inside steps.
+This is useful for dynamic key resolution, e.g. rotating keys or per-tenant secrets:
 
 ```ts
-import { setWorkflowCredentialsProvider } from "@mux/ai/workflows";
+import {
+  setWorkflowCredentialsProvider,
+} from "@mux/ai";
 
 setWorkflowCredentialsProvider(async () => ({
   muxTokenId: "mux-token-id",
   muxTokenSecret: "mux-token-secret",
-  openaiApiKey: "openai-api-key",
+  openaiApiKey: await getOpenAIKeyForTenant(),
 }));
 ```
 
@@ -466,6 +469,8 @@ S3_SECRET_ACCESS_KEY=your-r2-secret-key
 
 - **[Workflows Guide](./docs/WORKFLOWS.md)** - Detailed guide to each pre-built workflow with examples
 - **[API Reference](./docs/API.md)** - Complete API documentation for all functions, parameters, and return types
+- **[Workflow Encryption](./docs/WORKFLOW-ENCRYPTION.md)** - Encrypting credentials across Workflow DevKit boundaries
+- **[Storage Adapters](./docs/STORAGE-ADAPTERS.md)** - Using custom storage SDKs (AWS, Cloudflare R2, MinIO)
 - **[Primitives Guide](./docs/PRIMITIVES.md)** - Low-level building blocks for custom workflows
 - **[Examples](./docs/EXAMPLES.md)** - Running examples from the repository
 

package/dist/{index-DgCfxP4T.d.ts → index-BMqnP1RV.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 { k as TokenUsage, M as MuxAIOptions, I as ImageSubmissionMode, C as ChunkingStrategy, j as VideoEmbeddingsResult, T as ToneType } from './types-BhVuLeSp.js';
+import { M as MuxAIOptions, I as ImageSubmissionMode, h as TokenUsage, b as ChunkingStrategy, j as VideoEmbeddingsResult, i as ToneType, f as StorageAdapter } from './types-BQVi_wnh.js';
 
 interface ImageDownloadOptions {
     /** Request timeout in milliseconds (default: 10000) */
@@ -17,6 +17,155 @@ interface ImageDownloadOptions {
     exponentialBackoff?: boolean;
 }
 
+type SupportedProvider = "openai" | "anthropic" | "google";
+type SupportedEmbeddingProvider = "openai" | "google";
+type OpenAIModelId = Parameters<ReturnType<typeof createOpenAI>["chat"]>[0];
+type AnthropicModelId = Parameters<ReturnType<typeof createAnthropic>["chat"]>[0];
+type GoogleModelId = Parameters<ReturnType<typeof createGoogleGenerativeAI>["chat"]>[0];
+type OpenAIEmbeddingModelId = Parameters<ReturnType<typeof createOpenAI>["embedding"]>[0];
+type GoogleEmbeddingModelId = Parameters<ReturnType<typeof createGoogleGenerativeAI>["textEmbeddingModel"]>[0];
+interface ModelIdByProvider {
+    openai: OpenAIModelId;
+    anthropic: AnthropicModelId;
+    google: GoogleModelId;
+}
+interface EmbeddingModelIdByProvider {
+    openai: OpenAIEmbeddingModelId;
+    google: GoogleEmbeddingModelId;
+}
+
+/** A single yes/no question to be answered about video content. */
+interface Question {
+    /** The question text */
+    question: string;
+}
+/** A single answer to a question. */
+interface QuestionAnswer {
+    /** The original question */
+    question: string;
+    /** Answer selected from the allowed options */
+    answer: string;
+    /** Confidence score between 0 and 1 */
+    confidence: number;
+    /** Reasoning explaining the answer based on observable evidence */
+    reasoning: string;
+}
+/** Configuration options for askQuestions workflow. */
+interface AskQuestionsOptions extends MuxAIOptions {
+    /** AI provider to run (defaults to 'openai'). */
+    provider?: SupportedProvider;
+    /** Provider-specific chat model identifier. */
+    model?: ModelIdByProvider[SupportedProvider];
+    /** Allowed answers for each question (defaults to ["yes", "no"]). */
+    answerOptions?: string[];
+    /** Fetch transcript alongside storyboard (defaults to true). */
+    includeTranscript?: boolean;
+    /** Strip timestamps/markup from transcripts (defaults to true). */
+    cleanTranscript?: boolean;
+    /** How storyboard should be delivered to the provider (defaults to 'url'). */
+    imageSubmissionMode?: ImageSubmissionMode;
+    /** Fine-tune storyboard downloads when imageSubmissionMode === 'base64'. */
+    imageDownloadOptions?: ImageDownloadOptions;
+    /** Storyboard width in pixels (defaults to 640). */
+    storyboardWidth?: number;
+}
+/** Structured return payload for askQuestions workflow. */
+interface AskQuestionsResult {
+    /** Asset ID passed into the workflow. */
+    assetId: string;
+    /** Array of answers for each question. */
+    answers: QuestionAnswer[];
+    /** Storyboard image URL that was analyzed. */
+    storyboardUrl: string;
+    /** Token usage from the AI provider (for efficiency/cost analysis). */
+    usage?: TokenUsage;
+    /** Raw transcript text used for analysis (when includeTranscript is true). */
+    transcriptText?: string;
+}
+/** Zod schema for a single answer. */
+declare const questionAnswerSchema: z.ZodObject<{
+    question: z.ZodString;
+    answer: z.ZodString;
+    confidence: z.ZodNumber;
+    reasoning: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    question: string;
+    answer: string;
+    confidence: number;
+    reasoning: string;
+}, {
+    question: string;
+    answer: string;
+    confidence: number;
+    reasoning: string;
+}>;
+type QuestionAnswerType = z.infer<typeof questionAnswerSchema>;
+declare function createAskQuestionsSchema(allowedAnswers: [string, ...string[]]): z.ZodObject<{
+    answers: z.ZodArray<z.ZodObject<{
+        question: z.ZodString;
+        confidence: z.ZodNumber;
+        reasoning: z.ZodString;
+    } & {
+        answer: z.ZodEnum<[string, ...string[]]>;
+    }, "strip", z.ZodTypeAny, {
+        question: string;
+        answer: string;
+        confidence: number;
+        reasoning: string;
+    }, {
+        question: string;
+        answer: string;
+        confidence: number;
+        reasoning: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    answers: {
+        question: string;
+        answer: string;
+        confidence: number;
+        reasoning: string;
+    }[];
+}, {
+    answers: {
+        question: string;
+        answer: string;
+        confidence: number;
+        reasoning: string;
+    }[];
+}>;
+type AskQuestionsSchema = ReturnType<typeof createAskQuestionsSchema>;
+type AskQuestionsType = z.infer<AskQuestionsSchema>;
+/**
+ * Answer questions about a Mux video asset by analyzing storyboard frames and transcript.
+ * Defaults to yes/no answers unless `answerOptions` are provided.
+ *
+ * This workflow takes a list of questions and returns structured answers with confidence
+ * scores and reasoning for each question. All questions are processed in a single LLM call for
+ * efficiency.
+ *
+ * @param assetId - The Mux asset ID to analyze
+ * @param questions - Array of questions to answer (each must have a 'question' field)
+ * @param options - Configuration options for the workflow
+ * @returns Structured answers with confidence scores and reasoning
+ *
+ * @example
+ * ```typescript
+ * const result = await askQuestions("abc123", [
+ *   { question: "Does this video contain cooking?" },
+ *   { question: "Are there people visible in the video?" },
+ * ]);
+ *
+ * console.log(result.answers[0]);
+ * // {
+ * //   question: "Does this video contain cooking?",
+ * //   answer: "yes",
+ * //   confidence: 0.95,
+ * //   reasoning: "A chef prepares ingredients and cooks in a kitchen throughout the video."
+ * // }
+ * ```
+ */
+declare function askQuestions(assetId: string, questions: Question[], options?: AskQuestionsOptions): Promise<AskQuestionsResult>;
+
 /**
  * A single section of a prompt, rendered as an XML-like tag.
  */
@@ -39,23 +188,6 @@ type SectionOverride = string | PromptSection | undefined;
  */
 type PromptOverrides<TSections extends string> = Partial<Record<TSections, SectionOverride>>;
 
-type SupportedProvider = "openai" | "anthropic" | "google";
-type SupportedEmbeddingProvider = "openai" | "google";
-type OpenAIModelId = Parameters<ReturnType<typeof createOpenAI>["chat"]>[0];
-type AnthropicModelId = Parameters<ReturnType<typeof createAnthropic>["chat"]>[0];
-type GoogleModelId = Parameters<ReturnType<typeof createGoogleGenerativeAI>["chat"]>[0];
-type OpenAIEmbeddingModelId = Parameters<ReturnType<typeof createOpenAI>["embedding"]>[0];
-type GoogleEmbeddingModelId = Parameters<ReturnType<typeof createGoogleGenerativeAI>["textEmbeddingModel"]>[0];
-interface ModelIdByProvider {
-    openai: OpenAIModelId;
-    anthropic: AnthropicModelId;
-    google: GoogleModelId;
-}
-interface EmbeddingModelIdByProvider {
-    openai: OpenAIEmbeddingModelId;
-    google: GoogleEmbeddingModelId;
-}
-
 /** Structured payload returned from `hasBurnedInCaptions`. */
 interface BurnedInCaptionsResult {
     assetId: string;
@@ -108,12 +240,12 @@ declare const burnedInCaptionsSchema: z.ZodObject<{
     confidence: z.ZodNumber;
     detectedLanguage: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    hasBurnedInCaptions: boolean;
     confidence: number;
+    hasBurnedInCaptions: boolean;
     detectedLanguage: string | null;
 }, {
-    hasBurnedInCaptions: boolean;
     confidence: number;
+    hasBurnedInCaptions: boolean;
     detectedLanguage: string | null;
 }>;
 /** Inferred shape returned from the burned-in captions schema. */
@@ -237,6 +369,7 @@ interface ThumbnailModerationScore {
     sexual: number;
     violence: number;
     error: boolean;
+    errorMessage?: string;
 }
 /** Aggregated moderation payload returned from `getModerationScores`. */
 interface ModerationResult {
@@ -246,6 +379,8 @@ interface ModerationResult {
     /** Convenience flag so callers can understand why `thumbnailScores` may contain a transcript entry. */
     isAudioOnly: boolean;
     thumbnailScores: ThumbnailModerationScore[];
+    /** Workflow usage metadata (asset duration, thumbnails, etc.). */
+    usage?: TokenUsage;
     maxScores: {
         sexual: number;
         violence: number;
@@ -318,7 +453,7 @@ declare const summarySchema: z.ZodObject<{
     keywords: z.ZodArray<z.ZodString, "many">;
     title: z.ZodString;
     description: z.ZodString;
-}, "strip", z.ZodTypeAny, {
+}, "strict", z.ZodTypeAny, {
     title: string;
     description: string;
     keywords: string[];
@@ -497,6 +632,8 @@ interface AudioTranslationResult {
     dubbingId: string;
     uploadedTrackId?: string;
     presignedUrl?: string;
+    /** Workflow usage metadata (asset duration, thumbnails, etc.). */
+    usage?: TokenUsage;
 }
 /** Configuration accepted by `translateAudio`. */
 interface AudioTranslationOptions extends MuxAIOptions {
@@ -515,8 +652,8 @@ interface AudioTranslationOptions extends MuxAIOptions {
      * bucket and attached to the Mux asset.
      */
     uploadToMux?: boolean;
-    /** Override for env.ELEVENLABS_API_KEY. */
-    elevenLabsApiKey?: string;
+    /** Optional storage adapter override for upload + presign operations. */
+    storageAdapter?: StorageAdapter;
 }
 declare function translateAudio(assetId: string, toLanguageCode: string, options?: AudioTranslationOptions): Promise<AudioTranslationResult>;
 
@@ -561,6 +698,8 @@ interface TranslationOptions<P extends SupportedProvider = SupportedProvider> ex
      * bucket and attached to the Mux asset.
      */
     uploadToMux?: boolean;
+    /** Optional storage adapter override for upload + presign operations. */
+    storageAdapter?: StorageAdapter;
 }
 /** Schema used when requesting caption translation from a language model. */
 declare const translationSchema: z.ZodObject<{
@@ -574,6 +713,9 @@ declare const translationSchema: z.ZodObject<{
 type TranslationPayload = z.infer<typeof translationSchema>;
 declare function translateCaptions<P extends SupportedProvider = SupportedProvider>(assetId: string, fromLanguageCode: string, toLanguageCode: string, options: TranslationOptions<P>): Promise<TranslationResult>;
 
+type index_AskQuestionsOptions = AskQuestionsOptions;
+type index_AskQuestionsResult = AskQuestionsResult;
+type index_AskQuestionsType = AskQuestionsType;
 type index_AudioTranslationOptions = AudioTranslationOptions;
 type index_AudioTranslationResult = AudioTranslationResult;
 type index_BurnedInCaptionsAnalysis = BurnedInCaptionsAnalysis;
@@ -595,6 +737,9 @@ type index_HiveModerationSource = HiveModerationSource;
 type index_ModerationOptions = ModerationOptions;
 type index_ModerationProvider = ModerationProvider;
 type index_ModerationResult = ModerationResult;
+type index_Question = Question;
+type index_QuestionAnswer = QuestionAnswer;
+type index_QuestionAnswerType = QuestionAnswerType;
 declare const index_SUMMARY_KEYWORD_LIMIT: typeof SUMMARY_KEYWORD_LIMIT;
 type index_SummarizationOptions = SummarizationOptions;
 type index_SummarizationPromptOverrides = SummarizationPromptOverrides;
@@ -605,6 +750,7 @@ type index_ThumbnailModerationScore = ThumbnailModerationScore;
 type index_TranslationOptions<P extends SupportedProvider = SupportedProvider> = TranslationOptions<P>;
 type index_TranslationPayload = TranslationPayload;
 type index_TranslationResult = TranslationResult;
+declare const index_askQuestions: typeof askQuestions;
 declare const index_burnedInCaptionsSchema: typeof burnedInCaptionsSchema;
 declare const index_chapterSchema: typeof chapterSchema;
 declare const index_chaptersSchema: typeof chaptersSchema;
@@ -614,12 +760,13 @@ 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_questionAnswerSchema: typeof questionAnswerSchema;
 declare const index_summarySchema: typeof summarySchema;
 declare const index_translateAudio: typeof translateAudio;
 declare const index_translateCaptions: typeof translateCaptions;
 declare const index_translationSchema: typeof translationSchema;
 declare namespace index {
-  export { type index_AudioTranslationOptions as AudioTranslationOptions, type index_AudioTranslationResult as AudioTranslationResult, 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_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, type index_EmbeddingsOptions as EmbeddingsOptions, type index_EmbeddingsResult as EmbeddingsResult, 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, index_SUMMARY_KEYWORD_LIMIT as SUMMARY_KEYWORD_LIMIT, 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_TranslationOptions as TranslationOptions, type index_TranslationPayload as TranslationPayload, type index_TranslationResult as TranslationResult, index_burnedInCaptionsSchema as burnedInCaptionsSchema, index_chapterSchema as chapterSchema, index_chaptersSchema as chaptersSchema, 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_summarySchema as summarySchema, 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_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_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, type index_EmbeddingsOptions as EmbeddingsOptions, type index_EmbeddingsResult as EmbeddingsResult, 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_Question as Question, type index_QuestionAnswer as QuestionAnswer, type index_QuestionAnswerType as QuestionAnswerType, index_SUMMARY_KEYWORD_LIMIT as SUMMARY_KEYWORD_LIMIT, 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_TranslationOptions as TranslationOptions, type index_TranslationPayload as TranslationPayload, type index_TranslationResult as TranslationResult, index_askQuestions as askQuestions, index_burnedInCaptionsSchema as burnedInCaptionsSchema, index_chapterSchema as chapterSchema, index_chaptersSchema as chaptersSchema, 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_questionAnswerSchema as questionAnswerSchema, index_summarySchema as summarySchema, index_translateAudio as translateAudio, index_translateCaptions as translateCaptions, index_translationSchema as translationSchema };
 }
 
-export { type SummarizationPromptSections as A, type BurnedInCaptionsResult as B, type Chapter as C, type SummarizationPromptOverrides as D, type EmbeddingsOptions as E, type SummarizationOptions as F, getSummaryAndTags as G, type HiveModerationSource as H, type AudioTranslationResult as I, type AudioTranslationOptions as J, translateAudio as K, type TranslationResult as L, type ModerationResult as M, type TranslationOptions as N, translationSchema as O, type TranslationPayload as P, translateCaptions as Q, SUMMARY_KEYWORD_LIMIT as S, type ThumbnailModerationScore as T, type BurnedInCaptionsPromptSections as a, type BurnedInCaptionsPromptOverrides as b, type BurnedInCaptionsOptions as c, burnedInCaptionsSchema as d, type BurnedInCaptionsAnalysis as e, chapterSchema as f, chaptersSchema as g, hasBurnedInCaptions as h, index as i, type ChaptersType as j, type ChaptersResult as k, type ChaptersPromptSections as l, type ChaptersPromptOverrides as m, type ChaptersOptions as n, type ChapterSystemPromptSections as o, generateChapters as p, type EmbeddingsResult as q, generateEmbeddings as r, generateVideoEmbeddings as s, type ModerationProvider as t, type HiveModerationOutput as u, type ModerationOptions as v, getModerationScores as w, summarySchema as x, type SummaryType as y, type SummaryAndTagsResult as z };
+export { type AskQuestionsOptions as A, type BurnedInCaptionsAnalysis as B, type Chapter as C, type TranslationOptions as D, type EmbeddingsOptions as E, type TranslationPayload as F, type TranslationResult as G, type HiveModerationOutput as H, askQuestions as I, burnedInCaptionsSchema as J, chapterSchema as K, chaptersSchema as L, type ModerationOptions as M, generateChapters as N, generateEmbeddings as O, generateVideoEmbeddings as P, type Question as Q, getModerationScores as R, SUMMARY_KEYWORD_LIMIT as S, type ThumbnailModerationScore as T, getSummaryAndTags as U, hasBurnedInCaptions as V, questionAnswerSchema as W, summarySchema as X, translateAudio as Y, translateCaptions as Z, translationSchema as _, type AskQuestionsResult as a, type AskQuestionsType as b, type AudioTranslationOptions as c, type AudioTranslationResult as d, type BurnedInCaptionsOptions as e, type BurnedInCaptionsPromptOverrides as f, type BurnedInCaptionsPromptSections as g, type BurnedInCaptionsResult as h, index as i, type ChapterSystemPromptSections as j, type ChaptersOptions as k, type ChaptersPromptOverrides as l, type ChaptersPromptSections as m, type ChaptersResult as n, type ChaptersType as o, type EmbeddingsResult as p, type HiveModerationSource as q, type ModerationProvider as r, type ModerationResult as s, type QuestionAnswer as t, type QuestionAnswerType as u, type SummarizationOptions as v, type SummarizationPromptOverrides as w, type SummarizationPromptSections as x, type SummaryAndTagsResult as y, type SummaryType as z };

package/dist/{index-2oUwgWsE.d.ts → index-DZlygsvb.d.ts}

@@ -1,4 +1,103 @@
-import { b as WorkflowCredentialsInput, A as AssetTextTrack, c as MuxAsset, h as TextChunk, C as ChunkingStrategy } from './types-BhVuLeSp.js';
+import { k as WorkflowCredentialsInput, A as AssetTextTrack, d as MuxAsset, T as TextChunk, b as ChunkingStrategy } from './types-BQVi_wnh.js';
+
+interface HeatmapOptions {
+    /** Time window for results, e.g., ['7:days'] (default: ['7:days']) */
+    timeframe?: string;
+    /** Optional workflow credentials */
+    credentials?: WorkflowCredentialsInput;
+}
+interface HeatmapResponse {
+    assetId?: string;
+    videoId?: string;
+    playbackId?: string;
+    /** Array of 100 values representing engagement for each 1/100th of the video */
+    heatmap: number[];
+    timeframe: [number, number];
+}
+/**
+ * Fetches engagement heatmap for a Mux asset.
+ * Returns a length 100 array where each value represents how many times
+ * that 1/100th of the video was watched.
+ *
+ * @param assetId - The Mux asset ID
+ * @param options - Heatmap query options
+ * @returns Heatmap data with 100 engagement values
+ */
+declare function getHeatmapForAsset(assetId: string, options?: HeatmapOptions): Promise<HeatmapResponse>;
+/**
+ * Fetches engagement heatmap for a Mux video ID.
+ * Returns a length 100 array where each value represents how many times
+ * that 1/100th of the video was watched.
+ *
+ * @param videoId - The Mux video ID
+ * @param options - Heatmap query options
+ * @returns Heatmap data with 100 engagement values
+ */
+declare function getHeatmapForVideo(videoId: string, options?: HeatmapOptions): Promise<HeatmapResponse>;
+/**
+ * Fetches engagement heatmap for a Mux playback ID.
+ * Returns a length 100 array where each value represents how many times
+ * that 1/100th of the video was watched.
+ *
+ * @param playbackId - The Mux playback ID
+ * @param options - Heatmap query options
+ * @returns Heatmap data with 100 engagement values
+ */
+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[]>;
 
 declare const DEFAULT_STORYBOARD_WIDTH = 640;
 /**
@@ -127,6 +226,11 @@ interface ThumbnailOptions {
 declare function getThumbnailUrls(playbackId: string, duration: number, options?: ThumbnailOptions): Promise<string[]>;
 
 declare const index_DEFAULT_STORYBOARD_WIDTH: typeof DEFAULT_STORYBOARD_WIDTH;
+type index_HeatmapOptions = HeatmapOptions;
+type index_HeatmapResponse = HeatmapResponse;
+type index_Hotspot = Hotspot;
+type index_HotspotOptions = HotspotOptions;
+type index_HotspotResponse = HotspotResponse;
 type index_ThumbnailOptions = ThumbnailOptions;
 type index_TranscriptFetchOptions = TranscriptFetchOptions;
 type index_TranscriptResult = TranscriptResult;
@@ -140,6 +244,12 @@ declare const index_extractTextFromVTT: typeof extractTextFromVTT;
 declare const index_extractTimestampedTranscript: typeof extractTimestampedTranscript;
 declare const index_fetchTranscriptForAsset: typeof fetchTranscriptForAsset;
 declare const index_findCaptionTrack: typeof findCaptionTrack;
+declare const index_getHeatmapForAsset: typeof getHeatmapForAsset;
+declare const index_getHeatmapForPlaybackId: typeof getHeatmapForPlaybackId;
+declare const index_getHeatmapForVideo: typeof getHeatmapForVideo;
+declare const index_getHotspotsForAsset: typeof getHotspotsForAsset;
+declare const index_getHotspotsForPlaybackId: typeof getHotspotsForPlaybackId;
+declare const index_getHotspotsForVideo: typeof getHotspotsForVideo;
 declare const index_getReadyTextTracks: typeof getReadyTextTracks;
 declare const index_getStoryboardUrl: typeof getStoryboardUrl;
 declare const index_getThumbnailUrls: typeof getThumbnailUrls;
@@ -147,7 +257,7 @@ declare const index_parseVTTCues: typeof parseVTTCues;
 declare const index_secondsToTimestamp: typeof secondsToTimestamp;
 declare const index_vttTimestampToSeconds: typeof vttTimestampToSeconds;
 declare namespace index {
-  export { index_DEFAULT_STORYBOARD_WIDTH as DEFAULT_STORYBOARD_WIDTH, type index_ThumbnailOptions as ThumbnailOptions, type index_TranscriptFetchOptions as TranscriptFetchOptions, type index_TranscriptResult as TranscriptResult, type index_VTTCue as VTTCue, index_buildTranscriptUrl as buildTranscriptUrl, index_chunkByTokens as chunkByTokens, index_chunkText as chunkText, index_chunkVTTCues as chunkVTTCues, index_estimateTokenCount as estimateTokenCount, index_extractTextFromVTT as extractTextFromVTT, index_extractTimestampedTranscript as extractTimestampedTranscript, index_fetchTranscriptForAsset as fetchTranscriptForAsset, index_findCaptionTrack as findCaptionTrack, index_getReadyTextTracks as getReadyTextTracks, index_getStoryboardUrl as getStoryboardUrl, index_getThumbnailUrls as getThumbnailUrls, index_parseVTTCues as parseVTTCues, index_secondsToTimestamp as secondsToTimestamp, index_vttTimestampToSeconds as vttTimestampToSeconds };
+  export { index_DEFAULT_STORYBOARD_WIDTH as DEFAULT_STORYBOARD_WIDTH, 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_ThumbnailOptions as ThumbnailOptions, type index_TranscriptFetchOptions as TranscriptFetchOptions, type index_TranscriptResult as TranscriptResult, type index_VTTCue as VTTCue, index_buildTranscriptUrl as buildTranscriptUrl, index_chunkByTokens as chunkByTokens, index_chunkText as chunkText, index_chunkVTTCues as chunkVTTCues, 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_getStoryboardUrl as getStoryboardUrl, index_getThumbnailUrls as getThumbnailUrls, index_parseVTTCues as parseVTTCues, index_secondsToTimestamp as secondsToTimestamp, index_vttTimestampToSeconds as vttTimestampToSeconds };
 }
 
-export { DEFAULT_STORYBOARD_WIDTH as D, type ThumbnailOptions as T, type VTTCue as V, chunkVTTCues as a, chunkText as b, chunkByTokens as c, getThumbnailUrls as d, estimateTokenCount as e, type TranscriptFetchOptions as f, getStoryboardUrl as g, type TranscriptResult as h, index as i, getReadyTextTracks as j, findCaptionTrack as k, extractTextFromVTT as l, extractTimestampedTranscript as m, buildTranscriptUrl as n, fetchTranscriptForAsset as o, parseVTTCues as p, secondsToTimestamp as s, vttTimestampToSeconds as v };
+export { secondsToTimestamp as A, vttTimestampToSeconds as B, DEFAULT_STORYBOARD_WIDTH as D, type HeatmapOptions as H, type ThumbnailOptions as T, type VTTCue as V, type HeatmapResponse as a, type Hotspot as b, type HotspotOptions as c, type HotspotResponse as d, type TranscriptFetchOptions as e, type TranscriptResult as f, buildTranscriptUrl as g, chunkByTokens as h, index as i, chunkText as j, chunkVTTCues as k, estimateTokenCount as l, extractTextFromVTT as m, extractTimestampedTranscript as n, fetchTranscriptForAsset as o, findCaptionTrack as p, getHeatmapForAsset as q, getHeatmapForPlaybackId as r, getHeatmapForVideo as s, getHotspotsForAsset as t, getHotspotsForPlaybackId as u, getHotspotsForVideo as v, getReadyTextTracks as w, getStoryboardUrl as x, getThumbnailUrls as y, parseVTTCues as z };

package/dist/index.d.ts

@@ -1,14 +1,15 @@
-import { W as WorkflowCredentials } from './types-BhVuLeSp.js';
-export { A as AssetTextTrack, i as ChunkEmbedding, C as ChunkingStrategy, E as Encrypted, a as EncryptedPayload, I as ImageSubmissionMode, M as MuxAIOptions, c as MuxAsset, f as PlaybackAsset, P as PlaybackPolicy, h as TextChunk, g as TokenChunkingConfig, k as TokenUsage, T as ToneType, V as VTTChunkingConfig, j as VideoEmbeddingsResult, b as WorkflowCredentialsInput, d as decryptFromWorkflow, e as encryptForWorkflow } from './types-BhVuLeSp.js';
-export { i as primitives } from './index-2oUwgWsE.js';
-export { i as workflows } from './index-DgCfxP4T.js';
+import { W as WorkflowCredentials, S as StoragePutObjectInput, a as StoragePresignGetObjectInput } from './types-BQVi_wnh.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-BQVi_wnh.js';
+import { WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@workflow/serde';
+export { i as primitives } from './index-DZlygsvb.js';
+export { i as workflows } from './index-BMqnP1RV.js';
 import '@mux/mux-node';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
 
-var version = "0.5.2";
+var version = "0.7.2";
 
 /**
  * A function that returns workflow credentials, either synchronously or asynchronously.
@@ -21,4 +22,27 @@ type WorkflowCredentialsProvider = () => Promise<WorkflowCredentials | undefined
  */
 declare function setWorkflowCredentialsProvider(provider?: WorkflowCredentialsProvider): void;
 
-export { WorkflowCredentials, type WorkflowCredentialsProvider, setWorkflowCredentialsProvider, version };
+interface WorkflowStorageClientOptions {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+/**
+ * Serializable storage client wrapper for workflow boundaries.
+ *
+ * By default, this uses the internal SigV4 implementation to keep object
+ * operations compatible across edge/ESM and Node runtimes.
+ */
+declare class WorkflowStorageClient {
+    static classId: string;
+    private readonly accessKeyId?;
+    private readonly secretAccessKey?;
+    constructor(options?: WorkflowStorageClientOptions);
+    private resolveCredentials;
+    putObject(input: StoragePutObjectInput): Promise<void>;
+    createPresignedGetUrl(input: StoragePresignGetObjectInput): Promise<string>;
+    static [WORKFLOW_SERIALIZE](instance: WorkflowStorageClient): WorkflowStorageClientOptions;
+    static [WORKFLOW_DESERIALIZE](this: typeof WorkflowStorageClient, value: WorkflowStorageClientOptions): WorkflowStorageClient;
+}
+declare function createWorkflowStorageClient(options?: WorkflowStorageClientOptions): WorkflowStorageClient;
+
+export { StoragePresignGetObjectInput, StoragePutObjectInput, WorkflowCredentials, type WorkflowCredentialsProvider, WorkflowStorageClient, createWorkflowStorageClient, setWorkflowCredentialsProvider, version };