Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/validator-jsdoc-rename.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@tanstack/ai': patch
'@tanstack/ai-persistence': patch
---

docs: use the non-deprecated `createServerFn().validator()` API in JSDoc examples (was the deprecated `.inputValidator()`)
4 changes: 2 additions & 2 deletions docs/media/generations.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ import { generateImage } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

export const generateImageFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string; threadId: string }) => data)
.validator((data: { prompt: string; threadId: string }) => data)
.handler(async ({ data }) => {
return generateImage({
adapter: openaiImage('gpt-image-2.5-flare'),
Expand Down Expand Up @@ -202,7 +202,7 @@ import { generateImage, toServerSentEventsResponse } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

export const generateImageStreamFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string; threadId: string }) => data)
.validator((data: { prompt: string; threadId: string }) => data)
.handler(({ data }) => {
return toServerSentEventsResponse(
generateImage({
Expand Down
4 changes: 2 additions & 2 deletions docs/media/transcription-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ import { generateTranscription } from '@tanstack/ai'
import { openaiTranscription } from '@tanstack/ai-openai'

export const transcribeFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
(data: { audio: string; language?: string; threadId: string }) => data,
)
.handler(async ({ data }) => {
Expand Down Expand Up @@ -166,7 +166,7 @@ import { generateTranscription, toServerSentEventsResponse } from '@tanstack/ai'
import { openaiTranscription } from '@tanstack/ai-openai'

export const transcribeStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
(data: { audio: string; language?: string; threadId: string }) => data,
)
.handler(({ data }) => {
Expand Down
4 changes: 2 additions & 2 deletions docs/media/video-generation-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ import { generateVideo, getVideoJobStatus } from '@tanstack/ai'
import { openaiVideo } from '@tanstack/ai-openai'

export const generateVideoFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string; threadId: string }) => data)
.validator((data: { prompt: string; threadId: string }) => data)
.handler(async ({ data }) => {
const adapter = openaiVideo('sora-2')
const { threadId } = data
Expand Down Expand Up @@ -141,7 +141,7 @@ import { generateVideo, toServerSentEventsResponse } from '@tanstack/ai'
import { openaiVideo } from '@tanstack/ai-openai'

export const generateVideoStreamFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string; threadId: string }) => data)
.validator((data: { prompt: string; threadId: string }) => data)
.handler(({ data }) => {
return toServerSentEventsResponse(
generateVideo({
Expand Down
6 changes: 3 additions & 3 deletions docs/persistence/generation-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ import type { ImageGenerateInput } from '@tanstack/ai-client'
const persistence = memoryPersistence()

export const generateImageFn = createServerFn({ method: 'POST' })
.inputValidator((data: ImageGenerateInput & { threadId: string }) => data)
.validator((data: ImageGenerateInput & { threadId: string }) => data)
.handler(({ data: { threadId, ...input } }) => {
if (typeof input.prompt !== 'string') {
throw new Error('This endpoint accepts text image prompts only.')
Expand Down Expand Up @@ -299,7 +299,7 @@ const hydrationSchema = z.object({
})

export const getImageHydrationFn = createServerFn({ method: 'GET' })
.inputValidator(z.string().min(1))
.validator(z.string().min(1))
.handler(async ({ data: threadId }) => {
// `getGenerationHydration` does no auth. Check the session here, the
// way you pass `authorize` to `reconstructGeneration`.
Expand All @@ -309,7 +309,7 @@ export const getImageHydrationFn = createServerFn({ method: 'GET' })
})

export const joinImageRunFn = createServerFn({ method: 'GET' })
.inputValidator(z.string().min(1))
.validator(z.string().min(1))
.handler(({ data: runId }) =>
// The same SSE envelope that `generateImageFn` returns, so one client-side
// decoder covers both.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/replayRunStream.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async function* joinImageRun({ data: runId }: { data: string }) {
}

// Serve it from a server function whose handler is the generator above
// (`createServerFn({ method: 'GET' }).inputValidator(...)`).
// (`createServerFn({ method: 'GET' }).validator(...)`).
```

NOTE: the example deliberately declares the generator separately instead of
Expand Down
2 changes: 1 addition & 1 deletion docs/transports/server-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import { openaiText } from "@tanstack/ai-openai";
import type { UIMessage } from "@tanstack/ai";

export const chatFn = createServerFn({ method: "POST" })
.inputValidator((data: { messages: Array<UIMessage>; threadId: string }) => data)
.validator((data: { messages: Array<UIMessage>; threadId: string }) => data)
.handler(({ data }) =>
toServerSentEventsResponse(
chat({
Expand Down
2 changes: 1 addition & 1 deletion examples/react/evaluate/src/lib/server-functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export type TicketEvaluateResult = EvaluateResult<typeof TICKET_QUESTIONS>
* each call site keeps the adapter's literal model type.
*/
export const evaluateTicketFn = createServerFn({ method: 'POST' })
.inputValidator((data: EvaluateInput) => {
.validator((data: EvaluateInput) => {
if (!data.ticket.trim()) throw new Error('Ticket text is required')
if (!isProvider(data.provider)) {
throw new Error(`Unknown provider: ${data.provider}`)
Expand Down
28 changes: 14 additions & 14 deletions examples/ts-react-chat/src/lib/server-fns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ function imagePersistenceMiddleware() {
// =============================================================================

export const generateImageFn = createServerFn({ method: 'POST' })
.inputValidator(imageGenerateInputSchema)
.validator(imageGenerateInputSchema)
.handler(async ({ data }) => {
return generateImage({
adapter: grokImage('grok-imagine-image'),
Expand All @@ -142,7 +142,7 @@ export const generateImageFn = createServerFn({ method: 'POST' })
})

export const generateSpeechFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
text: z.string(),
Expand Down Expand Up @@ -171,7 +171,7 @@ export const generateSpeechFn = createServerFn({ method: 'POST' })
})

export const transcribeFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
audio: z.string(),
Expand Down Expand Up @@ -203,7 +203,7 @@ export const transcribeFn = createServerFn({ method: 'POST' })
})

export const generateAudioFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
prompt: z.string(),
Expand Down Expand Up @@ -232,7 +232,7 @@ export const generateAudioFn = createServerFn({ method: 'POST' })
})

export const summarizeFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
text: z.string(),
Expand All @@ -252,7 +252,7 @@ export const summarizeFn = createServerFn({ method: 'POST' })
})

export const generateVideoFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
prompt: z.string(),
Expand Down Expand Up @@ -305,7 +305,7 @@ export const generateVideoFn = createServerFn({ method: 'POST' })
// =============================================================================

export const generateImageStreamFn = createServerFn({ method: 'POST' })
.inputValidator(imageGenerateInputSchema)
.validator(imageGenerateInputSchema)
.handler(({ data }) => {
// One run id for the durability log and the run record so join can replay
// exactly the run hydration reports.
Expand Down Expand Up @@ -357,7 +357,7 @@ const generationHydrationSchema = z.object({

/** Mount hydration for image `persistence: true` over a fetcher (no GET route). */
export const getImageHydrationFn = createServerFn({ method: 'GET' })
.inputValidator(z.string().min(1))
.validator(z.string().min(1))
.handler(async ({ data: threadId }) => {
// No auth in this single-user demo — gate on session in a multi-user app.
return generationHydrationSchema.parse(
Expand All @@ -371,13 +371,13 @@ export const getImageHydrationFn = createServerFn({ method: 'GET' })
* `generateImageStreamFn` does (see `chunksFromSseResponse` on the page).
*/
export const joinImageRunFn = createServerFn({ method: 'GET' })
.inputValidator(z.string().min(1))
.validator(z.string().min(1))
.handler(({ data: runId }) =>
toServerSentEventsResponse(replayRunStream(memoryStream({ runId }))),
)

export const generateSpeechStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
text: z.string(),
Expand Down Expand Up @@ -409,7 +409,7 @@ export const generateSpeechStreamFn = createServerFn({ method: 'POST' })
})

export const transcribeStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
audio: z.string(),
Expand Down Expand Up @@ -444,7 +444,7 @@ export const transcribeStreamFn = createServerFn({ method: 'POST' })
})

export const summarizeStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
text: z.string(),
Expand All @@ -469,7 +469,7 @@ export const summarizeStreamFn = createServerFn({ method: 'POST' })
})

export const generateVideoStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
z.object({
threadId: z.string().min(1),
prompt: z.string(),
Expand All @@ -495,7 +495,7 @@ export const generateVideoStreamFn = createServerFn({ method: 'POST' })
// =============================================================================

export const chatFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
(data: {
messages: Array<UIMessage>
threadId: string
Expand Down
2 changes: 1 addition & 1 deletion examples/ts-react-chat/src/lib/use-realtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { realtimeClientTools } from '@/lib/realtime-tools'
type Provider = 'openai' | 'elevenlabs' | 'gemini' | 'grok'

const getRealtimeTokenFn = createServerFn({ method: 'POST' })
.inputValidator((data: { provider: Provider; language?: string }) => {
.validator((data: { provider: Provider; language?: string }) => {
if (!data.provider) throw new Error('Provider is required')
return data
})
Expand Down
12 changes: 6 additions & 6 deletions examples/ts-react-media/src/lib/server-functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ function isWorldResolution(value: string): value is WorldResolution {
}

export const generateImageFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: MediaPrompt; model: string }) => {
.validator((data: { prompt: MediaPrompt; model: string }) => {
if (!hasPromptContent(data.prompt)) throw new Error('Prompt is required')
if (!data.model) throw new Error('Model is required')
return data
Expand Down Expand Up @@ -701,7 +701,7 @@ async function videoStreamForModel(
* through the UI.
*/
export const generateVideoFn = createServerFn({ method: 'POST' })
.inputValidator((data: VideoRequest) => {
.validator((data: VideoRequest) => {
if (!hasPromptContent(data.prompt)) throw new Error('Prompt is required')
if (!data.model) throw new Error('Model is required')
return data
Expand Down Expand Up @@ -736,7 +736,7 @@ interface Model3DRequest {
* the one request, so the browser runs no polling loop.
*/
export const generate3DModelFn = createServerFn({ method: 'POST' })
.inputValidator((data: Model3DRequest) => {
.validator((data: Model3DRequest) => {
if (!hasPromptContent(data.prompt)) throw new Error('Prompt is required')
if (!isModel3DModelId(data.model)) {
throw new Error(`Unknown 3D model: ${data.model}`)
Expand Down Expand Up @@ -938,7 +938,7 @@ function seedanceStream(data: SeedanceRequest): AsyncIterable<StreamChunk> {
* to poll with — the server does the waiting and reports status on the wire.
*/
export const generateSeedanceVideoFn = createServerFn({ method: 'POST' })
.inputValidator((data: SeedanceRequest) => {
.validator((data: SeedanceRequest) => {
if (!hasPromptContent(data.prompt)) throw new Error('Prompt is required')
if (!data.model) throw new Error('Model is required')
return data
Expand All @@ -956,7 +956,7 @@ interface LiveVideoRequest {
* client (`@reactor-team/js-sdk` or `@fal-ai/client`). There is no job URL.
*/
export const generateLiveVideoFn = createServerFn({ method: 'POST' })
.inputValidator((data: LiveVideoRequest) => {
.validator((data: LiveVideoRequest) => {
if (typeof data.prompt !== 'string' || data.prompt.trim().length === 0) {
throw new Error('Prompt is required')
}
Expand Down Expand Up @@ -1032,7 +1032,7 @@ const WORLDLABS_TIMEOUT_MS = 12 * 60 * 1000
* and waits until the Marble world is ready (about 5 minutes).
*/
export const generateWorldFn = createServerFn({ method: 'POST' })
.inputValidator((data: WorldRequest) => {
.validator((data: WorldRequest) => {
if (typeof data.prompt !== 'string' || data.prompt.trim().length === 0) {
throw new Error('Prompt is required')
}
Expand Down
2 changes: 1 addition & 1 deletion examples/ts-react-rerank/src/lib/server-functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function isCohereRerankModel(model: string): model is CohereRerankModel {
* inference.
*/
export const rerankDocumentsFn = createServerFn({ method: 'POST' })
.inputValidator((data: RerankInput) => {
.validator((data: RerankInput) => {
if (!data.query.trim()) throw new Error('Query is required')
if (!isProvider(data.provider)) {
throw new Error(`Unknown provider: ${data.provider}`)
Expand Down
2 changes: 1 addition & 1 deletion packages/ai-persistence/src/reconstruct-generation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ export interface GetGenerationHydrationOptions {
* ```
*
* Wire that body up as the server function's handler — build it with
* `createServerFn({ method: 'GET' })`, add an `inputValidator` that returns
* `createServerFn({ method: 'GET' })`, add a `validator` that returns
* the thread id, then hand it the function above. (The chained call is shown
* split apart on purpose: Start's server-fn plugin decides which modules to
* transform by scanning source text for that call, and a package whose shipped
Expand Down
6 changes: 3 additions & 3 deletions packages/ai/skills/ai-core/media-generation/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ import { openaiImage } from '@tanstack/ai-openai'
import type { OpenAIImageModel } from '@tanstack/ai-openai'

export const generateImageStreamFn = createServerFn({ method: 'POST' })
.inputValidator(
.validator(
(data: { prompt: string; model?: OpenAIImageModel; threadId: string }) =>
data,
)
Expand Down Expand Up @@ -1120,7 +1120,7 @@ import { generateImage } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

export const generateImageStreamFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string }) => data)
.validator((data: { prompt: string }) => data)
.handler(({ data }) => {
// BUG: returning raw stream -- client cannot parse this
// (also a type error: an AsyncIterable is not a valid server-function return)
Expand All @@ -1141,7 +1141,7 @@ import { generateImage, toServerSentEventsResponse } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

export const generateImageStreamFn = createServerFn({ method: 'POST' })
.inputValidator((data: { prompt: string }) => data)
.validator((data: { prompt: string }) => data)
.handler(({ data }) => {
return toServerSentEventsResponse(
generateImage({
Expand Down
2 changes: 1 addition & 1 deletion packages/ai/src/stream-durability.ts
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ export function memoryStream(
* }
*
* // Serve it from a server function whose handler is the generator above
* // (`createServerFn({ method: 'GET' }).inputValidator(...)`).
* // (`createServerFn({ method: 'GET' }).validator(...)`).
* ```
*
* NOTE: the example deliberately declares the generator separately instead of
Expand Down
Loading
Loading