Skip to content

persistedCollectionOptions without a schema can't be passed to createCollection (follow-up to #1452) #2255

Open

Description

@stychu

Describe the bug

Wrapping a synced source that has no schema with persistedCollectionOptions fails to type-check when the schema type argument is left to inference. The result can't be passed to createCollection. That includes the Query Collection example in the SQLite persistence guide, as written.

Versions: @tanstack/db 0.15.2, @tanstack/browser-db-sqlite-persistence 0.2.37, TypeScript 7.0.2 (also reproduces on 5.9), strict mode. persisted.ts, types.ts and the collection source are unchanged on main at d2935d0.

To reproduce

import { createCollection, type CollectionConfig } from '@tanstack/db'
import {
  createBrowserWASQLitePersistence,
  persistedCollectionOptions,
  type BrowserWASQLiteDatabase,
} from '@tanstack/browser-db-sqlite-persistence'

type Todo = { id: string; title: string; completed: boolean }
declare const database: BrowserWASQLiteDatabase
const persistence = createBrowserWASQLitePersistence({ database })

const source: CollectionConfig<Todo, string> = {
  id: 'rows',
  getKey: (row) => row.id,
  sync: { sync: ({ markReady }) => markReady() },
}

// Fails with TS2769: No overload matches this call.
//   Types of property 'schema' are incompatible.
//   Type 'StandardSchemaV1<unknown, unknown> | undefined' is not assignable to type 'undefined'.
createCollection(
  persistedCollectionOptions({ ...source, persistence, schemaVersion: 1 }),
)

// Compiles:
createCollection(
  persistedCollectionOptions<Todo, string, never>({ ...source, persistence, schemaVersion: 1 }),
)

The guide's example (persistedCollectionOptions<Todo, string>({ ...queryCollectionOptions<Todo, string>({...}), persistence, schemaVersion: 1 })) fails the same way, with Type 'Todo' is not assignable to type 'undefined' on schema.

Expected behavior

A source without a schema should compose with createCollection without spelling out never, as the guide shows.

Notes

When the schema type isn't given, the sync-wrapped overload infers StandardSchemaV1<unknown, unknown> for it, and createCollection's no-schema overload rejects the result. #1866 fixed the schema case from #1452, but the no-schema case still fails. The type test in persisted.test-d.ts ("preserves sync-present utility typing") passes never explicitly, so the inferred form and the guide's example aren't covered. Adding them to the type tests, or passing never in the guide, would close the gap.

I found this while composing the Convex collection from #2230 with SQLite persistence. That PR is not the cause. It type-checks and runs once never and the adapter's utils type are passed explicitly.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions