react-query-firebase 2.6.1 → 2.6.3

package/package.json

@@ -5,13 +5,13 @@
         "url": "https://github.com/vpishuk/react-query-firebase/issues"
     },
     "peerDependencies": {
-        "@react-native-firebase/analytics": "^21.0.0",
-        "@react-native-firebase/app": "^21.0.0",
-        "@react-native-firebase/auth": "^21.0.0",
-        "@react-native-firebase/crashlytics": "^21.0.0",
-        "@react-native-firebase/firestore": "^21.0.0",
-        "@react-native-firebase/installations": "^21.0.0",
-        "@react-native-firebase/remote-config": "^21.0.0",
+        "@react-native-firebase/analytics": "^22.1.0",
+        "@react-native-firebase/app": "^22.1.0",
+        "@react-native-firebase/auth": "^22.1.0",
+        "@react-native-firebase/crashlytics": "^22.1.0",
+        "@react-native-firebase/firestore": "^22.1.0",
+        "@react-native-firebase/installations": "^22.1.0",
+        "@react-native-firebase/remote-config": "^22.1.0",
         "@tanstack/react-query": "^5.0.0",
         "firebase": "^11.0.0",
         "react": "^18.0.0 || ^19.0.0"
@@ -22,13 +22,13 @@
     "description": "This module offers react hooks to work with Firebase on react-native and web platforms",
     "devDependencies": {
         "@laverve/eslint-utils": "^5.1.1",
-        "@react-native-firebase/analytics": "^21.0.0",
-        "@react-native-firebase/app": "^21.0.0",
-        "@react-native-firebase/auth": "^21.0.0",
-        "@react-native-firebase/crashlytics": "^21.0.0",
-        "@react-native-firebase/firestore": "^21.0.0",
-        "@react-native-firebase/installations": "^21.0.0",
-        "@react-native-firebase/remote-config": "^21.0.0",
+        "@react-native-firebase/analytics": "^22.1.0",
+        "@react-native-firebase/app": "^22.1.0",
+        "@react-native-firebase/auth": "^22.1.0",
+        "@react-native-firebase/crashlytics": "^22.1.0",
+        "@react-native-firebase/firestore": "^22.1.0",
+        "@react-native-firebase/installations": "^22.1.0",
+        "@react-native-firebase/remote-config": "^22.1.0",
         "@types/react": "^19.0.2",
         "husky": "^9.1.1",
         "lint-staged": "^15.1.0",
@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.6.1"
+    "version": "2.6.3"
 }

package/react-native/auth/useIdToken.ts

@@ -63,7 +63,7 @@ export const useIdToken = (): UseIdTokenResult => {
     }, [callback]);
 
     useEffect(() => {
-        const unsubscribe = onIdTokenChanged(auth, (user: FirebaseAuthTypes.User) => {
+        const unsubscribe = onIdTokenChanged(auth, (user: FirebaseAuthTypes.User | null) => {
             if (user) {
                 user.getIdToken().then((idToken) => {
                     setIdToken(idToken);

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

@@ -1,6 +1,7 @@
 import { UseMutationOptions } from "@tanstack/react-query";
 import { FirebaseFirestoreTypes, WithFieldValue } from "@react-native-firebase/firestore";
 import { ReactNativeFirebase } from "@react-native-firebase/app";
+import { AppModel } from "../../types";
 /**
  * @inline
  */
@@ -13,7 +14,7 @@ export type UseAddDocMutationValues<AppModelType> = {
 /**
  * @inline
  */
-export type UseAddDocMutationOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown> = {
+export type UseAddDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
     /**
      * Reference to a collection where document must be added
      */
@@ -47,4 +48,4 @@ export type UseAddDocMutationOptions<AppModelType extends FirebaseFirestoreTypes
  * };
  * ```
  */
-export declare const useAddDocMutation: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown>({ collectionReference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;
+export declare const useAddDocMutation: <AppModelType extends AppModel = AppModel, TContext = unknown>({ collectionReference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;

package/react-native/firestore/useAddDocMutation.js

@@ -33,7 +33,7 @@ export const useAddDocMutation = ({ collectionReference, options = {} }) => {
         mutationFn: async ({ data }) => {
             const docRef = await addDoc(collectionReference, data);
             const docSnap = await getDoc(docRef);
-            return docSnap.data();
+            return { ...docSnap.data(), uid: docRef.id };
         }
     });
 };

package/react-native/firestore/useAddDocMutation.ts

@@ -3,6 +3,7 @@ import { FirebaseFirestoreTypes, addDoc, WithFieldValue, getDoc } from "@react-n
 
 import { ReactNativeFirebase } from "@react-native-firebase/app";
 import { useMemo } from "react";
+import { AppModel } from "../../types";
 
 /**
  * @inline
@@ -17,10 +18,7 @@ export type UseAddDocMutationValues<AppModelType> = {
 /**
  * @inline
  */
-export type UseAddDocMutationOptions<
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData,
-    TContext = unknown
-> = {
+export type UseAddDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
     /**
      * Reference to a collection where document must be added
      */
@@ -64,10 +62,7 @@ export type UseAddDocMutationOptions<
  * };
  * ```
  */
-export const useAddDocMutation = <
-    AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData,
-    TContext = unknown
->({
+export const useAddDocMutation = <AppModelType extends AppModel = AppModel, TContext = unknown>({
     collectionReference,
     options = {}
 }: UseAddDocMutationOptions<AppModelType, TContext>) => {
@@ -79,7 +74,7 @@ export const useAddDocMutation = <
         mutationFn: async ({ data }) => {
             const docRef = await addDoc<AppModelType>(collectionReference, data);
             const docSnap = await getDoc(docRef);
-            return docSnap.data() as AppModelType;
+            return { ...docSnap.data(), uid: docRef.id } as AppModelType;
         }
     });
 };

package/react-native/firestore/useEnsureDoc.js

@@ -32,7 +32,7 @@ export const useEnsureDoc = ({ reference, path, pathSegments, defaults, options
         ...options,
         queryFn: async () => {
             const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
-            if (existingDocSnap?.exists) {
+            if (existingDocSnap?.exists()) {
                 return { ...existingDocSnap.data(), uid: existingDocSnap.id };
             }
             const docRef = getDocRef({ db, reference, path, pathSegments });

package/react-native/firestore/useEnsureDoc.ts

@@ -60,7 +60,7 @@ export const useEnsureDoc = <AppModelType extends AppModel = AppModel>({
         queryFn: async () => {
             const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
 
-            if (existingDocSnap?.exists) {
+            if (existingDocSnap?.exists()) {
                 return { ...(existingDocSnap.data() as AppModelType), uid: existingDocSnap.id };
             }
 

package/react-native/firestore/useGetRealtimeDocData.js

@@ -34,12 +34,13 @@ export const useGetRealtimeDocData = ({ path, pathSegments, reference, onError }
             ? onSnapshot(ref, {
                 next: async (snapshot) => {
                     setIsFetching(false);
-                    setDoc(snapshot.data() || null);
+                    setDoc({ ...snapshot.data(), uid: snapshot.id });
                     setError(null);
                     setIsError(false);
                 },
                 error: (e) => {
                     setIsError(true);
+                    setDoc(null);
                     setError(e);
                     onError?.(e);
                 }

package/react-native/firestore/useGetRealtimeDocData.ts

@@ -78,12 +78,13 @@ export const useGetRealtimeDocData = <AppModelType extends AppModel = AppModel>(
             ? onSnapshot<AppModelType>(ref, {
                   next: async (snapshot) => {
                       setIsFetching(false);
-                      setDoc(snapshot.data() || null);
+                      setDoc({ ...snapshot.data(), uid: snapshot.id } as AppModelType);
                       setError(null);
                       setIsError(false);
                   },
                   error: (e) => {
                       setIsError(true);
+                      setDoc(null);
                       setError(e);
                       onError?.(e);
                   }

package/react-native/firestore/useInfiniteQuery.js

@@ -34,7 +34,7 @@ export const useInfiniteQuery = ({ options, collectionReference, queryConstraint
             const docs = [];
             if (querySnapshot) {
                 querySnapshot.forEach((doc) => {
-                    docs.push(doc.data());
+                    docs.push({ ...doc.data(), uid: doc.id });
                 });
             }
             return docs;

package/react-native/firestore/useInfiniteQuery.ts

@@ -105,7 +105,7 @@ export const useInfiniteQuery = <AppModelType extends AppModel = AppModel, TQuer
 
             if (querySnapshot) {
                 querySnapshot.forEach((doc) => {
-                    docs.push(doc.data());
+                    docs.push({ ...doc.data(), uid: doc.id });
                 });
             }
             return docs;

package/react-native/firestore/useQuery.js

@@ -33,7 +33,7 @@ export const useQuery = ({ options, collectionReference, queryConstraints = [],
             const docs = [];
             if (querySnapshot) {
                 querySnapshot.forEach((doc) => {
-                    docs.push(doc.data());
+                    docs.push({ ...doc.data(), uid: doc.id });
                 });
             }
             return docs;

package/react-native/firestore/useQuery.ts

@@ -80,7 +80,7 @@ export const useQuery = <AppModelType extends AppModel = AppModel>({
 
             if (querySnapshot) {
                 querySnapshot.forEach((doc) => {
-                    docs.push(doc.data());
+                    docs.push({ ...doc.data(), uid: doc.id });
                 });
             }
             return docs;

package/react-native/firestore/utils/getDocData.js

@@ -12,8 +12,8 @@ import { getDocSnap } from "./getDocSnap";
  */
 export const getDocData = async ({ db, reference, path, pathSegments }) => {
     const docSnap = await getDocSnap({ db, reference, path, pathSegments });
-    if (docSnap && docSnap?.exists) {
-        return docSnap.data();
+    if (docSnap && docSnap?.exists()) {
+        return { ...docSnap.data(), uid: docSnap.id };
     }
     return null;
 };

package/react-native/firestore/utils/getDocData.ts

@@ -25,8 +25,8 @@ export const getDocData = async <AppModelType extends AppModel = AppModel>({
 }: GetDocDataOptions<AppModelType>) => {
     const docSnap = await getDocSnap<AppModelType>({ db, reference, path, pathSegments });
 
-    if (docSnap && docSnap?.exists) {
-        return docSnap.data() as AppModelType;
+    if (docSnap && docSnap?.exists()) {
+        return { ...docSnap.data(), uid: docSnap.id } as AppModelType;
     }
 
     return null;

package/web/firestore/useEnsureDoc.js

@@ -31,17 +31,29 @@ export const useEnsureDoc = ({ reference, path, pathSegments, defaults, options
     return useQuery({
         ...options,
         queryFn: async () => {
-            const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
-            if (existingDocSnap?.exists) {
-                return { ...existingDocSnap.data(), uid: existingDocSnap.id };
+            const createDoc = async () => {
+                const docRef = getDocRef({ db, reference, path, pathSegments });
+                if (!docRef) {
+                    throw new Error(`Cannot fetch document reference using data: ${reference?.path}, ${path}, ${pathSegments?.join("/")}`);
+                }
+                await setDoc(docRef, defaults);
+                const docSnap = await getDoc(docRef);
+                return { ...docSnap.data(), uid: docSnap.id };
+            };
+            try {
+                const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
+                if (existingDocSnap?.exists()) {
+                    return { ...existingDocSnap.data(), uid: existingDocSnap.id };
+                }
+                return createDoc();
             }
-            const docRef = getDocRef({ db, reference, path, pathSegments });
-            if (!docRef) {
-                throw new Error(`Cannot fetch document reference using data: ${reference?.path}, ${path}, ${pathSegments?.join("/")}`);
+            catch (e) {
+                // permission denied error may arise because of a security rule
+                if (e.code === "permission-denied") {
+                    return createDoc();
+                }
+                throw e;
             }
-            await setDoc(docRef, defaults);
-            const docSnap = await getDoc(docRef);
-            return { ...docSnap.data(), uid: docSnap.id };
         }
     });
 };

package/web/firestore/useEnsureDoc.ts

@@ -1,5 +1,5 @@
 import { useQuery, UseQueryOptions } from "@tanstack/react-query";
-import { getDoc, setDoc } from "firebase/firestore";
+import { FirestoreError, getDoc, setDoc } from "firebase/firestore";
 
 import { AppModel } from "../../types";
 import { GetDocDataOptions } from "./utils/getDocData";
@@ -58,22 +58,35 @@ export const useEnsureDoc = <AppModelType extends AppModel = AppModel>({
     return useQuery({
         ...options,
         queryFn: async () => {
-            const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
+            const createDoc = async () => {
+                const docRef = getDocRef({ db, reference, path, pathSegments });
+                if (!docRef) {
+                    throw new Error(
+                        `Cannot fetch document reference using data: ${reference?.path}, ${path}, ${pathSegments?.join("/")}`
+                    );
+                }
 
-            if (existingDocSnap?.exists) {
-                return { ...(existingDocSnap.data() as AppModelType), uid: existingDocSnap.id };
-            }
+                await setDoc<AppModelType, AppModelType>(docRef, defaults);
+                const docSnap = await getDoc(docRef);
+                return { ...(docSnap.data() as AppModelType), uid: docSnap.id };
+            };
 
-            const docRef = getDocRef({ db, reference, path, pathSegments });
-            if (!docRef) {
-                throw new Error(
-                    `Cannot fetch document reference using data: ${reference?.path}, ${path}, ${pathSegments?.join("/")}`
-                );
-            }
+            try {
+                const existingDocSnap = await getDocSnap({ db, path, pathSegments, reference });
+
+                if (existingDocSnap?.exists()) {
+                    return { ...(existingDocSnap.data() as AppModelType), uid: existingDocSnap.id };
+                }
 
-            await setDoc<AppModelType, AppModelType>(docRef, defaults);
-            const docSnap = await getDoc(docRef);
-            return { ...(docSnap.data() as AppModelType), uid: docSnap.id };
+                return createDoc();
+            } catch (e) {
+                // permission denied error may arise because of a security rule
+                if ((e as FirestoreError).code === "permission-denied") {
+                    return createDoc();
+                }
+
+                throw e;
+            }
         }
     });
 };