react-query-firebase 2.0.3 → 2.1.1

package/react-native/auth/useIdToken.js

@@ -1,66 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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/firestore/index.d.ts

@@ -1,16 +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";

package/react-native/firestore/index.js

@@ -1,16 +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";

package/react-native/firestore/useAddDocMutation.d.ts

@@ -1,21 +0,0 @@
-import { UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseFirestoreTypes, WithFieldValue } from "@react-native-firebase/firestore";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-export type UseAddDocMutationValues<AppModelType> = {
-    data: WithFieldValue<AppModelType>;
-};
-export type UseAddDocMutationOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown> = {
-    reference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
-    options?: Omit<UseMutationOptions<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>, "mutationFn" | "mutationKey">;
-};
-/**
- * Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`.
- * It handles addition and optional conversion of the document data in Firestore.
- *
- * @param {Object} options - Options for the mutation hook
- * @param {FirebaseFirestore.FirebaseFirestoreTypes.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @param {UseMutationOptions<AppModelType, Error, { data: DbModelType }, TContext>} [options.options={}] - Optional configuration for the mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, { data: DbModelType }, TContext>} The mutation hook result containing status, error, and data of the mutation process.
- */
-export declare const useAddDocMutation: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData, TContext = unknown>({ reference, options }: UseAddDocMutationOptions<AppModelType, TContext>) => import("@tanstack/react-query").UseMutationResult<AppModelType, ReactNativeFirebase.NativeFirebaseError, UseAddDocMutationValues<AppModelType>, TContext>;

package/react-native/firestore/useAddDocMutation.js

@@ -1,25 +0,0 @@
-import { useMutation } from "@tanstack/react-query";
-import { addDoc, getDoc } from "@react-native-firebase/firestore";
-import { useMemo } from "react";
-/**
- * Provides a mutation hook to add a document to a Firestore collection utilizing React Query's `useMutation`.
- * It handles addition and optional conversion of the document data in Firestore.
- *
- * @param {Object} options - Options for the mutation hook
- * @param {FirebaseFirestore.FirebaseFirestoreTypes.CollectionReference<AppModelType>} options.reference - Firestore collection reference where the document should be added.
- * @param {UseMutationOptions<AppModelType, Error, { data: DbModelType }, TContext>} [options.options={}] - Optional configuration for the mutation.
- *
- * @returns {UseMutationResult<AppModelType, Error, { data: DbModelType }, TContext>} The mutation hook result containing status, error, and data of the mutation process.
- */
-export const useAddDocMutation = ({ reference, options = {} }) => {
-    const mutationKey = useMemo(() => [reference.path], [reference.path]);
-    return useMutation({
-        ...options,
-        mutationFn: async ({ data }) => {
-            const docRef = await addDoc(reference, data);
-            const docSnap = await getDoc(docRef);
-            return docSnap.data();
-        },
-        mutationKey
-    });
-};

package/react-native/firestore/useBatchWrite.d.ts

@@ -1,15 +0,0 @@
-import { UseMutationOptions } from "@tanstack/react-query";
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-import { ReactNativeFirebase } from "@react-native-firebase/app";
-export type UseBatchWriteVariables = (batch: FirebaseFirestoreTypes.WriteBatch) => Promise<void> | void;
-export type UseBatchWriteOptions<TContext = unknown> = {
-    options?: Omit<UseMutationOptions<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, TContext>, "mutationFn">;
-};
-/**
- * Custom hook to perform batch write operations using Firestore.
- * Utilizes a mutation to carry out the batch write transaction.
- * @template TContext - The type of context that can be passed into the hook, defaults to unknown.
- * @param {Object} options - The configuration options for the mutation operation.
- * @returns {Object} Returns an object composed of elements returned by useMutation, including properties such as status, and functions to trigger and control the mutation process.
- */
-export declare const useBatchWrite: <TContext = unknown>({ options }?: UseBatchWriteOptions<TContext>) => import("@tanstack/react-query").UseMutationResult<void, ReactNativeFirebase.NativeFirebaseError, UseBatchWriteVariables, TContext>;

package/react-native/firestore/useBatchWrite.js

@@ -1,21 +0,0 @@
-import { useMutation } from "@tanstack/react-query";
-import { writeBatch } from "@react-native-firebase/firestore";
-import { useFirestore } from "./useFirestore";
-/**
- * Custom hook to perform batch write operations using Firestore.
- * Utilizes a mutation to carry out the batch write transaction.
- * @template TContext - The type of context that can be passed into the hook, defaults to unknown.
- * @param {Object} options - The configuration options for the mutation operation.
- * @returns {Object} Returns an object composed of elements returned by useMutation, including properties such as status, and functions to trigger and control the mutation process.
- */
-export const useBatchWrite = ({ options = {} } = {}) => {
-    const db = useFirestore();
-    return useMutation({
-        ...options,
-        mutationFn: async (batchWriteFn) => {
-            const batch = writeBatch(db);
-            await batchWriteFn(batch);
-            return batch.commit();
-        }
-    });
-};

package/react-native/firestore/useCollectionReference.d.ts

@@ -1,18 +0,0 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-export type UseCollectionReferenceOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
-    reference?: FirebaseFirestoreTypes.CollectionReference<AppModelType> | FirebaseFirestoreTypes.DocumentReference<AppModelType>;
-    path: string;
-    pathSegments?: string[];
-};
-/**
- * Creates a reference to a Firestore collection based on the provided path, reference, and path segments.
- *
- * This hook utilizes useMemo for optimization, ensuring the collection reference is recalculated only when its dependencies change.
- *
- * @param {UseCollectionReferenceOptions<AppModelType>} options - The options including path, reference, and pathSegments to construct the Firestore collection reference.
- * @param {string} options.path - The base path for the collection.
- * @param {FirestoreReference} options.reference - An optional Firestore reference object that should be of type "collection".
- * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
- * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
- */
-export declare const useCollectionReference: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ path, reference, pathSegments }: UseCollectionReferenceOptions<AppModelType>) => FirebaseFirestoreTypes.CollectionReference<AppModelType>;

package/react-native/firestore/useCollectionReference.js

@@ -1,22 +0,0 @@
-import { collection } from "@react-native-firebase/firestore";
-import { useMemo } from "react";
-import { useFirestore } from "./useFirestore";
-/**
- * Creates a reference to a Firestore collection based on the provided path, reference, and path segments.
- *
- * This hook utilizes useMemo for optimization, ensuring the collection reference is recalculated only when its dependencies change.
- *
- * @param {UseCollectionReferenceOptions<AppModelType>} options - The options including path, reference, and pathSegments to construct the Firestore collection reference.
- * @param {string} options.path - The base path for the collection.
- * @param {FirestoreReference} options.reference - An optional Firestore reference object that should be of type "collection".
- * @param {string[]} options.pathSegments - Additional path segments to append to the base path.
- * @returns {CollectionReference} A Firestore collection reference constructed using the specified path, reference, and path segments.
- */
-export const useCollectionReference = ({ path, reference, pathSegments }) => {
-    const db = useFirestore();
-    return useMemo(() => {
-        return !reference
-            ? collection(db, path || "", ...(pathSegments || []))
-            : collection(reference, path, ...(pathSegments || []));
-    }, [db, reference, path, pathSegments]);
-};

package/react-native/firestore/useCompositeFilter.d.ts

@@ -1,32 +0,0 @@
-import { FirebaseFirestoreTypes } from "@react-native-firebase/firestore";
-type CompositeFilterDocumentData = FirebaseFirestoreTypes.DocumentData;
-export type QueryElement<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
-    operator?: "OR" | "AND";
-    children?: QueryElement[];
-    field?: keyof (DbModelType & {
-        documentId?: string[];
-    });
-    value?: DbModelType[keyof DbModelType];
-    op?: FirebaseFirestoreTypes.WhereFilterOp;
-};
-export type CompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
-    operator: "OR" | "AND";
-    children: QueryElement<DbModelType & {
-        documentId?: string[];
-    }>[];
-};
-export type UseCompositeFilter<DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData> = {
-    query?: CompositeFilter<DbModelType>;
-};
-/**
- * A custom hook that generates a composite filter for database queries, using the provided query configuration.
- * It applies either an 'OR' or 'AND' logical operation based on the type specified in the query.
- *
- * @param {Object} query - The query configuration object that contains subqueries and a type for logical combination.
- * @param {string} query.type - The type of composite operation ('or'/'and').
- * @param {Array} query.children - An array of subqueries that will be processed to form the composite filter.
- *
- * @returns {(Function|undefined)} A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints.
- */
-export declare const useCompositeFilter: <DbModelType extends CompositeFilterDocumentData = CompositeFilterDocumentData>({ query }: UseCompositeFilter<DbModelType>) => FirebaseFirestoreTypes.QueryCompositeFilterConstraint | undefined;
-export {};

package/react-native/firestore/useCompositeFilter.js

@@ -1,42 +0,0 @@
-import firebase, { and, or, where } from "@react-native-firebase/firestore";
-import { useMemo } from "react";
-/**
- * Constructs a composite query filter based on the provided query structure.
- * It recursively builds query constraints using logical "or" or "and" operators.
- *
- * @param {QueryElement<DbModelType>} query - The query element or structure to be evaluated and transformed into filter constraints.
- * @returns {QueryFieldFilterConstraint | null} A constructed query filter constraint based on the input query, or null if no valid constraints can be derived.
- */
-const buildCompositeQuery = (query) => {
-    if (query.children) {
-        const queryConstraints = query.children.map(buildCompositeQuery).filter((constraint) => !!constraint);
-        if (queryConstraints.length <= 0) {
-            return null;
-        }
-        return query.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
-    }
-    if (query.field && query.op) {
-        return where(query.field === "documentId" ? firebase.FieldPath.documentId() : query.field, query.op, query.value);
-    }
-    return null;
-};
-/**
- * A custom hook that generates a composite filter for database queries, using the provided query configuration.
- * It applies either an 'OR' or 'AND' logical operation based on the type specified in the query.
- *
- * @param {Object} query - The query configuration object that contains subqueries and a type for logical combination.
- * @param {string} query.type - The type of composite operation ('or'/'and').
- * @param {Array} query.children - An array of subqueries that will be processed to form the composite filter.
- *
- * @returns {(Function|undefined)} A composite query filter constraint function formed by combining subqueries or undefined if there are no valid constraints.
- */
-export const useCompositeFilter = ({ query }) => {
-    return useMemo(() => {
-        const queryConstraints = (query?.children?.map?.((subQuery) => buildCompositeQuery(subQuery))
-            ?.filter)?.((constraint) => !!constraint) ?? [];
-        if (queryConstraints.length <= 0) {
-            return undefined;
-        }
-        return query?.operator === "OR" ? or(...queryConstraints) : and(...queryConstraints);
-    }, [query]);
-};

package/react-native/firestore/useCountQuery.d.ts

@@ -1,23 +0,0 @@
-import { FirebaseFirestoreTypes, QueryConstraint, QueryNonFilterConstraint } from "@react-native-firebase/firestore";
-import { UseQueryResult, UseQueryOptions as UseReactQueryOptions } from "@tanstack/react-query";
-type UseCountQueryOptions<AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData> = {
-    options: Omit<UseReactQueryOptions<number, Error, number>, "queryFn"> & Required<Pick<UseReactQueryOptions<number, Error, number>, "queryKey">>;
-    collectionReference: FirebaseFirestoreTypes.CollectionReference<AppModelType>;
-    queryConstraints?: QueryConstraint[] | QueryNonFilterConstraint[];
-    compositeFilter?: FirebaseFirestoreTypes.QueryCompositeFilterConstraint;
-};
-/**
- * Executes a query with specified constraints and returns the count of matched documents.
- *
- * This function utilizes React Query to asynchronously fetch the count of documents from a server database
- * that match the provided query constraints and an optional composite filter.
- *
- * @param {UseCountQueryOptions<AppModelType>} options - Configuration options for the query.
- * @param {AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData} [options.options] - Additional options for the React Query.
- * @param {unknown} [options.query] - Reference to the query object to be executed.
- * @param {unknown[]} [options.queryConstraints=[]] - An array of constraints to apply to the query.
- * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
- * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
- */
-export declare const useCountQuery: <AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData>({ options, collectionReference, queryConstraints, compositeFilter }: UseCountQueryOptions<AppModelType>) => UseQueryResult<number>;
-export {};

package/react-native/firestore/useCountQuery.js

@@ -1,30 +0,0 @@
-import { getCountFromServer, query } from "@react-native-firebase/firestore";
-import { useQuery as useReactQuery } from "@tanstack/react-query";
-/**
- * Executes a query with specified constraints and returns the count of matched documents.
- *
- * This function utilizes React Query to asynchronously fetch the count of documents from a server database
- * that match the provided query constraints and an optional composite filter.
- *
- * @param {UseCountQueryOptions<AppModelType>} options - Configuration options for the query.
- * @param {AppModelType extends FirebaseFirestoreTypes.DocumentData = FirebaseFirestoreTypes.DocumentData} [options.options] - Additional options for the React Query.
- * @param {unknown} [options.query] - Reference to the query object to be executed.
- * @param {unknown[]} [options.queryConstraints=[]] - An array of constraints to apply to the query.
- * @param {unknown} [options.compositeFilter] - An optional composite filter to apply to the query.
- * @returns {UseQueryResult<number>} An object containing the number of documents that match the query.
- */
-export const useCountQuery = ({ options, collectionReference, queryConstraints = [], compositeFilter }) => {
-    return useReactQuery({
-        ...options,
-        queryFn: async () => {
-            const queryToExecute = compositeFilter
-                ? query(collectionReference, compositeFilter, ...queryConstraints)
-                : query(collectionReference, ...queryConstraints);
-            const querySnapshot = await getCountFromServer(queryToExecute);
-            if (querySnapshot) {
-                return querySnapshot.data().count;
-            }
-            return 0;
-        }
-    });
-};