@tanstack/ai-persistence/src/index.ts

Composable state persistence for TanStack AI messages, runs, interrupts, metadata, and locks.

// Store contracts + named chat shapes
export {
  composePersistence,
  defineAIPersistence,
  defineMessageStore,
  defineRunStore,
  defineInterruptStore,
  defineMetadataStore,
  defineGenerationRunStore,
  defineArtifactStore,
  defineBlobStore,
  // Run lifecycle helpers owned by @tanstack/ai, transiting through ./types so
  // this package's public surface stays a single import for backend authors.
  isTerminalRunStatus,
} from './types'
export type {
  MessageStore,
  RunStatus,
  TerminalRunStatus,
  RunRecord,
  RunStore,
  InterruptCommitEntry,
  InterruptRecord,
  InterruptStatus,
  InterruptStore,
  MetadataStore,
  // Named product shapes (prefer these over a sparse bag)
  ChatTranscriptStores,
  ChatPersistenceStores,
  ChatWithInterruptsStores,
  ChatTranscriptPersistence,
  ChatPersistence,
  ChatWithInterruptsPersistence,
  // Generation run store contract
  GenerationRunStatus,
  GenerationRunRecord,
  GenerationRunStore,
  // Generation artifact + blob store contracts
  ArtifactRecord,
  ArtifactStore,
  BlobBody,
  BlobRecord,
  BlobObject,
  BlobListPage,
  BlobPutOptions,
  BlobGetOptions,
  BlobRange,
  BlobListOptions,
  BlobStore,
  AIPersistence,
  AIPersistenceOverrides,
  ComposedAIPersistenceStores,
  // Shared conversation identity from @tanstack/ai. Stores key on
  // Scope.threadId; authorize multi-user access with Scope.userId/tenantId.
  Scope,
} from './types'
export type { PersistenceCompletion } from './capabilities'
// AIPersistenceStores is intentionally NOT re-exported — use a named chat
// shape or AIPersistence<{ messages: MessageStore, … }>.

// Core artifact wire types (re-exported for convenience)
export type {
  PersistedArtifactActivity,
  PersistedArtifactRef,
  PersistedArtifactRole,
} from '@tanstack/ai'

// Middleware (chat state — locks live in @tanstack/ai as withLocks)
export { withPersistence, withGenerationPersistence } from './middleware'
export type {
  WithPersistenceOptions,
  WithGenerationPersistenceOptions,
  ArtifactPersistenceOptions,
  GenerationArtifactDescriptor,
  GenerationArtifactExtractionInput,
  GenerationArtifactNameInput,
} from './middleware'

// Server helper: rehydrate a thread's messages for a client load
export { reconstructChat } from './reconstruct'
export type { ReconstructChatOptions } from './reconstruct'

// Server helper: rehydrate the last generation job for a client load
export {
  reconstructGeneration,
  getGenerationHydration,
} from './reconstruct-generation'
export type {
  ReconstructedGeneration,
  ReconstructGenerationOptions,
  GetGenerationHydrationOptions,
} from './reconstruct-generation'

// Server helpers: retrieve a persisted generation artifact + its bytes
export {
  retrieveArtifact,
  retrieveBlob,
  resolveArtifactBlobKey,
} from './retrieve'

// Byte-range helpers: parse a `Range` header (routes), clamp a range to an
// object's real size (store authors)
export { parseRangeHeader, resolveBlobRange } from './blob-range'

// Reference in-memory implementation
export { memoryPersistence } from './memory'

// Persistence-owned capabilities only. Locks: @tanstack/ai.
export {
  PersistenceCapability,
  InterruptsCapability,
  getPersistence,
  providePersistence,
  getInterrupts,
  provideInterrupts,
  PersistenceCompletionCapability,
  getPersistenceCompletion,
  providePersistenceCompletion,
} from './capabilities'