react-query-firebase 2.0.0-rc3 → 2.0.0-rc5

package/dist/src/firestore/useCollectionReference.d.ts

@@ -15,4 +15,4 @@ export type UseCollectionReferenceOptions<AppModelType extends FirebaseFirestore
  * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
  * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
  */
-export declare const useCollectionReference: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, reference, pathSegments }: UseCollectionReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.CollectionReference<FirebaseFirestoreTypes.DocumentData>;
+export declare const useCollectionReference: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, reference, pathSegments }: UseCollectionReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.CollectionReference<AppModelType> | null;

package/dist/src/firestore/useCollectionReference.js

@@ -18,5 +18,5 @@ export const useCollectionReference = ({ path, reference, pathSegments }) => {
         return !reference
             ? collection(db, path || "", ...(pathSegments || []))
             : collection(reference, path, ...(pathSegments || []));
-    }, [path, reference?.path, pathSegments]);
+    }, [db, reference, path, pathSegments]);
 };

package/dist/src/firestore/useCountQuery.d.ts

@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
 type UseCountQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
     options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> & Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -19,5 +19,5 @@ type UseCountQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentDa
  * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
  * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
  */
-export declare const useCountQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType>) => UseQueryResult<number>;
+export declare const useCountQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType>) => UseQueryResult<number>;
 export {};

package/dist/src/firestore/useCountQuery.js

@@ -13,13 +13,13 @@ import { useQuery as useReactQuery } from "@tanstack/react-query";
  * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
  * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
  */
-export const useCountQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
+export const useCountQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
     return useReactQuery({
         ...options,
         queryFn: async () => {
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...queryConstraints)
-                : query(queryReference, ...queryConstraints);
+                ? query(collectionReference, compositeFilter, ...queryConstraints)
+                : query(collectionReference, ...queryConstraints);
             const querySnapshot = await getCountFromServer(queryToExecute);
             if (querySnapshot) {
                 return querySnapshot.data().count;

package/dist/src/firestore/useDocReference.d.ts

@@ -14,6 +14,6 @@ export type UseDocReferenceOptions<AppModelType extends FirebaseFirestoreTypes.D
  * @param {DbModelType} options.reference - Reference data for the document, providing additional context or specifics.
  * @param {string[]} options.pathSegments - Parts of the path to construct the full document path dynamically.
  *
- * @returns {DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
+ * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
  */
 export declare const useDocReference: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, reference, pathSegments }: UseDocReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.DocumentReference<AppModelType> | null;

package/dist/src/firestore/useDocReference.js

@@ -29,13 +29,13 @@ const getDocReference = (db, { path, pathSegments, reference }) => {
  * @param {DbModelType} options.reference - Reference data for the document, providing additional context or specifics.
  * @param {string[]} options.pathSegments - Parts of the path to construct the full document path dynamically.
  *
- * @returns {DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
+ * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
  */
 export const useDocReference = ({ path, reference, pathSegments }) => {
     const db = useFirestore();
     const ref = useRef(getDocReference(db, { path, pathSegments, reference }));
     useEffect(() => {
         ref.current = getDocReference(db, { path, pathSegments, reference });
-    }, [path, reference, pathSegments]);
+    }, [db, path, reference, pathSegments]);
     return ref.current;
 };

package/dist/src/firestore/useInfiniteQuery.d.ts

@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
 import { UseInfiniteQueryOptions as UseReactInfiniteQueryOptions, QueryKey, UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query";
 type UseInfiniteQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
     options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryKey">>;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -13,5 +13,5 @@ type UseInfiniteQueryOptions<AppModelType extends FirebaseFirestoreTypes.Documen
  * @param {UseInfiniteQueryOptions<AppModelType, DbModelType>} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter.
  * @returns {UseInfiniteQueryResult<InfiniteData<AppModelType[]>>} Result object containing the infinite data and methods for fetching more pages.
  */
-export declare const useInfiniteQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
+export declare const useInfiniteQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
 export {};

package/dist/src/firestore/useInfiniteQuery.js

@@ -7,14 +7,14 @@ import { useInfiniteQuery as useInfiniteReactQuery } from "@tanstack/react-query
  * @param {UseInfiniteQueryOptions<AppModelType, DbModelType>} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter.
  * @returns {UseInfiniteQueryResult<InfiniteData<AppModelType[]>>} Result object containing the infinite data and methods for fetching more pages.
  */
-export const useInfiniteQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
+export const useInfiniteQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
     return useInfiniteReactQuery({
         ...options,
         queryFn: async ({ pageParam }) => {
             const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])];
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...allQueryConstraints)
-                : query(queryReference, ...allQueryConstraints);
+                ? query(collectionReference, compositeFilter, ...allQueryConstraints)
+                : query(collectionReference, ...allQueryConstraints);
             const querySnapshot = await getDocs(queryToExecute);
             const docs = [];
             if (querySnapshot) {

package/dist/src/firestore/useQuery.d.ts

@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
 type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> = {
     options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> & Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -13,12 +13,12 @@ type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> =
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
  *
  * @param {UseQueryOptions<AppModelType>}  options - Configuration options for the query.
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  queryReference - The reference to the query to be executed.
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  collectionReference - The reference to the query to be executed.
  * @param {QueryConstraint[]}  queryConstraints - Additional constraints to fine-tune the query.
  * @param {QueryConstraint}  compositeFilter - Optional composite filter to apply to the query.
  * @param {FirestoreDataConverter<AppModelType>}  converter - Optional data converter for transforming snapshots.
  *
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
  */
-export declare const useQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseQueryOptions<AppModelType>) => UseQueryResult<AppModelType[]>;
+export declare const useQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseQueryOptions<AppModelType>) => UseQueryResult<AppModelType[]>;
 export {};

package/dist/src/firestore/useQuery.js

@@ -7,20 +7,20 @@ import { useQuery as useReactQuery } from "@tanstack/react-query";
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
  *
  * @param {UseQueryOptions<AppModelType>}  options - Configuration options for the query.
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  queryReference - The reference to the query to be executed.
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  collectionReference - The reference to the query to be executed.
  * @param {QueryConstraint[]}  queryConstraints - Additional constraints to fine-tune the query.
  * @param {QueryConstraint}  compositeFilter - Optional composite filter to apply to the query.
  * @param {FirestoreDataConverter<AppModelType>}  converter - Optional data converter for transforming snapshots.
  *
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
  */
-export const useQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
+export const useQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
     return useReactQuery({
         ...options,
         queryFn: async () => {
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...queryConstraints)
-                : query(queryReference, ...queryConstraints);
+                ? query(collectionReference, compositeFilter, ...queryConstraints)
+                : query(collectionReference, ...queryConstraints);
             const querySnapshot = await getDocs(queryToExecute);
             const docs = [];
             if (querySnapshot) {

package/package.json

@@ -70,5 +70,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.0.0-rc3"
+    "version": "2.0.0-rc5"
 }

package/src/firestore/useCollectionReference.ts

@@ -30,12 +30,20 @@ export const useCollectionReference = <
     path,
     reference,
     pathSegments
-}: UseCollectionReferenceOptions<AppModelType>) => {
+}: UseCollectionReferenceOptions<AppModelType>): FirebaseFirestoreTypes.CollectionReference<AppModelType> | null => {
     const db = useFirestore();
 
     return useMemo(() => {
         return !reference
-            ? collection(db, path || "", ...(pathSegments || []))
-            : collection(reference, path, ...(pathSegments || []));
-    }, [path, reference?.path, pathSegments]);
+            ? (collection(
+                  db,
+                  path || "",
+                  ...(pathSegments || [])
+              ) as FirebaseFirestoreTypes.CollectionReference<AppModelType>)
+            : (collection(
+                  reference,
+                  path,
+                  ...(pathSegments || [])
+              ) as FirebaseFirestoreTypes.CollectionReference<AppModelType>);
+    }, [db, reference, path, pathSegments]);
 };

package/src/firestore/useCountQuery.ts

@@ -17,7 +17,7 @@ type UseCountQueryOptions<
 > = {
     options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> &
         Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -40,7 +40,7 @@ export const useCountQuery = <
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter
 }: UseCountQueryOptions<AppModelType>): UseQueryResult<number> => {
@@ -48,8 +48,8 @@ export const useCountQuery = <
         ...options,
         queryFn: async () => {
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
-                : query(queryReference, ...queryConstraints);
+                ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
+                : query(collectionReference, ...queryConstraints);
 
             const querySnapshot = await getCountFromServer(queryToExecute);
             if (querySnapshot) {

package/src/firestore/useDocReference.ts

@@ -50,7 +50,7 @@ const getDocReference = <
  * @param {DbModelType} options.reference - Reference data for the document, providing additional context or specifics.
  * @param {string[]} options.pathSegments - Parts of the path to construct the full document path dynamically.
  *
- * @returns {DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
+ * @returns {FirebaseFirestoreTypes.DocumentReference<AppModelType> | null} The Firestore document reference corresponding to the provided path and options, or null if not initialized.
  */
 export const useDocReference = <
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
@@ -58,7 +58,7 @@ export const useDocReference = <
     path,
     reference,
     pathSegments
-}: UseDocReferenceOptions<AppModelType>) => {
+}: UseDocReferenceOptions<AppModelType>): FirebaseFirestoreTypes.DocumentReference<AppModelType> | null => {
     const db = useFirestore();
     const ref = useRef<FirebaseFirestoreTypes.DocumentReference<AppModelType> | null>(
         getDocReference(db, { path, pathSegments, reference })
@@ -66,7 +66,7 @@ export const useDocReference = <
 
     useEffect(() => {
         ref.current = getDocReference(db, { path, pathSegments, reference });
-    }, [path, reference, pathSegments]);
+    }, [db, path, reference, pathSegments]);
 
     return ref.current;
 };

package/src/firestore/useInfiniteQuery.ts

@@ -43,7 +43,7 @@ type UseInfiniteQueryOptions<
                 "queryKey"
             >
         >;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -59,7 +59,7 @@ export const useInfiniteQuery = <
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter
 }: UseInfiniteQueryOptions<AppModelType>): UseInfiniteQueryResult<InfiniteData<AppModelType[]>> => {
@@ -68,8 +68,8 @@ export const useInfiniteQuery = <
         queryFn: async ({ pageParam }) => {
             const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])];
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[]))
-                : query(queryReference, ...allQueryConstraints);
+                ? query(collectionReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[]))
+                : query(collectionReference, ...allQueryConstraints);
 
             const querySnapshot = await getDocs(queryToExecute);
             const docs: AppModelType[] = [];

package/src/firestore/useQuery.ts

@@ -15,7 +15,7 @@ import {
 type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> = {
     options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> &
         Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
-    query: FirebaseFirestoreTypes.Query<AppModelType>;
+    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
 };
@@ -27,7 +27,7 @@ type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> =
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
  *
  * @param {UseQueryOptions<AppModelType>}  options - Configuration options for the query.
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  queryReference - The reference to the query to be executed.
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>}  collectionReference - The reference to the query to be executed.
  * @param {QueryConstraint[]}  queryConstraints - Additional constraints to fine-tune the query.
  * @param {QueryConstraint}  compositeFilter - Optional composite filter to apply to the query.
  * @param {FirestoreDataConverter<AppModelType>}  converter - Optional data converter for transforming snapshots.
@@ -38,7 +38,7 @@ export const useQuery = <
     AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter
 }: UseQueryOptions<AppModelType>): UseQueryResult<AppModelType[]> => {
@@ -46,8 +46,8 @@ export const useQuery = <
         ...options,
         queryFn: async () => {
             const queryToExecute = compositeFilter
-                ? query(queryReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
-                : query(queryReference, ...queryConstraints);
+                ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
+                : query(collectionReference, ...queryConstraints);
 
             const querySnapshot = await getDocs(queryToExecute);
             const docs: AppModelType[] = [];