react-query-firebase 1.1.0 → 1.2.1

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

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

package/dist/src/analytics/index.js

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

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

@@ -0,0 +1,10 @@
+type UseSetAnalyticsCollectionEnabledOptions = {
+    enabled?: boolean;
+};
+/**
+ * Custom hook to enable or disable analytics collection
+ * @param {Object}  options - The options for hook.
+ * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
+ */
+export declare const useSetAnalyticsCollectionEnabled: ({ enabled }: UseSetAnalyticsCollectionEnabledOptions) => void;
+export {};

package/dist/src/analytics/useSetAnalyticsCollectionEnabled.js

@@ -0,0 +1,16 @@
+import { setAnalyticsCollectionEnabled } from "firebase/analytics";
+import { useAnalytics } from "./useAnalytics";
+import { useEffect } from "react";
+/**
+ * Custom hook to enable or disable analytics collection
+ * @param {Object}  options - The options for hook.
+ * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
+ */
+export const useSetAnalyticsCollectionEnabled = ({ enabled = false }) => {
+    const analytics = useAnalytics();
+    useEffect(() => {
+        if (analytics) {
+            setAnalyticsCollectionEnabled(analytics, enabled);
+        }
+    }, [analytics]);
+};

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"
+     *              }
+     */
+    defaultConsent?: 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 { 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,7 +28,7 @@ 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, defaultConsent = {}, remoteConfigEnabled = true, remoteConfigSettings, remoteConfigDefaults = {} }) => {
     const firebase = useMemo(() => {
         return initializeApp(options);
     }, [options]);
@@ -50,9 +50,20 @@ export const FirebaseContextProvider = ({ emulators, options, children, authEnab
             }
             value.auth = auth;
         }
+        setConsent({
+            ad_personalization: "denied",
+            ad_storage: "denied",
+            ad_user_data: "denied",
+            analytics_storage: "denied",
+            functionality_storage: "denied",
+            personalization_storage: "denied",
+            security_storage: "denied",
+            ...defaultConsent
+        });
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
             const analytics = getAnalytics(firebase);
             value.analytics = analytics;
+            setAnalyticsCollectionEnabled(analytics, defaultConsent?.analytics_storage === "granted");
         }
         if (remoteConfigEnabled && typeof window !== "undefined") {
             const remoteConfig = getRemoteConfig(firebase);

package/package.json

@@ -60,5 +60,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "1.1.0"
+    "version": "1.2.1"
 }

package/src/analytics/index.ts

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

package/src/analytics/useSetAnalyticsCollectionEnabled.ts

@@ -0,0 +1,22 @@
+import { setAnalyticsCollectionEnabled } from "firebase/analytics";
+import { useAnalytics } from "./useAnalytics";
+import { useEffect } from "react";
+
+type UseSetAnalyticsCollectionEnabledOptions = {
+    enabled?: boolean;
+};
+
+/**
+ * Custom hook to enable or disable analytics collection
+ * @param {Object}  options - The options for hook.
+ * @param {string}  options.enabled - Flag that identifies if analytics collection is enabled.
+ */
+export const useSetAnalyticsCollectionEnabled = ({ enabled = false }: UseSetAnalyticsCollectionEnabledOptions) => {
+    const analytics = useAnalytics();
+
+    useEffect(() => {
+        if (analytics) {
+            setAnalyticsCollectionEnabled(analytics, enabled);
+        }
+    }, [analytics]);
+};

package/src/context/FirebaseContextProvider.tsx

@@ -1,7 +1,7 @@
 import React, { PropsWithChildren, 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"
+     *              }
+     */
+    defaultConsent?: 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,
+    defaultConsent = {},
     remoteConfigEnabled = true,
     remoteConfigSettings,
     remoteConfigDefaults = {}
@@ -147,9 +161,22 @@ export const FirebaseContextProvider: React.FC<FirebaseContextProviderProps> = (
             value.auth = auth;
         }
 
+        setConsent({
+            ad_personalization: "denied",
+            ad_storage: "denied",
+            ad_user_data: "denied",
+            analytics_storage: "denied",
+            functionality_storage: "denied",
+            personalization_storage: "denied",
+            security_storage: "denied",
+            ...defaultConsent
+        });
+
         if (analyticsEnabled && options.measurementId && typeof window !== "undefined") {
             const analytics = getAnalytics(firebase);
             value.analytics = analytics;
+
+            setAnalyticsCollectionEnabled(analytics, defaultConsent?.analytics_storage === "granted");
         }
 
         if (remoteConfigEnabled && typeof window !== "undefined") {