react-query-firebase 1.3.1 → 1.3.3

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

@@ -1,12 +1,30 @@
 /**
- * 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.
+ * @inline
  */
-export declare const useIdToken: () => {
+export type UseIdTokenResult = {
     idToken: string;
-    refresh: () => Promise<void>;
+    refresh: () => Promise<string | undefined>;
 };
+/**
+ * A hook to manage the ID token.
+ * It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed.
+ *
+ * @group Hook
+ *
+ * @returns {UseIdTokenResult}
+ *
+ * @example
+ * ```jsx
+ * export const MyComponent = () => {
+ *  const result = useIdToken();
+ *  useEffect(() => {
+ *      const timeout = setTimeout(() => {
+ *          result.refresh();
+ *      }, 5000);
+ *      return () => clearTimeout();
+ *  }, [])
+ *  console.log(resilt.idToken);
+ * };
+ * ```
+ */
+export declare const useIdToken: () => UseIdTokenResult;

package/dist/src/auth/useIdToken.js

@@ -3,12 +3,26 @@ import { useCurrentUser } from "./useCurrentUser";
 import { onIdTokenChanged } from "firebase/auth";
 import { useAuth } from "./useAuth";
 /**
- * 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.
+ * 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.
  *
- * @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.
+ * @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();
@@ -27,7 +41,7 @@ export const useIdToken = () => {
             return;
         }
         const idToken = await currentUser.getIdToken(true);
-        setIdToken(idToken);
+        return idToken;
     }, [currentUser, idToken]);
     useEffect(() => {
         callback();

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

@@ -1,6 +1,7 @@
 import React, { PropsWithChildren } from "react";
 import { ConsentSettings } from "firebase/analytics";
 import { RemoteConfigSettings } from "firebase/remote-config";
+import { FirestoreSettings } from "firebase/firestore";
 import { FirebaseOptions } from "firebase/app";
 /**
  * @inline
@@ -71,6 +72,13 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      *              }
      */
     consentSettings?: ConsentSettings;
+    /**
+     * Specifies custom configurations for your Cloud Firestore instance.
+     * You must set these before invoking any other methods.
+     * {@link https://firebase.google.com/docs/reference/js/firestore_.firestoresettings}
+     * @defaultValue {}
+     */
+    firestoreSettings?: FirestoreSettings;
     /**
      * Flag indicating whether Firebase Firestore should be enabled.
      * @defaultValue `true`

package/dist/src/context/FirebaseContextProvider.js

@@ -3,7 +3,7 @@ import { FirebaseContext } from "./FirebaseContext";
 import { connectAuthEmulator, getAuth } from "firebase/auth";
 import { getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig } from "firebase/remote-config";
-import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
+import { connectFirestoreEmulator, initializeFirestore } from "firebase/firestore";
 import { initializeApp } from "firebase/app";
 /**
  * FirebaseContextProvider component configures and provides Firebase services to its children.
@@ -28,7 +28,7 @@ import { initializeApp } from "firebase/app";
  * };
  * ```
  */
-export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {} }) => {
+export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {}, firestoreSettings }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
     }, [options]);
@@ -44,39 +44,53 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
             ...consentSettings
         });
     }, [consentSettings]);
-    const contextValue = useMemo(() => {
-        const value = {};
+    const firestore = useMemo(() => {
         if (firestoreEnabled) {
-            const firestore = getFirestore(firebase);
+            const localFirestore = initializeFirestore(firebase, firestoreSettings || {});
             if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(firestore, emulators.firestore.host, emulators.firestore.port);
+                connectFirestoreEmulator(localFirestore, emulators.firestore.host, emulators.firestore.port);
             }
-            value.firestore = firestore;
+            return localFirestore;
         }
+        return null;
+    }, [firestoreSettings, emulators?.firestore, firestoreEnabled]);
+    const auth = useMemo(() => {
         if (authEnabled) {
-            const auth = getAuth(firebase);
+            const localAuth = getAuth(firebase);
             if (emulators?.auth?.host) {
-                connectAuthEmulator(auth, emulators?.auth?.host, {
+                connectAuthEmulator(localAuth, emulators?.auth?.host, {
                     disableWarnings: true
                 });
             }
-            value.auth = auth;
+            return localAuth;
         }
+        return null;
+    }, [emulators?.auth, authEnabled]);
+    const analytics = useMemo(() => {
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
-            const analytics = getAnalytics(firebase);
-            value.analytics = analytics;
+            return getAnalytics(firebase);
         }
+        return null;
+    }, [analyticsEnabled, options.measurementId]);
+    const remoteConfig = useMemo(() => {
         if (remoteConfigEnabled && typeof window !== "undefined") {
-            const remoteConfig = getRemoteConfig(firebase);
+            const localRemoteConfig = getRemoteConfig(firebase);
             if (remoteConfigSettings) {
-                remoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
-                remoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
-                remoteConfig.defaultConfig = remoteConfigDefaults;
+                localRemoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
+                localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
+                localRemoteConfig.defaultConfig = remoteConfigDefaults;
             }
-            value.remoteConfig = remoteConfig;
+            return localRemoteConfig;
         }
-        return { firebase, ...value };
-    }, [firebase]);
+        return null;
+    }, [remoteConfigEnabled]);
+    const contextValue = useMemo(() => ({
+        firebase,
+        auth,
+        analytics,
+        firestore,
+        remoteConfig
+    }), [firebase, auth, analytics, firestore, remoteConfig]);
     useEffect(() => {
         if (contextValue.analytics) {
             setAnalyticsCollectionEnabled(contextValue.analytics, consentSettings?.analytics_storage === "granted");

package/package.json

@@ -60,5 +60,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "1.3.1"
+    "version": "1.3.3"
 }

package/src/auth/useIdToken.ts

@@ -4,14 +4,36 @@ import { onIdTokenChanged } from "firebase/auth";
 import { useAuth } from "./useAuth";
 
 /**
- * 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.
+ * @inline
+ */
+export type UseIdTokenResult = {
+    idToken: string;
+    refresh: () => Promise<string | undefined>;
+};
+
+/**
+ * A hook to manage the ID token.
+ * It monitors changes to the ID token and provides the token itself along with a refresh method to update the token when needed.
  *
- * @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.
+ * @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 = () => {
+export const useIdToken = (): UseIdTokenResult => {
     const auth = useAuth();
 
     const currentUser = useCurrentUser();
@@ -33,7 +55,7 @@ export const useIdToken = () => {
         }
 
         const idToken = await currentUser.getIdToken(true);
-        setIdToken(idToken);
+        return idToken;
     }, [currentUser, idToken]);
 
     useEffect(() => {

package/src/context/FirebaseContextProvider.tsx

@@ -3,7 +3,7 @@ import { FirebaseContext } from "./FirebaseContext";
 import { connectAuthEmulator, getAuth } from "firebase/auth";
 import { ConsentSettings, getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
-import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
+import { connectFirestoreEmulator, FirestoreSettings, initializeFirestore } from "firebase/firestore";
 import { FirebaseOptions, initializeApp } from "firebase/app";
 
 /**
@@ -78,6 +78,13 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      *              }
      */
     consentSettings?: ConsentSettings;
+    /**
+     * Specifies custom configurations for your Cloud Firestore instance.
+     * You must set these before invoking any other methods.
+     * {@link https://firebase.google.com/docs/reference/js/firestore_.firestoresettings}
+     * @defaultValue {}
+     */
+    firestoreSettings?: FirestoreSettings;
     /**
      * Flag indicating whether Firebase Firestore should be enabled.
      * @defaultValue `true`
@@ -132,7 +139,8 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
     consentSettings = {},
     remoteConfigEnabled = true,
     remoteConfigSettings,
-    remoteConfigDefaults = {}
+    remoteConfigDefaults = {},
+    firestoreSettings
 }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
@@ -151,46 +159,63 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         });
     }, [consentSettings]);
 
-    const contextValue = useMemo(() => {
-        const value: Partial<React.ContextType<typeof FirebaseContext>> = {};
-
+    const firestore = useMemo(() => {
         if (firestoreEnabled) {
-            const firestore = getFirestore(firebase);
+            const localFirestore = initializeFirestore(firebase, firestoreSettings || {});
 
             if (emulators?.firestore?.host && emulators?.firestore?.port) {
-                connectFirestoreEmulator(firestore, emulators.firestore.host, emulators.firestore.port);
+                connectFirestoreEmulator(localFirestore, emulators.firestore.host, emulators.firestore.port);
             }
 
-            value.firestore = firestore;
+            return localFirestore;
         }
 
+        return null;
+    }, [firestoreSettings, emulators?.firestore, firestoreEnabled]);
+
+    const auth = useMemo(() => {
         if (authEnabled) {
-            const auth = getAuth(firebase);
+            const localAuth = getAuth(firebase);
             if (emulators?.auth?.host) {
-                connectAuthEmulator(auth, emulators?.auth?.host, {
+                connectAuthEmulator(localAuth, emulators?.auth?.host, {
                     disableWarnings: true
                 });
             }
-            value.auth = auth;
+            return localAuth;
         }
+        return null;
+    }, [emulators?.auth, authEnabled]);
 
+    const analytics = useMemo(() => {
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
-            const analytics = getAnalytics(firebase);
-            value.analytics = analytics;
+            return getAnalytics(firebase);
         }
+        return null;
+    }, [analyticsEnabled, options.measurementId]);
 
+    const remoteConfig = useMemo(() => {
         if (remoteConfigEnabled && typeof window !== "undefined") {
-            const remoteConfig = getRemoteConfig(firebase);
+            const localRemoteConfig = getRemoteConfig(firebase);
             if (remoteConfigSettings) {
-                remoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
-                remoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
-                remoteConfig.defaultConfig = remoteConfigDefaults;
+                localRemoteConfig.settings.fetchTimeoutMillis = remoteConfigSettings.fetchTimeoutMillis;
+                localRemoteConfig.settings.minimumFetchIntervalMillis = remoteConfigSettings.minimumFetchIntervalMillis;
+                localRemoteConfig.defaultConfig = remoteConfigDefaults;
             }
-            value.remoteConfig = remoteConfig;
+            return localRemoteConfig;
         }
-
-        return { firebase, ...value };
-    }, [firebase]);
+        return null;
+    }, [remoteConfigEnabled]);
+
+    const contextValue = useMemo(
+        () => ({
+            firebase,
+            auth,
+            analytics,
+            firestore,
+            remoteConfig
+        }),
+        [firebase, auth, analytics, firestore, remoteConfig]
+    );
 
     useEffect(() => {
         if (contextValue.analytics) {