feat(types): validate queryOptions (#5991)

* feat: validate queryOptions

* chore: "disable" test because of upstream issue

Author: TkDodo

packages/react-query/src/__tests__/queryOptions.types.test.tsx

@@ -0,0 +1,31 @@
+import { queryOptions } from '../queryOptions'
+import { doNotExecute } from './utils'
+import type { Equal, Expect } from './utils'
+
+describe('queryOptions', () => {
+  it('should not allow excess properties', () => {
+    doNotExecute(() => {
+      // @ts-expect-error this is a good error, because stallTime does not exist!
+      return queryOptions({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        stallTime: 1000,
+      })
+    })
+  })
+  it('should infer types for callbacks', () => {
+    doNotExecute(() => {
+      return queryOptions({
+        queryKey: ['key'],
+        queryFn: () => Promise.resolve(5),
+        staleTime: 1000,
+        select: (data) => {
+          // @ts-expect-error data is in fact inferred as unknown
+          // see https://github.com/microsoft/TypeScript/issues/47599
+          const result: Expect<Equal<number, typeof data>> = true
+          return result
+        },
+      })
+    })
+  })
+})

packages/react-query/src/queryOptions.ts

@@ -23,6 +23,10 @@ export type DefinedInitialDataOptions<
     | (() => NonUndefinedGuard<TQueryFnData>)
 }
 
+type ValidateQueryOptions<T> = {
+  [K in keyof T]: K extends keyof UseQueryOptions ? T[K] : never
+}
+
 export function queryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
@@ -34,7 +38,7 @@ export function queryOptions<
     TData,
     TQueryKey
   > = UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
->(options: TOptions): TOptions
+>(options: ValidateQueryOptions<TOptions>): TOptions
 
 export function queryOptions<
   TQueryFnData = unknown,
@@ -47,7 +51,7 @@ export function queryOptions<
     TData,
     TQueryKey
   > = DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
->(options: TOptions): TOptions
+>(options: ValidateQueryOptions<TOptions>): TOptions
 
 export function queryOptions(options: unknown) {
   return options