react-query-firebase 1.0.3 → 1.0.5

package/README.md

@@ -9,13 +9,37 @@ This module offers a set of hooks to work with [Firebase](https://firebase.googl
 Run the following command to install:
 
 ```
-npm i react-query-firebase
+npm i react-query-firebase @tanstack/react-query --save
 ```
 
-## Usage
+## Basic Example
 
-TODO:
+```jsx
+import { useQuery, FirebaseContextProvider } from "react-query-firebase";
 
+const firebaseConfig = {};
+export const App = () => {
+    const [queryClient] = useState(() => new QueryClient({ defaultOptions: { queries: { throwOnError: true } } }));
+
+    return (
+        <QueryClientProvider client={queryClient}>
+            <FirebaseContextProvider options={firebaseConfig}>
+                <ChildComponent />
+            </FirebaseContextProvider>
+        </QueryClientProvider>
+    );
+};
+
+export const ChildComponent = () => {
+    const { data, isFetching } = useQuery({});
+
+    return <div>{JSON.stringify(data)}</div>;
+};
+```
+
+## Documentation
+
+1. [All docs](https://vpishuk.github.io/react-query-firebase).
 
 ## Contribution guidelines
 

package/dist/src/analytics/index.d.ts

@@ -1 +1,2 @@
 export * from "./useLogEvent";
+export * from "./useAnalytics";

package/dist/src/analytics/index.js

@@ -1 +1,2 @@
 export * from "./useLogEvent";
+export * from "./useAnalytics";

package/dist/src/analytics/useAnalytics.d.ts

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

package/dist/src/analytics/useAnalytics.js

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

package/dist/src/analytics/useLogEvent.d.ts

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

package/dist/src/analytics/useLogEvent.js

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

package/dist/src/auth/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./mutation-keys";
+export * from "./useAuth";
 export * from "./useCreateUserWitEmailAndPasswordMutation";
 export * from "./useSendEmailVerificationMutation";
 export * from "./useSignInWitEmailAndPasswordMutation";

package/dist/src/auth/index.js

@@ -1,4 +1,5 @@
 export * from "./mutation-keys";
+export * from "./useAuth";
 export * from "./useCreateUserWitEmailAndPasswordMutation";
 export * from "./useSendEmailVerificationMutation";
 export * from "./useSignInWitEmailAndPasswordMutation";

package/dist/src/auth/useAuth.d.ts

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

package/dist/src/auth/useAuth.js

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

package/dist/src/auth/useAuthStateReady.d.ts

@@ -1 +1,6 @@
+/**
+ * A custom hook that determines if the Firebase authentication state is ready.
+ * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
+ * @returns {boolean} Indicates whether the authentication state is ready.
+ */
 export declare const useAuthStateReady: () => boolean;

package/dist/src/auth/useAuthStateReady.js

@@ -1,5 +1,10 @@
-import { useAuth } from "../useAuth";
+import { useAuth } from "./useAuth";
 import { useCallback, useEffect, useState } from "react";
+/**
+ * A custom hook that determines if the Firebase authentication state is ready.
+ * It uses Firebase authentication to check if the auth state is ready and updates the state accordingly.
+ * @returns {boolean} Indicates whether the authentication state is ready.
+ */
 export const useAuthStateReady = () => {
     const firebaseAuth = useAuth();
     const [isAuthStateReady, setIsAuthStateReady] = useState(false);

package/dist/src/auth/useCreateUserWitEmailAndPasswordMutation.d.ts

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

package/dist/src/auth/useCreateUserWitEmailAndPasswordMutation.js

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

package/dist/src/auth/useCurrentUser.d.ts

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

package/dist/src/auth/useCurrentUser.js

@@ -1,5 +1,10 @@
-import { useAuth } from "../useAuth";
+import { useAuth } from "./useAuth";
 import { useEffect, useState } from "react";
+/**
+ * Hook that provides the current authenticated user from Firebase Auth.
+ * It listens for changes in the authentication state and updates the user accordingly.
+ * @returns {Object|null} The current authenticated user object or null if no user is authenticated.
+ */
 export const useCurrentUser = () => {
     const firebaseAuth = useAuth();
     const [currentUser, setCurrentUser] = useState(firebaseAuth.currentUser);

package/dist/src/auth/useIdToken.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Custom hook to manage an ID token for the current user.
+ * This hook provides an `idToken` value and a `refresh` function to manually refresh the token.
+ *
+ * @returns {Object} An object containing:
+ *   @returns {string} idToken - The current ID token for the user.
+ *   @returns {Function} refresh - A function to refresh the ID token.
+ */
 export declare const useIdToken: () => {
     idToken: string;
     refresh: () => Promise<void>;

package/dist/src/auth/useIdToken.js

@@ -1,5 +1,13 @@
 import { useCallback, useEffect, useState } from "react";
 import { useCurrentUser } from "./useCurrentUser";
+/**
+ * Custom hook to manage an ID token for the current user.
+ * This hook provides an `idToken` value and a `refresh` function to manually refresh the token.
+ *
+ * @returns {Object} An object containing:
+ *   @returns {string} idToken - The current ID token for the user.
+ *   @returns {Function} refresh - A function to refresh the ID token.
+ */
 export const useIdToken = () => {
     const currentUser = useCurrentUser();
     const [idToken, setIdToken] = useState("");

package/dist/src/auth/useReauthenticateWitCredentialMutation.d.ts

@@ -5,4 +5,12 @@ 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/dist/src/auth/useReauthenticateWitCredentialMutation.js

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

package/dist/src/auth/useReauthenticateWitRedirectMutation.d.ts

@@ -6,4 +6,12 @@ export type UseReauthenticateWitRedirectMutationVariables = {
     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/dist/src/auth/useReauthenticateWitRedirectMutation.js

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

package/dist/src/auth/useSendEmailVerificationMutation.d.ts

@@ -4,4 +4,10 @@ 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/dist/src/auth/useSendEmailVerificationMutation.js

@@ -1,6 +1,12 @@
 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,

package/dist/src/auth/useSignInWitEmailAndPasswordMutation.d.ts

@@ -5,4 +5,11 @@ 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/dist/src/auth/useSignInWitEmailAndPasswordMutation.js

@@ -1,7 +1,14 @@
 import { useMutation } from "@tanstack/react-query";
 import { signInWithEmailAndPassword } from "firebase/auth";
-import { useAuth } from "../useAuth";
+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({

package/dist/src/auth/useSignInWitRedirectMutation.d.ts

@@ -5,4 +5,10 @@ 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/dist/src/auth/useSignInWitRedirectMutation.js

@@ -1,7 +1,13 @@
 import { useMutation } from "@tanstack/react-query";
 import { signInWithRedirect } from "firebase/auth";
-import { useAuth } from "../useAuth";
+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({

package/dist/src/auth/useSignOutMutation.d.ts

@@ -1,3 +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/dist/src/auth/useSignOutMutation.js

@@ -1,7 +1,14 @@
 import { useMutation } from "@tanstack/react-query";
 import { signOut } from "firebase/auth";
 import { SIGN_OUT_MUTATION_KEY } from "./mutation-keys";
-import { useAuth } from "../useAuth";
+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({

package/dist/src/auth/useUpdateProfileMutation.d.ts

@@ -5,4 +5,11 @@ 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/dist/src/auth/useUpdateProfileMutation.js

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

package/dist/src/{FirebaseContext.d.ts → context/FirebaseContext.d.ts}

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

package/dist/src/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/dist/src/context/FirebaseContextProvider.d.ts

@@ -0,0 +1,105 @@
+import React, { PropsWithChildren } from "react";
+import { RemoteConfigSettings } from "firebase/remote-config";
+import { FirebaseOptions } 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;
+    /**
+     * 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;
+};
+/**
+ * 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 declare const FirebaseContextProvider: React.FC<FirebaseContextProviderProps>;

package/dist/src/{FirebaseContextProvider.js → context/FirebaseContextProvider.js}

@@ -5,6 +5,29 @@ import { getAnalytics } from "firebase/analytics";
 import { getRemoteConfig } from "firebase/remote-config";
 import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
 import { initializeApp } from "firebase/app";
+/**
+ * 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 = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {} }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
@@ -42,5 +65,5 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
         }
         return { firebase, ...value };
     }, [firebase]);
-    return React.createElement(FirebaseContext.Provider, { value: contextValue }, children);
+    return (React.createElement(FirebaseContext.Provider, { value: contextValue }, children));
 };

package/dist/src/context/index.d.ts

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

package/dist/src/context/index.js

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

package/dist/src/firestore/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./useFirestore";
 export * from "./useAddDocMutation";
 export * from "./useBatchWrite";
 export * from "./useCollectionReference";

package/dist/src/firestore/index.js

@@ -1,3 +1,4 @@
+export * from "./useFirestore";
 export * from "./useAddDocMutation";
 export * from "./useBatchWrite";
 export * from "./useCollectionReference";