react-query-firebase 2.1.1 → 2.1.3

package/package.json

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

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

@@ -0,0 +1,3 @@
+export * from "./useLogEvent";
+export * from "./useAnalytics";
+export * from "./useSetAnalyticsCollectionEnabled";

package/react-native/analytics/index.js

@@ -0,0 +1,3 @@
+export * from "./useLogEvent";
+export * from "./useAnalytics";
+export * from "./useSetAnalyticsCollectionEnabled";

package/react-native/analytics/useAnalytics.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Hook to access Firebase analytics from the Firebase context.
+ * @returns {any} The analytics object from the Firebase context.
+ */
+export declare const useAnalytics: () => import("@react-native-firebase/analytics").FirebaseAnalyticsTypes.Module;

package/react-native/analytics/useAnalytics.js

@@ -0,0 +1,10 @@
+import { useContext } from "react";
+import { FirebaseContext } from "../context/FirebaseContext";
+/**
+ * Hook to access Firebase analytics from the Firebase context.
+ * @returns {any} The analytics object from the Firebase context.
+ */
+export const useAnalytics = () => {
+    const { analytics } = useContext(FirebaseContext);
+    return analytics;
+};

package/react-native/analytics/useLogEvent.d.ts

@@ -0,0 +1,17 @@
+type UseLogEventOptions = {
+    eventName: string;
+    eventParams?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Custom hook to create a log event function that logs an analytics event with specified parameters.
+ * @param {Object}  options - The options for the log event.
+ * @param {string}  options.eventName - The name of the event to be logged.
+ * @param {Object}  options.eventParams - The parameters to be sent along with the event.
+ * @returns {Object} An object containing a `logEvent` function that, when called, logs the event.
+ */
+export declare const useLogEvent: ({ eventName, eventParams }: UseLogEventOptions) => {
+    logEvent: () => void;
+};
+export {};

package/react-native/analytics/useLogEvent.js

@@ -0,0 +1,21 @@
+import { logEvent } from "@react-native-firebase/analytics";
+import { useAnalytics } from "./useAnalytics";
+import { useCallback, useMemo } from "react";
+/**
+ * Custom hook to create a log event function that logs an analytics event with specified parameters.
+ * @param {Object}  options - The options for the log event.
+ * @param {string}  options.eventName - The name of the event to be logged.
+ * @param {Object}  options.eventParams - The parameters to be sent along with the event.
+ * @returns {Object} An object containing a `logEvent` function that, when called, logs the event.
+ */
+export const useLogEvent = ({ eventName, eventParams }) => {
+    const analytics = useAnalytics();
+    const logEventCallback = useCallback(() => {
+        if (analytics) {
+            logEvent(analytics, eventName, eventParams);
+        }
+    }, [eventName, eventParams, analytics]);
+    return useMemo(() => ({
+        logEvent: logEventCallback
+    }), [logEventCallback]);
+};

package/react-native/analytics/useSetAnalyticsCollectionEnabled.d.ts

@@ -0,0 +1,10 @@
+type UseSetAnalyticsCollectionEnabledOptions = {
+    enabled?: boolean;
+};
+/**
+ * Custom hook to enable or disable analytics collection
+ * @param {Object}  options - The options for hook.
+ * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
+ */
+export declare const useSetAnalyticsCollectionEnabled: ({ enabled }: UseSetAnalyticsCollectionEnabledOptions) => void;
+export {};

package/react-native/analytics/useSetAnalyticsCollectionEnabled.js

@@ -0,0 +1,16 @@
+import { setAnalyticsCollectionEnabled } from "@react-native-firebase/analytics";
+import { useAnalytics } from "./useAnalytics";
+import { useEffect } from "react";
+/**
+ * Custom hook to enable or disable analytics collection
+ * @param {Object}  options - The options for hook.
+ * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
+ */
+export const useSetAnalyticsCollectionEnabled = ({ enabled = false }) => {
+    const analytics = useAnalytics();
+    useEffect(() => {
+        if (analytics) {
+            setAnalyticsCollectionEnabled(analytics, enabled);
+        }
+    }, [analytics, enabled]);
+};

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

@@ -0,0 +1,12 @@
+export * from "./mutation-keys";
+export * from "./useAuth";
+export * from "./useCreateUserWitEmailAndPasswordMutation";
+export * from "./useSendEmailVerificationMutation";
+export * from "./useSignInWitEmailAndPasswordMutation";
+export * from "./useCurrentUser";
+export * from "./useSignInWitRedirectMutation";
+export * from "./useUpdateProfileMutation";
+export * from "./useSignOutMutation";
+export * from "./useIdToken";
+export * from "./useReauthenticateWitCredentialMutation";
+export * from "./useReauthenticateWitRedirectMutation";

package/react-native/auth/index.js

@@ -0,0 +1,12 @@
+export * from "./mutation-keys";
+export * from "./useAuth";
+export * from "./useCreateUserWitEmailAndPasswordMutation";
+export * from "./useSendEmailVerificationMutation";
+export * from "./useSignInWitEmailAndPasswordMutation";
+export * from "./useCurrentUser";
+export * from "./useSignInWitRedirectMutation";
+export * from "./useUpdateProfileMutation";
+export * from "./useSignOutMutation";
+export * from "./useIdToken";
+export * from "./useReauthenticateWitCredentialMutation";
+export * from "./useReauthenticateWitRedirectMutation";

package/react-native/auth/mutation-keys.d.ts

@@ -0,0 +1,7 @@
+export declare const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"];
+export declare const SEND_EMAIL_VERIFICATION_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
+export declare const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"];
+export declare const SIGN_IN_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
+export declare const SIGN_OUT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "SIGN_OUT"];
+export declare const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"];
+export declare const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY: readonly ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_CREDENTIAL"];

package/react-native/auth/mutation-keys.js

@@ -0,0 +1,19 @@
+export const CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
+    "FIREBASE",
+    "AUTH",
+    "CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION"
+];
+export const SEND_EMAIL_VERIFICATION_MUTATION_KEY = ["FIREBASE", "AUTH", "SEND_EMAIL_VERIFICATION_MUTATION"];
+export const SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY = [
+    "FIREBASE",
+    "AUTH",
+    "SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION"
+];
+export const SIGN_IN_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_IN_WITH_REDIRECT_MUTATION"];
+export const SIGN_OUT_MUTATION_KEY = ["FIREBASE", "AUTH", "SIGN_OUT"];
+export const REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY = ["FIREBASE", "AUTH", "REAUTHENTICATE_WITH_REDIRECT"];
+export const REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY = [
+    "FIREBASE",
+    "AUTH",
+    "REAUTHENTICATE_WITH_CREDENTIAL"
+];

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

@@ -0,0 +1,5 @@
+/**
+ * Custom hook to retrieve the authentication object from the Firebase context.
+ * @returns {Auth} The authentication object from the Firebase context.
+ */
+export declare const useAuth: () => import("@react-native-firebase/auth").FirebaseAuthTypes.Module;

package/react-native/auth/useAuth.js

@@ -0,0 +1,10 @@
+import { useContext } from "react";
+import { FirebaseContext } from "../context/FirebaseContext";
+/**
+ * Custom hook to retrieve the authentication object from the Firebase context.
+ * @returns {Auth} The authentication object from the Firebase context.
+ */
+export const useAuth = () => {
+    const { auth } = useContext(FirebaseContext);
+    return auth;
+};

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

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseCreateUserWitEmailAndPasswordMutationVariables = {
+    email: string;
+    password: string;
+};
+/**
+ * Custom hook to initiate a user creation process using email and password with Firebase authentication.
+ * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
+ */
+export declare const useCreateUserWitEmailAndPasswordMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>;

package/react-native/auth/useCreateUserWitEmailAndPasswordMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+import { createUserWithEmailAndPassword } from "@react-native-firebase/auth";
+import { useAuth } from "./useAuth";
+import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook to initiate a user creation process using email and password with Firebase authentication.
+ * This hook utilizes the `useMutation` functionality to support creating new user credentials asynchronously.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional settings to customize the mutation behavior, excluding `mutationKey` and `mutationFn`.
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>} The result of the mutation which includes status, user credentials, and error information if any.
+ */
+export const useCreateUserWitEmailAndPasswordMutation = (options = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationFn: async ({ email, password }) => await createUserWithEmailAndPassword(firebaseAuth, email, password),
+        mutationKey: CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,6 @@
+/**
+ * Hook that provides the current authenticated user from Firebase Auth.
+ * It listens for changes in the authentication state and updates the user accordingly.
+ * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
+ */
+export declare const useCurrentUser: () => import("@react-native-firebase/auth").FirebaseAuthTypes.User | null;

package/react-native/auth/useCurrentUser.js

@@ -0,0 +1,20 @@
+import { useAuth } from "./useAuth";
+import { useEffect, useState } from "react";
+/**
+ * Hook that provides the current authenticated user from Firebase Auth.
+ * It listens for changes in the authentication state and updates the user accordingly.
+ * @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);
+    useEffect(() => {
+        const unsubscribe = onAuthStateChanged((user) => {
+            setCurrentUser(user);
+        });
+        return () => {
+            unsubscribe();
+        };
+    }, [currentUser?.uid, onAuthStateChanged]);
+    return currentUser;
+};

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

@@ -0,0 +1,30 @@
+/**
+ * @inline
+ */
+export type UseIdTokenResult = {
+    idToken: string;
+    refresh: () => Promise<string | undefined>;
+};
+/**
+ * A hook to manage the ID token.
+ * It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed.
+ *
+ * @group Hook
+ *
+ * @returns {UseIdTokenResult}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const result = useIdToken();
+ *  useEffect(() => {
+ *      const timeout = setTimeout(() => {
+ *          result.refresh();
+ *      }, 5000);
+ *      return () => clearTimeout();
+ *  }, [])
+ *  console.log(resilt.idToken);
+ * };
+ * ```
+ */
+export declare const useIdToken: () => UseIdTokenResult;

package/react-native/auth/useIdToken.js

@@ -0,0 +1,66 @@
+import { useCallback, useEffect, useState } from "react";
+import { useCurrentUser } from "./useCurrentUser";
+import { onIdTokenChanged } from "@react-native-firebase/auth";
+import { useAuth } from "./useAuth";
+/**
+ * A hook to manage the ID token.
+ * It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed.
+ *
+ * @group Hook
+ *
+ * @returns {UseIdTokenResult}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const result = useIdToken();
+ *  useEffect(() => {
+ *      const timeout = setTimeout(() => {
+ *          result.refresh();
+ *      }, 5000);
+ *      return () => clearTimeout();
+ *  }, [])
+ *  console.log(resilt.idToken);
+ * };
+ * ```
+ */
+export const useIdToken = () => {
+    const auth = useAuth();
+    const currentUser = useCurrentUser();
+    const [idToken, setIdToken] = useState("");
+    const callback = useCallback(async () => {
+        if (!currentUser) {
+            setIdToken("");
+            return;
+        }
+        const idToken = await currentUser.getIdToken();
+        setIdToken(idToken);
+    }, [currentUser]);
+    const refresh = useCallback(async () => {
+        if (!currentUser) {
+            return;
+        }
+        const idToken = await currentUser.getIdToken(true);
+        return idToken;
+    }, [currentUser]);
+    useEffect(() => {
+        callback();
+    }, [callback]);
+    useEffect(() => {
+        const unsubscribe = onIdTokenChanged(auth, (user) => {
+            if (user) {
+                user.getIdToken().then((idToken) => {
+                    setIdToken(idToken);
+                });
+            }
+            else {
+                setIdToken("");
+            }
+        });
+        return () => unsubscribe();
+    }, [auth]);
+    return {
+        idToken,
+        refresh
+    };
+};

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

@@ -0,0 +1,16 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseReauthenticateWitCredentialMutationVariables = {
+    credential: FirebaseAuthTypes.AuthCredential;
+    user: FirebaseAuthTypes.User;
+};
+/**
+ * Custom hook to create a mutation for re-authenticating a user with a given credential.
+ * This hook utilizes useMutation from React Query to manage the asynchronous re-authentication
+ * process with Firebase credentials. It omits the default "mutationKey" and "mutationFn" options.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>} A useMutation result object managing the loading, error, and result state of the re-authentication mutation.
+ */
+export declare const useReauthenticateWitCredentialMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>;

package/react-native/auth/useReauthenticateWitCredentialMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { reauthenticateWithCredential } from "@react-native-firebase/auth";
+import { REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook to create a mutation for re-authenticating a user with a given credential.
+ * This hook utilizes useMutation from React Query to manage the asynchronous re-authentication
+ * process with Firebase credentials. It omits the default "mutationKey" and "mutationFn" options.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>} A useMutation result object managing the loading, error, and result state of the re-authentication mutation.
+ */
+export const useReauthenticateWitCredentialMutation = (options = {}) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ credential, user }) => reauthenticateWithCredential(user, credential),
+        mutationKey: REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,17 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes, PopupRedirectResolver } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseReauthenticateWitRedirectMutationVariables = {
+    authProvider: FirebaseAuthTypes.AuthProvider;
+    popupRedirectResolver?: PopupRedirectResolver;
+    user: FirebaseAuthTypes.User;
+};
+/**
+ * Custom hook that provides a mutation to reauthenticate a user with a given authentication provider using redirection.
+ * This hook uses the `useMutation` hook from the React Query library to handle async mutation logic.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configuration object for the mutation. It provides the ability to pass options to customize the behavior of the mutation.
+ * @template TContext - The type of any additional context you wish to pass to the mutation.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>} A mutation result object containing methods and state of the mutation.
+ */
+export declare const useReauthenticateWitRedirectMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>;

package/react-native/auth/useReauthenticateWitRedirectMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { reauthenticateWithRedirect } from "@react-native-firebase/auth";
+import { REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook that provides a mutation to reauthenticate a user with a given authentication provider using redirection.
+ * This hook uses the `useMutation` hook from the React Query library to handle async mutation logic.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configuration object for the mutation. It provides the ability to pass options to customize the behavior of the mutation.
+ * @template TContext - The type of any additional context you wish to pass to the mutation.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>} A mutation result object containing methods and state of the mutation.
+ */
+export const useReauthenticateWitRedirectMutation = (options = {}) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ authProvider, user, popupRedirectResolver }) => reauthenticateWithRedirect(user, authProvider, popupRedirectResolver),
+        mutationKey: REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,13 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseSendEmailVerificationMutationVariables = {
+    user: FirebaseAuthTypes.User;
+};
+/**
+ * A custom hook to create a mutation for sending an email verification to a user using Firebase.
+ * This uses the `useMutation` hook from a query library and wraps it with specific configuration options.
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, NativeReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>} An object containing mutation state and functions for managing the mutation lifecycle.
+ */
+export declare const useSendEmailVerificationMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>;

package/react-native/auth/useSendEmailVerificationMutation.js

@@ -0,0 +1,16 @@
+import { useMutation } from "@tanstack/react-query";
+import { sendEmailVerification } from "@react-native-firebase/auth";
+import { SEND_EMAIL_VERIFICATION_MUTATION_KEY } from "./mutation-keys";
+/**
+ * A custom hook to create a mutation for sending an email verification to a user using Firebase.
+ * This uses the `useMutation` hook from a query library and wraps it with specific configuration options.
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, NativeReactNativeFirebase.NativeFirebaseError, UseSendEmailVerificationMutationVariables, TContext>} An object containing mutation state and functions for managing the mutation lifecycle.
+ */
+export const useSendEmailVerificationMutation = (options = {}) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ user }) => await sendEmailVerification(user),
+        mutationKey: SEND_EMAIL_VERIFICATION_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseSignInWitEmailAndPasswordMutationVariables = {
+    email: string;
+    password: string;
+};
+/**
+ * Custom hook to perform a sign-in operation using email and password with Firebase Authentication.
+ * It utilizes the `useMutation` hook to manage the asynchronous operation and its state.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>, 'mutationKey' | 'mutationFn'>} options - Options to configure the mutation, excluding 'mutationKey' and 'mutationFn'.
+ * @returns {MutationResult} A mutation object containing the result of the sign-in process and helper functions.
+ */
+export declare const useSignInWitEmailAndPasswordMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>;

package/react-native/auth/useSignInWitEmailAndPasswordMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithEmailAndPassword } from "@react-native-firebase/auth";
+import { useAuth } from "./useAuth";
+import { SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook to perform a sign-in operation using email and password with Firebase Authentication.
+ * It utilizes the `useMutation` hook to manage the asynchronous operation and its state.
+ *
+ * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>, 'mutationKey' | 'mutationFn'>} options - Options to configure the mutation, excluding 'mutationKey' and 'mutationFn'.
+ * @returns {MutationResult} A mutation object containing the result of the sign-in process and helper functions.
+ */
+export const useSignInWitEmailAndPasswordMutation = (options = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationFn: async ({ email, password }) => signInWithEmailAndPassword(firebaseAuth, email, password),
+        mutationKey: SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,14 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes, PopupRedirectResolver } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseSignInWitRedirectMutationVariables = {
+    authProvider: FirebaseAuthTypes.AuthProvider;
+    popupRedirectResolver?: PopupRedirectResolver;
+};
+/**
+ * Custom hook for handling Firebase authentication using sign-in with redirect functionality.
+ * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export declare const useSignInWitRedirectMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>;

package/react-native/auth/useSignInWitRedirectMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithRedirect } from "@react-native-firebase/auth";
+import { useAuth } from "./useAuth";
+import { SIGN_IN_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook for handling Firebase authentication using sign-in with redirect functionality.
+ * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseSignInWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export const useSignInWitRedirectMutation = (options = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationFn: async ({ authProvider, popupRedirectResolver }) => signInWithRedirect(firebaseAuth, authProvider, popupRedirectResolver),
+        mutationKey: SIGN_IN_WITH_REDIRECT_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,10 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+/**
+ * Custom hook for handling the sign-out mutation using Firebase authentication.
+ * It wraps the useMutation hook to provide a sign-out function with Firebase.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding "queryKey" and "queryFn".
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>} A mutation object for handling the sign-out process, including methods for mutating and state tracking.
+ */
+export declare const useSignOutMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>;

package/react-native/auth/useSignOutMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+import { signOut } from "@react-native-firebase/auth";
+import { SIGN_OUT_MUTATION_KEY } from "./mutation-keys";
+import { useAuth } from "./useAuth";
+/**
+ * Custom hook for handling the sign-out mutation using Firebase authentication.
+ * It wraps the useMutation hook to provide a sign-out function with Firebase.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding "queryKey" and "queryFn".
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>} A mutation object for handling the sign-out process, including methods for mutating and state tracking.
+ */
+export const useSignOutMutation = (options = {}) => {
+    const firebaseAuth = useAuth();
+    return useMutation({
+        ...options,
+        mutationFn: async () => await signOut(firebaseAuth),
+        mutationKey: SIGN_OUT_MUTATION_KEY
+    });
+};

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

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseAuthTypes } from "@react-native-firebase/auth";
+import { ReactNativeFirebase } from "@react-native-firebase/app";
+export type UseUpdateProfileMutationVariables = {
+    displayName?: string;
+    user: FirebaseAuthTypes.User;
+};
+/**
+ * Custom hook to manage the mutation for updating a user's profile.
+ * Utilizes Firebase for updating the user's display name.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Configuration options for the mutation, excluding mutationKey and mutationFn.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>} The result of the mutation operation including statuses, data, and error information.
+ */
+export declare const useUpdateProfileMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>;

package/react-native/auth/useUpdateProfileMutation.js

@@ -0,0 +1,17 @@
+import { useMutation } from "@tanstack/react-query";
+import { updateProfile } from "@react-native-firebase/auth";
+import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
+/**
+ * Custom hook to manage the mutation for updating a user's profile.
+ * Utilizes Firebase for updating the user's display name.
+ *
+ * @param {Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Configuration options for the mutation, excluding mutationKey and mutationFn.
+ * @returns {UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseUpdateProfileMutationVariables, TContext>} The result of the mutation operation including statuses, data, and error information.
+ */
+export const useUpdateProfileMutation = (options = {}) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ displayName, user }) => await updateProfile(user, { displayName }),
+        mutationKey: CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
+    });
+};

package/react-native/context/FirebaseContextProvider.d.ts

@@ -59,7 +59,6 @@ export type FirebaseContextProviderEmulators = {
  * @inline
  */
 export type FirebaseContextProviderProps = PropsWithChildren & {
-    platform: "Web" | "ReactNative";
     /**
      * Defines configuration for firebase emulators
      */
@@ -67,7 +66,7 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
     /**
      * Configuration options for Firebase initialization. {@link https://firebase.google.com/docs/web/setup#config-object | Learn about the Firebase config object}
      */
-    options: ReactNativeFirebase.FirebaseAppOptions;
+    options?: ReactNativeFirebase.FirebaseAppOptions;
     /**
      * Flag indicating whether Firebase Auth should be enabled.
      */