react-query-firebase 1.1.0 → 1.2.0

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/package.json

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

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]);
+};