@arthurreira/analytics 0.18.0 → 0.19.0

package/dist/af-analytics.umd.js

@@ -38,8 +38,34 @@ var AfAnalytics = (() => {
   // src/vanilla.ts
   var vanilla_exports = {};
   __export(vanilla_exports, {
-    init: () => init
+    consent: () => consent,
+    init: () => init,
+    isOptedOut: () => isOptedOut,
+    optIn: () => optIn,
+    optOut: () => optOut
   });
+
+  // src/lib/consent.ts
+  var CONSENT_KEY = "af_analytics_opted_out";
+  function optOut() {
+    if (typeof localStorage === "undefined") return;
+    localStorage.setItem(CONSENT_KEY, "1");
+  }
+  function optIn() {
+    if (typeof localStorage === "undefined") return;
+    localStorage.removeItem(CONSENT_KEY);
+  }
+  function isOptedOut() {
+    if (typeof localStorage !== "undefined" && localStorage.getItem(CONSENT_KEY) === "1") return true;
+    if (typeof navigator !== "undefined" && navigator.doNotTrack === "1") return true;
+    return false;
+  }
+  function consent(enabled) {
+    if (enabled) optIn();
+    else optOut();
+  }
+
+  // src/vanilla.ts
   var _currentScript = document.currentScript;
   var SESSION_EXPIRY_MS = 30 * 60 * 1e3;
   var IDLE_TOUCH_INTERVAL_MS = 5 * 60 * 1e3;
@@ -97,6 +123,7 @@ var AfAnalytics = (() => {
     }
   }
   function send(apiUrl, apiKey, payload) {
+    if (isOptedOut()) return;
     fetch(`${apiUrl}/events`, {
       method: "POST",
       headers: { "X-API-Key": apiKey, "Content-Type": "application/json" },
@@ -235,6 +262,7 @@ var AfAnalytics = (() => {
     send(apiUrl, apiKey, __spreadValues(__spreadValues({}, baseFields(sessionId, "js_exception")), fields));
   }
   function init() {
+    if (isOptedOut()) return;
     const config = readConfig();
     if (!config) return;
     const { apiKey, apiUrl } = config;

package/dist/client.js

@@ -8,6 +8,14 @@ import { usePathname } from "next/navigation";
 // src/hooks/useAnalytics.ts
 import { useEffect, useRef } from "react";
 
+// src/lib/consent.ts
+var CONSENT_KEY = "af_analytics_opted_out";
+function isOptedOut() {
+  if (typeof localStorage !== "undefined" && localStorage.getItem(CONSENT_KEY) === "1") return true;
+  if (typeof navigator !== "undefined" && navigator.doNotTrack === "1") return true;
+  return false;
+}
+
 // src/lib/api.ts
 var BASE_FIELDS = (sessionId, eventType, path) => ({
   session_id: sessionId,
@@ -28,6 +36,7 @@ function getGpu() {
   }
 }
 async function createSession(apiUrl, apiKey, visitorId) {
+  if (isOptedOut()) return null;
   const sessionData = { visitor_id: visitorId };
   if (typeof window !== "undefined") {
     const nav = navigator;
@@ -77,6 +86,7 @@ async function createSession(apiUrl, apiKey, visitorId) {
   }
 }
 async function sendEvent(apiUrl, apiKey, payload) {
+  if (isOptedOut()) return;
   await fetch(`${apiUrl}/events`, {
     method: "POST",
     headers: {

package/dist/index.d.ts

@@ -1,3 +1,12 @@
+declare function optOut(): void;
+declare function optIn(): void;
+/**
+ * Returns true when the user has opted out via localStorage flag OR
+ * the browser-level DNT header is set to "1".
+ */
+declare function isOptedOut(): boolean;
+declare function consent(enabled: boolean): void;
+
 declare function createSession(apiUrl: string, apiKey: string, visitorId?: string): Promise<string | null>;
 declare function trackPageview(apiUrl: string, apiKey: string, sessionId: string, path: string): Promise<void>;
 declare function trackClick(apiUrl: string, apiKey: string, sessionId: string, path: string, e: MouseEvent, element: HTMLElement): Promise<void>;
@@ -19,4 +28,4 @@ interface PresenceConnection {
 }
 declare function connectPresence(apiKey: string, sessionId: string, wsUrl?: string): PresenceConnection;
 
-export { DEFAULT_WS_URL, type ExceptionFields, type PresenceConnection, connectPresence, createSession, trackCTA, trackClick, trackCopy, trackError, trackException, trackPageview, trackScroll, trackSearch };
+export { DEFAULT_WS_URL, type ExceptionFields, type PresenceConnection, connectPresence, consent, createSession, isOptedOut, optIn, optOut, trackCTA, trackClick, trackCopy, trackError, trackException, trackPageview, trackScroll, trackSearch };

package/dist/index.js

@@ -1,3 +1,23 @@
+// src/lib/consent.ts
+var CONSENT_KEY = "af_analytics_opted_out";
+function optOut() {
+  if (typeof localStorage === "undefined") return;
+  localStorage.setItem(CONSENT_KEY, "1");
+}
+function optIn() {
+  if (typeof localStorage === "undefined") return;
+  localStorage.removeItem(CONSENT_KEY);
+}
+function isOptedOut() {
+  if (typeof localStorage !== "undefined" && localStorage.getItem(CONSENT_KEY) === "1") return true;
+  if (typeof navigator !== "undefined" && navigator.doNotTrack === "1") return true;
+  return false;
+}
+function consent(enabled) {
+  if (enabled) optIn();
+  else optOut();
+}
+
 // src/lib/api.ts
 var BASE_FIELDS = (sessionId, eventType, path) => ({
   session_id: sessionId,
@@ -18,6 +38,7 @@ function getGpu() {
   }
 }
 async function createSession(apiUrl, apiKey, visitorId) {
+  if (isOptedOut()) return null;
   const sessionData = { visitor_id: visitorId };
   if (typeof window !== "undefined") {
     const nav = navigator;
@@ -67,6 +88,7 @@ async function createSession(apiUrl, apiKey, visitorId) {
   }
 }
 async function sendEvent(apiUrl, apiKey, payload) {
+  if (isOptedOut()) return;
   await fetch(`${apiUrl}/events`, {
     method: "POST",
     headers: {
@@ -206,7 +228,11 @@ function connectPresence(apiKey, sessionId, wsUrl = DEFAULT_WS_URL) {
 export {
   DEFAULT_WS_URL,
   connectPresence,
+  consent,
   createSession,
+  isOptedOut,
+  optIn,
+  optOut,
   trackCTA,
   trackClick,
   trackCopy,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arthurreira/analytics",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "type": "module",
   "scripts": {
     "build": "tsup",