fix: Allow queryKey to be optional

invertase · Dec 16, 2024 · a33dcf7 · a33dcf7
1 parent aef9440
commit a33dcf7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/packages/react/src/data-connect/useConnectQuery.ts b/packages/react/src/data-connect/useConnectQuery.ts
@@ -1,15 +1,16 @@
 import { useQuery, type UseQueryOptions } from "@tanstack/react-query";
 import { type FirebaseError } from "firebase/app";
+import type { PartialBy } from "../../utils";
 import {
   type QueryRef,
   type QueryResult,
   executeQuery,
 } from "firebase/data-connect";
 
-type UseConnectQueryOptions<TData = unknown, TError = FirebaseError> = Omit<
-  UseQueryOptions<TData, TError>,
-  "queryFn"
->;
+type UseConnectQueryOptions<
+  TData = unknown,
+  TError = FirebaseError
+> = PartialBy<Omit<UseQueryOptions<TData, TError>, "queryFn">, "queryKey">;
 
 export function useConnectQuery<
   Data extends Record<string, any>,

diff --git a/packages/react/utils.tsx b/packages/react/utils.tsx
@@ -17,3 +17,6 @@ const wrapper = ({ children }: { children: ReactNode }) => (
 );
 
 export { wrapper, queryClient };
+
+// Helper type to make some properties of a type optional.
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;