react-query-firebase 2.13.2 → 2.13.4

package/web/auth/useSignInWitEmailAndPasswordMutation.ts

@@ -1,34 +0,0 @@
-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.ts

@@ -1,33 +0,0 @@
-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/useSignInWithCredentialMutation.ts

@@ -1,31 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { AuthCredential, UserCredential, signInWithCredential } from "firebase/auth";
-
-import { SIGN_IN_WITH_CREDENTIAL_MUTATION_KEY } from "./mutation-keys";
-import { FirebaseError } from "firebase/app";
-import { useAuth } from "./useAuth";
-
-export type UseSignInWithCredentialMutationVariables = {
-    credential: AuthCredential;
-};
-
-/**
- * Custom hook for handling sign in using credential
- * This hook utilizes the `useMutation` mechanism to perform the sign-in operation.
- * @param {Omit<UseMutationOptions<UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.
- * @returns {UseMutationResult<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<UserCredential, FirebaseError, 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/web/auth/useSignOutMutation.ts

@@ -1,25 +0,0 @@
-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.ts

@@ -1,30 +0,0 @@
-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.ts

@@ -1,25 +0,0 @@
-"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);

package/web/context/FirebaseContextProvider.tsx

@@ -1,263 +0,0 @@
-import React, { PropsWithChildren, useEffect, useMemo } from "react";
-import { FirebaseContext } from "./FirebaseContext";
-import {
-    browserLocalPersistence,
-    browserSessionPersistence,
-    connectAuthEmulator,
-    getAuth,
-    Persistence,
-    setPersistence
-} from "firebase/auth";
-import { ConsentSettings, getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
-import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
-import { connectFirestoreEmulator, FirestoreSettings, initializeFirestore } from "firebase/firestore";
-import { FirebaseOptions, initializeApp } from "firebase/app";
-
-/**
- * @inline
- */
-export type FirebaseContextProviderFirestoreEmulatorConfig = {
-    /**
-     * Host to connect to Firebase Firestore Emulator
-     */
-    host: string;
-    /**
-     * Port to connect to Firebase Firestore Emulator
-     */
-    port: number;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderAuthEmulatorConfig = {
-    /**
-     * Host to connect to Firebase Auth Emulator
-     */
-    host: string;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderEmulators = {
-    /**
-     * Defines configuration for Firebase Firestore emulator. Optional.
-     */
-    firestore?: FirebaseContextProviderFirestoreEmulatorConfig;
-    /**
-     * Defines configuration for Firebase Auth emulator. Optional
-     */
-    auth?: FirebaseContextProviderAuthEmulatorConfig;
-};
-
-/**
- * @inline
- */
-export type FirebaseContextProviderProps = PropsWithChildren & {
-    /**
-     * Defines configuration for firebase emulators
-     */
-    emulators?: FirebaseContextProviderEmulators;
-    /**
-     * Configuration options for Firebase initialization. {@link https://firebase.google.com/docs/web/setup#config-object | Learn about the Firebase config object}
-     */
-    options: FirebaseOptions;
-    /**
-     * Flag indicating whether Firebase Auth should be enabled.
-     */
-    authEnabled?: boolean;
-    /**
-     * Flag indicating whether Firebase Analytics should be enabled.
-     * @defaultValue `true`
-     */
-    analyticsEnabled?: boolean;
-    /**
-     * Default user consent settings. Make sure to either use a consent platform or install custom consent form for a certain regions.
-     * @defaultValue {
-     *                  ad_personalization: "denied",
-     *                  ad_storage: "denied",
-     *                  ad_user_data: "denied",
-     *                  analytics_storage: "denied",
-     *                  functionality_storage: "denied",
-     *                  personalization_storage: "denied",
-     *                  security_storage: "denied"
-     *              }
-     */
-    consentSettings?: ConsentSettings;
-    /**
-     * Specifies custom configurations for your Cloud Firestore instance.
-     * You must set these before invoking any other methods.
-     * {@link https://firebase.google.com/docs/reference/js/firestore_.firestoresettings}
-     * @defaultValue {}
-     */
-    firestoreSettings?: FirestoreSettings;
-    /**
-     * Flag indicating whether Firebase Firestore should be enabled.
-     * @defaultValue `true`
-     */
-    firestoreEnabled?: boolean;
-    /**
-     * Configuration options for Firebase Remote Config Settings. {@link https://firebase.google.com/docs/reference/js/remote-config.remoteconfigsettings | Learn about the Firebase Remote COnfig Settings object}
-     * @defaultValue `true`
-     */
-    remoteConfigSettings?: RemoteConfigSettings;
-    /**
-     * Configuration options for Firebase Remote Config Defaults.
-     */
-    remoteConfigDefaults?: { [key: string]: string | number | boolean };
-    /**
-     * Flag indicating whether Firebase Remote Config should be enabled.
-     * @defaultValue `true`
-     */
-    remoteConfigEnabled?: boolean;
-    /**
-     * Firebase persistence type
-     * @defaultValue 'LOCAL'
-     */
-    authPersistenceType?: "SESSION" | "LOCAL" | "NONE" | "COOKIE";
-};
-
-/**
- * FirebaseContextProvider component configures and provides Firebase services to its children.
- * Initializes Firebase app and enables optional Firebase services such as Firestore, Auth, Analytics,
- * and Remote Config based on the provided configuration and parameters.
- *
- * @group Component
- *
- * @param {FirebaseContextProviderProps} props
- *
- * @returns {FirebaseContextProvider<FirebaseContextProviderProps>}
- *
- * @example
- * ```jsx
- * const firebaseConfig = {};
- * export const App = () => {
- *  return (
- *      <FirebaseContextProvider options={firebaseConfig}>
- *          <ChildComponent />
- *      </FirebaseContextProvider>
- *  );
- * };
- * ```
- */
-export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = ({
-    emulators,
-    options,
-    children,
-    authEnabled = true,
-    firestoreEnabled = true,
-    analyticsEnabled = true,
-    consentSettings = {},
-    remoteConfigEnabled = true,
-    remoteConfigSettings,
-    remoteConfigDefaults = {},
-    firestoreSettings,
-    authPersistenceType
-}) => {
-    const firebase = useMemo(() => {
-        return initializeApp(options);
-    }, [options]);
-
-    useEffect(() => {
-        setConsent({
-            ad_personalization: "denied",
-            ad_storage: "denied",
-            ad_user_data: "denied",
-            analytics_storage: "denied",
-            functionality_storage: "denied",
-            personalization_storage: "denied",
-            security_storage: "denied",
-            ...consentSettings
-        });
-    }, [consentSettings]);
-
-    const firestore = useMemo(() => {
-        if (firestoreEnabled) {
-            const localFirestore = initializeFirestore(firebase, firestoreSettings || {});
-
-            if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(localFirestore, emulators.firestore.host, emulators.firestore.port);
-            }
-
-            return localFirestore;
-        }
-
-        return null;
-    }, [firestoreSettings, emulators?.firestore, firestoreEnabled, firebase]);
-
-    const authPersistence = useMemo(() => {
-        switch (authPersistenceType) {
-            case "NONE":
-            case "COOKIE":
-                return { type: "NONE" } as Persistence;
-            case "SESSION":
-                return browserSessionPersistence;
-            default:
-            case "LOCAL":
-                return browserLocalPersistence;
-        }
-    }, [authPersistenceType]);
-
-    const auth = useMemo(() => {
-        if (authEnabled) {
-            const localAuth = getAuth(firebase);
-            if (emulators?.auth?.host) {
-                connectAuthEmulator(localAuth, emulators?.auth?.host, {
-                    disableWarnings: true
-                });
-            }
-            return localAuth;
-        }
-        return null;
-    }, [emulators?.auth, authEnabled, firebase]);
-
-    useEffect(() => {
-        if (authPersistence && auth) {
-            setPersistence(auth, authPersistence);
-        }
-    }, [auth, authPersistence]);
-
-    const analytics = useMemo(() => {
-        if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
-            return getAnalytics(firebase);
-        }
-        return null;
-    }, [analyticsEnabled, options.measurementId, firebase]);
-
-    const remoteConfig = useMemo(() => {
-        if (remoteConfigEnabled && typeof window !== "undefined") {
-            const localRemoteConfig = getRemoteConfig(firebase);
-            if (remoteConfigSettings) {
-                localRemoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
-                localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
-                localRemoteConfig.defaultConfig = remoteConfigDefaults;
-            }
-            return localRemoteConfig;
-        }
-        return null;
-    }, [remoteConfigEnabled, firebase, remoteConfigDefaults, remoteConfigSettings]);
-
-    const contextValue = useMemo(
-        () => ({
-            firebase,
-            auth,
-            analytics,
-            firestore,
-            remoteConfig
-        }),
-        [firebase, auth, analytics, firestore, remoteConfig]
-    );
-
-    useEffect(() => {
-        if (contextValue.analytics) {
-            setAnalyticsCollectionEnabled(contextValue.analytics, consentSettings?.analytics_storage === "granted");
-        }
-    }, [consentSettings?.analytics_storage, contextValue.analytics]);
-
-    return (
-        <FirebaseContext.Provider value={contextValue as React.ContextType<typeof FirebaseContext>}>
-            {children}
-        </FirebaseContext.Provider>
-    );
-};

package/web/context/index.d.ts

@@ -1 +0,0 @@
-export * from "./FirebaseContextProvider";

package/web/context/index.js

@@ -1 +0,0 @@
-export * from "./FirebaseContextProvider";

package/web/context/index.ts

@@ -1 +0,0 @@
-export * from "./FirebaseContextProvider";

package/web/firestore/index.d.ts

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-export * from "./useSetDocMutation";
-export * from "./useUpdateDocMutation";
-export * from "./useGetRealtimeDocData";
-export * from "./useQueryConstraints";
-export * from "./useEnsureDoc";
-export * from "./utils/getDocData";
-export * from "./utils/getDocSnap";
-export * from "./utils/getDocRef";
-export * from "./utils/buildQueryConstraint";
-export * from "./utils/buildCompositeFilter";

package/web/firestore/index.js

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-export * from "./useSetDocMutation";
-export * from "./useUpdateDocMutation";
-export * from "./useGetRealtimeDocData";
-export * from "./useQueryConstraints";
-export * from "./useEnsureDoc";
-export * from "./utils/getDocData";
-export * from "./utils/getDocSnap";
-export * from "./utils/getDocRef";
-export * from "./utils/buildQueryConstraint";
-export * from "./utils/buildCompositeFilter";

package/web/firestore/index.ts

@@ -1,23 +0,0 @@
-export * from "./useFirestore";
-export * from "./useAddDocMutation";
-export * from "./useBatchWrite";
-export * from "./useCollectionReference";
-export * from "./useCompositeFilter";
-export * from "./useCountQuery";
-export * from "./useDeleteDocMutation";
-export * from "./useDocReference";
-export * from "./useDocReferences";
-export * from "./useGetDocData";
-export * from "./useInfiniteQuery";
-export * from "./useQuery";
-export * from "./useRunTransaction";
-export * from "./useSetDocMutation";
-export * from "./useUpdateDocMutation";
-export * from "./useGetRealtimeDocData";
-export * from "./useQueryConstraints";
-export * from "./useEnsureDoc";
-export * from "./utils/getDocData";
-export * from "./utils/getDocSnap";
-export * from "./utils/getDocRef";
-export * from "./utils/buildQueryConstraint";
-export * from "./utils/buildCompositeFilter";

package/web/firestore/useAddDocMutation.ts

@@ -1,74 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { addDoc, WithFieldValue, CollectionReference, getDoc } from "firebase/firestore";
-
-import { FirebaseError } from "firebase/app";
-import { useMemo } from "react";
-import { AppModel } from "../../types";
-
-/**
- * @inline
- */
-export type UseAddDocMutationValues<AppModelType> = {
-    /**
-     * Data to write
-     */
-    data: WithFieldValue<AppModelType>;
-};
-
-/**
- * @inline
- */
-export type UseAddDocMutationOptions<AppModelType extends AppModel = AppModel, TContext = unknown> = {
-    /**
-     * Reference to a collection where document must be added
-     */
-    collectionReference: CollectionReference<AppModelType, AppModelType>;
-    /**
-     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
-     */
-    options?: Omit<
-        UseMutationOptions<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>,
-        "mutationFn"
-    >;
-};
-
-/**
- * Executes a mutation and returns added document
- *
- * @group Hook
- *
- * @param {UseAddDocMutationOptions<AppModelType>} options - Configuration options for the mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, UseAddDocMutationValues<AppModelType>, TContext>}  A mutation result
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useAddDocMutation({
- *      options: {
- *      },
- *      reference: collection(),
- *  });
- *
- *  // ....
- *  mutate({data: {test: 'value'}});
- *  // ....
- * };
- * ```
- */
-export const useAddDocMutation = <AppModelType extends AppModel = AppModel, TContext = unknown>({
-    collectionReference,
-    options = {}
-}: UseAddDocMutationOptions<AppModelType, TContext>) => {
-    const mutationKey = useMemo(() => [collectionReference.path], [collectionReference.path]);
-
-    return useMutation({
-        mutationKey,
-        ...options,
-        mutationFn: async ({ data }) => {
-            const docRef = await addDoc<AppModelType, AppModelType>(collectionReference, data);
-            const docSnap = await getDoc(docRef);
-            return { ...docSnap.data(), uid: docSnap.id } as AppModelType;
-        }
-    });
-};

package/web/firestore/useBatchWrite.ts

@@ -1,58 +0,0 @@
-import { useMutation, UseMutationOptions } from "@tanstack/react-query";
-import { writeBatch, WriteBatch } from "firebase/firestore";
-
-import { FirebaseError } from "firebase/app";
-import { useFirestore } from "./useFirestore";
-
-/**
- * @inline
- */
-export type UseBatchWriteVariables = (batch: WriteBatch) => Promise<void> | void;
-
-/**
- * @inline
- */
-export type UseBatchWriteOptions = {
-    /**
-     * Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.
-     */
-    options?: Omit<UseMutationOptions<void, FirebaseError, UseBatchWriteVariables>, "mutationFn">;
-};
-
-/**
- * Custom hook to perform batch write operations using Firestore.
- *
- * @group Hook
- *
- * @param {UseBatchWriteOptions} options - Configuration options for the query.
- *
- * @returns {UseMutationResult<void, Error, UseAddDocMutationValues<AppModelType>>}  A mutation result
- *
- * @example
- * ```jsx
- * export const MyComponent = () => {
- *  const {mutate} = useBatchWrite({
- *      options: {
- *      },
- *  });
- *
- *  // ....
- *  mutate(() => {
- *      ref.update({...})
- *  });
- *  // ....
- * };
- * ```
- */
-export const useBatchWrite = ({ options = {} }: UseBatchWriteOptions = {}) => {
-    const db = useFirestore();
-
-    return useMutation({
-        ...options,
-        mutationFn: async (batchWriteFn) => {
-            const batch = writeBatch(db);
-            await batchWriteFn(batch);
-            return batch.commit();
-        }
-    });
-};