fix types

Author: maxstevens-nl

src/create-zero-composables.test.ts

@@ -3,8 +3,8 @@ import {
   createCRUDBuilder,
   createSchema,
   defineMutator,
-  defineMutators,
-  defineQueries,
+  defineMutatorsWithType,
+  defineQueriesWithType,
   defineQuery,
   number,
   string,
@@ -85,6 +85,7 @@ describe('createZeroComposables', () => {
 
   it('useQuery works whithout explicitly calling useZero', async () => {
     const crud = createCRUDBuilder(testSchema)
+    const defineMutators = defineMutatorsWithType<typeof testSchema>()
     const mutators = defineMutators({
       test: {
         insert: defineMutator(
@@ -108,6 +109,7 @@ describe('createZeroComposables', () => {
     await zero.mutate(mutators.test.insert({ id: 2, name: 'test2' })).client
 
     const zql = createBuilder(testSchema)
+    const defineQueries = defineQueriesWithType<typeof testSchema>()
     const queries = defineQueries({
       byId: defineQuery(
         z.number(),

src/query.test.ts

@@ -1,5 +1,17 @@
 import type { TTL } from '@rocicorp/zero'
-import { createBuilder, createCRUDBuilder, createSchema, defineMutator, defineMutators, defineQueries, defineQuery, number, string, table, Zero } from '@rocicorp/zero'
+import {
+  createBuilder,
+  createCRUDBuilder,
+  createSchema,
+  defineMutator,
+  defineMutatorsWithType,
+  defineQueriesWithType,
+  defineQuery,
+  number,
+  string,
+  table,
+  Zero,
+} from '@rocicorp/zero'
 import { describe, expect, it, onTestFinished, vi } from 'vitest'
 import { nextTick, ref, watchEffect } from 'vue'
 import z from 'zod'
@@ -22,6 +34,7 @@ async function setupTestEnvironment() {
   const userID = ref('asdf')
 
   const crud = createCRUDBuilder(schema)
+  const defineMutators = defineMutatorsWithType<typeof schema>()
   const mutators = defineMutators({
     table: {
       insert: defineMutator(
@@ -52,6 +65,7 @@ async function setupTestEnvironment() {
   await zero.value.mutate(mutators.table.insert({ a: 2, b: 'b' })).client
 
   const zql = createBuilder(schema)
+  const defineQueries = defineQueriesWithType<typeof schema>()
   const queries = defineQueries({
     byId: defineQuery(
       z.number(),
@@ -274,6 +288,7 @@ describe('useQuery', () => {
 
   it('can still be used without createZero', async () => {
     const crud = createCRUDBuilder(schema)
+    const defineMutators = defineMutatorsWithType<typeof schema>()
     const mutators = defineMutators({
       table: {
         insert: defineMutator(
@@ -295,6 +310,7 @@ describe('useQuery', () => {
     await zero.mutate(mutators.table.insert({ a: 2, b: 'b' })).client
 
     const zql = createBuilder(schema)
+    const defineQueries = defineQueriesWithType<typeof schema>()
     const queries = defineQueries({
       table: defineQuery(
         () => zql.table,

src/view.test.ts

@@ -6,8 +6,8 @@ import {
   createCRUDBuilder,
   createSchema,
   defineMutator,
-  defineMutators,
-  defineQueries,
+  defineMutatorsWithType,
+  defineQueriesWithType,
   defineQuery,
   number,
   relationships,
@@ -21,13 +21,6 @@ import z from 'zod'
 import { addContextToQuery } from './query'
 import { VueView, vueViewFactory } from './view'
 
-type AllSchemas = typeof simpleSchema & typeof collapseSchema & typeof treeSchema
-declare module '@rocicorp/zero' {
-  interface DefaultTypes {
-    schema: AllSchemas
-  }
-}
-
 const simpleSchema = createSchema({
   tables: [
     table('table')
@@ -40,7 +33,8 @@ const simpleSchema = createSchema({
 })
 
 function setupSimple() {
-  const crud = createCRUDBuilder<AllSchemas>(simpleSchema)
+  const crud = createCRUDBuilder(simpleSchema)
+  const defineMutators = defineMutatorsWithType<typeof simpleSchema>()
   const mutators = defineMutators({
     insert: defineMutator(
       z.object({ a: z.number(), b: z.string() }),
@@ -73,6 +67,7 @@ function setupSimple() {
   })
 
   const zql = createBuilder(simpleSchema)
+  const defineQueries = defineQueriesWithType<typeof simpleSchema>()
   const queries = defineQueries({
     table: defineQuery(() => zql.table),
   })
@@ -105,7 +100,8 @@ const treeSchema = createSchema({
 })
 
 function setupTree() {
-  const crud = createCRUDBuilder<AllSchemas>(treeSchema)
+  const crud = createCRUDBuilder(treeSchema)
+  const defineMutators = defineMutatorsWithType<typeof treeSchema>()
   const mutators = defineMutators({
     insert: defineMutator(
       z.object({ id: z.number(), name: z.string(), data: z.string().optional().nullable(), childID: z.number().nullable() }),
@@ -146,6 +142,7 @@ function setupTree() {
   })
 
   const zql = createBuilder(treeSchema)
+  const defineQueries = defineQueriesWithType<typeof treeSchema>()
   const queries = defineQueries({
     table: defineQuery(() => zql.tree.related('children')),
     one: defineQuery(() => zql.tree.related('children').one()),
@@ -211,6 +208,7 @@ function setupCollapse() {
   })
 
   const zql = createBuilder(collapseSchema)
+  const defineQueries = defineQueriesWithType<typeof collapseSchema>()
   const queries = defineQueries({
     issuesWithLabelsQuery: defineQuery(() => zql.issue.related('labels')),
   })
@@ -224,9 +222,7 @@ describe('vueView', () => {
   it('basics', async () => {
     const { zero, mutators, tableQuery } = setupSimple()
 
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.insert({ a: 1, b: 'a' })).client
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.insert({ a: 2, b: 'b' })).client
 
     const view = zero.materialize(
@@ -252,7 +248,6 @@ describe('vueView', () => {
     // TODO: Test with a real resolver
     // expect(view.status).toEqual("complete");
 
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.insert({ a: 3, b: 'c' })).client
 
     expect(view.data).toMatchInlineSnapshot(`
@@ -275,9 +270,7 @@ describe('vueView', () => {
     ]
   `)
 
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.delete({ a: 1 })).client
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.delete({ a: 2 })).client
 
     expect(view.data).toMatchInlineSnapshot(`
@@ -290,7 +283,6 @@ describe('vueView', () => {
     ]
   `)
 
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
     await zero.mutate(mutators.delete({ a: 3 })).client
 
     expect(view.data).toEqual([])
@@ -305,7 +297,6 @@ describe('vueView', () => {
     expect(view.data?.length).toBe(0)
 
     for (const i in [...Array.from({ length: iterations }).keys()]) {
-    // @ts-expect-error - We can't augment the zero instance with the schema, because we're using multiple schemas
       await zero.mutate(mutators.insert({ a: Number(i), b: 'a' })).client
     }
 

test/index.test.ts

@@ -1,4 +1,14 @@
-import { createBuilder, createCRUDBuilder, createSchema, defineMutator, defineMutators, defineQueries, defineQuery, string, table } from '@rocicorp/zero'
+import {
+  createBuilder,
+  createCRUDBuilder,
+  createSchema,
+  defineMutator,
+  defineMutatorsWithType,
+  defineQueriesWithType,
+  defineQuery,
+  string,
+  table,
+} from '@rocicorp/zero'
 import { describe, expect, it } from 'vitest'
 import z from 'zod'
 import { createZeroComposables } from '../src'
@@ -14,15 +24,10 @@ const schema = createSchema({
   tables: [user],
 })
 
-declare module '@rocicorp/zero' {
-  interface DefaultTypes {
-    schema: typeof schema
-  }
-}
-
 describe('zero-vue', () => {
   it('works', async () => {
     const crud = createCRUDBuilder(schema)
+    const defineMutators = defineMutatorsWithType<typeof schema>()
     const mutators = defineMutators({
       insert: defineMutator(
         z.object({ id: z.string(), name: z.string() }),
@@ -44,11 +49,12 @@ describe('zero-vue', () => {
     const zero = useZero()
 
     const zql = createBuilder(schema)
+    const defineQueries = defineQueriesWithType<typeof schema>()
     const queries = defineQueries({
       user: defineQuery(() => zql.user),
     })
 
-    const { data: users } = useQuery(queries.user)
+    const { data: users } = useQuery(queries.user())
 
     expect(users.value).toEqual([])