react-query-firebase 2.13.2 → 2.13.3

package/web/auth/useAuthStateReady.ts

@@ -1,5 +1,5 @@
+import { useEffect, useState } from "react";
 import { useAuth } from "./useAuth";
-import { useCallback, useEffect, useState } from "react";
 
 /**
  * A custom hook that determines if the Firebase authentication state is ready.
@@ -22,14 +22,9 @@ export const useAuthStateReady = () => {
 
     const [isAuthStateReady, setIsAuthStateReady] = useState(false);
 
-    const callback = useCallback(async () => {
-        await firebaseAuth.authStateReady();
-        setIsAuthStateReady(true);
-    }, [firebaseAuth]);
-
     useEffect(() => {
-        callback();
-    }, [callback]);
+        firebaseAuth.authStateReady().then(() => setIsAuthStateReady(true));
+    }, [firebaseAuth]);
 
     return isAuthStateReady;
 };

package/web/auth/useCreateUserWitEmailAndPasswordMutation.ts

@@ -1,7 +1,7 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { createUserWithEmailAndPassword, UserCredential } from "firebase/auth";
-import { useAuth } from "./useAuth";
 import { FirebaseError } from "firebase/app";
+import { useAuth } from "./useAuth";
 import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
 
 export type UseCreateUserWitEmailAndPasswordMutationVariables = {

package/web/auth/useCurrentUser.js

@@ -1,6 +1,6 @@
 import { onAuthStateChanged } from "firebase/auth";
-import { useAuth } from "./useAuth";
 import { useEffect, useState } from "react";
+import { useAuth } from "./useAuth";
 /**
  * Hook that provides the current authenticated user from Firebase Auth.
  * It listens for changes in the authentication state and updates the user accordingly.

package/web/auth/useCurrentUser.ts

@@ -1,6 +1,6 @@
 import { onAuthStateChanged } from "firebase/auth";
-import { useAuth } from "./useAuth";
 import { useEffect, useState } from "react";
+import { useAuth } from "./useAuth";
 
 /**
  * Hook that provides the current authenticated user from Firebase Auth.

package/web/auth/useGetRedirectResultMutation.js

@@ -1,7 +1,7 @@
 import { useMutation } from "@tanstack/react-query";
+import { getRedirectResult } from "firebase/auth";
 import { useAuth } from "./useAuth";
 import { GET_REDIRECT_RESULT_MUTATION_KEY } from "./mutation-keys";
-import { getRedirectResult } from "firebase/auth";
 /**
  * Custom hook to retrieve redirect result after sign in with redirect.
  * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.

package/web/auth/useGetRedirectResultMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { useAuth } from "./useAuth";
-import { GET_REDIRECT_RESULT_MUTATION_KEY } from "./mutation-keys";
 import { getRedirectResult, UserCredential } from "firebase/auth";
 import { FirebaseError } from "firebase/app";
+import { useAuth } from "./useAuth";
+import { GET_REDIRECT_RESULT_MUTATION_KEY } from "./mutation-keys";
 
 /**
  * Custom hook to retrieve redirect result after sign in with redirect.

package/web/auth/useIdToken.js

@@ -1,6 +1,6 @@
 import { useCallback, useEffect, useState } from "react";
-import { useCurrentUser } from "./useCurrentUser";
 import { onIdTokenChanged, getIdToken } from "firebase/auth";
+import { useCurrentUser } from "./useCurrentUser";
 import { useAuth } from "./useAuth";
 /**
  * A hook to manage the ID token.
@@ -44,7 +44,7 @@ export const useIdToken = () => {
         return idToken;
     }, [currentUser]);
     useEffect(() => {
-        callback();
+        setTimeout(callback, 0);
     }, [callback]);
     useEffect(() => {
         const unsubscribe = onIdTokenChanged(auth, (user) => {

package/web/auth/useIdToken.ts

@@ -1,6 +1,6 @@
 import { useCallback, useEffect, useState } from "react";
-import { useCurrentUser } from "./useCurrentUser";
 import { onIdTokenChanged, getIdToken } from "firebase/auth";
+import { useCurrentUser } from "./useCurrentUser";
 import { useAuth } from "./useAuth";
 
 /**
@@ -59,7 +59,7 @@ export const useIdToken = (): UseIdTokenResult => {
     }, [currentUser]);
 
     useEffect(() => {
-        callback();
+        setTimeout(callback, 0);
     }, [callback]);
 
     useEffect(() => {

package/web/auth/useLinkWithCredentialMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { linkWithCredential, User, AuthCredential, UserCredential } from "firebase/auth";
 
-import { LINK_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { LINK_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 
 export type UseLinkWitCredentialMutationVariables = {
     user: User;

package/web/auth/useReauthenticateWitCredentialMutation.ts

@@ -1,7 +1,7 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { reauthenticateWithCredential, User, AuthCredential, UserCredential } from "firebase/auth";
-import { REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 
 export type UseReauthenticateWitCredentialMutationVariables = {
     credential: AuthCredential;

package/web/auth/useReauthenticateWitRedirectMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { reauthenticateWithRedirect, AuthProvider, PopupRedirectResolver, User } from "firebase/auth";
 
-import { REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
 
 export type UseReauthenticateWitRedirectMutationVariables = {
     authProvider: AuthProvider;

package/web/auth/useSendEmailVerificationMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { sendEmailVerification, User } from "firebase/auth";
 
-import { SEND_EMAIL_VERIFICATION_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { SEND_EMAIL_VERIFICATION_MUTATION_KEY } from "./mutation-keys";
 
 export type UseSendEmailVerificationMutationVariables = {
     user: User;

package/web/auth/useSignInAnonymouslyMutation.ts

@@ -1,9 +1,9 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signInAnonymously, UserCredential } from "firebase/auth";
 
+import { ReactNativeFirebase } from "@react-native-firebase/app";
 import { useAuth } from "./useAuth";
 import { SIGN_IN_ANONYMOUSLY_MUTATION_KEY } from "./mutation-keys";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
 
 /**
  * @inline

package/web/auth/useSignInWitEmailAndPasswordMutation.ts

@@ -1,9 +1,9 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signInWithEmailAndPassword, UserCredential } from "firebase/auth";
 
+import { FirebaseError } from "firebase/app";
 import { useAuth } from "./useAuth";
 import { SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
-import { FirebaseError } from "firebase/app";
 
 export type UseSignInWitEmailAndPasswordMutationVariables = {
     email: string;

package/web/auth/useSignInWitRedirectMutation.ts

@@ -1,9 +1,9 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signInWithRedirect, AuthProvider, PopupRedirectResolver } from "firebase/auth";
 
+import { FirebaseError } from "firebase/app";
 import { useAuth } from "./useAuth";
 import { SIGN_IN_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
-import { FirebaseError } from "firebase/app";
 
 export type UseSignInWitRedirectMutationVariables = {
     authProvider: AuthProvider;

package/web/auth/useSignInWithCredentialMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { AuthCredential, UserCredential, signInWithCredential } from "firebase/auth";
 
-import { SIGN_IN_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { SIGN_IN_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
 import { useAuth } from "./useAuth";
 
 export type UseSignInWithCredentialMutationVariables = {

package/web/auth/useSignOutMutation.ts

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signOut } from "firebase/auth";
 
-import { SIGN_OUT_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
+import { SIGN_OUT_MUTATION_KEY } from "./mutation-keys";
 import { useAuth } from "./useAuth";
 
 /**

package/web/context/FirebaseContextProvider.js

@@ -1,10 +1,10 @@
 import React, { useEffect, useMemo } from "react";
-import { FirebaseContext } from "./FirebaseContext";
 import { browserLocalPersistence, browserSessionPersistence, connectAuthEmulator, getAuth, setPersistence } from "firebase/auth";
 import { getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig } from "firebase/remote-config";
 import { connectFirestoreEmulator, initializeFirestore } from "firebase/firestore";
 import { initializeApp } from "firebase/app";
+import { FirebaseContext } from "./FirebaseContext";
 /**
  * FirebaseContextProvider component configures and provides Firebase services to its children.
  * Initializes Firebase app and enables optional Firebase services such as Firestore, Auth, Analytics,
@@ -53,7 +53,7 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
             return localFirestore;
         }
         return null;
-    }, [firestoreSettings, emulators?.firestore, firestoreEnabled, firebase]);
+    }, [firestoreSettings, emulators, firestoreEnabled, firebase]);
     const authPersistence = useMemo(() => {
         switch (authPersistenceType) {
             case "NONE":

package/web/context/FirebaseContextProvider.tsx

@@ -1,5 +1,4 @@
 import React, { PropsWithChildren, useEffect, useMemo } from "react";
-import { FirebaseContext } from "./FirebaseContext";
 import {
     browserLocalPersistence,
     browserSessionPersistence,
@@ -12,6 +11,7 @@ import { ConsentSettings, getAnalytics, setAnalyticsCollectionEnabled, setConsen
 import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
 import { connectFirestoreEmulator, FirestoreSettings, initializeFirestore } from "firebase/firestore";
 import { FirebaseOptions, initializeApp } from "firebase/app";
+import { FirebaseContext } from "./FirebaseContext";
 
 /**
  * @inline
@@ -184,7 +184,7 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         }
 
         return null;
-    }, [firestoreSettings, emulators?.firestore, firestoreEnabled, firebase]);
+    }, [firestoreSettings, emulators, firestoreEnabled, firebase]);
 
     const authPersistence = useMemo(() => {
         switch (authPersistenceType) {

package/web/firestore/useCollectionReference.ts

@@ -1,8 +1,8 @@
 import { collection, CollectionReference, DocumentReference } from "firebase/firestore";
 
 import { useMemo } from "react";
-import { useFirestore } from "./useFirestore";
 import { AppModel } from "../../types";
+import { useFirestore } from "./useFirestore";
 
 /**
  * @inline

package/web/firestore/useCountQuery.d.ts

@@ -1,7 +1,7 @@
 import { CollectionReference, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 /**
  * @inline
  */

package/web/firestore/useCountQuery.ts

@@ -12,8 +12,8 @@ import {
     useQuery as useReactQuery,
     UseQueryOptions as UseReactQueryOptions
 } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 
 /**
  * @inline

package/web/firestore/useDocReference.d.ts

@@ -1,4 +1,3 @@
-import { DocumentReference } from "firebase/firestore";
 import { AppModel } from "../../types";
 import { GetDocRefOptions } from "./utils/getDocRef";
 /**
@@ -24,4 +23,4 @@ export type UseDocReferenceOptions<AppModelType extends AppModel = AppModel> = O
  * };
  * ```
  */
-export declare const useDocReference: <AppModelType extends AppModel = AppModel>({ path, reference, pathSegments }: UseDocReferenceOptions<AppModelType>) => DocumentReference<AppModelType, AppModelType> | null;
+export declare const useDocReference: <AppModelType extends AppModel = AppModel>({ path, reference, pathSegments }: UseDocReferenceOptions<AppModelType>) => import("@firebase/firestore").DocumentReference<AppModelType, AppModelType> | null;

package/web/firestore/useDocReference.js

@@ -1,4 +1,4 @@
-import { useEffect, useRef } from "react";
+import { useMemo } from "react";
 import { useFirestore } from "./useFirestore";
 import { getDocRef } from "./utils/getDocRef";
 /**
@@ -22,9 +22,7 @@ import { getDocRef } from "./utils/getDocRef";
  */
 export const useDocReference = ({ path, reference, pathSegments }) => {
     const db = useFirestore();
-    const ref = useRef(getDocRef({ db, path, pathSegments, reference }));
-    useEffect(() => {
-        ref.current = getDocRef({ db, path, pathSegments, reference });
-    }, [path, reference, pathSegments, db]);
-    return ref.current;
+    return useMemo(() => {
+        return getDocRef({ db, path, pathSegments, reference });
+    }, [db, path, pathSegments, reference]);
 };

package/web/firestore/useDocReference.ts

@@ -1,8 +1,6 @@
-import { DocumentReference } from "firebase/firestore";
-
-import { useEffect, useRef } from "react";
-import { useFirestore } from "./useFirestore";
+import { useMemo } from "react";
 import { AppModel } from "../../types";
+import { useFirestore } from "./useFirestore";
 import { getDocRef, GetDocRefOptions } from "./utils/getDocRef";
 
 /**
@@ -38,13 +36,8 @@ export const useDocReference = <AppModelType extends AppModel = AppModel>({
     pathSegments
 }: UseDocReferenceOptions<AppModelType>) => {
     const db = useFirestore();
-    const ref = useRef<DocumentReference<AppModelType, AppModelType> | null>(
-        getDocRef({ db, path, pathSegments, reference })
-    );
-
-    useEffect(() => {
-        ref.current = getDocRef({ db, path, pathSegments, reference });
-    }, [path, reference, pathSegments, db]);
 
-    return ref.current;
+    return useMemo(() => {
+        return getDocRef({ db, path, pathSegments, reference });
+    }, [db, path, pathSegments, reference]);
 };

package/web/firestore/useDocReferences.ts

@@ -1,6 +1,6 @@
 import { useMemo } from "react";
-import { useFirestore } from "./useFirestore";
 import { AppModel } from "../../types";
+import { useFirestore } from "./useFirestore";
 import { getDocRef, GetDocRefOptions } from "./utils/getDocRef";
 
 /**

package/web/firestore/useGetDocData.d.ts

@@ -1,6 +1,6 @@
-import { GetDocDataOptions } from "./utils/getDocData";
 import { UseQueryOptions } from "@tanstack/react-query";
 import { AppModel } from "../../types";
+import { GetDocDataOptions } from "./utils/getDocData";
 /**
  * @inline
  */

package/web/firestore/useGetDocData.js

@@ -1,6 +1,6 @@
+import { useQuery } from "@tanstack/react-query";
 import { useFirestore } from "./useFirestore";
 import { getDocData } from "./utils/getDocData";
-import { useQuery } from "@tanstack/react-query";
 /**
  * Executes a query on a Firestore data source and returns the resulting document.
  *

package/web/firestore/useGetDocData.ts

@@ -1,7 +1,7 @@
-import { useFirestore } from "./useFirestore";
-import { getDocData, GetDocDataOptions } from "./utils/getDocData";
 import { useQuery, UseQueryOptions } from "@tanstack/react-query";
 import { AppModel } from "../../types";
+import { useFirestore } from "./useFirestore";
+import { getDocData, GetDocDataOptions } from "./utils/getDocData";
 
 /**
  * @inline

package/web/firestore/useGetRealtimeDocData.ts

@@ -2,8 +2,8 @@ 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";
+import { useDocReference } from "./useDocReference";
 
 /**
  * @inline

package/web/firestore/useInfiniteQuery.d.ts

@@ -1,7 +1,7 @@
 import { CollectionReference, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseInfiniteQueryOptions as UseReactInfiniteQueryOptions, QueryKey, UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 /**
  * @inline
  */

package/web/firestore/useInfiniteQuery.ts

@@ -14,8 +14,8 @@ import {
     UseInfiniteQueryResult,
     InfiniteData
 } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 
 /**
  * @inline

package/web/firestore/useQuery.d.ts

@@ -1,7 +1,7 @@
 import { CollectionReference, QueryConstraint, QueryNonFilterConstraint } from "firebase/firestore";
 import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 /**
  * @inline
  */

package/web/firestore/useQuery.ts

@@ -12,8 +12,8 @@ import {
     useQuery as useReactQuery,
     UseQueryOptions as UseReactQueryOptions
 } from "@tanstack/react-query";
-import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 import { AppModel } from "../../types";
+import { QueryFilterConstraint } from "./utils/buildCompositeFilter";
 
 /**
  * @inline

package/web/firestore/useQueryConstraints.ts

@@ -1,7 +1,7 @@
 import { QueryNonFilterConstraint } from "firebase/firestore";
+import { useMemo } from "react";
 import { AppModel } from "../../types/AppModel";
 import { NonFilterQueryConstraint } from "../../types/QueryConstraints";
-import { useMemo } from "react";
 import { buildQueryConstraint } from "./utils/buildQueryConstraint";
 
 /**

package/web/firestore/utils/getDocData.d.ts

@@ -1,5 +1,5 @@
-import { GetDocSnapOptions } from "./getDocSnap";
 import { AppModel } from "../../../types";
+import { GetDocSnapOptions } from "./getDocSnap";
 /**
  * @inline
  */

package/web/firestore/utils/getDocData.ts

@@ -1,5 +1,5 @@
-import { getDocSnap, GetDocSnapOptions } from "./getDocSnap";
 import { AppModel } from "../../../types";
+import { getDocSnap, GetDocSnapOptions } from "./getDocSnap";
 
 /**
  * @inline

package/web/firestore/utils/getDocSnap.d.ts

@@ -1,5 +1,5 @@
-import { GetDocRefOptions } from "./getDocRef";
 import { AppModel } from "../../../types";
+import { GetDocRefOptions } from "./getDocRef";
 /**
  * @inline
  */

package/web/firestore/utils/getDocSnap.ts

@@ -1,6 +1,6 @@
 import { getDoc as firestoreGetDoc } from "firebase/firestore";
-import { getDocRef, GetDocRefOptions } from "./getDocRef";
 import { AppModel } from "../../../types";
+import { getDocRef, GetDocRefOptions } from "./getDocRef";
 
 /**
  * @inline

package/web/remoteConfig/useFetchAndActivate.js

@@ -1,6 +1,6 @@
-import { useRemoteConfig } from "./useRemoteConfig";
 import { ensureInitialized, fetchAndActivate } from "firebase/remote-config";
 import { useCallback, useMemo, useState } from "react";
+import { useRemoteConfig } from "./useRemoteConfig";
 /**
  * Custom hook to fetch and activate remote configuration settings.
  * Initializes remote configuration, fetches, activates it, and tracks the fetch status.

package/web/remoteConfig/useFetchAndActivate.ts

@@ -1,6 +1,6 @@
-import { useRemoteConfig } from "./useRemoteConfig";
 import { ensureInitialized, fetchAndActivate } from "firebase/remote-config";
 import { useCallback, useMemo, useState } from "react";
+import { useRemoteConfig } from "./useRemoteConfig";
 
 /**
  * Custom hook to fetch and activate remote configuration settings.

package/web/remoteConfig/useGetValue.js

@@ -1,6 +1,6 @@
 import { getValue } from "firebase/remote-config";
-import { useRemoteConfig } from "./useRemoteConfig";
 import { useMemo } from "react";
+import { useRemoteConfig } from "./useRemoteConfig";
 /**
  * Custom hook to retrieve a value associated with a specified key from remote configuration.
  * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.

package/web/remoteConfig/useGetValue.ts

@@ -1,6 +1,6 @@
 import { getValue } from "firebase/remote-config";
-import { useRemoteConfig } from "./useRemoteConfig";
 import { useMemo } from "react";
+import { useRemoteConfig } from "./useRemoteConfig";
 
 /**
  * Custom hook to retrieve a value associated with a specified key from remote configuration.