react-query-firebase 1.0.2 → 1.0.4

package/dist/src/firestore/utils/getDocData.d.ts

@@ -1,4 +1,18 @@
 import { DocumentData } from "firebase/firestore";
 import { GetDocSnapOptions } from "./getDocSnap";
 export type GetDocDataOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData> = GetDocSnapOptions<AppModelType, DbModelType>;
+/**
+ * Asynchronously retrieves document data from a specified database and reference.
+ * Utilizes the helper function `getDocSnap` to fetch the document snapshot and
+ * checks if the document exists before returning its data.
+ *
+ * @param {Object} options - The options for fetching document data.
+ * @param {FirebaseFirestore} options.db - The Firestore database instance.
+ * @param {DocumentReference=} options.reference - The document reference. This is an optional parameter.
+ * @param {string=} options.path - The path to the document in the database. This is an optional parameter.
+ * @param {Array<string>=} options.pathSegments - The path segments for the document's path. This is an optional parameter.
+ *
+ * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists,
+ * or null if the document does not exist.
+ */
 export declare const getDocData: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ db, reference, path, pathSegments }: GetDocDataOptions<AppModelType, DbModelType>) => Promise<AppModelType | null>;

package/dist/src/firestore/utils/getDocData.js

@@ -1,4 +1,18 @@
 import { getDocSnap } from "./getDocSnap";
+/**
+ * Asynchronously retrieves document data from a specified database and reference.
+ * Utilizes the helper function `getDocSnap` to fetch the document snapshot and
+ * checks if the document exists before returning its data.
+ *
+ * @param {Object} options - The options for fetching document data.
+ * @param {FirebaseFirestore} options.db - The Firestore database instance.
+ * @param {DocumentReference=} options.reference - The document reference. This is an optional parameter.
+ * @param {string=} options.path - The path to the document in the database. This is an optional parameter.
+ * @param {Array<string>=} options.pathSegments - The path segments for the document's path. This is an optional parameter.
+ *
+ * @returns {Promise<AppModelType | null>} Returns a promise that resolves to the document data if it exists,
+ * or null if the document does not exist.
+ */
 export const getDocData = async ({ db, reference, path, pathSegments }) => {
     const docSnap = await getDocSnap({ db, reference, path, pathSegments });
     if (docSnap && docSnap.exists()) {

package/dist/src/firestore/utils/getDocRef.d.ts

@@ -5,4 +5,15 @@ export type GetDocRefOptions<AppModelType extends DocumentData = DocumentData, D
     path?: string;
     pathSegments?: string[];
 };
+/**
+ * Retrieves a document reference based on provided database options.
+ * Either `reference` or `path` must be provided, not both.
+ *
+ * @param {Object} options - The options for getting a document reference.
+ * @param {Firestore} options.db - The Firestore database instance.
+ * @param {DocumentReference | CollectionReference | null} [options.reference] - Reference to a document or collection.
+ * @param {string | null} [options.path] - Path to the document.
+ * @param {string[] | null} [options.pathSegments] - Additional path segments if any.
+ * @returns {DocumentReference<AppModelType, DbModelType>} The document reference.
+ */
 export declare const getDocRef: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ db, reference, path, pathSegments }: GetDocRefOptions<AppModelType, DbModelType>) => Promise<DocumentReference<AppModelType, DbModelType>>;

package/dist/src/firestore/utils/getDocRef.js

@@ -1,4 +1,15 @@
 import { doc } from "firebase/firestore";
+/**
+ * Retrieves a document reference based on provided database options.
+ * Either `reference` or `path` must be provided, not both.
+ *
+ * @param {Object} options - The options for getting a document reference.
+ * @param {Firestore} options.db - The Firestore database instance.
+ * @param {DocumentReference | CollectionReference | null} [options.reference] - Reference to a document or collection.
+ * @param {string | null} [options.path] - Path to the document.
+ * @param {string[] | null} [options.pathSegments] - Additional path segments if any.
+ * @returns {DocumentReference<AppModelType, DbModelType>} The document reference.
+ */
 export const getDocRef = async ({ db, reference, path, pathSegments }) => {
     if (!reference && !path) {
         throw new Error("One of the options must be provided: path or reference.");

package/dist/src/firestore/utils/getDocSnap.d.ts

@@ -1,4 +1,20 @@
 import { DocumentData } from "firebase/firestore";
 import { GetDocRefOptions } from "./getDocRef";
 export type GetDocSnapOptions<AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData> = GetDocRefOptions<AppModelType, DbModelType>;
+/**
+ * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
+ * or path information. This function handles getting the appropriate document reference based on
+ * the parameters provided, and then fetches the document data from Firestore.
+ *
+ * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
+ *                                                                for retrieving the document
+ *                                                                snapshot.
+ * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
+ * @param {string} options.reference - A string representing a direct Firestore document reference.
+ * @param {string} options.path - A Firestore path string leading to the document.
+ * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
+ * @returns {Promise<DocumentData | null>} A promise that resolves to the document data if the
+ *                                         document exists, or `null` if the document does not exist
+ *                                         or if the reference could not be obtained.
+ */
 export declare const getDocSnap: <AppModelType extends DocumentData = DocumentData, DbModelType extends DocumentData = DocumentData>({ db, reference, path, pathSegments }: GetDocSnapOptions<AppModelType, DbModelType>) => Promise<import("@firebase/firestore").DocumentSnapshot<AppModelType, DbModelType> | null>;

package/dist/src/firestore/utils/getDocSnap.js

@@ -1,5 +1,21 @@
 import { getDoc as firestoreGetDoc } from "firebase/firestore";
 import { getDocRef } from "./getDocRef";
+/**
+ * Asynchronously retrieves a document snapshot from Firestore using a specified document reference
+ * or path information. This function handles getting the appropriate document reference based on
+ * the parameters provided, and then fetches the document data from Firestore.
+ *
+ * @param {GetDocSnapOptions<AppModelType, DbModelType>} options - An object containing options
+ *                                                                for retrieving the document
+ *                                                                snapshot.
+ * @param {DocumentData} options.db - The Firestore database instance to perform the operation on.
+ * @param {string} options.reference - A string representing a direct Firestore document reference.
+ * @param {string} options.path - A Firestore path string leading to the document.
+ * @param {string[]} options.pathSegments - An array of path segments to build the Firestore path.
+ * @returns {Promise<DocumentData | null>} A promise that resolves to the document data if the
+ *                                         document exists, or `null` if the document does not exist
+ *                                         or if the reference could not be obtained.
+ */
 export const getDocSnap = async ({ db, reference, path, pathSegments }) => {
     const docRef = await getDocRef({ db, reference, path, pathSegments });
     if (docRef) {

package/dist/src/index.d.ts

@@ -1,10 +1,5 @@
-export * from "./useAuth";
-export * from "./useFirebase";
-export * from "./useFirestore";
-export * from "./FirebaseContextProvider";
-export * from "./useAnalytics";
-export * from "./useRemoteConfig";
 export * from "./analytics";
 export * from "./auth";
+export * from "./context";
 export * from "./firestore";
 export * from "./remoteConfig";

package/dist/src/index.js

@@ -1,10 +1,5 @@
-export * from "./useAuth";
-export * from "./useFirebase";
-export * from "./useFirestore";
-export * from "./FirebaseContextProvider";
-export * from "./useAnalytics";
-export * from "./useRemoteConfig";
 export * from "./analytics";
 export * from "./auth";
+export * from "./context";
 export * from "./firestore";
 export * from "./remoteConfig";

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

@@ -1,2 +1,3 @@
 export * from "./useFetchAndActivate";
 export * from "./useGetValue";
+export * from "./useRemoteConfig";

package/dist/src/remoteConfig/index.js

@@ -1,2 +1,3 @@
 export * from "./useFetchAndActivate";
 export * from "./useGetValue";
+export * from "./useRemoteConfig";

package/dist/src/remoteConfig/useFetchAndActivate.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Custom hook to fetch and activate remote configuration settings.
+ * Initializes remote configuration, fetches, activates it, and tracks the fetch status.
+ * @returns {Object} An object containing:
+ * - {Function} fetchAndActivate - Callback function to fetch and activate remote configuration.
+ * - {Boolean} isFetched - Boolean representing whether the fetch-and-activate process completed.
+ */
 export declare const useFetchAndActivate: () => {
     fetchAndActivate: () => Promise<void>;
     isFetched: boolean;

package/dist/src/remoteConfig/useFetchAndActivate.js

@@ -1,14 +1,23 @@
-import { useRemoteConfig } from "../useRemoteConfig";
+import { useRemoteConfig } from "./useRemoteConfig";
 import { ensureInitialized, fetchAndActivate } from "firebase/remote-config";
 import { useCallback, useMemo, useState } from "react";
+/**
+ * Custom hook to fetch and activate remote configuration settings.
+ * Initializes remote configuration, fetches, activates it, and tracks the fetch status.
+ * @returns {Object} An object containing:
+ * - {Function} fetchAndActivate - Callback function to fetch and activate remote configuration.
+ * - {Boolean} isFetched - Boolean representing whether the fetch-and-activate process completed.
+ */
 export const useFetchAndActivate = () => {
     const remoteConfig = useRemoteConfig();
     const [isFetched, setIsFetched] = useState(false);
     const fetchAndActivateCallback = useCallback(async () => {
         try {
-            await ensureInitialized(remoteConfig);
-            await fetchAndActivate(remoteConfig);
-            setIsFetched(true);
+            if (remoteConfig) {
+                await ensureInitialized(remoteConfig);
+                await fetchAndActivate(remoteConfig);
+                setIsFetched(true);
+            }
         }
         catch (e) {
             setIsFetched(true);

package/dist/src/remoteConfig/useGetValue.d.ts

@@ -1 +1,7 @@
+/**
+ * Custom hook to retrieve a value associated with a specified key from remote configuration.
+ * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.
+ * @param {string} key - The key for which the corresponding value is to be fetched from the remote configuration.
+ * @returns {any | null} The value associated with the specified key if available, otherwise null.
+ */
 export declare const useGetValue: (key: string) => import("@firebase/remote-config").Value | null;

package/dist/src/remoteConfig/useGetValue.js

@@ -1,6 +1,12 @@
 import { getValue } from "firebase/remote-config";
-import { useRemoteConfig } from "../useRemoteConfig";
+import { useRemoteConfig } from "./useRemoteConfig";
 import { useMemo } from "react";
+/**
+ * Custom hook to retrieve a value associated with a specified key from remote configuration.
+ * Utilizes memoization to optimize performance by recalculating the result only if dependencies change.
+ * @param {string} key - The key for which the corresponding value is to be fetched from the remote configuration.
+ * @returns {any | null} The value associated with the specified key if available, otherwise null.
+ */
 export const useGetValue = (key) => {
     const remoteConfig = useRemoteConfig();
     return useMemo(() => {

package/dist/src/remoteConfig/useRemoteConfig.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Hook to access the Firebase Remote Config instance from the context.
+ * @returns {RemoteConfig} The remoteConfig object from the Firebase context.
+ */
+export declare const useRemoteConfig: () => import("@firebase/remote-config").RemoteConfig;

package/dist/src/remoteConfig/useRemoteConfig.js

@@ -0,0 +1,10 @@
+import { useContext } from "react";
+import { FirebaseContext } from "../context/FirebaseContext";
+/**
+ * Hook to access the Firebase Remote Config instance from the context.
+ * @returns {RemoteConfig} The remoteConfig object from the Firebase context.
+ */
+export const useRemoteConfig = () => {
+    const { remoteConfig } = useContext(FirebaseContext);
+    return remoteConfig;
+};

package/package.json

@@ -8,8 +8,8 @@
         "firebase": "^11.0.1"
     },
     "peerDependencies": {
-        "react": "^19.0.0",
-        "@tanstack/react-query": "^5.62.15"
+        "@tanstack/react-query": "^5.62.15",
+        "react": "^19.0.0"
     },
     "publishConfig": {
         "access": "public"
@@ -22,7 +22,11 @@
         "lint-staged": "^15.1.0",
         "prettier": "^3.0.3",
         "react": "^19.0.0",
-        "typescript": "^5.2.2"
+        "typedoc": "^0.27.6",
+        "typedoc-plugin-markdown": "^4.4.1",
+        "typedoc-vitepress-theme": "^1.1.2",
+        "typescript": "^5.2.2",
+        "vitepress": "^1.5.0"
     },
     "homepage": "https://github.com/vpishuk/react-query-firebase",
     "keywords": [
@@ -51,7 +55,11 @@
         "lint": "eslint",
         "lint:fix": "eslint  --fix",
         "lint:staged": "lint-staged",
-        "prepare": "husky"
+        "prepare": "husky",
+        "docs:generate": "rm -rf docs/ && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-vitepress-theme",
+        "docs:dev": "vitepress dev",
+        "docs:build": "vitepress build",
+        "docs:preview": "vitepress preview"
     },
-    "version": "1.0.2"
+    "version": "1.0.4"
 }

package/src/analytics/index.ts

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

package/src/analytics/useAnalytics.ts

@@ -0,0 +1,12 @@
+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/src/analytics/useLogEvent.ts

@@ -1,5 +1,5 @@
 import { logEvent } from "firebase/analytics";
-import { useAnalytics } from "../useAnalytics";
+import { useAnalytics } from "./useAnalytics";
 import { useCallback, useMemo } from "react";
 
 type UseLogEventOptions = {
@@ -9,6 +9,13 @@ type UseLogEventOptions = {
     };
 };
 
+/**
+ * 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 }: UseLogEventOptions) => {
     const analytics = useAnalytics();
 

package/src/auth/index.ts

@@ -1,4 +1,5 @@
 export * from "./mutation-keys";
+export * from "./useAuth";
 export * from "./useCreateUserWitEmailAndPasswordMutation";
 export * from "./useSendEmailVerificationMutation";
 export * from "./useSignInWitEmailAndPasswordMutation";
@@ -7,5 +8,6 @@ export * from "./useAuthStateReady";
 export * from "./useSignInWitRedirectMutation";
 export * from "./useUpdateProfileMutation";
 export * from "./useSignOutMutation";
+export * from "./useIdToken";
 export * from "./useReauthenticateWitCredentialMutation";
 export * from "./useReauthenticateWitRedirectMutation";

package/src/auth/useAuth.ts

@@ -0,0 +1,12 @@
+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/src/auth/useAuthStateReady.ts

@@ -1,6 +1,11 @@
-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();
 

package/src/auth/useCreateUserWitEmailAndPasswordMutation.ts

@@ -1,6 +1,6 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { createUserWithEmailAndPassword, UserCredential } from "firebase/auth";
-import { useAuth } from "../useAuth";
+import { useAuth } from "./useAuth";
 import { FirebaseError } from "firebase/app";
 import { CREATE_USER_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
 
@@ -9,6 +9,13 @@ export type UseCreateUserWitEmailAndPasswordMutationVariables = {
     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 const useCreateUserWitEmailAndPasswordMutation = <TContext = unknown>(
     options: Omit<
         UseMutationOptions<UserCredential, FirebaseError, UseCreateUserWitEmailAndPasswordMutationVariables, TContext>,

package/src/auth/useCurrentUser.ts

@@ -1,6 +1,11 @@
-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();
 

package/src/auth/useIdToken.ts

@@ -1,6 +1,14 @@
 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/src/auth/useReauthenticateWitCredentialMutation.ts

@@ -8,6 +8,14 @@ export type UseReauthenticateWitCredentialMutationVariables = {
     user: User;
 };
 
+/**
+ * Custom hook to create a mutation for re-authenticating a user with a given credential.
+ * This hook utilizes useMutation from React Query to manage the asynchronous re-authentication
+ * process with Firebase credentials. It omits the default "mutationKey" and "mutationFn" options.
+ *
+ * @param {Omit<UseMutationOptions<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn">}  options - Optional mutation options excluding "mutationKey" and "mutationFn".
+ * @returns {UseMutationResult<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>} A useMutation result object managing the loading, error, and result state of the re-authentication mutation.
+ */
 export const useReauthenticateWitCredentialMutation = <TContext = unknown>(
     options: Omit<
         UseMutationOptions<UserCredential, FirebaseError, UseReauthenticateWitCredentialMutationVariables, TContext>,

package/src/auth/useReauthenticateWitRedirectMutation.ts

@@ -10,6 +10,14 @@ export type UseReauthenticateWitRedirectMutationVariables = {
     user: User;
 };
 
+/**
+ * Custom hook that provides a mutation to reauthenticate a user with a given authentication provider using redirection.
+ * This hook uses the `useMutation` hook from the React Query library to handle async mutation logic.
+ *
+ * @param {Omit<UseMutationOptions<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn">} options - Optional configuration object for the mutation. It provides the ability to pass options to customize the behavior of the mutation.
+ * @template TContext - The type of any additional context you wish to pass to the mutation.
+ * @returns {UseMutationResult<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>} A mutation result object containing methods and state of the mutation.
+ */
 export const useReauthenticateWitRedirectMutation = <TContext = unknown>(
     options: Omit<
         UseMutationOptions<void, FirebaseError, UseReauthenticateWitRedirectMutationVariables, TContext>,

package/src/auth/useSendEmailVerificationMutation.ts

@@ -8,6 +8,12 @@ export type UseSendEmailVerificationMutationVariables = {
     user: User;
 };
 
+/**
+ * A custom hook to create a mutation for sending an email verification to a user using Firebase.
+ * This uses the `useMutation` hook from a query library and wraps it with specific configuration options.
+ * @param {Omit<UseMutationOptions<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>, "queryKey" | "queryFn">} options - Configuration options for the mutation, excluding `queryKey` and `queryFn`.
+ * @returns {UseMutationResult<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>} An object containing mutation state and functions for managing the mutation lifecycle.
+ */
 export const useSendEmailVerificationMutation = <TContext = unknown>(
     options: Omit<
         UseMutationOptions<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>,

package/src/auth/useSignInWitEmailAndPasswordMutation.ts

@@ -1,7 +1,7 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signInWithEmailAndPassword, UserCredential } from "firebase/auth";
 
-import { useAuth } from "../useAuth";
+import { useAuth } from "./useAuth";
 import { SIGN_IN_WITH_EMAIL_AND_PASSWORD_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
 
@@ -10,6 +10,13 @@ export type UseSignInWitEmailAndPasswordMutationVariables = {
     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>,

package/src/auth/useSignInWitRedirectMutation.ts

@@ -1,7 +1,7 @@
 import { useMutation, UseMutationOptions } from "@tanstack/react-query";
 import { signInWithRedirect, AuthProvider, PopupRedirectResolver } from "firebase/auth";
 
-import { useAuth } from "../useAuth";
+import { useAuth } from "./useAuth";
 import { SIGN_IN_WITH_REDIRECT_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
 
@@ -10,6 +10,12 @@ export type UseSignInWitRedirectMutationVariables = {
     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>,

package/src/auth/useSignOutMutation.ts

@@ -3,8 +3,15 @@ import { signOut } from "firebase/auth";
 
 import { SIGN_OUT_MUTATION_KEY } from "./mutation-keys";
 import { FirebaseError } from "firebase/app";
-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 = <TContext = unknown>(
     options: Omit<UseMutationOptions<void, FirebaseError, void, TContext>, "queryKey" | "queryFn"> = {}
 ) => {

package/src/auth/useUpdateProfileMutation.ts

@@ -8,6 +8,13 @@ export type UseUpdateProfileMutationVariables = {
     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>,

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

@@ -1,4 +1,5 @@
 "use client";
+
 import { createContext } from "react";
 
 import { Auth } from "firebase/auth";
@@ -7,7 +8,7 @@ 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;
@@ -15,4 +16,10 @@ export type FirebaseContextValue = {
     firestore: Firestore;
 };
 
-export const FirebaseContext = createContext<Partial<FirebaseContextValue>>({});
+/**
+ * FirebaseContext is a shared context across children that provides access to firebase features
+ *
+ * @internal
+ */
+
+export const FirebaseContext = createContext<FirebaseContextValue>({} as FirebaseContextValue);