import { useGeneration } from './use-generation' import { reconstructAudioResult } from '@tanstack/ai-client' import type { UseGenerationOptions, UseGenerationReturn, } from './use-generation' import type { AudioGenerationResult, StreamChunk } from '@tanstack/ai' import type { AIDevtoolsDisplayOptions, AudioGenerateInput, ConnectConnectionAdapter, GenerationClientState, GenerationFetcher, GenerationPersistenceOptions, InferGenerationOutputFromReturn, } from '@tanstack/ai-client' import type { Accessor } from 'solid-js' /** * Options for the useGenerateAudio hook. * * @template TOutput - The transformed output type (defaults to AudioGenerationResult) */ export interface UseGenerateAudioOptions< TOutput = AudioGenerationResult, > extends Pick< UseGenerationOptions, | 'persistence' | 'threadId' | 'hydrateGeneration' | 'joinRun' | 'byok' | 'byokProvider' > { /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */ connection?: ConnectConnectionAdapter /** Direct async function for audio generation */ fetcher?: GenerationFetcher /** Additional body parameters to send with connect-based adapter requests */ body?: Record /** Display options for TanStack AI Devtools. */ devtools?: AIDevtoolsDisplayOptions /** * Callback when audio is generated. Can optionally return a transformed value. * * - Return a non-null value to transform and store it as the result * - Return `null` to keep the previous result unchanged * - Return nothing (`void`) to store the raw result as-is */ onResult?: (result: AudioGenerationResult) => TOutput | null | void /** Callback when an error occurs */ onError?: (error: Error) => void /** Callback when progress is reported (0-100) */ onProgress?: (progress: number, message?: string) => void /** Callback for each stream chunk (connect-based adapter mode only) */ onChunk?: (chunk: StreamChunk) => void } /** * Return type for the useGenerateAudio hook. * * @template TOutput - The transformed output type (defaults to AudioGenerationResult) */ export interface UseGenerateAudioReturn< TOutput = AudioGenerationResult, > extends Omit, 'generate'> { /** Trigger audio generation */ generate: (input: AudioGenerateInput) => Promise /** The generation result containing audio, or null */ result: Accessor /** Whether generation is in progress */ isLoading: Accessor /** Current error, if any */ error: Accessor /** Current state of the generation */ status: Accessor } /** * Solid hook for generating audio (music, sound effects) using AI models. * * @example * ```tsx * import { useGenerateAudio } from '@tanstack/ai-solid' * import { fetchServerSentEvents } from '@tanstack/ai-client' * * function AudioGenerator() { * const { generate, result, isLoading } = useGenerateAudio({ * connection: fetchServerSentEvents('/api/generate/audio'), * }) * * return ( *
* * {result()?.audio.url &&
* ) * } * ``` */ export function useGenerateAudio( options: Omit< UseGenerateAudioOptions, 'onResult' | 'persistence' | 'threadId' > & { onResult?: (result: AudioGenerationResult) => TTransformed } & GenerationPersistenceOptions, ): UseGenerateAudioReturn< InferGenerationOutputFromReturn > { const devtools = { ...options.devtools, framework: 'solid', hookName: 'useGenerateAudio', outputKind: 'audio' as const, } const generation = useGeneration< AudioGenerateInput, AudioGenerationResult, TTransformed >({ ...options, devtools, reconstructResult: reconstructAudioResult, }) return generation }