@mux/ai 0.5.2 → 0.7.2

package/dist/{types-BhVuLeSp.d.ts → types-BQVi_wnh.d.ts}

@@ -18,8 +18,8 @@ declare const WORKFLOW_ENCRYPTION_ALGORITHM: "aes-256-gcm";
  * - Keys should be invalidated/deleted after rotation, not kept indefinitely
  *
  * Security notes:
- * - `kid` is stored in plaintext (not encrypted) — don't put sensitive data in it
- * - Tampering with `kid` doesn't weaken security — wrong key = decryption fails
+ * - `kid` is stored in plaintext (not encrypted) - don't put sensitive data in it
+ * - Tampering with `kid` doesn't weaken security - wrong key = decryption fails
  */
 interface EncryptedPayload {
     v: typeof WORKFLOW_ENCRYPTION_VERSION;
@@ -40,13 +40,6 @@ type Encrypted<T> = EncryptedPayload & {
  * @param key - 32-byte secret key (base64 string or Uint8Array)
  * @param keyId - Optional key identifier for rotation support (stored in plaintext)
  * @returns Encrypted payload with metadata, safe to pass through untrusted channels
- *
- * @example
- * // Without key ID
- * const encrypted = await encryptForWorkflow(credentials, secretKey);
- *
- * // With key ID for rotation support
- * const encrypted = await encryptForWorkflow(credentials, secretKey, "key-2024-01");
  */
 declare function encryptForWorkflow<T>(value: T, key: Uint8Array | string, keyId?: string): Promise<Encrypted<T>>;
 /**
@@ -56,15 +49,40 @@ declare function encryptForWorkflow<T>(value: T, key: Uint8Array | string, keyId
  * @param key - Same 32-byte secret key used for encryption
  * @returns The original decrypted value
  * @throws If payload is invalid, tampered with, or key is wrong
- *
- * @example
- * // With key rotation: read kid to look up the correct key
- * const keyId = payload.kid ?? "default";
- * const key = keyStore.get(keyId);
- * const credentials = await decryptFromWorkflow(payload, key);
  */
 declare function decryptFromWorkflow<T>(payload: EncryptedPayload, key: Uint8Array | string): Promise<T>;
 
+/** Input shape for uploading objects through a storage adapter. */
+interface StoragePutObjectInput {
+    endpoint: string;
+    region: string;
+    bucket: string;
+    key: string;
+    body: string | Uint8Array;
+    contentType?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+/** Input shape for presigning object download URLs through a storage adapter. */
+interface StoragePresignGetObjectInput {
+    endpoint: string;
+    region: string;
+    bucket: string;
+    key: string;
+    expiresInSeconds: number;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+/** Optional pluggable storage backend for S3-compatible object operations. */
+interface StorageAdapter {
+    putObject: (input: StoragePutObjectInput) => Promise<void>;
+    createPresignedGetUrl: (input: StoragePresignGetObjectInput) => Promise<string>;
+}
+interface WorkflowMuxClient {
+    createClient: () => Promise<Mux>;
+    getSigningKey: () => string | undefined;
+    getPrivateKey: () => string | undefined;
+}
 /**
  * Base options mixed into every higher-level workflow configuration.
  */
@@ -76,20 +94,33 @@ interface MuxAIOptions {
      * Use encryptForWorkflow when running in Workflow Dev Kit environments.
      */
     credentials?: WorkflowCredentialsInput;
+    /** Optional storage adapter for upload and presigning operations. */
+    storageAdapter?: StorageAdapter;
 }
 /**
- * Plaintext workflow credentials. Avoid passing these to Workflow Dev Kit start()
- * unless you are not using workflow serialization.
+ * Workflow credentials.
+ *
+ * Supports plain credential objects and primitive credential fields for
+ * per-request multi-tenant workflows.
  */
 interface WorkflowCredentials {
+    /** Direct Mux API token ID for per-request credential injection. */
     muxTokenId?: string;
+    /** Direct Mux API token secret for per-request credential injection. */
     muxTokenSecret?: string;
+    /** Optional direct Mux signing key ID for signed playback URL generation. */
     muxSigningKey?: string;
+    /** Optional direct Mux private key for signed playback URL generation. */
     muxPrivateKey?: string;
+    /** Optional direct OpenAI API key for per-request credential injection. */
     openaiApiKey?: string;
+    /** Optional direct Anthropic API key for per-request credential injection. */
     anthropicApiKey?: string;
+    /** Optional direct Google API key for per-request credential injection. */
     googleApiKey?: string;
+    /** Optional direct Hive API key for per-request credential injection. */
     hiveApiKey?: string;
+    /** Optional direct ElevenLabs API key for per-request credential injection. */
     elevenLabsApiKey?: string;
 }
 /** Credentials that are safe to serialize across workflow boundaries. */
@@ -175,6 +206,17 @@ interface VideoEmbeddingsResult {
         embeddingDimensions: number;
         generatedAt: string;
     };
+    /** Workflow usage metadata (asset duration, thumbnails, etc.). */
+    usage?: TokenUsage;
+}
+/**
+ * Metadata attached to usage objects for workflow context.
+ */
+interface UsageMetadata {
+    /** Total asset duration in seconds. */
+    assetDurationSeconds?: number;
+    /** Number of thumbnails sampled for workflows that use thumbnails. */
+    thumbnailCount?: number;
 }
 /**
  * Token usage breakdown returned by AI SDK providers.
@@ -191,6 +233,8 @@ interface TokenUsage {
     reasoningTokens?: number;
     /** Input tokens served from cache (reduces cost). */
     cachedInputTokens?: number;
+    /** Workflow metadata (asset duration, thumbnails, etc.). */
+    metadata?: UsageMetadata;
 }
 
-export { type AssetTextTrack as A, type ChunkingStrategy as C, type Encrypted as E, type ImageSubmissionMode as I, type MuxAIOptions as M, type PlaybackPolicy as P, type ToneType as T, type VTTChunkingConfig as V, type WorkflowCredentials as W, type EncryptedPayload as a, type WorkflowCredentialsInput as b, type MuxAsset as c, decryptFromWorkflow as d, encryptForWorkflow as e, type PlaybackAsset as f, type TokenChunkingConfig as g, type TextChunk as h, type ChunkEmbedding as i, type VideoEmbeddingsResult as j, type TokenUsage as k };
+export { type AssetTextTrack as A, type ChunkEmbedding as C, type Encrypted as E, type ImageSubmissionMode as I, type MuxAIOptions as M, type PlaybackAsset as P, type StoragePutObjectInput as S, type TextChunk as T, type UsageMetadata as U, type VTTChunkingConfig as V, type WorkflowCredentials as W, type StoragePresignGetObjectInput as a, type ChunkingStrategy as b, type EncryptedPayload as c, type MuxAsset as d, type PlaybackPolicy as e, type StorageAdapter as f, type TokenChunkingConfig as g, type TokenUsage as h, type ToneType as i, type VideoEmbeddingsResult as j, type WorkflowCredentialsInput as k, type WorkflowMuxClient as l, decryptFromWorkflow as m, encryptForWorkflow as n };

package/dist/workflows/index.d.ts

@@ -1,7 +1,7 @@
-export { J as AudioTranslationOptions, I as AudioTranslationResult, e as BurnedInCaptionsAnalysis, c as BurnedInCaptionsOptions, b as BurnedInCaptionsPromptOverrides, a as BurnedInCaptionsPromptSections, B as BurnedInCaptionsResult, C as Chapter, o as ChapterSystemPromptSections, n as ChaptersOptions, m as ChaptersPromptOverrides, l as ChaptersPromptSections, k as ChaptersResult, j as ChaptersType, E as EmbeddingsOptions, q as EmbeddingsResult, u as HiveModerationOutput, H as HiveModerationSource, v as ModerationOptions, t as ModerationProvider, M as ModerationResult, S as SUMMARY_KEYWORD_LIMIT, F as SummarizationOptions, D as SummarizationPromptOverrides, A as SummarizationPromptSections, z as SummaryAndTagsResult, y as SummaryType, T as ThumbnailModerationScore, N as TranslationOptions, P as TranslationPayload, L as TranslationResult, d as burnedInCaptionsSchema, f as chapterSchema, g as chaptersSchema, p as generateChapters, r as generateEmbeddings, s as generateVideoEmbeddings, w as getModerationScores, G as getSummaryAndTags, h as hasBurnedInCaptions, x as summarySchema, K as translateAudio, Q as translateCaptions, O as translationSchema } from '../index-DgCfxP4T.js';
+export { A as AskQuestionsOptions, a as AskQuestionsResult, b as AskQuestionsType, c as AudioTranslationOptions, d as AudioTranslationResult, B as BurnedInCaptionsAnalysis, e as BurnedInCaptionsOptions, f as BurnedInCaptionsPromptOverrides, g as BurnedInCaptionsPromptSections, h as BurnedInCaptionsResult, C as Chapter, j as ChapterSystemPromptSections, k as ChaptersOptions, l as ChaptersPromptOverrides, m as ChaptersPromptSections, n as ChaptersResult, o as ChaptersType, E as EmbeddingsOptions, p as EmbeddingsResult, H as HiveModerationOutput, q as HiveModerationSource, M as ModerationOptions, r as ModerationProvider, s as ModerationResult, Q as Question, t as QuestionAnswer, u as QuestionAnswerType, S as SUMMARY_KEYWORD_LIMIT, v as SummarizationOptions, w as SummarizationPromptOverrides, x as SummarizationPromptSections, y as SummaryAndTagsResult, z as SummaryType, T as ThumbnailModerationScore, D as TranslationOptions, F as TranslationPayload, G as TranslationResult, I as askQuestions, J as burnedInCaptionsSchema, K as chapterSchema, L as chaptersSchema, N as generateChapters, O as generateEmbeddings, P as generateVideoEmbeddings, R as getModerationScores, U as getSummaryAndTags, V as hasBurnedInCaptions, W as questionAnswerSchema, X as summarySchema, Y as translateAudio, Z as translateCaptions, _ as translationSchema } from '../index-BMqnP1RV.js';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
-import '../types-BhVuLeSp.js';
+import '../types-BQVi_wnh.js';
 import '@mux/mux-node';