react-query-firebase 2.1.4 → 2.2.0

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.1.4"
+    "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/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();