@orpc/react 0.0.4 → 0.0.5

package/src/general-hooks.ts

@@ -1,5 +1,6 @@
 import type { Schema, SchemaInput, SchemaOutput } from '@orpc/contract'
 import type { PartialDeep, SetOptional } from '@orpc/shared'
+import type { ORPCQueryFilters } from './tanstack-query'
 import {
   type DefaultError,
   type Mutation,
@@ -11,19 +12,18 @@ import {
 } from '@tanstack/react-query'
 import { type ORPCContext, useORPCContext } from './react-context'
 import { getMutationKeyFromPath, getQueryKeyFromPath } from './tanstack-key'
-import type { ORPCQueryFilters } from './tanstack-query'
 
 export interface GeneralHooks<
   TInputSchema extends Schema,
   TOutputSchema extends Schema,
   THandlerOutput extends SchemaOutput<TOutputSchema>,
 > {
-  useIsFetching(
+  useIsFetching: (
     filers?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
-  ): number
-  useIsMutating(filters?: SetOptional<MutationFilters, 'mutationKey'>): number
+  ) => number
+  useIsMutating: (filters?: SetOptional<MutationFilters, 'mutationKey'>) => number
 
-  useMutationState<
+  useMutationState: <
     UResult = MutationState<
       SchemaOutput<TOutputSchema, THandlerOutput>,
       DefaultError,
@@ -38,7 +38,8 @@ export interface GeneralHooks<
         SchemaInput<TInputSchema>
       >,
     ) => UResult
-  }): UResult[]
+  }
+  ) => UResult[]
 }
 
 export interface CreateGeneralHooksOptions {
@@ -56,7 +57,7 @@ export function createGeneralHooks<
   TInputSchema extends Schema = undefined,
   TOutputSchema extends Schema = undefined,
   THandlerOutput extends
-    SchemaOutput<TOutputSchema> = SchemaOutput<TOutputSchema>,
+  SchemaOutput<TOutputSchema> = SchemaOutput<TOutputSchema>,
 >(
   options: CreateGeneralHooksOptions,
 ): GeneralHooks<TInputSchema, TOutputSchema, THandlerOutput> {

package/src/general-utils.test-d.ts

@@ -2,17 +2,17 @@ import type { SchemaOutput } from '@orpc/contract'
 import type { Promisable } from '@orpc/shared'
 import type { InfiniteData } from '@tanstack/react-query'
 import {
+  queryClient,
   type UserCreateInputSchema,
   type UserFindInputSchema,
   type UserListInputSchema,
   type UserListOutputSchema,
   type UserSchema,
-  queryClient,
 } from '../tests/orpc'
 import { createGeneralUtils } from './general-utils'
 
 const user_utils = createGeneralUtils({
-  queryClient: queryClient,
+  queryClient,
   path: ['user'],
 })
 
@@ -21,7 +21,7 @@ const user_find_utils = createGeneralUtils<
   typeof UserSchema,
   SchemaOutput<typeof UserSchema>
 >({
-  queryClient: queryClient,
+  queryClient,
   path: ['user', 'find'],
 })
 
@@ -30,7 +30,7 @@ const user_list_utils = createGeneralUtils<
   typeof UserListOutputSchema,
   SchemaOutput<typeof UserListOutputSchema>
 >({
-  queryClient: queryClient,
+  queryClient,
   path: ['user', 'list'],
 })
 
@@ -39,7 +39,7 @@ const user_create_utils = createGeneralUtils<
   typeof UserSchema,
   SchemaOutput<typeof UserSchema>
 >({
-  queryClient: queryClient,
+  queryClient,
   path: ['user', 'create'],
 })
 
@@ -121,9 +121,9 @@ describe('setInfiniteQueriesData', () => {
     user_list_utils.setInfiniteQueriesData({}, (old) => {
       expectTypeOf(old).toEqualTypeOf<
         | InfiniteData<
-            SchemaOutput<typeof UserListOutputSchema>,
+          SchemaOutput<typeof UserListOutputSchema>,
             number | undefined
-          >
+        >
         | undefined
       >()
 

package/src/general-utils.test.tsx

@@ -1,11 +1,4 @@
 import type { SchemaOutput } from '@orpc/contract'
-import {
-  QueryClient,
-  useInfiniteQuery,
-  useMutation,
-  useQuery,
-} from '@tanstack/react-query'
-import { renderHook } from '@testing-library/react'
 import type {
   UserCreateInputSchema,
   UserFindInputSchema,
@@ -13,6 +6,13 @@ import type {
   UserListOutputSchema,
   UserSchema,
 } from '../tests/orpc'
+import {
+  QueryClient,
+  useInfiniteQuery,
+  useMutation,
+  useQuery,
+} from '@tanstack/react-query'
+import { renderHook } from '@testing-library/react'
 import { createGeneralUtils } from './general-utils'
 
 let qc = new QueryClient()
@@ -299,8 +299,8 @@ describe('refetch', () => {
   const infiniteQueryKey = [['user', 'list'], { type: 'infinite' }]
   const queryKey = [['user', 'list'], { type: 'query' }]
 
-  const fn1 = vi.fn(() => new Promise((resolve) => setTimeout(resolve, 100)))
-  const fn2 = vi.fn(() => new Promise((resolve) => setTimeout(resolve, 100)))
+  const fn1 = vi.fn(() => new Promise(resolve => setTimeout(resolve, 100)))
+  const fn2 = vi.fn(() => new Promise(resolve => setTimeout(resolve, 100)))
 
   beforeEach(() => {
     fn1.mockClear()
@@ -321,7 +321,7 @@ describe('refetch', () => {
     renderHook(() =>
       useQuery(
         {
-          queryKey: queryKey,
+          queryKey,
           queryFn: fn2,
         },
         qc,
@@ -338,7 +338,7 @@ describe('refetch', () => {
     expect(fn1).toHaveBeenCalledTimes(1)
     expect(fn2).toHaveBeenCalledTimes(1)
 
-    await new Promise((resolve) => setTimeout(resolve, 101))
+    await new Promise(resolve => setTimeout(resolve, 101))
     user_utils.refetch()
 
     expect(fn1).toHaveBeenCalledTimes(2)
@@ -350,7 +350,7 @@ describe('refetch', () => {
     expect(fn1).toHaveBeenCalledTimes(1)
     expect(fn2).toHaveBeenCalledTimes(1)
 
-    await new Promise((resolve) => setTimeout(resolve, 101))
+    await new Promise(resolve => setTimeout(resolve, 101))
     user_utils.refetch({ queryType: 'query' })
 
     expect(fn1).toHaveBeenCalledTimes(1)
@@ -363,7 +363,7 @@ describe('refetch', () => {
     expect(fn1).toHaveBeenCalledTimes(1)
     expect(fn2).toHaveBeenCalledTimes(1)
 
-    await new Promise((resolve) => setTimeout(resolve, 101))
+    await new Promise(resolve => setTimeout(resolve, 101))
     user_list_utils.refetch()
 
     expect(fn1).toHaveBeenCalledTimes(2)
@@ -376,7 +376,7 @@ describe('refetch', () => {
     expect(fn1).toHaveBeenCalledTimes(1)
     expect(fn2).toHaveBeenCalledTimes(1)
 
-    await new Promise((resolve) => setTimeout(resolve, 101))
+    await new Promise(resolve => setTimeout(resolve, 101))
     user_list_utils.refetch({ queryType: 'infinite' })
 
     expect(fn1).toHaveBeenCalledTimes(2)
@@ -389,7 +389,7 @@ describe('refetch', () => {
     expect(fn1).toHaveBeenCalledTimes(1)
     expect(fn2).toHaveBeenCalledTimes(1)
 
-    await new Promise((resolve) => setTimeout(resolve, 101))
+    await new Promise(resolve => setTimeout(resolve, 101))
     user_find_utils.refetch()
 
     expect(fn1).toHaveBeenCalledTimes(1)
@@ -407,7 +407,7 @@ describe('cancel', () => {
         {
           queryKey: infiniteQueryKey,
           queryFn: async () =>
-            await new Promise((resolve) => setTimeout(resolve, 100)),
+            await new Promise(resolve => setTimeout(resolve, 100)),
           getNextPageParam: () => 2,
           initialPageParam: 1,
         },
@@ -418,9 +418,9 @@ describe('cancel', () => {
     renderHook(() =>
       useQuery(
         {
-          queryKey: queryKey,
+          queryKey,
           queryFn: async () =>
-            await new Promise((resolve) => setTimeout(resolve, 100)),
+            await new Promise(resolve => setTimeout(resolve, 100)),
         },
         qc,
       ),
@@ -516,8 +516,8 @@ describe('reset', () => {
   const infiniteQueryKey = [['user', 'list'], { type: 'infinite' }]
   const queryKey = [['user', 'list'], { type: 'query' }]
 
-  const fn1 = vi.fn(() => new Promise((resolve) => setTimeout(resolve, 100)))
-  const fn2 = vi.fn(() => new Promise((resolve) => setTimeout(resolve, 100)))
+  const fn1 = vi.fn(() => new Promise(resolve => setTimeout(resolve, 100)))
+  const fn2 = vi.fn(() => new Promise(resolve => setTimeout(resolve, 100)))
 
   beforeEach(() => {
     fn1.mockClear()
@@ -538,7 +538,7 @@ describe('reset', () => {
     renderHook(() =>
       useQuery(
         {
-          queryKey: queryKey,
+          queryKey,
           queryFn: fn2,
         },
         qc,
@@ -594,7 +594,7 @@ it('isFetching', () => {
       {
         queryKey: infiniteQueryKey,
         queryFn: async () =>
-          await new Promise((resolve) => setTimeout(resolve, 100)),
+          await new Promise(resolve => setTimeout(resolve, 100)),
         getNextPageParam: () => 2,
         initialPageParam: 1,
       },
@@ -605,9 +605,9 @@ it('isFetching', () => {
   renderHook(() =>
     useQuery(
       {
-        queryKey: queryKey,
+        queryKey,
         queryFn: async () =>
-          await new Promise((resolve) => setTimeout(resolve, 100)),
+          await new Promise(resolve => setTimeout(resolve, 100)),
       },
       qc,
     ),
@@ -630,7 +630,7 @@ it('isMutating', async () => {
     useMutation(
       {
         mutationKey: [['user', 'create']],
-        mutationFn: () => new Promise((resolve) => setTimeout(resolve, 100)),
+        mutationFn: () => new Promise(resolve => setTimeout(resolve, 100)),
       },
       qc,
     ),

package/src/general-utils.ts

@@ -16,41 +16,39 @@ import type {
   SetDataOptions,
   Updater,
 } from '@tanstack/react-query'
-import { getMutationKeyFromPath, getQueryKeyFromPath } from './tanstack-key'
 import type {
   ORPCInvalidateQueryFilters,
   ORPCQueryFilters,
 } from './tanstack-query'
 import type { SchemaInputForInfiniteQuery } from './types'
+import { getMutationKeyFromPath, getQueryKeyFromPath } from './tanstack-key'
 
 export interface GeneralUtils<
   TInputSchema extends Schema,
   TOutputSchema extends Schema,
   THandlerOutput extends SchemaOutput<TOutputSchema>,
 > {
-  getQueriesData(
+  getQueriesData: (
     filters?: OmitKeyof<
       ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
       'queryType'
     >,
-  ): [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
-  getInfiniteQueriesData(
+  ) => [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
+  getInfiniteQueriesData: (
     filters?: OmitKeyof<
       ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
       'queryType'
     >,
-  ): [
+  ) => [
     QueryKey,
-    (
-      | InfiniteData<
-          SchemaOutput<TOutputSchema, THandlerOutput>,
-          SchemaInput<TInputSchema>['cursor']
-        >
-      | undefined
-    ),
+    | undefined
+    | InfiniteData<
+      SchemaOutput<TOutputSchema, THandlerOutput>,
+      SchemaInput<TInputSchema>['cursor']
+    >,
   ][]
 
-  setQueriesData(
+  setQueriesData: (
     filters: OmitKeyof<
       ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
       'queryType'
@@ -60,78 +58,76 @@ export interface GeneralUtils<
       SchemaOutput<TOutputSchema, THandlerOutput> | undefined
     >,
     options?: SetDataOptions,
-  ): [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
-  setInfiniteQueriesData(
+  ) => [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
+  setInfiniteQueriesData: (
     filters: OmitKeyof<
       ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
       'queryType'
     >,
     updater: Updater<
       | InfiniteData<
-          SchemaOutput<TOutputSchema, THandlerOutput>,
-          SchemaInput<TInputSchema>['cursor']
-        >
+        SchemaOutput<TOutputSchema, THandlerOutput>,
+        SchemaInput<TInputSchema>['cursor']
+      >
       | undefined,
       | InfiniteData<
-          SchemaOutput<TOutputSchema, THandlerOutput>,
-          SchemaInput<TInputSchema>['cursor']
-        >
+        SchemaOutput<TOutputSchema, THandlerOutput>,
+        SchemaInput<TInputSchema>['cursor']
+      >
       | undefined
     >,
     options?: SetDataOptions,
-  ): [
+  ) => [
     QueryKey,
-    (
-      | InfiniteData<
-          SchemaOutput<TOutputSchema, THandlerOutput>,
-          SchemaInput<TInputSchema>['cursor']
-        >
-      | undefined
-    ),
+    | undefined
+    | InfiniteData<
+      SchemaOutput<TOutputSchema, THandlerOutput>,
+      SchemaInput<TInputSchema>['cursor']
+    >,
   ][]
 
-  invalidate(
+  invalidate: (
     filters?: ORPCInvalidateQueryFilters<
       PartialDeep<SchemaInput<TInputSchema>>
     >,
     options?: InvalidateOptions,
-  ): Promise<void>
-  refetch(
+  ) => Promise<void>
+  refetch: (
     filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
     options?: RefetchOptions,
-  ): Promise<void>
-  cancel(
+  ) => Promise<void>
+  cancel: (
     filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
     options?: CancelOptions,
-  ): Promise<void>
-  remove(
+  ) => Promise<void>
+  remove: (
     filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
-  ): void
-  reset(
+  ) => void
+  reset: (
     filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
     options?: ResetOptions,
-  ): Promise<void>
+  ) => Promise<void>
 
-  isFetching(
+  isFetching: (
     filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
-  ): number
-  isMutating(filters?: SetOptional<MutationFilters, 'mutationKey'>): number
+  ) => number
+  isMutating: (filters?: SetOptional<MutationFilters, 'mutationKey'>) => number
 
-  getQueryDefaults(
+  getQueryDefaults: (
     filters?: Pick<
       ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
       'input' | 'queryKey'
     >,
-  ): OmitKeyof<
+  ) => OmitKeyof<
     QueryObserverOptions<SchemaOutput<TOutputSchema, THandlerOutput>>,
     'queryKey'
   >
-  getInfiniteQueryDefaults(
+  getInfiniteQueryDefaults: (
     filters?: Pick<
       ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
       'input' | 'queryKey'
     >,
-  ): OmitKeyof<
+  ) => OmitKeyof<
     QueryObserverOptions<
       SchemaOutput<TOutputSchema, THandlerOutput>,
       DefaultError,
@@ -143,7 +139,7 @@ export interface GeneralUtils<
     'queryKey'
   >
 
-  setQueryDefaults(
+  setQueryDefaults: (
     options: Partial<
       OmitKeyof<
         QueryObserverOptions<SchemaOutput<TOutputSchema, THandlerOutput>>,
@@ -154,8 +150,8 @@ export interface GeneralUtils<
       ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
       'input' | 'queryKey'
     >,
-  ): void
-  setInfiniteQueryDefaults(
+  ) => void
+  setInfiniteQueryDefaults: (
     options: Partial<
       OmitKeyof<
         QueryObserverOptions<
@@ -173,7 +169,7 @@ export interface GeneralUtils<
       ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
       'input' | 'queryKey'
     >,
-  ): void
+  ) => void
 
   getMutationDefaults: (
     filters?: Pick<MutationFilters, 'mutationKey'>,
@@ -210,7 +206,7 @@ export function createGeneralUtils<
   TInputSchema extends Schema = undefined,
   TOutputSchema extends Schema = undefined,
   THandlerOutput extends
-    SchemaOutput<TOutputSchema> = SchemaOutput<TOutputSchema>,
+  SchemaOutput<TOutputSchema> = SchemaOutput<TOutputSchema>,
 >(
   options: CreateGeneralUtilsOptions,
 ): GeneralUtils<TInputSchema, TOutputSchema, THandlerOutput> {
@@ -344,40 +340,40 @@ export function createGeneralUtils<
 
     getQueryDefaults(filters) {
       return options.queryClient.getQueryDefaults(
-        filters?.queryKey ??
-          getQueryKeyFromPath(options.path, {
-            input: filters?.input,
-            type: 'query',
-          }),
+        filters?.queryKey
+        ?? getQueryKeyFromPath(options.path, {
+          input: filters?.input,
+          type: 'query',
+        }),
       )
     },
     getInfiniteQueryDefaults(filters) {
       return options.queryClient.getQueryDefaults(
-        filters?.queryKey ??
-          getQueryKeyFromPath(options.path, {
-            input: filters?.input,
-            type: 'infinite',
-          }),
+        filters?.queryKey
+        ?? getQueryKeyFromPath(options.path, {
+          input: filters?.input,
+          type: 'infinite',
+        }),
       ) as any
     },
 
     setQueryDefaults(options_, filters) {
       return options.queryClient.setQueryDefaults(
-        filters?.queryKey ??
-          getQueryKeyFromPath(options.path, {
-            input: filters?.input,
-            type: 'query',
-          }),
+        filters?.queryKey
+        ?? getQueryKeyFromPath(options.path, {
+          input: filters?.input,
+          type: 'query',
+        }),
         options_ as any,
       )
     },
     setInfiniteQueryDefaults(options_, filters) {
       return options.queryClient.setQueryDefaults(
-        filters?.queryKey ??
-          getQueryKeyFromPath(options.path, {
-            input: filters?.input,
-            type: 'infinite',
-          }),
+        filters?.queryKey
+        ?? getQueryKeyFromPath(options.path, {
+          input: filters?.input,
+          type: 'infinite',
+        }),
         options_ as any,
       )
     },

package/src/index.ts

@@ -2,7 +2,7 @@ export * from './general-hooks'
 export * from './general-utils'
 export * from './procedure-hooks'
 export * from './procedure-utils'
+export * from './react'
 export * from './react-context'
 export * from './react-hooks'
 export * from './react-utils'
-export * from './react'

package/src/orpc-path.ts

@@ -15,7 +15,7 @@ export function getORPCPath(
   const val = Reflect.get(orpc, orpcPathSymbol)
 
   if (!Array.isArray(val)) {
-    throw new Error(
+    throw new TypeError(
       'orpcPathSymbol is not implemented, please use getORPCPath with correct instance.',
     )
   }

package/src/procedure-hooks.test-d.ts

@@ -81,9 +81,9 @@ describe('useInfiniteQuery', () => {
     expectTypeOf(query.data).toEqualTypeOf<
       | undefined
       | InfiniteData<
-          SchemaOutput<typeof UserListOutputSchema>,
+        SchemaOutput<typeof UserListOutputSchema>,
           number | undefined
-        >
+      >
     >()
   })
 
@@ -111,11 +111,11 @@ describe('useInfiniteQuery', () => {
     expectTypeOf(query.data).toEqualTypeOf<
       | undefined
       | {
-          select: InfiniteData<
-            SchemaOutput<typeof UserListOutputSchema>,
+        select: InfiniteData<
+          SchemaOutput<typeof UserListOutputSchema>,
             number | undefined
-          >
-        }
+        >
+      }
     >()
   })
 })

package/src/procedure-hooks.test.tsx

@@ -2,12 +2,12 @@ import type { SchemaOutput } from '@orpc/contract'
 import { renderHook, screen, waitFor } from '@testing-library/react'
 import {
   ORPCContext,
+  queryClient,
   type UserCreateInputSchema,
   type UserFindInputSchema,
   type UserListInputSchema,
   type UserListOutputSchema,
   type UserSchema,
-  queryClient,
   wrapper,
 } from '../tests/orpc'
 import { createProcedureHooks } from './procedure-hooks'