react-query-firebase 2.10.0 → 2.11.0

package/package.json

@@ -74,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.10.0"
+    "version": "2.11.0"
 }

package/react-native/auth/useCurrentUser.js

@@ -1,3 +1,4 @@
+import { onAuthStateChanged } from "@react-native-firebase/auth";
 import { useAuth } from "./useAuth";
 import { useEffect, useState } from "react";
 /**
@@ -6,15 +7,15 @@ import { useEffect, useState } from "react";
  * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
  */
 export const useCurrentUser = () => {
-    const { onAuthStateChanged, currentUser: fbCurrentUser } = useAuth();
-    const [currentUser, setCurrentUser] = useState(fbCurrentUser);
+    const firebaseAuth = useAuth();
+    const [currentUser, setCurrentUser] = useState(firebaseAuth.currentUser);
     useEffect(() => {
-        const unsubscribe = onAuthStateChanged((user) => {
+        const unsubscribe = onAuthStateChanged(firebaseAuth, (user) => {
             setCurrentUser(user);
         });
         return () => {
             unsubscribe();
         };
-    }, [currentUser?.uid, onAuthStateChanged]);
+    }, [firebaseAuth]);
     return currentUser;
 };

package/react-native/auth/useCurrentUser.ts

@@ -1,3 +1,4 @@
+import { onAuthStateChanged } from "@react-native-firebase/auth";
 import { useAuth } from "./useAuth";
 import { useEffect, useState } from "react";
 
@@ -7,18 +8,19 @@ import { useEffect, useState } from "react";
  * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
  */
 export const useCurrentUser = () => {
-    const { onAuthStateChanged, currentUser: fbCurrentUser } = useAuth();
+    const firebaseAuth = useAuth();
 
-    const [currentUser, setCurrentUser] = useState(fbCurrentUser);
+    const [currentUser, setCurrentUser] = useState(firebaseAuth.currentUser);
 
     useEffect(() => {
-        const unsubscribe = onAuthStateChanged((user) => {
+        const unsubscribe = onAuthStateChanged(firebaseAuth, (user) => {
             setCurrentUser(user);
         });
+
         return () => {
             unsubscribe();
         };
-    }, [currentUser?.uid, onAuthStateChanged]);
+    }, [firebaseAuth]);
 
     return currentUser;
 };

package/web/auth/index.d.ts

@@ -17,3 +17,4 @@ export * from "./useFacebookAuthProviderCredential";
 export * from "./useAppleAuthProviderCredential";
 export * from "./useLinkWithCredentialMutation";
 export * from "./useSignInWithCredentialMutation";
+export * from "./useGetRedirectResultMutation";

package/web/auth/index.js

@@ -17,3 +17,4 @@ export * from "./useFacebookAuthProviderCredential";
 export * from "./useAppleAuthProviderCredential";
 export * from "./useLinkWithCredentialMutation";
 export * from "./useSignInWithCredentialMutation";
+export * from "./useGetRedirectResultMutation";

package/web/auth/index.ts

@@ -17,3 +17,4 @@ export * from "./useFacebookAuthProviderCredential";
 export * from "./useAppleAuthProviderCredential";
 export * from "./useLinkWithCredentialMutation";
 export * from "./useSignInWithCredentialMutation";
+export * from "./useGetRedirectResultMutation";

package/web/auth/mutation-keys.d.ts

@@ -1,4 +1,5 @@
 export declare const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"];
+export declare const GET_REDIRECT_RESULT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "GET_REDIRECT_RESULT_MUTATION"];
 export declare const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
 export declare const SIGN_IN_ANONYMOUSLY_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"];
 export declare const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"];

package/web/auth/mutation-keys.js

@@ -3,6 +3,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "AUTH",
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ];
+export const GET_REDIRECT_RESULT_MUTATION_KEY = ["FIREBASE", "AUTH", "GET_REDIRECT_RESULT_MUTATION"];
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
 export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"];
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [

package/web/auth/mutation-keys.ts

@@ -3,6 +3,7 @@ export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
     "AUTH",
     "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
 ] as const;
+export const GET_REDIRECT_RESULT_MUTATION_KEY = ["FIREBASE", "AUTH", "GET_REDIRECT_RESULT_MUTATION"] as const;
 export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"] as const;
 export const SIGN_IN_ANONYMOUSLY_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_ANONYMOUSLY_MUTATION"] as const;
 export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [

package/web/auth/useGetRedirectResultMutation.d.ts

@@ -0,0 +1,11 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { UserCredential } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+/**
+ * Custom hook to retrieve redirect result after sign in with redirect.
+ * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
+ *
+ * @param {Omit<UseMutationOptions<UserCredential, FirebaseError, void, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
+ * @returns {UseMutationResult<UserCredential, FirebaseError, void, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
+ */
+export declare const useGetRedirectResultMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<UserCredential | null, FirebaseError, void, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<UserCredential | null, FirebaseError, void, TContext>;

package/web/auth/useGetRedirectResultMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+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.
+ *
+ * @param {Omit<UseMutationOptions<UserCredential, FirebaseError, void, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
+ * @returns {UseMutationResult<UserCredential, FirebaseError, void, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
+ */
+export const useGetRedirectResultMutation = (options = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationFn: async () => await getRedirectResult(firebaseAuth),
+        mutationKey: GET_REDIRECT_RESULT_MUTATION_KEY
+    });
+};

package/web/auth/useGetRedirectResultMutation.ts

@@ -0,0 +1,27 @@
+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";
+
+/**
+ * Custom hook to retrieve redirect result after sign in with redirect.
+ * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
+ *
+ * @param {Omit<UseMutationOptions<UserCredential, FirebaseError, void, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
+ * @returns {UseMutationResult<UserCredential, FirebaseError, void, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
+ */
+export const useGetRedirectResultMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<UserCredential | null, FirebaseError, void, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    const firebaseAuth = useAuth();
+
+    return useMutation({
+        ...options,
+        mutationFn: async () => await getRedirectResult(firebaseAuth),
+        mutationKey: GET_REDIRECT_RESULT_MUTATION_KEY
+    });
+};