react-query-firebase 2.3.1 → 2.3.3

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.3.1"
+    "version": "2.3.3"
 }

package/react-native/firestore/useGetRealtimeDocData.d.ts

@@ -1,9 +1,10 @@
 import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
 import { ReactNativeFirebase } from "@react-native-firebase/app";
+import { AppModel } from "../../types";
 /**
  * @inline
  */
-export type UseGetRealtimeDocDataOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
+export type UseGetRealtimeDocDataOptions<AppModelType extends AppModel = AppModel> = {
     /**
      * A slash-separated path to a document. Has to be omitted to use
      */
@@ -11,7 +12,7 @@ export type UseGetRealtimeDocDataOptions<AppModelType extends FirebaseFirestoreT
     /**
      * A reference to a collection.
      */
-    reference?: FirebaseFirestoreTypes.CollectionReference<AppModelType> | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
+    reference?: FirebaseFirestoreTypes.DocumentReference<AppModelType>;
     /**
      * Additional path segments that will be applied relative
      * to the first argument.
@@ -54,4 +55,4 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  * };
  * ```
  */
-export declare const useGetRealtimeDocData: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, pathSegments, reference, onError }: UseGetRealtimeDocDataOptions<AppModelType>) => UseGetRealtimeDocDataResult<AppModelType>;
+export declare const useGetRealtimeDocData: <AppModelType extends AppModel = AppModel>({ path, pathSegments, reference, onError }: UseGetRealtimeDocDataOptions<AppModelType>) => UseGetRealtimeDocDataResult<AppModelType>;

package/react-native/firestore/useGetRealtimeDocData.ts

@@ -3,13 +3,12 @@ import { FirebaseFirestoreTypes, onSnapshot } from "@react-native-firebase/fires
 import { useEffect, useMemo, useState } from "react";
 import { ReactNativeFirebase } from "@react-native-firebase/app";
 import { useDocReference } from "./useDocReference";
+import { AppModel } from "../../types";
 
 /**
  * @inline
  */
-export type UseGetRealtimeDocDataOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
-> = {
+export type UseGetRealtimeDocDataOptions<AppModelType extends AppModel = AppModel> = {
     /**
      * A slash-separated path to a document. Has to be omitted to use
      */
@@ -17,9 +16,7 @@ export type UseGetRealtimeDocDataOptions<
     /**
      * A reference to a collection.
      */
-    reference?:
-        | FirebaseFirestoreTypes.CollectionReference<AppModelType>
-        | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
+    reference?: FirebaseFirestoreTypes.DocumentReference<AppModelType>;
     /**
      * Additional path segments that will be applied relative
      * to the first argument.
@@ -64,9 +61,7 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  * };
  * ```
  */
-export const useGetRealtimeDocData = <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData
->({
+export const useGetRealtimeDocData = <AppModelType extends AppModel = AppModel>({
     path,
     pathSegments,
     reference,

package/react-native/firestore/useInfiniteQuery.d.ts

@@ -5,11 +5,11 @@ import { AppModel } from "../../types";
 /**
  * @inline
  */
-type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = {
+type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey> = {
     /**
      * Reqct-query options that must include queryKey and shall not define queryFn
      */
-    options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, TPageParam>, "queryKey">>;
+    options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryNonFilterConstraint>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryNonFilterConstraint>, "queryKey">>;
     /**
      * Reference to a Firestore collection
      */
@@ -45,5 +45,5 @@ type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey
  * };
  * ```
  */
-export declare const useInfiniteQuery: <AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>({ options, collectionReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType, TQueryKey, TPageParam>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
+export declare const useInfiniteQuery: <AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey>({ options, collectionReference, queryConstraints, compositeFilter }: UseInfiniteQueryOptions<AppModelType, TQueryKey>) => UseInfiniteQueryResult<InfiniteData<AppModelType[]>>;
 export {};

package/react-native/firestore/useInfiniteQuery.ts

@@ -19,11 +19,7 @@ import { AppModel } from "../../types";
 /**
  * @inline
  */
-type UseInfiniteQueryOptions<
-    AppModelType extends AppModel = AppModel,
-    TQueryKey extends QueryKey = QueryKey,
-    TPageParam = unknown
-> = {
+type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey> = {
     /**
      * Reqct-query options that must include queryKey and shall not define queryFn
      */
@@ -34,7 +30,7 @@ type UseInfiniteQueryOptions<
             InfiniteData<AppModelType[]>,
             AppModelType[],
             TQueryKey,
-            TPageParam
+            QueryNonFilterConstraint
         >,
         "queryFn"
     > &
@@ -46,7 +42,7 @@ type UseInfiniteQueryOptions<
                     InfiniteData<AppModelType[]>,
                     AppModelType[],
                     TQueryKey,
-                    TPageParam
+                    QueryNonFilterConstraint
                 >,
                 "queryKey"
             >
@@ -90,18 +86,12 @@ type UseInfiniteQueryOptions<
  * };
  * ```
  */
-export const useInfiniteQuery = <
-    AppModelType extends AppModel = AppModel,
-    TQueryKey extends QueryKey = QueryKey,
-    TPageParam = unknown
->({
+export const useInfiniteQuery = <AppModelType extends AppModel = AppModel, TQueryKey extends QueryKey = QueryKey>({
     options,
     collectionReference,
     queryConstraints = [],
     compositeFilter
-}: UseInfiniteQueryOptions<AppModelType, TQueryKey, TPageParam>): UseInfiniteQueryResult<
-    InfiniteData<AppModelType[]>
-> => {
+}: UseInfiniteQueryOptions<AppModelType, TQueryKey>): UseInfiniteQueryResult<InfiniteData<AppModelType[]>> => {
     return useInfiniteReactQuery({
         ...options,
         queryFn: async ({ pageParam }) => {

package/react-native/firestore/useQueryConstraints.d.ts

@@ -1,3 +1,4 @@
+import { type QueryNonFilterConstraint } from "@react-native-firebase/firestore";
 import { AppModel } from "../../types/AppModel";
 import { type NonFilterQueryConstraint } from "../../types/QueryConstraints";
 /**
@@ -29,7 +30,7 @@ export type UseQueryConstraints<AppModelType extends AppModel = AppModel> = {
  * };
  * ```
  */
-export declare const buildQueryConstraint: <AppModelType extends AppModel = AppModel>(constraint: NonFilterQueryConstraint<AppModelType>) => import("@react-native-firebase/firestore").QueryOrderByConstraint | import("@react-native-firebase/firestore").QueryLimitConstraint | import("@react-native-firebase/firestore").QueryStartAtConstraint;
+export declare const buildQueryConstraint: <AppModelType extends AppModel = AppModel>(constraint: NonFilterQueryConstraint<AppModelType>) => QueryNonFilterConstraint;
 /**
  * A hook to build a list of non-filter query constraints for firebase queries.
  * It uses buildQueryConstraint method and useMemo hook.
@@ -51,4 +52,4 @@ export declare const buildQueryConstraint: <AppModelType extends AppModel = AppM
  * ]};
  * ```
  */
-export declare const useQueryConstraints: <AppModelType extends AppModel = AppModel>({ constraints }: UseQueryConstraints<AppModelType>) => (import("@react-native-firebase/firestore").QueryOrderByConstraint | import("@react-native-firebase/firestore").QueryLimitConstraint | import("@react-native-firebase/firestore").QueryStartAtConstraint)[];
+export declare const useQueryConstraints: <AppModelType extends AppModel = AppModel>({ constraints }: UseQueryConstraints<AppModelType>) => QueryNonFilterConstraint[];

package/react-native/firestore/useQueryConstraints.ts

@@ -1,4 +1,13 @@
-import { startAt, orderBy, limit, limitToLast, startAfter, endAt, endBefore } from "@react-native-firebase/firestore";
+import {
+    startAt,
+    orderBy,
+    limit,
+    limitToLast,
+    startAfter,
+    endAt,
+    endBefore,
+    type QueryNonFilterConstraint
+} from "@react-native-firebase/firestore";
 import { useMemo } from "react";
 import { AppModel } from "../../types/AppModel";
 import { type NonFilterQueryConstraint } from "../../types/QueryConstraints";
@@ -35,7 +44,7 @@ export type UseQueryConstraints<AppModelType extends AppModel = AppModel> = {
  */
 export const buildQueryConstraint = <AppModelType extends AppModel = AppModel>(
     constraint: NonFilterQueryConstraint<AppModelType>
-) => {
+): QueryNonFilterConstraint => {
     switch (constraint.type) {
         case "orderBy":
             return orderBy(constraint.fieldPath as string, constraint.directionStr);
@@ -77,7 +86,7 @@ export const buildQueryConstraint = <AppModelType extends AppModel = AppModel>(
  */
 export const useQueryConstraints = <AppModelType extends AppModel = AppModel>({
     constraints
-}: UseQueryConstraints<AppModelType>) => {
+}: UseQueryConstraints<AppModelType>): QueryNonFilterConstraint[] => {
     return useMemo(() => {
         return constraints.map(buildQueryConstraint);
     }, [constraints]);

package/web/firestore/useGetRealtimeDocData.d.ts

@@ -1,9 +1,10 @@
-import { CollectionReference, DocumentData, DocumentReference } from "firebase/firestore";
+import { DocumentReference } from "firebase/firestore";
 import { FirebaseError } from "firebase/app";
+import { AppModel } from "../../types";
 /**
  * @inline
  */
-export type UseGetRealtimeDocDataOptions<AppModelType, DbModelType extends DocumentData = DocumentData> = {
+export type UseGetRealtimeDocDataOptions<AppModelType extends AppModel = AppModel> = {
     /**
      * A slash-separated path to a document. Has to be omitted to use
      */
@@ -11,7 +12,7 @@ export type UseGetRealtimeDocDataOptions<AppModelType, DbModelType extends Docum
     /**
      * A reference to a collection.
      */
-    reference?: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>;
+    reference?: DocumentReference<AppModelType, AppModelType>;
     /**
      * Additional path segments that will be applied relative
      * to the first argument.
@@ -37,7 +38,7 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  *
  * @group Hook
  *
- * @param {UseGetRealtimeDocDataOptions<AppModelType, DbModelType>} options
+ * @param {UseGetRealtimeDocDataOptions<AppModelType>} options
  *
  * @returns {UseGetRealtimeDocDataResult<AppModelType>}
  *
@@ -54,4 +55,4 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  * };
  * ```
  */
-export declare const useGetRealtimeDocData: <AppModelType, DbModelType extends DocumentData = DocumentData>({ path, pathSegments, reference, onError }: UseGetRealtimeDocDataOptions<AppModelType, DbModelType>) => UseGetRealtimeDocDataResult<AppModelType>;
+export declare const useGetRealtimeDocData: <AppModelType extends AppModel = AppModel>({ path, pathSegments, reference, onError }: UseGetRealtimeDocDataOptions<AppModelType>) => UseGetRealtimeDocDataResult<AppModelType>;

package/web/firestore/useGetRealtimeDocData.js

@@ -6,7 +6,7 @@ import { useDocReference } from "./useDocReference";
  *
  * @group Hook
  *
- * @param {UseGetRealtimeDocDataOptions<AppModelType, DbModelType>} options
+ * @param {UseGetRealtimeDocDataOptions<AppModelType>} options
  *
  * @returns {UseGetRealtimeDocDataResult<AppModelType>}
  *

package/web/firestore/useGetRealtimeDocData.ts

@@ -1,13 +1,14 @@
-import { CollectionReference, DocumentData, DocumentReference, onSnapshot } from "firebase/firestore";
+import { DocumentReference, onSnapshot } from "firebase/firestore";
 
 import { useEffect, useMemo, useState } from "react";
 import { FirebaseError } from "firebase/app";
 import { useDocReference } from "./useDocReference";
+import { AppModel } from "../../types";
 
 /**
  * @inline
  */
-export type UseGetRealtimeDocDataOptions<AppModelType, DbModelType extends DocumentData = DocumentData> = {
+export type UseGetRealtimeDocDataOptions<AppModelType extends AppModel = AppModel> = {
     /**
      * A slash-separated path to a document. Has to be omitted to use
      */
@@ -15,7 +16,7 @@ export type UseGetRealtimeDocDataOptions<AppModelType, DbModelType extends Docum
     /**
      * A reference to a collection.
      */
-    reference?: CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>;
+    reference?: DocumentReference<AppModelType, AppModelType>;
     /**
      * Additional path segments that will be applied relative
      * to the first argument.
@@ -43,7 +44,7 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  *
  * @group Hook
  *
- * @param {UseGetRealtimeDocDataOptions<AppModelType, DbModelType>} options
+ * @param {UseGetRealtimeDocDataOptions<AppModelType>} options
  *
  * @returns {UseGetRealtimeDocDataResult<AppModelType>}
  *
@@ -60,12 +61,12 @@ export type UseGetRealtimeDocDataResult<AppModelType> = {
  * };
  * ```
  */
-export const useGetRealtimeDocData = <AppModelType, DbModelType extends DocumentData = DocumentData>({
+export const useGetRealtimeDocData = <AppModelType extends AppModel = AppModel>({
     path,
     pathSegments,
     reference,
     onError
-}: UseGetRealtimeDocDataOptions<AppModelType, DbModelType>): UseGetRealtimeDocDataResult<AppModelType> => {
+}: UseGetRealtimeDocDataOptions<AppModelType>): UseGetRealtimeDocDataResult<AppModelType> => {
     const ref = useDocReference({ path, reference, pathSegments });
     const [doc, setDoc] = useState<AppModelType | null>(null);
     const [isError, setIsError] = useState(false);

package/web/firestore/useInfiniteQuery.d.ts

@@ -9,7 +9,7 @@ type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey
     /**
      * Reqct-query options that must include queryKey and shall not define queryFn
      */
-    options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryConstraint>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryConstraint>, "queryKey">>;
+    options: Omit<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryNonFilterConstraint>, "queryFn"> & Required<Pick<UseReactInfiniteQueryOptions<AppModelType[], Error, InfiniteData<AppModelType[]>, AppModelType[], TQueryKey, QueryNonFilterConstraint>, "queryKey">>;
     /**
      * Reference to a Firestore collection
      */

package/web/firestore/useInfiniteQuery.ts

@@ -31,7 +31,7 @@ type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey
             InfiniteData<AppModelType[]>,
             AppModelType[],
             TQueryKey,
-            QueryConstraint
+            QueryNonFilterConstraint
         >,
         "queryFn"
     > &
@@ -43,7 +43,7 @@ type UseInfiniteQueryOptions<AppModelType extends AppModel = AppModel, TQueryKey
                     InfiniteData<AppModelType[]>,
                     AppModelType[],
                     TQueryKey,
-                    QueryConstraint
+                    QueryNonFilterConstraint
                 >,
                 "queryKey"
             >