fix type of default query

Author: devgioele

src/engine/pagination.ts

@@ -52,7 +52,7 @@ export const useAbstractQueryAndPagination = <
 >(
   router: Router,
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: TDefaultQuery,
+  defaultQuery: TDefaultQuery = {} as TDefaultQuery,
   defaultPagination?: Partial<PaginationQuery>,
   options?: Partial<AbstractQueryOptions>,
 ) => {

src/engine/query.ts

@@ -38,7 +38,7 @@ export type RouterSSR = Router & {
   isReady: boolean
 }
 
-export const useQuery = <T extends Query>(router: Router, defaultQuery: T) => {
+export const useQuery = (router: Router, defaultQuery: Query) => {
   const resetQuery = useCallback(() => {
     router.setQuery(defaultQuery, defaultQuery)
   }, [router, defaultQuery])
@@ -47,7 +47,7 @@ export const useQuery = <T extends Query>(router: Router, defaultQuery: T) => {
 
   return {
     query,
-    setQuery: (query: Partial<T>) => {
+    setQuery: (query: Query) => {
       router.setQuery(query, defaultQuery)
     },
     resetQuery,
@@ -81,7 +81,7 @@ export const useAbstractQuery = <
 >(
   router: Router,
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: TDefaultQuery,
+  defaultQuery: TDefaultQuery = {} as TDefaultQuery,
   options?: Partial<AbstractQueryOptions>,
 ) => {
   const mergedOptions = useMemo(

src/routers/__test__/nextRouter.test.ts

@@ -1,7 +1,7 @@
 import { act, renderHook } from '@testing-library/react'
 import router from 'next/router'
 import { z } from 'zod'
-import { vi } from 'vitest'
+import { expectTypeOf, vi } from 'vitest'
 import { useQuery, useQueryAndPagination } from '../../zod/routers/nextRouter'
 import { usePagination } from '../nextRouter'
 
@@ -82,11 +82,43 @@ describe('NextRouter', () => {
     })
 
     expect(result.current.query.search).toBe(search)
+    expectTypeOf(result.current.query.search).toEqualTypeOf<string>()
     expect(router.query.search).toBe(search)
     expect(result.current.page).toBe(0)
     expect(router.query.page).toBeUndefined()
   })
 
+  test('passing no default query should return query values that are possibly undefined', () => {
+    const { result: resultQueryAndPagination } = renderHook(() =>
+      useQueryAndPagination(searchSchema),
+    )
+    expectTypeOf(resultQueryAndPagination.current.query.search).toEqualTypeOf<
+      string | undefined
+    >()
+
+    const { result: resultQuery } = renderHook(() => useQuery(searchSchema))
+    expectTypeOf(resultQuery.current.query.search).toEqualTypeOf<
+      string | undefined
+    >()
+  })
+
+  test('passing a default query should return query values that are not undefined', () => {
+    const { result: resultQueryAndPagination } = renderHook(() =>
+      useQueryAndPagination(searchSchema, { search: '' }),
+    )
+    expectTypeOf(
+      resultQueryAndPagination.current.query.search,
+    ).toEqualTypeOf<string>()
+
+    const { result: resultQuery } = renderHook(() =>
+      useQuery(searchSchema, { search: '' }),
+    )
+    expectTypeOf(resultQuery.current.query.search).toEqualTypeOf<string>()
+
+    const { result: resultPagination } = renderHook(() => usePagination())
+    expectTypeOf(resultPagination.current.page).toEqualTypeOf<number>()
+  })
+
   test('change default parameters', () => {
     const page = 1
     const size = 10
@@ -261,6 +293,7 @@ describe('NextRouter', () => {
     })
 
     expect(result.current.query.search).toBe(search)
+    expectTypeOf(result.current.query.search).toEqualTypeOf<string>()
     expect(router.query.search).toBe(search)
   })
 
@@ -270,6 +303,9 @@ describe('NextRouter', () => {
     )
 
     expect(result.current.query.department).toBeUndefined()
+    expectTypeOf(result.current.query.department).toEqualTypeOf<
+      string | undefined
+    >()
   })
 
   test('the query should be a merge of the default query and the current query', () => {

src/routers/inMemory.ts

@@ -29,18 +29,24 @@ const useInMemoryRouter = (): Router => {
   }
 }
 
-export const useQuery = <TQuery extends AbstractQuery>(
+export const useQuery = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   options?: Partial<AbstractQueryOptions>,
 ) => {
   const router = useInMemoryRouter()
   return useAbstractQuery(router, parseQuery, defaultQuery, options)
 }
 
-export const useQueryAndPagination = <TQuery extends AbstractQuery>(
+export const useQueryAndPagination = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   defaultPagination?: Partial<PaginationQuery>,
   options?: Partial<AbstractQueryOptions>,
 ) => {

src/routers/nextRouter.ts

@@ -59,19 +59,25 @@ const useNextRouter = (
   }
 }
 
-export const useQuery = <TQuery extends AbstractQuery>(
+export const useQuery = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
 ) => {
   const router = useNextRouter(options)
   const result = useAbstractQuery(router, parseQuery, defaultQuery, options)
   return { ...result, queryIsReady: router.isReady }
 }
 
-export const useQueryAndPagination = <TQuery extends AbstractQuery>(
+export const useQueryAndPagination = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   defaultPagination?: Partial<PaginationQuery>,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
 ) => {

src/routers/reactRouter.ts

@@ -67,18 +67,24 @@ const useReactRouter = (
   }
 }
 
-export const useQuery = <TQuery extends AbstractQuery>(
+export const useQuery = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
 ) => {
   const router = useReactRouter(options)
   return useAbstractQuery(router, parseQuery, defaultQuery, options)
 }
 
-export const useQueryAndPagination = <TQuery extends AbstractQuery>(
+export const useQueryAndPagination = <
+  TQuery extends AbstractQuery,
+  TDefaultQuery extends Partial<TQuery>,
+>(
   parseQuery: ParseQuery<TQuery>,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   defaultPagination?: Partial<PaginationQuery>,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
 ) => {

src/zod/routers/nextRouter.ts

@@ -10,18 +10,25 @@ import { RouterWithHistoryOptions } from '../../routers/shared'
 export const useQuery = <
   TSchema extends z.ZodTypeAny,
   TQuery extends z.output<TSchema>,
+  TDefaultQuery extends Partial<TQuery>,
 >(
   schemaQuery: TSchema,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
-) => useQueryVanilla(zodParser(schemaQuery), defaultQuery, options)
+) =>
+  useQueryVanilla<TQuery, TDefaultQuery>(
+    zodParser(schemaQuery),
+    defaultQuery,
+    options,
+  )
 
 export const useQueryAndPagination = <
   TSchema extends z.ZodTypeAny,
   TQuery extends z.output<TSchema>,
+  TDefaultQuery extends Partial<TQuery>,
 >(
   schemaQuery: TSchema,
-  defaultQuery: Partial<TQuery> = {},
+  defaultQuery?: TDefaultQuery,
   defaultPagination?: Partial<PaginationQuery>,
   options?: Partial<AbstractQueryOptions & RouterWithHistoryOptions>,
 ) =>