react-query-firebase 2.0.0-rc7 → 2.0.0

package/package.json

@@ -73,5 +73,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.0.0-rc7"
+    "version": "2.0.0"
 }

package/react-native/firestore/useCompositeFilter.js

@@ -9,19 +9,15 @@ import { useMemo } from "react";
  */
 const buildCompositeQuery = (query) => {
     if (query.children) {
-        const queryConstraints = query.children
-            .map((subQuery) => {
-            if (subQuery.field && subQuery.op) {
-                return where(query.field === "documentId" ? firebase.FieldPath.documentId() : query.field, subQuery.op, query.value);
-            }
-            return buildCompositeQuery(subQuery);
-        })
-            .filter((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
         if (queryConstraints.length <= 0) {
             return null;
         }
         return query.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
+    if (query.field && query.op) {
+        return where(query.field === "documentId" ? firebase.FieldPath.documentId() : query.field, query.op, query.value);
+    }
     return null;
 };
 /**

package/react-native/firestore/useCompositeFilter.ts

@@ -30,20 +30,9 @@ export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData =
 
 const buildCompositeQuery = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
     query: QueryElement<DbModelType>
-): FirebaseFirestoreTypes.QueryFieldFilterConstraint | FirebaseFirestoreTypes.QueryCompositeFilterConstraint | null => {
+): FirebaseFirestoreTypes.QueryFilterConstraint | null => {
     if (query.children) {
-        const queryConstraints = query.children
-            .map((subQuery) => {
-                if (subQuery.field && subQuery.op) {
-                    return where(
-                        query.field === "documentId" ? firebase.FieldPath.documentId() : (query.field as string),
-                        subQuery.op,
-                        query.value
-                    );
-                }
-                return buildCompositeQuery(subQuery);
-            })
-            .filter((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
 
         if (queryConstraints.length <= 0) {
             return null;
@@ -52,6 +41,14 @@ const buildCompositeQuery = <DbModelType extends CompositeFilterDocumentData = C
         return (query as CompositeFilter).operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
 
+    if (query.field && query.op) {
+        return where(
+            query.field === "documentId" ? firebase.FieldPath.documentId() : (query.field as string),
+            query.op,
+            query.value
+        ) as unknown as FirebaseFirestoreTypes.QueryFilterConstraint;
+    }
+
     return null;
 };
 

package/web/firestore/useCompositeFilter.d.ts

@@ -1,4 +1,4 @@
-import { DocumentData, QueryCompositeFilterConstraint, WhereFilterOp } from "firebase/firestore";
+import { DocumentData, WhereFilterOp, QueryCompositeFilterConstraint } from "firebase/firestore";
 type CompositeFilterDocumentData = DocumentData;
 export type QueryElement<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = Partial<QueryCompositeFilterConstraint> & {
     children?: QueryElement[];
@@ -8,7 +8,8 @@ export type QueryElement<DbModelType extends CompositeFilterDocumentData = Compo
     value?: DbModelType[keyof DbModelType];
     op?: WhereFilterOp;
 };
-export type CompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = QueryCompositeFilterConstraint & {
+export type CompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
+    operator: "OR" | "AND";
     children: QueryElement<DbModelType & {
         documentId?: string[];
     }>[];

package/web/firestore/useCompositeFilter.js

@@ -1,21 +1,19 @@
-import { and, documentId, or, where } from "firebase/firestore";
+import { documentId, and, or, where } from "firebase/firestore";
 import { useMemo } from "react";
 /**
  * Constructs a composite query filter based on the provided query structure.
  * It recursively builds query constraints using logical "or" or "and" operators.
  *
  * @param {QueryElement<DbModelType>} query - The query element or structure to be evaluated and transformed into filter constraints.
- * @returns {QueryFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
+ * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
  */
 const buildCompositeQuery = (query) => {
     if (query.children) {
-        const queryConstraints = query.children
-            .map((subQuery) => buildCompositeQuery(subQuery))
-            .filter((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
         if (queryConstraints.length <= 0) {
             return null;
         }
-        return query.type === "or" ? or(...queryConstraints) : and(...queryConstraints);
+        return query.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
     if (query.field && query.op) {
         return where(query.field === "documentId" ? documentId() : query.field, query.op, query.value);
@@ -38,6 +36,6 @@ export const useCompositeFilter = ({ query }) => {
         if (queryConstraints.length <= 0) {
             return undefined;
         }
-        return query?.type === "or" ? or(...queryConstraints) : and(...queryConstraints);
+        return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }, [query]);
 };

package/web/firestore/useCompositeFilter.ts

@@ -1,10 +1,10 @@
 import {
     DocumentData,
-    QueryCompositeFilterConstraint,
     QueryFilterConstraint,
     WhereFilterOp,
-    and,
+    QueryCompositeFilterConstraint,
     documentId,
+    and,
     or,
     where
 } from "firebase/firestore";
@@ -20,10 +20,10 @@ export type QueryElement<DbModelType extends CompositeFilterDocumentData = Compo
         op?: WhereFilterOp;
     };
 
-export type CompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> =
-    QueryCompositeFilterConstraint & {
-        children: QueryElement<DbModelType & { documentId?: string[] }>[];
-    };
+export type CompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
+    operator: "OR" | "AND";
+    children: QueryElement<DbModelType & { documentId?: string[] }>[];
+};
 
 export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
     query?: CompositeFilter<DbModelType>;
@@ -34,22 +34,20 @@ export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData =
  * It recursively builds query constraints using logical "or" or "and" operators.
  *
  * @param {QueryElement<DbModelType>} query - The query element or structure to be evaluated and transformed into filter constraints.
- * @returns {QueryFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
+ * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
  */
 
 const buildCompositeQuery = <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>(
     query: QueryElement<DbModelType>
 ): QueryFilterConstraint | null => {
     if (query.children) {
-        const queryConstraints = query.children
-            .map((subQuery) => buildCompositeQuery(subQuery))
-            .filter<QueryFilterConstraint>((constraint) => !!constraint);
+        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
 
         if (queryConstraints.length <= 0) {
             return null;
         }
 
-        return (query as CompositeFilter).type === "or" ? or(...queryConstraints) : and(...queryConstraints);
+        return (query as CompositeFilter).operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
 
     if (query.field && query.op) {
@@ -81,6 +79,6 @@ export const useCompositeFilter = <DbModelType extends CompositeFilterDocumentDa
         if (queryConstraints.length <= 0) {
             return undefined;
         }
-        return query?.type === "or" ? or(...queryConstraints) : and(...queryConstraints);
+        return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }, [query]);
 };

package/web/firestore/useCountQuery.d.ts

@@ -1,8 +1,8 @@
-import { DocumentData, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
+import { DocumentData, CollectionReference, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
 type UseCountQueryOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData> = {
     options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> & Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
 };
@@ -19,5 +19,5 @@ type UseCountQueryOptions<AppModelType extends DocumentData = DocumentData, DbMo
  * @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 DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType, DbModelType>) => UseQueryResult<number>;
+export declare const useCountQuery: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType, DbModelType>) => UseQueryResult<number>;
 export {};

package/web/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/web/firestore/useCountQuery.ts

@@ -1,7 +1,7 @@
 import {
     DocumentData,
     getCountFromServer,
-    Query,
+    CollectionReference,
     query,
     QueryCompositeFilterConstraint,
     QueryConstraint,
@@ -20,7 +20,7 @@ type UseCountQueryOptions<
 > = {
     options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> &
         Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
 };
@@ -44,7 +44,7 @@ export const useCountQuery = <
     DbModelType extends DocumentData = DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter
 }: UseCountQueryOptions<AppModelType, DbModelType>): UseQueryResult<number> => {
@@ -52,8 +52,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/web/firestore/useInfiniteQuery.d.ts

@@ -1,8 +1,8 @@
-import { DocumentData, FirestoreDataConverter, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
+import { CollectionReference, DocumentData, FirestoreDataConverter, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseInfiniteQueryOptions as UseReactInfiniteQueryOptions, QueryKey, UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query";
 type UseInfiniteQueryOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData, TQueryKey extends QueryKey = QueryKey> = {
     options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryConstraint>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryConstraint>, "queryKey">>;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
     converter?: FirestoreDataConverter<AppModelType, DbModelType>;
@@ -14,5 +14,5 @@ type UseInfiniteQueryOptions<AppModelType extends DocumentData = DocumentData, D
  * @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 DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter, converter }: UseInfiniteQueryOptions<AppModelType, DbModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
+export declare const useInfiniteQuery: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, collectionReference, queryConstraints, compositeFilter, converter }: UseInfiniteQueryOptions<AppModelType, DbModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
 export {};

package/web/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, converter }) => {
+export const useInfiniteQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter, converter }) => {
     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(converter ? queryToExecute.withConverter(converter) : queryToExecute);
             const docs = [];
             if (querySnapshot) {

package/web/firestore/useInfiniteQuery.ts

@@ -1,8 +1,8 @@
 import {
+    CollectionReference,
     DocumentData,
     FirestoreDataConverter,
     getDocs,
-    Query,
     query,
     QueryCompositeFilterConstraint,
     QueryConstraint,
@@ -46,7 +46,7 @@ type UseInfiniteQueryOptions<
                 "queryKey"
             >
         >;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
     converter?: FirestoreDataConverter<AppModelType, DbModelType>;
@@ -64,7 +64,7 @@ export const useInfiniteQuery = <
     DbModelType extends DocumentData = DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter,
     converter
@@ -74,8 +74,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(converter ? queryToExecute.withConverter(converter) : queryToExecute);
             const docs: AppModelType[] = [];

package/web/firestore/useQuery.d.ts

@@ -1,8 +1,8 @@
-import { DocumentData, FirestoreDataConverter, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
+import { DocumentData, FirestoreDataConverter, CollectionReference, QueryCompositeFilterConstraint, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
 type UseQueryOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData> = {
     options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> & Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
     converter?: FirestoreDataConverter<AppModelType, DbModelType>;
@@ -21,5 +21,5 @@ type UseQueryOptions<AppModelType extends DocumentData = DocumentData, DbModelTy
  *
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
  */
-export declare const useQuery: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter, converter }: UseQueryOptions<AppModelType, DbModelType>) => UseQueryResult<AppModelType[]>;
+export declare const useQuery: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ options, collectionReference, queryConstraints, compositeFilter, converter }: UseQueryOptions<AppModelType, DbModelType>) => UseQueryResult<AppModelType[]>;
 export {};

package/web/firestore/useQuery.js

@@ -14,13 +14,13 @@ import { useQuery as useReactQuery } from "@tanstack/react-query";
  *
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
  */
-export const useQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter, converter }) => {
+export const useQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter, converter }) => {
     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(converter ? queryToExecute.withConverter(converter) : queryToExecute);
             const docs = [];
             if (querySnapshot) {

package/web/firestore/useQuery.ts

@@ -2,7 +2,7 @@ import {
     DocumentData,
     FirestoreDataConverter,
     getDocs,
-    Query,
+    CollectionReference,
     query,
     QueryCompositeFilterConstraint,
     QueryConstraint,
@@ -21,7 +21,7 @@ type UseQueryOptions<
 > = {
     options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> &
         Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
-    query: Query<AppModelType, DbModelType>;
+    collectionReference: CollectionReference<AppModelType, DbModelType>;
     queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
     compositeFilter?: QueryCompositeFilterConstraint;
     converter?: FirestoreDataConverter<AppModelType, DbModelType>;
@@ -46,7 +46,7 @@ export const useQuery = <
     DbModelType extends DocumentData = DocumentData
 >({
     options,
-    query: queryReference,
+    collectionReference,
     queryConstraints = [],
     compositeFilter,
     converter
@@ -55,8 +55,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(converter ? queryToExecute.withConverter(converter) : queryToExecute);
             const docs: AppModelType[] = [];