@base44-preview/sdk 0.8.57-pr.359.9ff5e66 → 0.8.57-pr.360.71a2580

package/dist/modules/analytics.d.ts

@@ -6,6 +6,9 @@ export declare const ANALYTICS_INITIALIZATION_EVENT_NAME = "__initialization_eve
 export declare const ANALYTICS_SESSION_DURATION_EVENT_NAME = "__session_duration_event__";
 export declare const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";
 export declare const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY = "base44_analytics_session_id";
+export declare const ANALYTICS_MODE_META_NAME = "base44-analytics";
+/** Whether analytics may run and store the session id on this page. */
+export declare function isAnalyticsAllowed(): boolean;
 export interface AnalyticsModuleArgs {
     axiosClient: AxiosInstance;
     serverUrl: string;

package/dist/modules/analytics.js

@@ -5,6 +5,25 @@ export const ANALYTICS_INITIALIZATION_EVENT_NAME = "__initialization_event__";
 export const ANALYTICS_SESSION_DURATION_EVENT_NAME = "__session_duration_event__";
 export const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";
 export const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY = "base44_analytics_session_id";
+// Set by the Base44 server from the app owner's choice: "off" never tracks,
+// "consent" waits for the page's Google Consent Mode `analytics_storage` grant,
+// "on" tracks until that consent is denied. Absent: track as before.
+export const ANALYTICS_MODE_META_NAME = "base44-analytics";
+function readAnalyticsMode() {
+    var _a;
+    if (typeof document === "undefined")
+        return null;
+    try {
+        const content = (_a = document
+            .querySelector(`meta[name="${ANALYTICS_MODE_META_NAME}"]`)) === null || _a === void 0 ? void 0 : _a.getAttribute("content");
+        return content === "off" || content === "consent" || content === "on"
+            ? content
+            : null;
+    }
+    catch (_b) {
+        return null;
+    }
+}
 const defaultConfiguration = {
     // default to enabled //
     enabled: true,
@@ -33,15 +52,80 @@ const analyticsSharedState = getSharedInstance(ANALYTICS_SHARED_STATE_NAME, () =
         ...getAnalyticsConfigFromUrlParams(),
     },
 }));
+///////////////////////////////////////////////
+//// visitor consent                       ////
+///////////////////////////////////////////////
+// Its own shared instance: an older SDK copy on the page may own "analytics".
+const consentSharedState = getSharedInstance("analytics-consent", () => {
+    const analyticsMode = readAnalyticsMode();
+    return {
+        analyticsMode,
+        // Whether the visitor may be tracked and the session id stored.
+        consentGranted: analyticsMode !== "consent",
+        isWatchingConsent: false,
+        listeners: [],
+    };
+});
+/** Whether analytics may run and store the session id on this page. */
+export function isAnalyticsAllowed() {
+    const { analyticsMode, consentGranted } = consentSharedState;
+    return analyticsMode !== "off" && consentGranted;
+}
+function setConsentGranted(granted) {
+    var _a;
+    if (consentSharedState.consentGranted === granted)
+        return;
+    consentSharedState.consentGranted = granted;
+    if (!granted) {
+        try {
+            const sessionId = localStorage.getItem(ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY);
+            // Same id for the rest of the tab, so an anonymous agent chat keeps its owner.
+            if (sessionId)
+                (_a = analyticsSharedState.fallbackSessionId) !== null && _a !== void 0 ? _a : (analyticsSharedState.fallbackSessionId = sessionId);
+            localStorage.removeItem(ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY);
+        }
+        catch (_b) {
+            // storage unavailable: nothing was stored
+        }
+    }
+    for (const listener of [...consentSharedState.listeners]) {
+        listener(granted);
+    }
+}
+// Subscribes once to the consent listener Base44 injects next to the meta tag.
+// Without it (e.g. a CSP blocked the inline script) "consent" never grants.
+function watchAnalyticsConsent() {
+    const state = consentSharedState;
+    if (state.isWatchingConsent)
+        return;
+    state.isWatchingConsent = true;
+    if (state.analyticsMode !== "consent" && state.analyticsMode !== "on")
+        return;
+    const b44Consent = typeof window !== "undefined" ? window.__b44Consent : undefined;
+    b44Consent === null || b44Consent === void 0 ? void 0 : b44Consent.on("analytics_storage", () => setConsentGranted(true), () => setConsentGranted(false));
+}
+function onConsentChange(listener) {
+    consentSharedState.listeners.push(listener);
+    return () => {
+        const listeners = consentSharedState.listeners;
+        const index = listeners.indexOf(listener);
+        if (index >= 0)
+            listeners.splice(index, 1);
+    };
+}
 export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthModule, enabled, }) => {
     var _a;
     // prevent overflow of events //
     const { maxQueueSize, throttleTime, batchSize } = analyticsSharedState.config;
+    watchAnalyticsConsent();
     // Disable analytics on React Native. It defines `window` but not `document`,
     // so the per-callsite `typeof window` guards below aren't enough to keep it
     // from touching `document` (e.g. `document.referrer` on init). Node/SSR is
     // still handled by those `window` guards, so this doesn't affect it.
-    if (!enabled || !((_a = analyticsSharedState.config) === null || _a === void 0 ? void 0 : _a.enabled) || isReactNative) {
+    if (!enabled ||
+        !((_a = analyticsSharedState.config) === null || _a === void 0 ? void 0 : _a.enabled) ||
+        isReactNative ||
+        consentSharedState.analyticsMode === "off") {
         return {
             track: () => { },
             cleanup: () => { },
@@ -70,7 +154,8 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
         }
     };
     const flush = async (eventsData, options = {}) => {
-        if (eventsData.length === 0)
+        // Consent may have been withdrawn while these events waited.
+        if (eventsData.length === 0 || !isAnalyticsAllowed())
             return;
         const sessionContext_ = await getSessionContext(userAuthModule);
         const events = eventsData.map(transformEventDataToApiRequestData(sessionContext_));
@@ -90,7 +175,8 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
         });
     };
     const track = (params) => {
-        if (analyticsSharedState.requestsQueue.length >= maxQueueSize) {
+        if (!isAnalyticsAllowed() ||
+            analyticsSharedState.requestsQueue.length >= maxQueueSize) {
             return;
         }
         const intrinsicData = getEventIntrinsicData();
@@ -126,23 +212,45 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
             onDocVisible();
         }
     };
-    const cleanup = () => {
+    let isStarted = false;
+    const start = () => {
+        if (isStarted)
+            return;
+        isStarted = true;
+        // start the flusing process ///
+        startProcessing();
+        // start the heart beat processor //
+        clearHeartBeatProcessor = startHeartBeatProcessor(track);
+        // track the referrer event //
+        trackInitializationEvent(track);
+        // start the visibility change listener //
+        if (typeof window !== "undefined") {
+            window.addEventListener("visibilitychange", onVisibilityChange);
+        }
+    };
+    const stop = () => {
+        isStarted = false;
         stopAnalyticsProcessor();
         clearHeartBeatProcessor === null || clearHeartBeatProcessor === void 0 ? void 0 : clearHeartBeatProcessor();
         if (typeof window !== "undefined") {
             window.removeEventListener("visibilitychange", onVisibilityChange);
         }
     };
-    // start the flusing process ///
-    startProcessing();
-    // start the heart beat processor //
-    clearHeartBeatProcessor = startHeartBeatProcessor(track);
-    // track the referrer event //
-    trackInitializationEvent(track);
-    // start the visibility change listener //
-    if (typeof window !== "undefined") {
-        window.addEventListener("visibilitychange", onVisibilityChange);
-    }
+    const stopWatchingConsent = onConsentChange((granted) => {
+        if (granted) {
+            start();
+        }
+        else {
+            stop();
+            analyticsSharedState.requestsQueue.splice(0);
+        }
+    });
+    const cleanup = () => {
+        stopWatchingConsent();
+        stop();
+    };
+    if (isAnalyticsAllowed())
+        start();
     return {
         track,
         cleanup,
@@ -338,19 +446,21 @@ function getFallbackSessionId() {
     return ((_a = analyticsSharedState.fallbackSessionId) !== null && _a !== void 0 ? _a : (analyticsSharedState.fallbackSessionId = generateUuid()));
 }
 export function getAnalyticsSessionId() {
-    if (typeof window === "undefined") {
+    var _a;
+    if (typeof window === "undefined" || !isAnalyticsAllowed()) {
         return getFallbackSessionId();
     }
     try {
         const sessionId = localStorage.getItem(ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY);
         if (!sessionId) {
-            const newSessionId = generateUuid();
+            // An id used before consent was granted carries on, so it is stored now.
+            const newSessionId = (_a = analyticsSharedState.fallbackSessionId) !== null && _a !== void 0 ? _a : generateUuid();
             localStorage.setItem(ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY, newSessionId);
             return newSessionId;
         }
         return sessionId;
     }
-    catch (_a) {
+    catch (_b) {
         return getFallbackSessionId();
     }
 }

package/dist/modules/app-logs.js

@@ -1,3 +1,4 @@
+import { isAnalyticsAllowed } from "./analytics.js";
 /**
  * Creates the app logs module for the Base44 SDK.
  *
@@ -11,6 +12,9 @@ export function createAppLogsModule(axios, appId) {
     return {
         // Log user activity in the app
         async logUserInApp(pageName) {
+            // A page visit feeds App Analytics, so it follows the same consent.
+            if (!isAnalyticsAllowed())
+                return;
             await axios.post(`${baseURL}/log-user-in-app/${pageName}`);
         },
         // Fetch app logs with optional parameters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.57-pr.359.9ff5e66",
+  "version": "0.8.57-pr.360.71a2580",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",