fix: arktype schemas (#279)

Co-authored-by: Kyle Mathews <mathews.kyle@gmail.com>

Author: mckamyk

.changeset/chubby-ties-pump.md

@@ -0,0 +1,5 @@
+---
+"@tanstack/db": patch
+---
+
+fix arktype schemas for collections

packages/db/package.json

@@ -7,7 +7,8 @@
     "@standard-schema/spec": "^1.0.0"
   },
   "devDependencies": {
-    "@vitest/coverage-istanbul": "^3.0.9"
+    "@vitest/coverage-istanbul": "^3.0.9",
+    "arktype": "^2.1.20"
   },
   "exports": {
     ".": {

packages/db/src/collection.ts

@@ -1,7 +1,8 @@
 import { withArrayChangeTracking, withChangeTracking } from "./proxy"
-import { createTransaction, getActiveTransaction } from "./transactions"
 import { SortedMap } from "./SortedMap"
+import { createTransaction, getActiveTransaction } from "./transactions"
 import type { Transaction } from "./transactions"
+import type { StandardSchemaV1 } from "@standard-schema/spec"
 import type {
   ChangeListener,
   ChangeMessage,
@@ -19,7 +20,6 @@ import type {
   TransactionWithMutations,
   UtilsRecord,
 } from "./types"
-import type { StandardSchemaV1 } from "@standard-schema/spec"
 
 // Store collections in memory
 export const collectionsStore = new Map<string, CollectionImpl<any, any, any>>()
@@ -1242,7 +1242,7 @@ export class CollectionImpl<
 
   private ensureStandardSchema(schema: unknown): StandardSchema<T> {
     // If the schema already implements the standard-schema interface, return it
-    if (schema && typeof schema === `object` && `~standard` in schema) {
+    if (schema && `~standard` in (schema as {})) {
       return schema as StandardSchema<T>
     }
 

packages/db/tests/collection.test.ts

@@ -1,5 +1,6 @@
-import { describe, expect, expectTypeOf, it, vi } from "vitest"
+import { type } from "arktype"
 import mitt from "mitt"
+import { describe, expect, expectTypeOf, it, vi } from "vitest"
 import { z } from "zod"
 import { SchemaValidationError, createCollection } from "../src/collection"
 import { createTransaction } from "../src/transactions"
@@ -956,6 +957,99 @@ describe(`Collection`, () => {
 })
 
 describe(`Collection with schema validation`, () => {
+  it(`should validate data against arktype schema on insert`, () => {
+    // Create a Zod schema for a user
+    const userSchema = type({
+      name: `string > 0`,
+      age: `number.integer > 0`,
+      "email?": `string.email`,
+    })
+
+    // Create a collection with the schema
+    const collection = createCollection<typeof userSchema.infer>({
+      id: `test`,
+      getKey: (item) => item.name,
+      startSync: true,
+      sync: {
+        sync: ({ begin, commit }) => {
+          begin()
+          commit()
+        },
+      },
+      schema: userSchema,
+    })
+    const mutationFn = async () => {}
+
+    // Valid data should work
+    const validUser = {
+      name: `Alice`,
+      age: 30,
+      email: `alice@example.com`,
+    }
+
+    const tx1 = createTransaction({ mutationFn })
+    tx1.mutate(() => collection.insert(validUser))
+
+    // Invalid data should throw SchemaValidationError
+    const invalidUser = {
+      name: ``, // Empty name (fails min length)
+      age: -5, // Negative age (fails positive)
+      email: `not-an-email`, // Invalid email
+    }
+
+    try {
+      const tx2 = createTransaction({ mutationFn })
+      tx2.mutate(() => collection.insert(invalidUser))
+      // Should not reach here
+      expect(true).toBe(false)
+    } catch (error) {
+      expect(error).toBeInstanceOf(SchemaValidationError)
+      if (error instanceof SchemaValidationError) {
+        expect(error.type).toBe(`insert`)
+        expect(error.issues.length).toBeGreaterThan(0)
+        // Check that we have validation errors for each invalid field
+        expect(error.issues.some((issue) => issue.path?.includes(`name`))).toBe(
+          true
+        )
+        expect(error.issues.some((issue) => issue.path?.includes(`age`))).toBe(
+          true
+        )
+        expect(
+          error.issues.some((issue) => issue.path?.includes(`email`))
+        ).toBe(true)
+      }
+    }
+
+    // Partial updates should work with valid data
+    const tx3 = createTransaction({ mutationFn })
+    tx3.mutate(() =>
+      collection.update(`Alice`, (draft) => {
+        draft.age = 31
+      })
+    )
+
+    // Partial updates should fail with invalid data
+    try {
+      const tx4 = createTransaction({ mutationFn })
+      tx4.mutate(() =>
+        collection.update(`Alice`, (draft) => {
+          draft.age = -1
+        })
+      )
+      // Should not reach here
+      expect(true).toBe(false)
+    } catch (error) {
+      expect(error).toBeInstanceOf(SchemaValidationError)
+      if (error instanceof SchemaValidationError) {
+        expect(error.type).toBe(`update`)
+        expect(error.issues.length).toBeGreaterThan(0)
+        expect(error.issues.some((issue) => issue.path?.includes(`age`))).toBe(
+          true
+        )
+      }
+    }
+  })
+
   it(`should validate data against schema on insert`, () => {
     // Create a Zod schema for a user
     const userSchema = z.object({

packages/query-db-collection/src/query.ts

@@ -265,7 +265,6 @@ export function queryCollectionOptions<
     throw new Error(`[QueryCollection] queryClient must be provided.`)
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (!getKey) {
     throw new Error(`[QueryCollection] getKey must be provided.`)
   }