react-query-firebase 2.13.3 → 2.14.0

package/react-native/auth/useIdToken.ts

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

package/react-native/auth/useLinkWithCredentialMutation.ts

@@ -1,35 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { linkWithCredential, FirebaseAuthTypes } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { LINK_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
-
-export type UseLinkWitCredentialMutationVariables = {
-    user: FirebaseAuthTypes.User;
-    credential: FirebaseAuthTypes.AuthCredential;
-};
-
-/**
- * Custom hook for handling linking of Firebase account to auth provider using credential
- * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, UseLinkWitCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
- */
-export const useLinkWithCredentialMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            FirebaseAuthTypes.UserCredential,
-            ReactNativeFirebase.NativeFirebaseError,
-            UseLinkWitCredentialMutationVariables,
-            TContext
-        >,
-        "mutationKey" | "mutationFn"
-    > = {}
-) => {
-    return useMutation({
-        ...options,
-        mutationFn: async ({ user, credential }: UseLinkWitCredentialMutationVariables) =>
-            linkWithCredential(user, credential),
-        mutationKey: LINK_WITH_CREDENTIAL_MUTATION_KEY
-    });
-};

package/react-native/auth/useReauthenticateWitCredentialMutation.ts

@@ -1,36 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { reauthenticateWithCredential, FirebaseAuthTypes } from "@react-native-firebase/auth";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
-
-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 const useReauthenticateWitCredentialMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            FirebaseAuthTypes.UserCredential,
-            ReactNativeFirebase.NativeFirebaseError,
-            UseReauthenticateWitCredentialMutationVariables,
-            TContext
-        >,
-        "mutationKey" | "mutationFn"
-    > = {}
-) => {
-    return useMutation({
-        ...options,
-        mutationFn: async ({ credential, user }: UseReauthenticateWitCredentialMutationVariables) =>
-            reauthenticateWithCredential(user, credential),
-        mutationKey: REAUTHENTICATE_WITH_CREDENTIAL_MUTATION_KEY
-    });
-};

package/react-native/auth/useReauthenticateWitRedirectMutation.ts

@@ -1,42 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { reauthenticateWithRedirect, FirebaseAuthTypes, PopupRedirectResolver } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
-
-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 const useReauthenticateWitRedirectMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            void,
-            ReactNativeFirebase.NativeFirebaseError,
-            UseReauthenticateWitRedirectMutationVariables,
-            TContext
-        >,
-        "mutationKey" | "mutationFn"
-    > = {}
-) => {
-    return useMutation({
-        ...options,
-        mutationFn: async ({
-            authProvider,
-            user,
-            popupRedirectResolver
-        }: UseReauthenticateWitRedirectMutationVariables) =>
-            reauthenticateWithRedirect(user, authProvider, popupRedirectResolver),
-        mutationKey: REAUTHENTICATE_WITH_REDIRECT_MUTATION_KEY
-    });
-};

package/react-native/auth/useSendEmailVerificationMutation.ts

@@ -1,33 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { sendEmailVerification, FirebaseAuthTypes } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { SEND_EMAIL_VERIFICATION_MUTATION_KEY } from "./mutation-keys";
-
-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 const useSendEmailVerificationMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            void,
-            ReactNativeFirebase.NativeFirebaseError,
-            UseSendEmailVerificationMutationVariables,
-            TContext
-        >,
-        "queryKey" | "queryFn"
-    > = {}
-) => {
-    return useMutation({
-        ...options,
-        mutationFn: async ({ user }) => await sendEmailVerification(user),
-        mutationKey: SEND_EMAIL_VERIFICATION_MUTATION_KEY
-    });
-};

package/react-native/auth/useSignInAnonymouslyMutation.ts

@@ -1,52 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { signInAnonymously, FirebaseAuthTypes } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { useAuth } from "./useAuth";
-import { SIGN_IN_ANONYMOUSLY_MUTATION_KEY } from "./mutation-keys";
-
-/**
- * @inline
- */
-export type UseSignInAnonymouslyMutationOptions = {
-    /**
-     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
-     */
-    options?: Omit<
-        UseMutationOptions<FirebaseAuthTypes.UserCredential, ReactNativeFirebase.NativeFirebaseError, void>,
-        "mutationFn"
-    >;
-};
-
-/**
- * Executes a mutation and returns users credentials
- *
- * @group Hook
- *
- * @param {useSignInAnonymouslyMutation} options - Configuration options for the mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useSignInAnonymouslyMutation({
- *      options: {
- *      },
- *  });
- *
- *  // ....
- *  mutate();
- *  // ....
- * };
- * ```
- */
-export const useSignInAnonymouslyMutation = ({ options = {} }: UseSignInAnonymouslyMutationOptions = {}) => {
-    const firebaseAuth = useAuth();
-
-    return useMutation({
-        ...options,
-        mutationKey: SIGN_IN_ANONYMOUSLY_MUTATION_KEY,
-        mutationFn: async () => signInAnonymously(firebaseAuth)
-    });
-};

package/react-native/auth/useSignInWitEmailAndPasswordMutation.ts

@@ -1,39 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { signInWithEmailAndPassword, FirebaseAuthTypes } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { useAuth } from "./useAuth";
-import { SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
-
-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 const useSignInWitEmailAndPasswordMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            FirebaseAuthTypes.UserCredential,
-            ReactNativeFirebase.NativeFirebaseError,
-            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/react-native/auth/useSignInWitRedirectMutation.ts

@@ -1,38 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { signInWithRedirect, FirebaseAuthTypes, PopupRedirectResolver } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { useAuth } from "./useAuth";
-import { SIGN_IN_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
-
-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 const useSignInWitRedirectMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            void,
-            ReactNativeFirebase.NativeFirebaseError,
-            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/react-native/auth/useSignInWithCredentialMutation.ts

@@ -1,36 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseAuthTypes, signInWithCredential } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { SIGN_IN_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
-import { useAuth } from "./useAuth";
-
-export type UseSignInWithCredentialMutationVariables = {
-    credential: FirebaseAuthTypes.AuthCredential;
-};
-
-/**
- * Custom hook for handling sign in using credential
- * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
- * @param {Omit<UseMutationOptions<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
- * @returns {UseMutationResult<FirebaseAuthTypes.UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>} The result object from the useMutation hook, containing the mutation function and its current state.
- */
-export const useSignInWithCredentialMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<
-            FirebaseAuthTypes.UserCredential,
-            ReactNativeFirebase.NativeFirebaseError,
-            UseSignInWithCredentialMutationVariables,
-            TContext
-        >,
-        "mutationKey" | "mutationFn"
-    > = {}
-) => {
-    const auth = useAuth();
-    return useMutation({
-        ...options,
-        mutationFn: async ({ credential }: UseSignInWithCredentialMutationVariables) =>
-            signInWithCredential(auth, credential),
-        mutationKey: SIGN_IN_WITH_CREDENTIAL_MUTATION_KEY
-    });
-};

package/react-native/auth/useSignOutMutation.ts

@@ -1,28 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { signOut } from "@react-native-firebase/auth";
-
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-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 = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, void, TContext>,
-        "queryKey" | "queryFn"
-    > = {}
-) => {
-    const firebaseAuth = useAuth();
-
-    return useMutation({
-        ...options,
-        mutationFn: async () => await signOut(firebaseAuth),
-        mutationKey: SIGN_OUT_MUTATION_KEY
-    });
-};

package/react-native/auth/useUpdateProfileMutation.ts

@@ -1,30 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { updateProfile, FirebaseAuthTypes } from "@react-native-firebase/auth";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
-
-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 const useUpdateProfileMutation = <TContext = unknown>(
-    options: Omit<
-        UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, 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/react-native/context/FirebaseContext.ts

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