CtrlK
BlogDocsLog inGet started
Tessl Logo

ai-persistence

Durability and state persistence for TanStack AI chats with @tanstack/ai-persistence. Routes to server chat persistence (withPersistence), client persistence (localStorage/IndexedDB), the store contracts, and adapter recipes. Distinguishes delivery durability (resumable streams) from conversation state. Use when conversations must survive reloads, multi-device, approvals, or server restarts — NOT for stream reconnect alone.

75

Quality

93%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Low

Low-risk findings worth noting

SKILL.md
Quality
Evals
Security

TanStack AI Persistence

Builds on the ai-core skill in @tanstack/ai, and usually ai-core/chat-experience.

TanStack AI splits delivery durability from state persistence. They share no code and solve different problems.

LayerAnswersPackage / API
Delivery durabilityReconnect to a stream still runningmemoryStream / @tanstack/ai-durable-stream on the response; see resumable streams docs
State persistenceWhat is the conversation, later?Client persistence on useChat + server withPersistence from @tanstack/ai-persistence

A replayable stream is not a saved conversation. A saved conversation is not a live stream. Production apps often use both.

Persistence is a contract, not a database

@tanstack/ai-persistence ships the store interfaces, the middleware that drives them, an in-memory reference backend, and a conformance testkit. It does not ship a backend for your database, and you do not need one: implement the stores against whatever you already run — Postgres, SQLite, D1, Mongo — and hand the result to withPersistence. The core never inspects your tables.

Ships in the packageWhat it is
MessageStore / RunStore / InterruptStore / MetadataStoreThe four state contracts
withPersistence / withGenerationPersistenceChat + generation middleware
memoryPersistence()In-process reference backend (dev, tests)
reconstructChatServer hydrate route helper
LockStore / withLocks / InMemoryLockStore (from @tanstack/ai/locks)Coordination, not this package — see ai-core/locks
@tanstack/ai-persistence/testkitrunPersistenceConformance compatibility gate

Sub-skills

Need to...Read
Wire server-side chat history, runs, interruptsai-persistence/server/SKILL.md
Survive reloads in the browserai-core/client-persistence/SKILL.md in @tanstack/ai
Implement the store interfaces for your DBai-persistence/stores/SKILL.md
Multi-instance locks (separate from state)ai-core/locks/SKILL.md in @tanstack/ai

Adding persistence to an app? Pick the recipe that matches what it already runs — each one writes a single chat-persistence.ts against the app's existing database client and schema:

The app runs...Read
Drizzle ORM (SQLite / Postgres / MySQL)ai-persistence/build-drizzle-adapter/SKILL.md
Prismaai-persistence/build-prisma-adapter/SKILL.md
Cloudflare Workers + D1 (± Durable Object locks)ai-persistence/build-cloudflare-adapter/SKILL.md
Anything else — raw pg, Kysely, SQLite, Mongoai-persistence/build-custom-adapter/SKILL.md

State persistence has two halves

HalfStoresSurvivesTypical use
Clienttranscript ± resume pointer in browser storagereload / tab close (per browser)SPA restore, offline-first
Servermessages, runs, interrupts, metadata in your DBrestart + multi-deviceauthoritative history, durable approvals

They are independent. Use either alone or both.

Identity: threadId and Scope

Server stores key on threadId (same as chat({ threadId }) / ChatMiddlewareContext.threadId / Scope.threadId from @tanstack/ai).

  • Store methods take bare threadId strings for adapter simplicity.
  • Multi-user isolation is your job: derive userId / tenantId from session server-side; authorize before load/save / reconstructChat.
  • Never treat a client-supplied thread id alone as ownership — ids are guessable.

Authoritative-history contract

When both halves run, ownership per turn is decided by request messages:

Client sendsMeaningOn finish
Non-empty messagesFull transcript (source of truth)Server overwrites stored thread
Empty messagesContinue from server copyServer loads stored thread

Never post a delta as messages — that wipes history down to the delta.

Client-authoritative: always send full transcript; browser is truth, server mirrors.
Server-authoritative: send empty messages (or hydrate via server load); server is truth, multi-device works.

Recommended production stack

  1. Client: persistence: true — server-authoritative, no client cache.
  2. Server: withPersistence(backend) — messages + runs + interrupts.
  3. Route: delivery durability if mid-stream reconnect matters.
  4. Optional: withLocks(distributedLockStore) from @tanstack/ai/locks when other middleware needs multi-instance coordination (not part of the state bag).

Minimal end-to-end sketch

Server

import {
  chat,
  chatParamsFromRequest,
  toServerSentEventsResponse,
} from '@tanstack/ai'
import { openaiText } from '@tanstack/ai-openai'
import { withPersistence } from '@tanstack/ai-persistence'
// Your adapter — see ai-persistence/stores.
import { persistence } from './persistence'

export async function POST(request: Request) {
  const params = await chatParamsFromRequest(request)
  const stream = chat({
    adapter: openaiText('gpt-5.5'),
    messages: params.messages,
    threadId: params.threadId,
    runId: params.runId,
    ...(params.resume ? { resume: params.resume } : {}),
    middleware: [withPersistence(persistence)],
  })
  return toServerSentEventsResponse(stream)
}

Client (server-authoritative)

import { useChat, fetchServerSentEvents } from '@tanstack/ai-react'

function Chat({ threadId }: { threadId: string }) {
  const { messages, sendMessage } = useChat({
    threadId,
    connection: fetchServerSentEvents('/api/chat'),
    persistence: true,
  })
  // ...
}

With persistence: true, the client caches nothing and hydrates the transcript from the server on mount (thread id is the key). Pair with a server load path such as reconstructChat for the GET.

Critical rules

  1. Not Vercel AI SDK. Persistence is @tanstack/ai-persistence + middleware, not Vercel useChat storage hacks.
  2. saveThread is full overwrite, never append.
  3. createOrResume is insert-if-absent for the same runId.
  4. Interrupt create is insert-if-absent — never clobber resolved → pending.
  5. Locks ≠ state. Import withLocks from @tanstack/ai/locks. Sandbox resume is a sandbox-package concern — not a stores key. stores accepts only messages, runs, interrupts, metadata.
  6. You own the schema. No package invents migrations for you.
  7. Run the conformance testkit against any adapter you write.
  8. Authorize thread access at the route boundary.

Cross-references

  • ai-core/chat-experience (@tanstack/ai) — useChat, SSE, client persistence option overview
  • ai-core/middleware (@tanstack/ai) — middleware hooks; withPersistence is a ChatMiddleware
  • Resumable streams docs — delivery durability only
Repository
TanStack/ai
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.