@mux/ai 0.4.0 → 0.5.0

package/README.md

@@ -8,7 +8,7 @@
 `@mux/ai` does this by providing:
 
 Easy to use, purpose-driven, cost effective, configurable **_workflow functions_** that integrate with a variety of popular AI/LLM providers (OpenAI, Anthropic, Google).
-- **Examples:** [`getSummaryAndTags`](#video-summarization), [`getModerationScores`](#content-moderation), [`hasBurnedInCaptions`](#burned-in-caption-detection), [`generateChapters`](#chapter-generation), [`generateVideoEmbeddings`](#video-search-with-embeddings), [`translateCaptions`](#caption-translation), [`translateAudio`](#audio-dubbing)
+- **Examples:** [`getSummaryAndTags`](#video-summarization), [`getModerationScores`](#content-moderation), [`hasBurnedInCaptions`](#burned-in-caption-detection), [`generateChapters`](#chapter-generation), [`generateEmbeddings`](#search-with-embeddings), [`translateCaptions`](#caption-translation), [`translateAudio`](#audio-dubbing)
 - Workflows automatically ship with `"use workflow"` [compatability with Workflow DevKit](#compatability-with-workflow-devkit)
 
 Convenient, parameterized, commonly needed **_primitive functions_** backed by [Mux Video](https://www.mux.com/video-api) for building your own media-based AI workflows and integrations.
@@ -86,10 +86,10 @@ 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 |
-| [`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 (required), Captions (required) | None |
-| [`generateVideoEmbeddings`](./docs/WORKFLOWS.md#video-embeddings)<br/>[API](./docs/API.md#generatevideoembeddingsassetid-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 (required), Captions (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 (required), Captions (required) | AWS S3 (if `uploadToMux=true`) |
-| [`translateAudio`](./docs/WORKFLOWS.md#audio-dubbing)<br/>[API](./docs/API.md#translateaudioassetid-tolanguagecode-options) · [Source](./src/workflows/translate-audio.ts) | Create AI-dubbed audio tracks in different languages for an asset | ElevenLabs only           | ElevenLabs Dubbing API                                             | Video (required), Audio (required) | AWS S3 (if `uploadToMux=true`) |
+| [`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`) |
+| [`translateAudio`](./docs/WORKFLOWS.md#audio-dubbing)<br/>[API](./docs/API.md#translateaudioassetid-tolanguagecode-options) · [Source](./src/workflows/translate-audio.ts) | Create AI-dubbed audio tracks in different languages for an asset | ElevenLabs only           | ElevenLabs Dubbing API                                             | Video or audio-only, Audio (required) | AWS S3 (if `uploadToMux=true`) |
 
 ## Compatability with Workflow DevKit
 
@@ -108,6 +108,58 @@ const run = await start(getSummaryAndTags, [assetId]);
 // const result = await run.returnValue
 ```
 
+### Multi-tenant credentials with Workflow Dev Kit (interim encryption pattern)
+
+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.
+
+```ts
+import { start } from "workflow/api";
+import { encryptForWorkflow, getSummaryAndTags } from "@mux/ai/workflows";
+
+const workflowKey = process.env.MUX_AI_WORKFLOW_SECRET_KEY!;
+const encryptedCredentials = encryptForWorkflow(
+  {
+    muxTokenId: "mux-token-id",
+    muxTokenSecret: "mux-token-secret",
+    openaiApiKey: "openai-api-key",
+  },
+  workflowKey,
+);
+
+const run = await start(getSummaryAndTags, [
+  "your-asset-id",
+  { 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!,
+  );
+}
+```
+
+You can also register a credential provider on the execution host to resolve secrets inside steps:
+
+```ts
+import { setWorkflowCredentialsProvider } from "@mux/ai/workflows";
+
+setWorkflowCredentialsProvider(async () => ({
+  muxTokenId: "mux-token-id",
+  muxTokenSecret: "mux-token-secret",
+  openaiApiKey: "openai-api-key",
+}));
+```
+
 ### Features of Workflow DevKit
 
 - [Observability Dashboard](https://useworkflow.dev/docs/observability)
@@ -165,7 +217,7 @@ console.log(result.tags);         // ["typescript", "tutorial", "programming"]
 
 ### Content Moderation
 
-Automatically detect inappropriate content in videos:
+Automatically detect inappropriate content in videos (or audio-only assets with transcripts):
 
 ```typescript
 import { getModerationScores } from "@mux/ai/workflows";
@@ -201,14 +253,14 @@ player.addChapters(result.chapters);
 // ]
 ```
 
-### Video Search with Embeddings
+### Search with Embeddings
 
-Generate embeddings for semantic video search:
+Generate embeddings for semantic search over transcripts:
 
 ```typescript
-import { generateVideoEmbeddings } from "@mux/ai/workflows";
+import { generateEmbeddings } from "@mux/ai/workflows";
 
-const result = await generateVideoEmbeddings("your-asset-id", {
+const result = await generateEmbeddings("your-asset-id", {
   provider: "openai",
   languageCode: "en",
   chunkingStrategy: {
@@ -327,7 +379,7 @@ Different workflows support various AI providers. You only need to configure API
 
 ### OpenAI
 
-**Used by:** `getSummaryAndTags`, `getModerationScores`, `hasBurnedInCaptions`, `generateChapters`, `generateVideoEmbeddings`, `translateCaptions`
+**Used by:** `getSummaryAndTags`, `getModerationScores`, `hasBurnedInCaptions`, `generateChapters`, `generateEmbeddings`, `translateCaptions`
 
 **Get your API key:** [OpenAI API Keys](https://platform.openai.com/api-keys)
 
@@ -347,7 +399,7 @@ ANTHROPIC_API_KEY=your_anthropic_api_key
 
 ### Google Generative AI
 
-**Used by:** `getSummaryAndTags`, `hasBurnedInCaptions`, `generateChapters`, `generateVideoEmbeddings`, `translateCaptions`
+**Used by:** `getSummaryAndTags`, `hasBurnedInCaptions`, `generateChapters`, `generateEmbeddings`, `translateCaptions`
 
 **Get your API key:** [Google AI Studio](https://aistudio.google.com/app/apikey)
 
@@ -436,6 +488,8 @@ Please see our **[Contributing Guide](./CONTRIBUTING.md)** for details on:
 - Submitting pull requests
 - Reporting issues
 
+> **Note on integration tests:** The integration suite runs against real Mux assets. If you want to run `npm run test:integration` with your own Mux credentials, you’ll also need to set Mux test asset IDs (see `env.test.example`, the “Integration test assets (Mux)” section in `CONTRIBUTING.md`, and `tests/helpers/mux-test-assets.ts` for the expected test asset IDs).
+
 For questions or discussions, feel free to [open an issue](https://github.com/muxinc/ai/issues).
 
 ## License

package/dist/{index-D3fZHu0h.d.ts → index-BdpEVCbj.d.ts}

@@ -2,8 +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 { g as TokenUsage, M as MuxAIOptions, I as ImageSubmissionMode, C as ChunkingStrategy, f as VideoEmbeddingsResult, T as ToneType } from './types-DzOQNn9R.js';
-import { Buffer } from 'node:buffer';
+import { k as TokenUsage, M as MuxAIOptions, I as ImageSubmissionMode, C as ChunkingStrategy, j as VideoEmbeddingsResult, T as ToneType } from './types-KcVfWtUl.js';
 
 interface ImageDownloadOptions {
     /** Request timeout in milliseconds (default: 10000) */
@@ -160,17 +159,58 @@ interface ChaptersResult {
     assetId: string;
     languageCode: string;
     chapters: Chapter[];
+    /** Token usage from the AI provider (for efficiency/cost analysis). */
+    usage?: TokenUsage;
 }
+/**
+ * Sections of the chaptering user prompt that can be overridden.
+ * Use these to customize the AI's behavior for your specific use case.
+ */
+type ChaptersPromptSections = "task" | "outputFormat" | "chapterGuidelines" | "titleGuidelines";
+/**
+ * Override specific sections of the chaptering prompt.
+ * Each key corresponds to a section that can be customized.
+ *
+ * @example
+ * ```typescript
+ * const result = await generateChapters(assetId, "en", {
+ *   promptOverrides: {
+ *     titleGuidelines: "Use short, punchy titles under 6 words.",
+ *   },
+ * });
+ * ```
+ */
+type ChaptersPromptOverrides = PromptOverrides<ChaptersPromptSections>;
 /** Configuration accepted by `generateChapters`. */
 interface ChaptersOptions extends MuxAIOptions {
     /** AI provider used to interpret the transcript (defaults to 'openai'). */
     provider?: SupportedProvider;
     /** Provider-specific model identifier. */
     model?: ModelIdByProvider[SupportedProvider];
+    /**
+     * Override specific sections of the user prompt.
+     * Useful for customizing chaptering criteria for specific use cases.
+     */
+    promptOverrides?: ChaptersPromptOverrides;
+    /**
+     * Minimum number of chapters to generate per hour of content.
+     * Defaults to 3.
+     */
+    minChaptersPerHour?: number;
+    /**
+     * Maximum number of chapters to generate per hour of content.
+     * Defaults to 8.
+     */
+    maxChaptersPerHour?: number;
 }
+/**
+ * Sections of the chaptering system prompt that can be overridden.
+ * Use these to customize the AI's persona and constraints.
+ */
+type ChapterSystemPromptSections = "role" | "context" | "constraints" | "qualityGuidelines";
 declare function generateChapters(assetId: string, languageCode: string, options?: ChaptersOptions): Promise<ChaptersResult>;
 
-/** Configuration accepted by `generateVideoEmbeddings`. */
+/** Configuration accepted by `generateEmbeddings`. */
 interface EmbeddingsOptions extends MuxAIOptions {
     /** AI provider used to generate embeddings (defaults to 'openai'). */
     provider?: SupportedEmbeddingProvider;
@@ -183,38 +223,13 @@ interface EmbeddingsOptions extends MuxAIOptions {
     /** Maximum number of chunks to process concurrently (defaults to 5). */
     batchSize?: number;
 }
+/** Alias for embedding results (supports video or audio transcripts). */
+type EmbeddingsResult = VideoEmbeddingsResult;
+declare function generateEmbeddings(assetId: string, options?: EmbeddingsOptions): Promise<EmbeddingsResult>;
 /**
- * Generates vector embeddings for a video asset's transcript.
- *
- * This function:
- * 1. Fetches the video transcript from Mux
- * 2. Chunks the transcript according to the specified strategy
- * 3. Generates embeddings for each chunk using the specified AI provider
- * 4. Returns both individual chunk embeddings and an averaged embedding
- *
- * @param assetId - Mux asset ID
- * @param options - Configuration options
- * @returns Video embeddings result with chunks and averaged embedding
- *
- * @example
- * ```typescript
- * const embeddings = await generateVideoEmbeddings("asset-id", {
- *   provider: "openai",
- *   chunkingStrategy: { type: "token", maxTokens: 500, overlap: 100 },
- * });
- *
- * // Store in vector database
- * for (const chunk of embeddings.chunks) {
- *   await db.insert({
- *     assetId: embeddings.assetId,
- *     chunkId: chunk.chunkId,
- *     embedding: chunk.embedding,
- *     metadata: chunk.metadata,
- *   });
- * }
- * ```
+ * @deprecated Use {@link generateEmbeddings} instead. This name will be removed in a future release.
  */
-declare function generateVideoEmbeddings(assetId: string, options?: EmbeddingsOptions): Promise<VideoEmbeddingsResult>;
+declare function generateVideoEmbeddings(assetId: string, options?: EmbeddingsOptions): Promise<EmbeddingsResult>;
 
 /** Per-thumbnail moderation result returned from `getModerationScores`. */
 interface ThumbnailModerationScore {
@@ -226,6 +241,10 @@ interface ThumbnailModerationScore {
 /** Aggregated moderation payload returned from `getModerationScores`. */
 interface ModerationResult {
     assetId: string;
+    /** Whether moderation ran on thumbnails (video) or transcript text (audio-only). */
+    mode: "thumbnails" | "transcript";
+    /** Convenience flag so callers can understand why `thumbnailScores` may contain a transcript entry. */
+    isAudioOnly: boolean;
     thumbnailScores: ThumbnailModerationScore[];
     maxScores: {
         sexual: number;
@@ -244,7 +263,7 @@ type HiveModerationSource = {
     value: string;
 } | {
     kind: "file";
-    buffer: Buffer;
+    buffer: Uint8Array;
     contentType: string;
 };
 interface HiveModerationOutput {
@@ -259,6 +278,11 @@ interface ModerationOptions extends MuxAIOptions {
     provider?: ModerationProvider;
     /** OpenAI moderation model identifier (defaults to 'omni-moderation-latest'). */
     model?: string;
+    /**
+     * Optional transcript language code used when moderating audio-only assets.
+     * If omitted, the first ready text track will be used.
+     */
+    languageCode?: string;
     /** Override the default sexual/violence thresholds (0-1). */
     thresholds?: {
         sexual?: number;
@@ -276,8 +300,14 @@ interface ModerationOptions extends MuxAIOptions {
     imageDownloadOptions?: ImageDownloadOptions;
 }
 /**
- * Moderate a Mux asset's thumbnails.
+ * Moderate a Mux asset.
+ * - Video assets: moderates storyboard thumbnails (image moderation)
+ * - Audio-only assets: moderates transcript text (text moderation)
+ *
+ * Provider notes:
  * - provider 'openai' uses OpenAI's hosted moderation endpoint (requires OPENAI_API_KEY)
+ *   Ref: https://platform.openai.com/docs/guides/moderation
+ * - provider 'hive' uses Hive's moderation API for thumbnails only (requires HIVE_API_KEY)
  */
 declare function getModerationScores(assetId: string, options?: ModerationOptions): Promise<ModerationResult>;
 
@@ -306,8 +336,8 @@ interface SummaryAndTagsResult {
     description: string;
     /** Up to 10 keywords extracted by the model. */
     tags: string[];
-    /** Storyboard image URL that was analyzed. */
-    storyboardUrl: string;
+    /** Storyboard image URL that was analyzed (undefined for audio-only assets). */
+    storyboardUrl?: string;
     /** Token usage from the AI provider (for efficiency/cost analysis). */
     usage?: TokenUsage;
     /** Raw transcript text used for analysis (when includeTranscript is true). */
@@ -550,10 +580,14 @@ type index_BurnedInCaptionsPromptOverrides = BurnedInCaptionsPromptOverrides;
 type index_BurnedInCaptionsPromptSections = BurnedInCaptionsPromptSections;
 type index_BurnedInCaptionsResult = BurnedInCaptionsResult;
 type index_Chapter = Chapter;
+type index_ChapterSystemPromptSections = ChapterSystemPromptSections;
 type index_ChaptersOptions = ChaptersOptions;
+type index_ChaptersPromptOverrides = ChaptersPromptOverrides;
+type index_ChaptersPromptSections = ChaptersPromptSections;
 type index_ChaptersResult = ChaptersResult;
 type index_ChaptersType = ChaptersType;
 type index_EmbeddingsOptions = EmbeddingsOptions;
+type index_EmbeddingsResult = EmbeddingsResult;
 type index_HiveModerationOutput = HiveModerationOutput;
 type index_HiveModerationSource = HiveModerationSource;
 type index_ModerationOptions = ModerationOptions;
@@ -573,6 +607,7 @@ declare const index_burnedInCaptionsSchema: typeof burnedInCaptionsSchema;
 declare const index_chapterSchema: typeof chapterSchema;
 declare const index_chaptersSchema: typeof chaptersSchema;
 declare const index_generateChapters: typeof generateChapters;
+declare const index_generateEmbeddings: typeof generateEmbeddings;
 declare const index_generateVideoEmbeddings: typeof generateVideoEmbeddings;
 declare const index_getModerationScores: typeof getModerationScores;
 declare const index_getSummaryAndTags: typeof getSummaryAndTags;
@@ -582,7 +617,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_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_ChaptersOptions as ChaptersOptions, type index_ChaptersResult as ChaptersResult, type index_ChaptersType as ChaptersType, type index_EmbeddingsOptions as EmbeddingsOptions, 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_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_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 AudioTranslationResult as A, type BurnedInCaptionsResult as B, type Chapter as C, translateAudio as D, type EmbeddingsOptions as E, type TranslationResult as F, type TranslationOptions as G, type HiveModerationSource as H, translationSchema as I, type TranslationPayload as J, translateCaptions as K, type ModerationResult as M, 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 ChaptersOptions as l, generateChapters as m, generateVideoEmbeddings as n, type ModerationProvider as o, type HiveModerationOutput as p, type ModerationOptions as q, getModerationScores as r, summarySchema as s, type SummaryType as t, type SummaryAndTagsResult as u, type SummarizationPromptSections as v, type SummarizationPromptOverrides as w, type SummarizationOptions as x, getSummaryAndTags as y, type AudioTranslationOptions as z };
+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 };

package/dist/{index-BcNDGOI6.d.ts → index-Dmo55n-5.d.ts}

@@ -1,4 +1,4 @@
-import { A as AssetTextTrack, a as MuxAsset, d as TextChunk, C as ChunkingStrategy } from './types-DzOQNn9R.js';
+import { b as WorkflowCredentialsInput, A as AssetTextTrack, c as MuxAsset, h as TextChunk, C as ChunkingStrategy } from './types-KcVfWtUl.js';
 
 declare const DEFAULT_STORYBOARD_WIDTH = 640;
 /**
@@ -10,7 +10,7 @@ declare const DEFAULT_STORYBOARD_WIDTH = 640;
  * @param shouldSign - Flag for whether or not to use signed playback IDs (default: false)
  * @returns Storyboard URL (signed if shouldSign is true)
  */
-declare function getStoryboardUrl(playbackId: string, width?: number, shouldSign?: boolean): Promise<string>;
+declare function getStoryboardUrl(playbackId: string, width?: number, shouldSign?: boolean, credentials?: WorkflowCredentialsInput): Promise<string>;
 
 /** A single cue from a VTT file with timing info. */
 interface VTTCue {
@@ -23,6 +23,14 @@ interface TranscriptFetchOptions {
     cleanTranscript?: boolean;
     /** Optional signing context for signed playback IDs */
     shouldSign?: boolean;
+    credentials?: WorkflowCredentialsInput;
+    /**
+     * When true, throws if no usable transcript can be retrieved (no ready text track,
+     * missing track id, fetch error, or empty transcript).
+     *
+     * Default behavior is non-fatal and returns an empty `transcriptText`.
+     */
+    required?: boolean;
 }
 interface TranscriptResult {
     transcriptText: string;
@@ -33,6 +41,14 @@ declare function getReadyTextTracks(asset: MuxAsset): AssetTextTrack[];
 declare function findCaptionTrack(asset: MuxAsset, languageCode?: string): AssetTextTrack | undefined;
 declare function extractTextFromVTT(vttContent: string): string;
 declare function vttTimestampToSeconds(timestamp: string): number;
+/**
+ * Converts seconds to a human-readable timestamp.
+ * Returns M:SS for durations under an hour, H:MM:SS for an hour or more.
+ *
+ * @param seconds - The number of seconds to convert
+ * @returns A formatted timestamp string (e.g., "2:05" or "01:02:05")
+ */
+declare function secondsToTimestamp(seconds: number): string;
 declare function extractTimestampedTranscript(vttContent: string): string;
 /**
  * Parses VTT content into structured cues with timing.
@@ -50,7 +66,7 @@ declare function parseVTTCues(vttContent: string): VTTCue[];
  * @param shouldSign - Flag for whether or not to use signed playback IDs
  * @returns Transcript URL (signed if context provided)
  */
-declare function buildTranscriptUrl(playbackId: string, trackId: string, shouldSign?: boolean): Promise<string>;
+declare function buildTranscriptUrl(playbackId: string, trackId: string, shouldSign?: boolean, credentials?: WorkflowCredentialsInput): Promise<string>;
 declare function fetchTranscriptForAsset(asset: MuxAsset, playbackId: string, options?: TranscriptFetchOptions): Promise<TranscriptResult>;
 
 /**
@@ -94,6 +110,8 @@ interface ThumbnailOptions {
     width?: number;
     /** Flag for whether or not to use signed playback IDs (default: false) */
     shouldSign?: boolean;
+    /** Workflow credentials for signing (optional). */
+    credentials?: WorkflowCredentialsInput;
 }
 /**
  * Generates thumbnail URLs at regular intervals based on video duration.
@@ -124,9 +142,10 @@ declare const index_getReadyTextTracks: typeof getReadyTextTracks;
 declare const index_getStoryboardUrl: typeof getStoryboardUrl;
 declare const index_getThumbnailUrls: typeof getThumbnailUrls;
 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_vttTimestampToSeconds as vttTimestampToSeconds };
+  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 { 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, vttTimestampToSeconds as v };
+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 };

package/dist/index.d.ts

@@ -1,13 +1,24 @@
-export { i as primitives } from './index-BcNDGOI6.js';
-export { A as AssetTextTrack, e as ChunkEmbedding, C as ChunkingStrategy, I as ImageSubmissionMode, M as MuxAIOptions, a as MuxAsset, b as PlaybackAsset, P as PlaybackPolicy, d as TextChunk, c as TokenChunkingConfig, g as TokenUsage, T as ToneType, V as VTTChunkingConfig, f as VideoEmbeddingsResult } from './types-DzOQNn9R.js';
-export { i as workflows } from './index-D3fZHu0h.js';
+import { W as WorkflowCredentials } from './types-KcVfWtUl.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-KcVfWtUl.js';
+export { i as primitives } from './index-Dmo55n-5.js';
+export { i as workflows } from './index-BdpEVCbj.js';
 import '@mux/mux-node';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
-import 'node:buffer';
 
-declare const version = "0.1.0";
+var version = "0.5.0";
 
-export { version };
+/**
+ * A function that returns workflow credentials, either synchronously or asynchronously.
+ * Used to inject credentials from external sources (e.g., a secrets manager).
+ */
+type WorkflowCredentialsProvider = () => Promise<WorkflowCredentials | undefined> | WorkflowCredentials | undefined;
+/**
+ * Registers a custom credentials provider for the module.
+ * The provider will be called whenever credentials need to be resolved.
+ */
+declare function setWorkflowCredentialsProvider(provider?: WorkflowCredentialsProvider): void;
+
+export { WorkflowCredentials, type WorkflowCredentialsProvider, setWorkflowCredentialsProvider, version };