react-query-firebase 2.0.0-rc4 → 2.0.0-rc5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/src/firestore/useCountQuery.d.ts +2 -2
  2. package/dist/src/firestore/useCountQuery.js +3 -3
  3. package/dist/src/firestore/useInfiniteQuery.d.ts +2 -2
  4. package/dist/src/firestore/useInfiniteQuery.js +3 -3
  5. package/dist/src/firestore/useQuery.d.ts +3 -3
  6. package/dist/src/firestore/useQuery.js +4 -4
  7. package/package.json +1 -1
  8. package/src/firestore/useCountQuery.ts +4 -4
  9. package/src/firestore/useInfiniteQuery.ts +4 -4
  10. package/src/firestore/useQuery.ts +5 -5
package/dist/src/firestore/useCountQuery.d.ts CHANGED
@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
2
2
  import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
3
3
  type UseCountQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
4
4
  options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> & Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
5
- query: FirebaseFirestoreTypes.Query<AppModelType>;
5
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
6
6
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
7
7
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
8
8
  };
@@ -19,5 +19,5 @@ type UseCountQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentDa
19
19
  * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
20
20
  * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
21
21
  */
22
- export declare const useCountQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType>) => UseQueryResult<number>;
22
+ export declare const useCountQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType>) => UseQueryResult<number>;
23
23
  export {};
package/dist/src/firestore/useCountQuery.js CHANGED
@@ -13,13 +13,13 @@ import { useQuery as useReactQuery } from "@tanstack/react-query";
13
13
  * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
14
14
  * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
15
15
  */
16
- export const useCountQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
16
+ export const useCountQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
17
17
  return useReactQuery({
18
18
  ...options,
19
19
  queryFn: async () => {
20
20
  const queryToExecute = compositeFilter
21
- ? query(queryReference, compositeFilter, ...queryConstraints)
22
- : query(queryReference, ...queryConstraints);
21
+ ? query(collectionReference, compositeFilter, ...queryConstraints)
22
+ : query(collectionReference, ...queryConstraints);
23
23
  const querySnapshot = await getCountFromServer(queryToExecute);
24
24
  if (querySnapshot) {
25
25
  return querySnapshot.data().count;
package/dist/src/firestore/useInfiniteQuery.d.ts CHANGED
@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
2
2
  import { UseInfiniteQueryOptions as UseReactInfiniteQueryOptions, QueryKey, UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query";
3
3
  type UseInfiniteQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
4
4
  options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryKey">>;
5
- query: FirebaseFirestoreTypes.Query<AppModelType>;
5
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
6
6
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
7
7
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
8
8
  };
@@ -13,5 +13,5 @@ type UseInfiniteQueryOptions<AppModelType extends FirebaseFirestoreTypes.Documen
13
13
  * @param {UseInfiniteQueryOptions<AppModelType, DbModelType>} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter.
14
14
  * @returns {UseInfiniteQueryResult<InfiniteData<AppModelType[]>>} Result object containing the infinite data and methods for fetching more pages.
15
15
  */
16
- export declare const useInfiniteQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
16
+ export declare const useInfiniteQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
17
17
  export {};
package/dist/src/firestore/useInfiniteQuery.js CHANGED
@@ -7,14 +7,14 @@ import { useInfiniteQuery as useInfiniteReactQuery } from "@tanstack/react-query
7
7
  * @param {UseInfiniteQueryOptions<AppModelType, DbModelType>} options - Configuration options for the infinite query, including Firestore query reference, query constraints, composite filter, and data converter.
8
8
  * @returns {UseInfiniteQueryResult<InfiniteData<AppModelType[]>>} Result object containing the infinite data and methods for fetching more pages.
9
9
  */
10
- export const useInfiniteQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
10
+ export const useInfiniteQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
11
11
  return useInfiniteReactQuery({
12
12
  ...options,
13
13
  queryFn: async ({ pageParam }) => {
14
14
  const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])];
15
15
  const queryToExecute = compositeFilter
16
- ? query(queryReference, compositeFilter, ...allQueryConstraints)
17
- : query(queryReference, ...allQueryConstraints);
16
+ ? query(collectionReference, compositeFilter, ...allQueryConstraints)
17
+ : query(collectionReference, ...allQueryConstraints);
18
18
  const querySnapshot = await getDocs(queryToExecute);
19
19
  const docs = [];
20
20
  if (querySnapshot) {
package/dist/src/firestore/useQuery.d.ts CHANGED
@@ -2,7 +2,7 @@ import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } fro
2
2
  import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
3
3
  type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> = {
4
4
  options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> & Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
5
- query: FirebaseFirestoreTypes.Query<AppModelType>;
5
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
6
6
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
7
7
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
8
8
  };
@@ -13,12 +13,12 @@ type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> =
13
13
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
14
14
  *
15
15
  * @param {UseQueryOptions<AppModelType>} options - Configuration options for the query.
16
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} queryReference - The reference to the query to be executed.
16
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} collectionReference - The reference to the query to be executed.
17
17
  * @param {QueryConstraint[]} queryConstraints - Additional constraints to fine-tune the query.
18
18
  * @param {QueryConstraint} compositeFilter - Optional composite filter to apply to the query.
19
19
  * @param {FirestoreDataConverter<AppModelType>} converter - Optional data converter for transforming snapshots.
20
20
  *
21
21
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
22
22
  */
23
- export declare const useQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, query: queryReference, queryConstraints, compositeFilter }: UseQueryOptions<AppModelType>) => UseQueryResult<AppModelType[]>;
23
+ export declare const useQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseQueryOptions<AppModelType>) => UseQueryResult<AppModelType[]>;
24
24
  export {};
package/dist/src/firestore/useQuery.js CHANGED
@@ -7,20 +7,20 @@ import { useQuery as useReactQuery } from "@tanstack/react-query";
7
7
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
8
8
  *
9
9
  * @param {UseQueryOptions<AppModelType>} options - Configuration options for the query.
10
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} queryReference - The reference to the query to be executed.
10
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} collectionReference - The reference to the query to be executed.
11
11
  * @param {QueryConstraint[]} queryConstraints - Additional constraints to fine-tune the query.
12
12
  * @param {QueryConstraint} compositeFilter - Optional composite filter to apply to the query.
13
13
  * @param {FirestoreDataConverter<AppModelType>} converter - Optional data converter for transforming snapshots.
14
14
  *
15
15
  * @returns {UseQueryResult<AppModelType[]>} Result containing an array of documents that match the query criteria.
16
16
  */
17
- export const useQuery = ({ options, query: queryReference, queryConstraints = [], compositeFilter }) => {
17
+ export const useQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
18
18
  return useReactQuery({
19
19
  ...options,
20
20
  queryFn: async () => {
21
21
  const queryToExecute = compositeFilter
22
- ? query(queryReference, compositeFilter, ...queryConstraints)
23
- : query(queryReference, ...queryConstraints);
22
+ ? query(collectionReference, compositeFilter, ...queryConstraints)
23
+ : query(collectionReference, ...queryConstraints);
24
24
  const querySnapshot = await getDocs(queryToExecute);
25
25
  const docs = [];
26
26
  if (querySnapshot) {
package/package.json CHANGED
@@ -70,5 +70,5 @@
70
70
  "docs:build": "vitepress build docs",
71
71
  "docs:preview": "vitepress preview docs"
72
72
  },
73
- "version": "2.0.0-rc4"
73
+ "version": "2.0.0-rc5"
74
74
  }
package/src/firestore/useCountQuery.ts CHANGED
@@ -17,7 +17,7 @@ type UseCountQueryOptions<
17
17
  > = {
18
18
  options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> &
19
19
  Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
20
- query: FirebaseFirestoreTypes.Query<AppModelType>;
20
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
21
21
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
22
22
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
23
23
  };
@@ -40,7 +40,7 @@ export const useCountQuery = <
40
40
  AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
41
41
  >({
42
42
  options,
43
- query: queryReference,
43
+ collectionReference,
44
44
  queryConstraints = [],
45
45
  compositeFilter
46
46
  }: UseCountQueryOptions<AppModelType>): UseQueryResult<number> => {
@@ -48,8 +48,8 @@ export const useCountQuery = <
48
48
  ...options,
49
49
  queryFn: async () => {
50
50
  const queryToExecute = compositeFilter
51
- ? query(queryReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
52
- : query(queryReference, ...queryConstraints);
51
+ ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
52
+ : query(collectionReference, ...queryConstraints);
53
53
 
54
54
  const querySnapshot = await getCountFromServer(queryToExecute);
55
55
  if (querySnapshot) {
package/src/firestore/useInfiniteQuery.ts CHANGED
@@ -43,7 +43,7 @@ type UseInfiniteQueryOptions<
43
43
  "queryKey"
44
44
  >
45
45
  >;
46
- query: FirebaseFirestoreTypes.Query<AppModelType>;
46
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
47
47
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
48
48
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
49
49
  };
@@ -59,7 +59,7 @@ export const useInfiniteQuery = <
59
59
  AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
60
60
  >({
61
61
  options,
62
- query: queryReference,
62
+ collectionReference,
63
63
  queryConstraints = [],
64
64
  compositeFilter
65
65
  }: UseInfiniteQueryOptions<AppModelType>): UseInfiniteQueryResult<InfiniteData<AppModelType[]>> => {
@@ -68,8 +68,8 @@ export const useInfiniteQuery = <
68
68
  queryFn: async ({ pageParam }) => {
69
69
  const allQueryConstraints = [...queryConstraints, ...(pageParam ? [pageParam] : [])];
70
70
  const queryToExecute = compositeFilter
71
- ? query(queryReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[]))
72
- : query(queryReference, ...allQueryConstraints);
71
+ ? query(collectionReference, compositeFilter, ...(allQueryConstraints as QueryNonFilterConstraint[]))
72
+ : query(collectionReference, ...allQueryConstraints);
73
73
 
74
74
  const querySnapshot = await getDocs(queryToExecute);
75
75
  const docs: AppModelType[] = [];
package/src/firestore/useQuery.ts CHANGED
@@ -15,7 +15,7 @@ import {
15
15
  type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> = {
16
16
  options: Omit<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryFn"> &
17
17
  Required<Pick<UseReactQueryOptions<AppModelType[], Error, AppModelType[]>, "queryKey">>;
18
- query: FirebaseFirestoreTypes.Query<AppModelType>;
18
+ collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
19
19
  queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
20
20
  compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
21
21
  };
@@ -27,7 +27,7 @@ type UseQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData> =
27
27
  * reference and constraints. It supports optional filtering, conversion, and additional query constraints.
28
28
  *
29
29
  * @param {UseQueryOptions<AppModelType>} options - Configuration options for the query.
30
- * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} queryReference - The reference to the query to be executed.
30
+ * @param {FirebaseFirestoreTypes.DocumentReference<AppModelType>} collectionReference - The reference to the query to be executed.
31
31
  * @param {QueryConstraint[]} queryConstraints - Additional constraints to fine-tune the query.
32
32
  * @param {QueryConstraint} compositeFilter - Optional composite filter to apply to the query.
33
33
  * @param {FirestoreDataConverter<AppModelType>} converter - Optional data converter for transforming snapshots.
@@ -38,7 +38,7 @@ export const useQuery = <
38
38
  AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
39
39
  >({
40
40
  options,
41
- query: queryReference,
41
+ collectionReference,
42
42
  queryConstraints = [],
43
43
  compositeFilter
44
44
  }: UseQueryOptions<AppModelType>): UseQueryResult<AppModelType[]> => {
@@ -46,8 +46,8 @@ export const useQuery = <
46
46
  ...options,
47
47
  queryFn: async () => {
48
48
  const queryToExecute = compositeFilter
49
- ? query(queryReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
50
- : query(queryReference, ...queryConstraints);
49
+ ? query(collectionReference, compositeFilter, ...(queryConstraints as QueryNonFilterConstraint[]))
50
+ : query(collectionReference, ...queryConstraints);
51
51
 
52
52
  const querySnapshot = await getDocs(queryToExecute);
53
53
  const docs: AppModelType[] = [];