react-query-firebase 2.0.0-rc6 → 2.0.0-rc7

package/web/auth/useIdToken.ts

@@ -0,0 +1,83 @@
+import { useCallback, useEffect, useState } from "react";
+import { useCurrentUser } from "./useCurrentUser";
+import { onIdTokenChanged } from "firebase/auth";
+import { useAuth } from "./useAuth";
+
+/**
+ * @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 const useIdToken = (): UseIdTokenResult => {
+    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, idToken]);
+
+    const refresh = useCallback(async () => {
+        if (!currentUser) {
+            return;
+        }
+
+        const idToken = await currentUser.getIdToken(true);
+        return idToken;
+    }, [currentUser, idToken]);
+
+    useEffect(() => {
+        callback();
+    }, [currentUser?.uid ?? ""]);
+
+    useEffect(() => {
+        const unsubscribe = onIdTokenChanged(auth, (user) => {
+            if (user) {
+                user.getIdToken().then((idToken) => {
+                    setIdToken(idToken);
+                });
+            } else {
+                setIdToken("");
+            }
+        });
+
+        return () => unsubscribe();
+    }, [idToken]);
+
+    return {
+        idToken,
+        refresh
+    };
+};

package/web/auth/useReauthenticateWitCredentialMutation.d.ts

@@ -0,0 +1,16 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { User, AuthCredential, UserCredential } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+export type UseReauthenticateWitCredentialMutationVariables = {
+    credential: AuthCredential;
+    user: 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<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<UserCredential, FirebaseError, 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<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>;

package/web/auth/useReauthenticateWitCredentialMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { reauthenticateWithCredential } from "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<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<UserCredential, FirebaseError, 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/web/auth/useReauthenticateWitCredentialMutation.ts

@@ -0,0 +1,31 @@
+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";
+
+export type UseReauthenticateWitCredentialMutationVariables = {
+    credential: AuthCredential;
+    user: 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<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>} A useMutation result object managing the loading, error, and result state of the re-authentication mutation.
+ */
+export const useReauthenticateWitCredentialMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ credential, user }: UseReauthenticateWitCredentialMutationVariables) =>
+            reauthenticateWithCredential(user, credential),
+        mutationKey: REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY
+    });
+};

package/web/auth/useReauthenticateWitRedirectMutation.d.ts

@@ -0,0 +1,17 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { AuthProvider, PopupRedirectResolver, User } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+export type UseReauthenticateWitRedirectMutationVariables = {
+    authProvider: AuthProvider;
+    popupRedirectResolver?: PopupRedirectResolver;
+    user: 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, FirebaseError, 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, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>} A mutation result object containing methods and state of the mutation.
+ */
+export declare const useReauthenticateWitRedirectMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>;

package/web/auth/useReauthenticateWitRedirectMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { reauthenticateWithRedirect } from "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, FirebaseError, 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, FirebaseError, 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/web/auth/useReauthenticateWitRedirectMutation.ts

@@ -0,0 +1,37 @@
+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";
+
+export type UseReauthenticateWitRedirectMutationVariables = {
+    authProvider: AuthProvider;
+    popupRedirectResolver?: PopupRedirectResolver;
+    user: 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, FirebaseError, 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, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>} A mutation result object containing methods and state of the mutation.
+ */
+export const useReauthenticateWitRedirectMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({
+            authProvider,
+            user,
+            popupRedirectResolver
+        }: UseReauthenticateWitRedirectMutationVariables) =>
+            reauthenticateWithRedirect(user, authProvider, popupRedirectResolver),
+        mutationKey: REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY
+    });
+};

package/web/auth/useSendEmailVerificationMutation.d.ts

@@ -0,0 +1,13 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { User } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+export type UseSendEmailVerificationMutationVariables = {
+    user: 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, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>} An object containing mutation state and functions for managing the mutation lifecycle.
+ */
+export declare const useSendEmailVerificationMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseMutationResult<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>;

package/web/auth/useSendEmailVerificationMutation.js

@@ -0,0 +1,16 @@
+import { useMutation } from "@tanstack/react-query";
+import { sendEmailVerification } from "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, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, FirebaseError, 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/web/auth/useSendEmailVerificationMutation.ts

@@ -0,0 +1,28 @@
+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";
+
+export type UseSendEmailVerificationMutationVariables = {
+    user: 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, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>} An object containing mutation state and functions for managing the mutation lifecycle.
+ */
+export const useSendEmailVerificationMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>,
+        "queryKey" | "queryFn"
+    > = {}
+) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ user }) => await sendEmailVerification(user),
+        mutationKey: SEND_EMAIL_VERIFICATION_MUTATION_KEY
+    });
+};

package/web/auth/useSignInWitEmailAndPasswordMutation.d.ts

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { UserCredential } from "firebase/auth";
+import { FirebaseError } from "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<UserCredential, FirebaseError, 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<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>;

package/web/auth/useSignInWitEmailAndPasswordMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithEmailAndPassword } from "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<UserCredential, FirebaseError, 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/web/auth/useSignInWitEmailAndPasswordMutation.ts

@@ -0,0 +1,34 @@
+import { useMutation, UseMutationOptions } from "@tanstack/react-query";
+import { signInWithEmailAndPassword, UserCredential } from "firebase/auth";
+
+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;
+    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<UserCredential, FirebaseError, 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 = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    const firebaseAuth = useAuth();
+
+    return useMutation({
+        ...options,
+        mutationFn: async ({ email, password }: UseSignInWitEmailAndPasswordMutationVariables) =>
+            signInWithEmailAndPassword(firebaseAuth, email, password),
+        mutationKey: SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
+    });
+};

package/web/auth/useSignInWitRedirectMutation.d.ts

@@ -0,0 +1,14 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { AuthProvider, PopupRedirectResolver } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+export type UseSignInWitRedirectMutationVariables = {
+    authProvider: 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, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<void, FirebaseError, 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, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>;

package/web/auth/useSignInWitRedirectMutation.js

@@ -0,0 +1,18 @@
+import { useMutation } from "@tanstack/react-query";
+import { signInWithRedirect } from "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, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<void, FirebaseError, 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/web/auth/useSignInWitRedirectMutation.ts

@@ -0,0 +1,33 @@
+import { useMutation, UseMutationOptions } from "@tanstack/react-query";
+import { signInWithRedirect, AuthProvider, PopupRedirectResolver } from "firebase/auth";
+
+import { useAuth } from "./useAuth";
+import { SIGN_IN_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
+import { FirebaseError } from "firebase/app";
+
+export type UseSignInWitRedirectMutationVariables = {
+    authProvider: 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, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
+ * @returns {UseMutationResult<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
+ */
+export const useSignInWitRedirectMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    const firebaseAuth = useAuth();
+
+    return useMutation({
+        ...options,
+        mutationFn: async ({ authProvider, popupRedirectResolver }: UseSignInWitRedirectMutationVariables) =>
+            signInWithRedirect(firebaseAuth, authProvider, popupRedirectResolver),
+        mutationKey: SIGN_IN_WITH_REDIRECT_MUTATION_KEY
+    });
+};

package/web/auth/useSignOutMutation.d.ts

@@ -0,0 +1,10 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { FirebaseError } from "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, FirebaseError, void, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding "queryKey" and "queryFn".
+ * @returns {UseMutationResult<void, FirebaseError, 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, FirebaseError, void, TContext>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseMutationResult<void, FirebaseError, void, TContext>;

package/web/auth/useSignOutMutation.js

@@ -0,0 +1,19 @@
+import { useMutation } from "@tanstack/react-query";
+import { signOut } from "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, FirebaseError, void, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding "queryKey" and "queryFn".
+ * @returns {UseMutationResult<void, FirebaseError, 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/web/auth/useSignOutMutation.ts

@@ -0,0 +1,25 @@
+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 { 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, FirebaseError, void, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding "queryKey" and "queryFn".
+ * @returns {UseMutationResult<void, FirebaseError, void, TContext>} A mutation object for handling the sign-out process, including methods for mutating and state tracking.
+ */
+export const useSignOutMutation = <TContext = unknown>(
+    options: Omit<UseMutationOptions<void, FirebaseError, void, TContext>, "queryKey" | "queryFn"> = {}
+) => {
+    const firebaseAuth = useAuth();
+
+    return useMutation({
+        ...options,
+        mutationFn: async () => await signOut(firebaseAuth),
+        mutationKey: SIGN_OUT_MUTATION_KEY
+    });
+};

package/web/auth/useUpdateProfileMutation.d.ts

@@ -0,0 +1,15 @@
+import { UseMutationOptions } from "@tanstack/react-query";
+import { User } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+export type UseUpdateProfileMutationVariables = {
+    displayName?: string;
+    user: 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, FirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Configuration options for the mutation, excluding mutationKey and mutationFn.
+ * @returns {UseMutationResult<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>} The result of the mutation operation including statuses, data, and error information.
+ */
+export declare const useUpdateProfileMutation: <TContext = unknown>(options?: Omit<UseMutationOptions<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">) => import("@tanstack/react-query").UseMutationResult<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>;

package/web/auth/useUpdateProfileMutation.js

@@ -0,0 +1,17 @@
+import { useMutation } from "@tanstack/react-query";
+import { updateProfile } from "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, FirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Configuration options for the mutation, excluding mutationKey and mutationFn.
+ * @returns {UseMutationResult<void, FirebaseError, 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/web/auth/useUpdateProfileMutation.ts

@@ -0,0 +1,30 @@
+import { useMutation, UseMutationOptions } from "@tanstack/react-query";
+import { updateProfile, User } from "firebase/auth";
+import { FirebaseError } from "firebase/app";
+import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
+
+export type UseUpdateProfileMutationVariables = {
+    displayName?: string;
+    user: 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, FirebaseError, UseUpdateProfileMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Configuration options for the mutation, excluding mutationKey and mutationFn.
+ * @returns {UseMutationResult<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>} The result of the mutation operation including statuses, data, and error information.
+ */
+export const useUpdateProfileMutation = <TContext = unknown>(
+    options: Omit<
+        UseMutationOptions<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>,
+        "mutationKey" | "mutationFn"
+    > = {}
+) => {
+    return useMutation({
+        ...options,
+        mutationFn: async ({ displayName, user }: UseUpdateProfileMutationVariables) =>
+            await updateProfile(user, { displayName }),
+        mutationKey: CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY
+    });
+};

package/web/context/FirebaseContext.d.ts

@@ -0,0 +1,19 @@
+import { Auth } from "firebase/auth";
+import { Analytics } from "firebase/analytics";
+import { Firestore } from "firebase/firestore";
+import { FirebaseApp } from "firebase/app";
+import { RemoteConfig } from "firebase/remote-config";
+type FirebaseContextValue = {
+    auth: Auth;
+    analytics: Analytics;
+    firebase: FirebaseApp;
+    remoteConfig: RemoteConfig;
+    firestore: Firestore;
+};
+/**
+ * FirebaseContext is a shared context across children that provides access to firebase features
+ *
+ * @internal
+ */
+export declare const FirebaseContext: import("react").Context<FirebaseContextValue>;
+export {};

package/web/context/FirebaseContext.js

@@ -0,0 +1,8 @@
+"use client";
+import { createContext } from "react";
+/**
+ * FirebaseContext is a shared context across children that provides access to firebase features
+ *
+ * @internal
+ */
+export const FirebaseContext = createContext({});

package/web/context/FirebaseContext.ts

@@ -0,0 +1,25 @@
+"use client";
+
+import { createContext } from "react";
+
+import { Auth } from "firebase/auth";
+import { Analytics } from "firebase/analytics";
+import { Firestore } from "firebase/firestore";
+import { FirebaseApp } from "firebase/app";
+import { RemoteConfig } from "firebase/remote-config";
+
+type FirebaseContextValue = {
+    auth: Auth;
+    analytics: Analytics;
+    firebase: FirebaseApp;
+    remoteConfig: RemoteConfig;
+    firestore: Firestore;
+};
+
+/**
+ * FirebaseContext is a shared context across children that provides access to firebase features
+ *
+ * @internal
+ */
+
+export const FirebaseContext = createContext<FirebaseContextValue>({} as FirebaseContextValue);