react-query-firebase 2.1.3 → 2.2.0

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.1.3"
+    "version": "2.2.0"
 }

package/react-native/auth/index.d.ts

@@ -10,3 +10,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useAuthStateReady";

package/react-native/auth/index.js

@@ -10,3 +10,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useAuthStateReady";

package/react-native/auth/index.ts

@@ -10,3 +10,4 @@ export * from "./useSignOutMutation";
 export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";
+export * from "./useAuthStateReady";

package/react-native/auth/useAuthStateReady.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A custom hook that determines if the Firebase authentication state is ready.
+ * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
+ */
+export declare const useAuthStateReady: () => boolean;

package/react-native/auth/useAuthStateReady.js

@@ -0,0 +1,33 @@
+import { useAuth } from "./useAuth";
+import { useEffect, useState } from "react";
+/**
+ * A custom hook that determines if the Firebase authentication state is ready.
+ * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
+ */
+export const useAuthStateReady = () => {
+    const firebaseAuth = useAuth();
+    const [isAuthStateReady, setIsAuthStateReady] = useState(false);
+    useEffect(() => {
+        const subscription = firebaseAuth.onAuthStateChanged(() => {
+            if (!isAuthStateReady) {
+                setIsAuthStateReady(true);
+            }
+        });
+        return () => {
+            subscription();
+        };
+    }, [firebaseAuth, isAuthStateReady]);
+    return isAuthStateReady;
+};

package/react-native/auth/useAuthStateReady.ts

@@ -0,0 +1,38 @@
+import { useAuth } from "./useAuth";
+import { useEffect, useState } from "react";
+
+/**
+ * A custom hook that determines if the Firebase authentication state is ready.
+ * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
+ */
+export const useAuthStateReady = () => {
+    const firebaseAuth = useAuth();
+
+    const [isAuthStateReady, setIsAuthStateReady] = useState(false);
+
+    useEffect(() => {
+        const subscription = firebaseAuth.onAuthStateChanged(() => {
+            if (!isAuthStateReady) {
+                setIsAuthStateReady(true);
+            }
+        });
+
+        return () => {
+            subscription();
+        };
+    }, [firebaseAuth, isAuthStateReady]);
+
+    return isAuthStateReady;
+};

package/react-native/context/FirebaseContextProvider.js

@@ -1,8 +1,9 @@
 import React, { useEffect, useMemo } from "react";
 import { FirebaseContext } from "./FirebaseContext";
-import { connectAuthEmulator } from "@react-native-firebase/auth";
-import { setAnalyticsCollectionEnabled, setConsent } from "@react-native-firebase/analytics";
-import { connectFirestoreEmulator } from "@react-native-firebase/firestore";
+import auth, { connectAuthEmulator } from "@react-native-firebase/auth";
+import analytics, { setAnalyticsCollectionEnabled, setConsent } from "@react-native-firebase/analytics";
+import remoteConfig from "@react-native-firebase/remote-config";
+import firestore, { connectFirestoreEmulator } from "@react-native-firebase/firestore";
 import firebase from "@react-native-firebase/app";
 /**
  * FirebaseContextProvider component configures and provides Firebase services to its children.
@@ -30,7 +31,7 @@ import firebase from "@react-native-firebase/app";
 export const FirebaseContextProvider = ({ emulators, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {}, firestoreSettings }) => {
     const internalFirebase = useMemo(() => firebase, []);
     useEffect(() => {
-        setConsent(firebase.analytics(), {
+        setConsent(analytics(), {
             ad_personalization: false,
             ad_storage: false,
             ad_user_data: false,
@@ -44,19 +45,19 @@ export const FirebaseContextProvider = ({ emulators, children, authEnabled = tru
     const internalFirestore = useMemo(() => {
         if (firestoreEnabled) {
             if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(internalFirebase.firestore(), emulators.firestore.host, emulators.firestore.port);
+                connectFirestoreEmulator(firestore(), emulators.firestore.host, emulators.firestore.port);
             }
-            const localFirestore = internalFirebase.firestore();
+            const localFirestore = firestore();
             if (firestoreSettings) {
                 localFirestore.settings(firestoreSettings);
             }
             return localFirestore;
         }
         return null;
-    }, [emulators?.firestore, firestoreEnabled, internalFirebase, firestoreSettings]);
+    }, [emulators?.firestore, firestoreEnabled, firestoreSettings]);
     const internalAuth = useMemo(() => {
         if (authEnabled) {
-            const localAuth = internalFirebase.auth();
+            const localAuth = auth();
             if (emulators?.auth?.host) {
                 connectAuthEmulator(localAuth, emulators?.auth?.host, {
                     disableWarnings: true
@@ -65,16 +66,16 @@ export const FirebaseContextProvider = ({ emulators, children, authEnabled = tru
             return localAuth;
         }
         return null;
-    }, [emulators?.auth, authEnabled, internalFirebase]);
+    }, [emulators?.auth, authEnabled]);
     const internalAnalytics = useMemo(() => {
         if (analyticsEnabled) {
-            return internalFirebase.analytics();
+            return analytics();
         }
         return null;
-    }, [analyticsEnabled, internalFirebase]);
+    }, [analyticsEnabled]);
     const internalRemoteConfig = useMemo(() => {
         if (remoteConfigEnabled) {
-            const localRemoteConfig = internalFirebase.remoteConfig();
+            const localRemoteConfig = remoteConfig();
             if (remoteConfigSettings) {
                 localRemoteConfig.settings.fetchTimeMillis = remoteConfigSettings.fetchTimeMillis;
                 localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
@@ -83,7 +84,7 @@ export const FirebaseContextProvider = ({ emulators, children, authEnabled = tru
             return localRemoteConfig;
         }
         return null;
-    }, [remoteConfigEnabled, remoteConfigSettings, internalFirebase, remoteConfigDefaults]);
+    }, [remoteConfigEnabled, remoteConfigSettings, remoteConfigDefaults]);
     const contextValue = useMemo(() => ({
         firebase: internalFirebase,
         auth: internalAuth,

package/react-native/context/FirebaseContextProvider.tsx

@@ -1,9 +1,13 @@
 import React, { PropsWithChildren, useEffect, useMemo } from "react";
 import { FirebaseContext, FirebaseContextValue } from "./FirebaseContext";
-import { connectAuthEmulator } from "@react-native-firebase/auth";
-import { FirebaseAnalyticsTypes, setAnalyticsCollectionEnabled, setConsent } from "@react-native-firebase/analytics";
-import { FirebaseRemoteConfigTypes } from "@react-native-firebase/remote-config";
-import { connectFirestoreEmulator } from "@react-native-firebase/firestore";
+import auth, { connectAuthEmulator } from "@react-native-firebase/auth";
+import analytics, {
+    FirebaseAnalyticsTypes,
+    setAnalyticsCollectionEnabled,
+    setConsent
+} from "@react-native-firebase/analytics";
+import remoteConfig, { FirebaseRemoteConfigTypes } from "@react-native-firebase/remote-config";
+import firestore, { connectFirestoreEmulator } from "@react-native-firebase/firestore";
 import firebase, { ReactNativeFirebase } from "@react-native-firebase/app";
 
 /**
@@ -163,7 +167,7 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
     const internalFirebase = useMemo(() => firebase, []);
 
     useEffect(() => {
-        setConsent(firebase.analytics(), {
+        setConsent(analytics(), {
             ad_personalization: false,
             ad_storage: false,
             ad_user_data: false,
@@ -178,14 +182,10 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
     const internalFirestore = useMemo(() => {
         if (firestoreEnabled) {
             if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(
-                    internalFirebase.firestore(),
-                    emulators.firestore.host,
-                    emulators.firestore.port
-                );
+                connectFirestoreEmulator(firestore(), emulators.firestore.host, emulators.firestore.port);
             }
 
-            const localFirestore = internalFirebase.firestore();
+            const localFirestore = firestore();
             if (firestoreSettings) {
                 localFirestore.settings(firestoreSettings);
             }
@@ -193,11 +193,11 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         }
 
         return null;
-    }, [emulators?.firestore, firestoreEnabled, internalFirebase, firestoreSettings]);
+    }, [emulators?.firestore, firestoreEnabled, firestoreSettings]);
 
     const internalAuth = useMemo(() => {
         if (authEnabled) {
-            const localAuth = internalFirebase.auth();
+            const localAuth = auth();
             if (emulators?.auth?.host) {
                 connectAuthEmulator(localAuth, emulators?.auth?.host, {
                     disableWarnings: true
@@ -206,18 +206,18 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
             return localAuth;
         }
         return null;
-    }, [emulators?.auth, authEnabled, internalFirebase]);
+    }, [emulators?.auth, authEnabled]);
 
     const internalAnalytics = useMemo(() => {
         if (analyticsEnabled) {
-            return internalFirebase.analytics();
+            return analytics();
         }
         return null;
-    }, [analyticsEnabled, internalFirebase]);
+    }, [analyticsEnabled]);
 
     const internalRemoteConfig = useMemo(() => {
         if (remoteConfigEnabled) {
-            const localRemoteConfig = internalFirebase.remoteConfig();
+            const localRemoteConfig = remoteConfig();
             if (remoteConfigSettings) {
                 localRemoteConfig.settings.fetchTimeMillis = remoteConfigSettings.fetchTimeMillis;
                 localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
@@ -226,7 +226,7 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
             return localRemoteConfig;
         }
         return null;
-    }, [remoteConfigEnabled, remoteConfigSettings, internalFirebase, remoteConfigDefaults]);
+    }, [remoteConfigEnabled, remoteConfigSettings, remoteConfigDefaults]);
 
     const contextValue = useMemo(
         () => ({

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

@@ -36,5 +36,5 @@ export declare const buildCompositeFilter: <DbModelType extends CompositeFilterD
  *
  * @returns {(Function|undefined)} A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints.
  */
-export declare const useCompositeFilter: <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>({ query }: UseCompositeFilter<DbModelType>) => FirebaseFirestoreTypes.QueryCompositeFilterConstraint | undefined;
+export declare const useCompositeFilter: <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>({ query }: UseCompositeFilter<DbModelType>) => FirebaseFirestoreTypes.QueryFilterConstraint | undefined;
 export {};

package/react-native/firestore/useCompositeFilter.js

@@ -13,6 +13,9 @@ export const buildCompositeFilter = (query) => {
         if (queryConstraints.length <= 0) {
             return null;
         }
+        if (queryConstraints.length <= 1) {
+            return queryConstraints[0];
+        }
         return query.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
     if (query.field && query.op) {
@@ -37,6 +40,9 @@ export const useCompositeFilter = ({ query }) => {
         if (queryConstraints.length <= 0) {
             return undefined;
         }
+        if (queryConstraints.length <= 1) {
+            return queryConstraints[0];
+        }
         return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }, [query]);
 };

package/react-native/firestore/useCompositeFilter.ts

@@ -38,6 +38,10 @@ export const buildCompositeFilter = <DbModelType extends CompositeFilterDocument
             return null;
         }
 
+        if (queryConstraints.length <= 1) {
+            return queryConstraints[0];
+        }
+
         return (query as CompositeFilter).operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }
 
@@ -73,6 +77,11 @@ export const useCompositeFilter = <DbModelType extends CompositeFilterDocumentDa
         if (queryConstraints.length <= 0) {
             return undefined;
         }
+
+        if (queryConstraints.length <= 1) {
+            return queryConstraints[0];
+        }
+
         return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
     }, [query]);
 };

package/web/auth/useAuthStateReady.d.ts

@@ -1,6 +1,17 @@
 /**
  * A custom hook that determines if the Firebase authentication state is ready.
  * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
- * @returns {boolean} Indicates whether the authentication state is ready.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
  */
 export declare const useAuthStateReady: () => boolean;

package/web/auth/useAuthStateReady.js

@@ -3,7 +3,18 @@ import { useCallback, useEffect, useState } from "react";
 /**
  * A custom hook that determines if the Firebase authentication state is ready.
  * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
- * @returns {boolean} Indicates whether the authentication state is ready.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
  */
 export const useAuthStateReady = () => {
     const firebaseAuth = useAuth();

package/web/auth/useAuthStateReady.ts

@@ -4,7 +4,18 @@ import { useCallback, useEffect, useState } from "react";
 /**
  * A custom hook that determines if the Firebase authentication state is ready.
  * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
- * @returns {boolean} Indicates whether the authentication state is ready.
+ *
+ * @group Hook
+ *
+ * @returns {boolean}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const isAuthStateReady = useAuthStateReady();
+ *  console.log(isAuthStateReady);
+ * };
+ * ```
  */
 export const useAuthStateReady = () => {
     const firebaseAuth = useAuth();