@base44/sdk 0.8.7 → 0.8.9

package/dist/modules/analytics.d.ts

@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
 import { TrackEventParams, AnalyticsModuleOptions } from "./analytics.types";
 import type { AuthModule } from "./auth.types";
 export declare const USER_HEARTBEAT_EVENT_NAME = "__user_heartbeat_event__";
-export declare const ANALYTICS_CONFIG_WINDOW_KEY = "base44_analytics_config";
+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 interface AnalyticsModuleArgs {
     axiosClient: AxiosInstance;
@@ -14,5 +14,5 @@ export declare const createAnalyticsModule: ({ axiosClient, serverUrl, appId, us
     track: (params: TrackEventParams) => void;
     cleanup: () => void;
 };
-export declare function getAnalyticsModuleOptionsFromWindow(): AnalyticsModuleOptions | undefined;
+export declare function getAnalyticsConfigFromUrlParams(): AnalyticsModuleOptions | undefined;
 export declare function getAnalyticsSessionId(): string;

package/dist/modules/analytics.js

@@ -1,10 +1,11 @@
 import { getSharedInstance } from "../utils/sharedInstance";
 import { generateUuid } from "../utils/common";
 export const USER_HEARTBEAT_EVENT_NAME = "__user_heartbeat_event__";
-export const ANALYTICS_CONFIG_WINDOW_KEY = "base44_analytics_config";
+export const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";
 export const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY = "base44_analytics_session_id";
 const defaultConfiguration = {
-    enabled: true,
+    // default to disabled //
+    enabled: false,
     maxQueueSize: 1000,
     throttleTime: 1000,
     batchSize: 30,
@@ -22,7 +23,7 @@ const analyticsSharedState = getSharedInstance(ANALYTICS_SHARED_STATE_NAME, () =
     sessionContext: null,
     config: {
         ...defaultConfiguration,
-        ...getAnalyticsModuleOptionsFromWindow(),
+        ...getAnalyticsConfigFromUrlParams(),
     },
 }));
 export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthModule, }) => {
@@ -44,20 +45,27 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
             data: { events },
         });
     };
+    // currently disabled, until fully tested  //
+    const beaconRequest = async (events) => {
+        const beaconPayload = JSON.stringify({ events });
+        try {
+            const blob = new Blob([beaconPayload], { type: "application/json" });
+            return (typeof navigator === "undefined" ||
+                beaconPayload.length > 60000 ||
+                !navigator.sendBeacon(trackBatchUrl, blob));
+        }
+        catch (_a) {
+            return false;
+        }
+    };
     const flush = async (eventsData) => {
         const sessionContext_ = await getSessionContext(userAuthModule);
         const events = eventsData.map(transformEventDataToApiRequestData(sessionContext_));
-        const beaconPayload = JSON.stringify({ events });
         try {
-            if (typeof navigator === "undefined" ||
-                beaconPayload.length > 60000 ||
-                !navigator.sendBeacon(trackBatchUrl, beaconPayload)) {
-                // beacon didn't work, fallback to axios
-                await batchRequestFallback(events);
-            }
+            return batchRequestFallback(events);
         }
         catch (_a) {
-            // TODO: think about retries if needed
+            // do nothing
         }
     };
     const startProcessing = () => {
@@ -189,10 +197,22 @@ async function getSessionContext(userAuthModule) {
     }
     return analyticsSharedState.sessionContext;
 }
-export function getAnalyticsModuleOptionsFromWindow() {
+export function getAnalyticsConfigFromUrlParams() {
     if (typeof window === "undefined")
         return undefined;
-    return window[ANALYTICS_CONFIG_WINDOW_KEY];
+    const urlParams = new URLSearchParams(window.location.search);
+    const analyticsEnable = urlParams.get(ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY);
+    // if the url param is not set, return undefined //
+    if (analyticsEnable == null || !analyticsEnable.length)
+        return undefined;
+    // remove the url param from the url //
+    const newUrlParams = new URLSearchParams(window.location.search);
+    newUrlParams.delete(ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY);
+    const newUrl = window.location.pathname +
+        (newUrlParams.toString() ? "?" + newUrlParams.toString() : "");
+    window.history.replaceState({}, "", newUrl);
+    // return the config object //
+    return { enabled: analyticsEnable === "true" };
 }
 export function getAnalyticsSessionId() {
     if (typeof window === "undefined") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44/sdk",
-  "version": "0.8.7",
+  "version": "0.8.9",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",