react-query-firebase 1.2.0 → 1.2.2

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

@@ -1,4 +1,5 @@
 import React, { PropsWithChildren } from "react";
+import { ConsentSettings } from "firebase/analytics";
 import { RemoteConfigSettings } from "firebase/remote-config";
 import { FirebaseOptions } from "firebase/app";
 /**
@@ -57,6 +58,19 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @defaultValue `true`
      */
     analyticsEnabled?: boolean;
+    /**
+     * Default user consent settings. Make sure to either use a consent platform or install custom consent form for a certain regions.
+     * @defaultValue {
+     *                  ad_personalization: "denied",
+     *                  ad_storage: "denied",
+     *                  ad_user_data: "denied",
+     *                  analytics_storage: "denied",
+     *                  functionality_storage: "denied",
+     *                  personalization_storage: "denied",
+     *                  security_storage: "denied"
+     *              }
+     */
+    consentSettings?: ConsentSettings;
     /**
      * Flag indicating whether Firebase Firestore should be enabled.
      * @defaultValue `true`

package/dist/src/context/FirebaseContextProvider.js

@@ -1,7 +1,7 @@
-import React, { useMemo } from "react";
+import React, { useEffect, useMemo } from "react";
 import { FirebaseContext } from "./FirebaseContext";
 import { connectAuthEmulator, getAuth } from "firebase/auth";
-import { getAnalytics } from "firebase/analytics";
+import { getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig } from "firebase/remote-config";
 import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
 import { initializeApp } from "firebase/app";
@@ -28,10 +28,22 @@ import { initializeApp } from "firebase/app";
  * };
  * ```
  */
-export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {} }) => {
+export const FirebaseContextProvider = ({ emulators, options, children, authEnabled = true, firestoreEnabled = true, analyticsEnabled = true, consentSettings = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {} }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
     }, [options]);
+    useEffect(() => {
+        setConsent({
+            ad_personalization: "denied",
+            ad_storage: "denied",
+            ad_user_data: "denied",
+            analytics_storage: "denied",
+            functionality_storage: "denied",
+            personalization_storage: "denied",
+            security_storage: "denied",
+            ...consentSettings
+        });
+    }, [consentSettings]);
     const contextValue = useMemo(() => {
         const value = {};
         if (firestoreEnabled) {
@@ -65,5 +77,10 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
         }
         return { firebase, ...value };
     }, [firebase]);
+    useEffect(() => {
+        if (contextValue.analytics) {
+            setAnalyticsCollectionEnabled(contextValue.analytics, consentSettings?.analytics_storage === "granted");
+        }
+    }, [consentSettings]);
     return (React.createElement(FirebaseContext.Provider, { value: contextValue }, children));
 };

package/package.json

@@ -60,5 +60,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "1.2.0"
+    "version": "1.2.2"
 }

package/src/context/FirebaseContextProvider.tsx

@@ -1,7 +1,7 @@
-import React, { PropsWithChildren, useMemo } from "react";
+import React, { PropsWithChildren, useEffect, useMemo } from "react";
 import { FirebaseContext } from "./FirebaseContext";
 import { connectAuthEmulator, getAuth } from "firebase/auth";
-import { getAnalytics } from "firebase/analytics";
+import { ConsentSettings, getAnalytics, setAnalyticsCollectionEnabled, setConsent } from "firebase/analytics";
 import { getRemoteConfig, RemoteConfigSettings } from "firebase/remote-config";
 import { connectFirestoreEmulator, getFirestore } from "firebase/firestore";
 import { FirebaseOptions, initializeApp } from "firebase/app";
@@ -65,6 +65,19 @@ export type FirebaseContextProviderProps = PropsWithChildren & {
      * @defaultValue `true`
      */
     analyticsEnabled?: boolean;
+    /**
+     * Default user consent settings. Make sure to either use a consent platform or install custom consent form for a certain regions.
+     * @defaultValue {
+     *                  ad_personalization: "denied",
+     *                  ad_storage: "denied",
+     *                  ad_user_data: "denied",
+     *                  analytics_storage: "denied",
+     *                  functionality_storage: "denied",
+     *                  personalization_storage: "denied",
+     *                  security_storage: "denied"
+     *              }
+     */
+    consentSettings?: ConsentSettings;
     /**
      * Flag indicating whether Firebase Firestore should be enabled.
      * @defaultValue `true`
@@ -116,6 +129,7 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
     authEnabled = true,
     firestoreEnabled = true,
     analyticsEnabled = true,
+    consentSettings = {},
     remoteConfigEnabled = true,
     remoteConfigSettings,
     remoteConfigDefaults = {}
@@ -124,6 +138,19 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         return initializeApp(options);
     }, [options]);
 
+    useEffect(() => {
+        setConsent({
+            ad_personalization: "denied",
+            ad_storage: "denied",
+            ad_user_data: "denied",
+            analytics_storage: "denied",
+            functionality_storage: "denied",
+            personalization_storage: "denied",
+            security_storage: "denied",
+            ...consentSettings
+        });
+    }, [consentSettings]);
+
     const contextValue = useMemo(() => {
         const value: Partial<React.ContextType<typeof FirebaseContext>> = {};
 
@@ -165,6 +192,12 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
         return { firebase, ...value };
     }, [firebase]);
 
+    useEffect(() => {
+        if (contextValue.analytics) {
+            setAnalyticsCollectionEnabled(contextValue.analytics, consentSettings?.analytics_storage === "granted");
+        }
+    }, [consentSettings]);
+
     return (
         <FirebaseContext.Provider value={contextValue as React.ContextType<typeof FirebaseContext>}>
             {children}