@mux/ai 0.4.2 → 0.5.0

package/dist/types-KcVfWtUl.d.ts

@@ -0,0 +1,202 @@
+import Mux from '@mux/mux-node';
+
+/**
+ * Workflow Crypto
+ *
+ * Provides AES-256-GCM encryption for securely passing credentials to workflows.
+ * Encrypted payloads are JSON-serializable and include version/algorithm metadata
+ * for forward compatibility.
+ */
+declare const WORKFLOW_ENCRYPTION_VERSION = 1;
+declare const WORKFLOW_ENCRYPTION_ALGORITHM: "aes-256-gcm";
+/**
+ * Structure of an encrypted payload (all fields are base64-encoded where applicable).
+ *
+ * The optional `kid` (key ID) field supports key rotation scenarios:
+ * - Include a `kid` when encrypting to identify which key was used
+ * - On decryption, read `payload.kid` to look up the correct key
+ * - 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
+ */
+interface EncryptedPayload {
+    v: typeof WORKFLOW_ENCRYPTION_VERSION;
+    alg: typeof WORKFLOW_ENCRYPTION_ALGORITHM;
+    kid?: string;
+    iv: string;
+    tag: string;
+    ciphertext: string;
+}
+/** Branded type that preserves the original type information for decryption */
+type Encrypted<T> = EncryptedPayload & {
+    __type?: T;
+};
+/**
+ * Encrypts a value for secure transport to a workflow.
+ *
+ * @param value - Any JSON-serializable value (typically WorkflowCredentials)
+ * @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>>;
+/**
+ * Decrypts and deserializes a workflow payload.
+ *
+ * @param payload - Encrypted payload from `encryptForWorkflow`
+ * @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>;
+
+/**
+ * Base options mixed into every higher-level workflow configuration.
+ */
+interface MuxAIOptions {
+    /** Optional timeout (ms) for helper utilities that support request limits. */
+    timeout?: number;
+    /**
+     * Optional cancellation signal passed through to underlying AI SDK calls.
+     * When aborted, in-flight model requests will be
+     * cancelled where supported.
+     */
+    abortSignal?: AbortSignal;
+    /**
+     * Optional credentials for workflow execution.
+     * Use encryptForWorkflow when running in Workflow Dev Kit environments.
+     */
+    credentials?: WorkflowCredentialsInput;
+}
+/**
+ * Plaintext workflow credentials. Avoid passing these to Workflow Dev Kit start()
+ * unless you are not using workflow serialization.
+ */
+interface WorkflowCredentials {
+    muxTokenId?: string;
+    muxTokenSecret?: string;
+    muxSigningKey?: string;
+    muxPrivateKey?: string;
+    openaiApiKey?: string;
+    anthropicApiKey?: string;
+    googleApiKey?: string;
+    hiveApiKey?: string;
+    elevenLabsApiKey?: string;
+}
+/** Credentials that are safe to serialize across workflow boundaries. */
+type WorkflowCredentialsInput = WorkflowCredentials | Encrypted<WorkflowCredentials>;
+/** Tone controls for the summarization helper. */
+type ToneType = "neutral" | "playful" | "professional";
+/** Common transport for image-based workflows. */
+type ImageSubmissionMode = "url" | "base64";
+/** Result of calling mux-node's asset retrieval helper. */
+type MuxAsset = Awaited<ReturnType<Mux["video"]["assets"]["retrieve"]>>;
+/** Single ready track extracted from a Mux asset. */
+type AssetTextTrack = NonNullable<MuxAsset["tracks"]>[number];
+/** Playback policy type for Mux assets. */
+type PlaybackPolicy = "public" | "signed";
+/** Convenience bundle returned by `getPlaybackIdForAsset`. */
+interface PlaybackAsset {
+    asset: MuxAsset;
+    playbackId: string;
+    /** The policy type of the playback ID ('public' or 'signed'). */
+    policy: PlaybackPolicy;
+}
+/** Configuration for token-based chunking. */
+interface TokenChunkingConfig {
+    type: "token";
+    /** Maximum tokens per chunk. */
+    maxTokens: number;
+    /** Number of overlapping tokens between chunks. */
+    overlap?: number;
+}
+/** Configuration for VTT-aware chunking that respects cue boundaries. */
+interface VTTChunkingConfig {
+    type: "vtt";
+    /** Maximum tokens per chunk. */
+    maxTokens: number;
+    /** Number of cues to overlap between chunks (default: 2). */
+    overlapCues?: number;
+}
+/** Union type for all chunking strategy configurations. */
+type ChunkingStrategy = TokenChunkingConfig | VTTChunkingConfig;
+/** A single chunk of text extracted from a transcript. */
+interface TextChunk {
+    /** Unique identifier for this chunk. */
+    id: string;
+    /** The text content of the chunk. */
+    text: string;
+    /** Number of tokens in this chunk. */
+    tokenCount: number;
+    /** Start time in seconds (if available from timestamped transcript). */
+    startTime?: number;
+    /** End time in seconds (if available from timestamped transcript). */
+    endTime?: number;
+}
+/** A chunk with its embedding vector. */
+interface ChunkEmbedding {
+    /** Reference to the chunk ID. */
+    chunkId: string;
+    /** The embedding vector. */
+    embedding: number[];
+    /** Optional metadata for this chunk. */
+    metadata: {
+        startTime?: number;
+        endTime?: number;
+        tokenCount: number;
+    };
+}
+/** Result of generating embeddings for a video asset. */
+interface VideoEmbeddingsResult {
+    /** The Mux asset ID. */
+    assetId: string;
+    /** Individual chunk embeddings. */
+    chunks: ChunkEmbedding[];
+    /** Averaged embedding across all chunks. */
+    averagedEmbedding: number[];
+    /** AI provider used. */
+    provider: string;
+    /** Model used for embedding generation. */
+    model: string;
+    /** Additional metadata about the generation. */
+    metadata: {
+        totalChunks: number;
+        totalTokens: number;
+        chunkingStrategy: string;
+        embeddingDimensions: number;
+        generatedAt: string;
+    };
+}
+/**
+ * Token usage breakdown returned by AI SDK providers.
+ * Used for efficiency and cost analysis.
+ */
+interface TokenUsage {
+    /** Number of tokens in the input prompt (text + image). */
+    inputTokens?: number;
+    /** Number of tokens generated in the output. */
+    outputTokens?: number;
+    /** Total tokens consumed (input + output). */
+    totalTokens?: number;
+    /** Tokens used for chain-of-thought reasoning (if applicable). */
+    reasoningTokens?: number;
+    /** Input tokens served from cache (reduces cost). */
+    cachedInputTokens?: number;
+}
+
+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 };

package/dist/workflows/index.d.ts

@@ -1,8 +1,7 @@
-export { z as AudioTranslationOptions, A as AudioTranslationResult, e as BurnedInCaptionsAnalysis, c as BurnedInCaptionsOptions, b as BurnedInCaptionsPromptOverrides, a as BurnedInCaptionsPromptSections, B as BurnedInCaptionsResult, C as Chapter, l as ChaptersOptions, k as ChaptersResult, j as ChaptersType, E as EmbeddingsOptions, p as HiveModerationOutput, H as HiveModerationSource, q as ModerationOptions, o as ModerationProvider, M as ModerationResult, S as SUMMARY_KEYWORD_LIMIT, x as SummarizationOptions, w as SummarizationPromptOverrides, v as SummarizationPromptSections, u as SummaryAndTagsResult, t as SummaryType, T as ThumbnailModerationScore, G as TranslationOptions, J as TranslationPayload, F as TranslationResult, d as burnedInCaptionsSchema, f as chapterSchema, g as chaptersSchema, m as generateChapters, n as generateVideoEmbeddings, r as getModerationScores, y as getSummaryAndTags, h as hasBurnedInCaptions, s as summarySchema, D as translateAudio, K as translateCaptions, I as translationSchema } from '../index-D3fZHu0h.js';
+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-BdpEVCbj.js';
 import 'zod';
 import '@ai-sdk/anthropic';
 import '@ai-sdk/google';
 import '@ai-sdk/openai';
-import '../types-DzOQNn9R.js';
+import '../types-KcVfWtUl.js';
 import '@mux/mux-node';
-import 'node:buffer';