@dotcms/analytics 1.1.1-next.7 → 1.1.1-next.8

package/lib/core/dot-content-analytics.d.ts

@@ -1,4 +1,11 @@
+import { ANALYTICS_WINDOWS_ACTIVE_KEY, ANALYTICS_WINDOWS_CLEANUP_KEY } from '../../../../uve/src/internal.ts';
 import { DotCMSAnalytics, DotCMSAnalyticsConfig } from './shared/models';
+declare global {
+    interface Window {
+        [ANALYTICS_WINDOWS_ACTIVE_KEY]?: boolean;
+        [ANALYTICS_WINDOWS_CLEANUP_KEY]?: () => void;
+    }
+}
 /**
  * Creates an analytics instance for content analytics tracking.
  *

package/lib/core/dot-content-analytics.js

@@ -1,33 +1,34 @@
-import { Analytics as o } from "analytics";
-import { dotAnalytics as s } from "./plugin/dot-analytics.plugin.js";
-import { dotAnalyticsEnricherPlugin as l } from "./plugin/enricher/dot-analytics.enricher.plugin.js";
-import { dotAnalyticsIdentityPlugin as u } from "./plugin/identity/dot-analytics.identity.plugin.js";
-import { cleanupActivityTracking as a } from "./shared/dot-content-analytics.activity-tracker.js";
-const f = (i) => {
-  if (!i.siteAuth)
-    return console.error('DotCMS Analytics: Missing "siteAuth" in configuration'), null;
-  if (!i.server)
-    return console.error('DotCMS Analytics: Missing "server" in configuration'), null;
-  const t = o({
+import { Analytics as a } from "analytics";
+import { ANALYTICS_WINDOWS_ACTIVE_KEY as r, ANALYTICS_WINDOWS_CLEANUP_KEY as s } from "../../uve/src/internal/constants.js";
+import { dotAnalytics as l } from "./plugin/dot-analytics.plugin.js";
+import { dotAnalyticsEnricherPlugin as c } from "./plugin/enricher/dot-analytics.enricher.plugin.js";
+import { dotAnalyticsIdentityPlugin as p } from "./plugin/identity/dot-analytics.identity.plugin.js";
+import { validateAnalyticsConfig as m } from "./shared/dot-content-analytics.utils.js";
+import { cleanupActivityTracking as u } from "./shared/dot-content-analytics.activity-tracker.js";
+const I = (n) => {
+  const o = m(n);
+  if (o)
+    return console.error(`DotCMS Analytics: Missing ${o.join(" and ")} in configuration`), typeof window < "u" && (window[r] = !1), null;
+  const i = a({
     app: "dotAnalytics",
-    debug: i.debug,
+    debug: n.debug,
     plugins: [
-      u(i),
+      p(n),
       // Inject identity context (user_id, session_id, local_tz)
-      l(),
+      c(),
       // Enrich and clean payload with page, device, utm data and custom data
-      s(i)
+      l(n)
       // Send events to server
     ]
-  }), r = () => a();
-  return typeof window < "u" && (window.addEventListener("beforeunload", r), window.__dotAnalyticsCleanup = r), {
+  }), e = () => u();
+  return typeof window < "u" && (window.addEventListener("beforeunload", e), window[s] = e, window[r] = !0, window.dispatchEvent(new CustomEvent("dotcms:analytics:ready"))), {
     /**
      * Track a page view.
      * Session activity is automatically updated by the identity plugin.
      * @param payload - Optional custom data to include with the page view (any valid JSON object)
      */
-    pageView: (n = {}) => {
-      t == null || t.page(n);
+    pageView: (t = {}) => {
+      i == null || i.page(t);
     },
     /**
      * Track a custom event.
@@ -35,11 +36,11 @@ const f = (i) => {
      * @param eventName - The name of the event to track
      * @param payload - Custom data to include with the event (any valid JSON object)
      */
-    track: (n, e = {}) => {
-      t == null || t.track(n, e);
+    track: (t, d = {}) => {
+      i == null || i.track(t, d);
     }
   };
 };
 export {
-  f as initializeContentAnalytics
+  I as initializeContentAnalytics
 };

package/lib/core/shared/dot-content-analytics.activity-tracker.d.ts

@@ -1,4 +1,11 @@
+import { ANALYTICS_WINDOWS_ACTIVE_KEY, ANALYTICS_WINDOWS_CLEANUP_KEY } from '../../../../../uve/src/internal.ts';
 import { DotCMSAnalyticsConfig } from './models';
+declare global {
+    interface Window {
+        [ANALYTICS_WINDOWS_CLEANUP_KEY]?: () => void;
+        [ANALYTICS_WINDOWS_ACTIVE_KEY]?: boolean;
+    }
+}
 /**
  * Updates session activity with throttling
  */
@@ -15,7 +22,7 @@ export declare const getSessionInfo: () => {
  */
 export declare const initializeActivityTracking: (config: DotCMSAnalyticsConfig) => void;
 /**
- * Cleans up activity tracking listeners
+ * Cleans up activity tracking listeners and resets analytics state
  */
 export declare const cleanupActivityTracking: () => void;
 /**

package/lib/core/shared/dot-content-analytics.activity-tracker.js

@@ -1,5 +1,6 @@
-import { DEFAULT_SESSION_TIMEOUT_MINUTES as c, ACTIVITY_EVENTS as r } from "./constants/dot-content-analytics.constants.js";
-class o {
+import { ANALYTICS_WINDOWS_ACTIVE_KEY as o, ANALYTICS_WINDOWS_CLEANUP_KEY as r } from "../../../uve/src/internal/constants.js";
+import { DEFAULT_SESSION_TIMEOUT_MINUTES as c, ACTIVITY_EVENTS as v } from "./constants/dot-content-analytics.constants.js";
+class l {
   constructor() {
     this.activityListeners = [], this.lastActivityTime = Date.now(), this.inactivityTimer = null, this.isThrottled = !1, this.config = null, this.ACTIVITY_THROTTLE_MS = 1e3;
   }
@@ -44,7 +45,7 @@ class o {
     if (this.cleanup(), this.config = i, typeof window > "u")
       return;
     const s = () => this.updateSessionActivity();
-    r.forEach((a) => {
+    v.forEach((a) => {
       window.addEventListener(a, s, { passive: !0 }), this.activityListeners.push(
         () => window.removeEventListener(a, s)
       );
@@ -72,15 +73,15 @@ class o {
     };
   }
 }
-const t = new o(), h = () => {
+const t = new l(), u = () => {
   t.updateSessionActivity();
-}, l = (e) => {
+}, d = (e) => {
   t.initialize(e);
-}, T = () => {
-  t.cleanup();
+}, y = () => {
+  t.cleanup(), typeof window < "u" && (window[o] = !1, window[r] = void 0, window.dispatchEvent(new CustomEvent("dotcms:analytics:cleanup")));
 };
 export {
-  T as cleanupActivityTracking,
-  l as initializeActivityTracking,
-  h as updateSessionActivity
+  y as cleanupActivityTracking,
+  d as initializeActivityTracking,
+  u as updateSessionActivity
 };

package/lib/core/shared/dot-content-analytics.utils.d.ts

@@ -1,6 +1,21 @@
 import { PageData } from 'analytics';
 import { AnalyticsBasePayloadWithContext, DotCMSAnalyticsConfig, DotCMSAnalyticsEventContext, DotCMSBrowserData, DotCMSEventDeviceData, DotCMSEventUtmData, EnrichedAnalyticsPayload } from './models';
 export { cleanupActivityTracking, getLastActivity, getSessionInfo, initializeActivityTracking, isUserInactive, updateSessionActivity } from './dot-content-analytics.activity-tracker';
+/**
+ * Validates required configuration fields for Analytics initialization.
+ *
+ * @param config - The analytics configuration to validate
+ * @returns Array of missing field names, or null if all required fields are present
+ *
+ * @example
+ * ```ts
+ * const missing = validateAnalyticsConfig(config);
+ * if (missing) {
+ *   console.error(`Missing: ${missing.join(' and ')}`);
+ * }
+ * ```
+ */
+export declare function validateAnalyticsConfig(config: DotCMSAnalyticsConfig): string[] | null;
 /**
  * Generates a cryptographically secure random ID.
  * @internal This function is for internal use only and should not be used outside of the SDK.

package/lib/core/shared/dot-content-analytics.utils.js

@@ -1,9 +1,15 @@
-import { ANALYTICS_JS_DEFAULT_PROPERTIES as w, SESSION_STORAGE_KEY as h, DEFAULT_SESSION_TIMEOUT_MINUTES as _, USER_ID_KEY as l, EXPECTED_UTM_KEYS as f } from "./constants/dot-content-analytics.constants.js";
-let g = null, u = null;
+import { ANALYTICS_JS_DEFAULT_PROPERTIES as f, SESSION_STORAGE_KEY as h, DEFAULT_SESSION_TIMEOUT_MINUTES as w, USER_ID_KEY as l, EXPECTED_UTM_KEYS as _ } from "./constants/dot-content-analytics.constants.js";
+import "../../../uve/src/internal/constants.js";
+function U(t) {
+  var n, s;
+  const e = [];
+  return (n = t.siteAuth) != null && n.trim() || e.push('"siteAuth"'), (s = t.server) != null && s.trim() || e.push('"server"'), e.length > 0 ? e : null;
+}
+let u = null, g = null;
 const d = (t) => {
   const e = Date.now(), n = Math.random().toString(36).substr(2, 9), s = Math.random().toString(36).substr(2, 9);
   return `${t}_${e}_${n}${s}`;
-}, S = {
+}, m = {
   getItem: (t) => {
     try {
       return localStorage.getItem(t);
@@ -19,8 +25,8 @@ const d = (t) => {
     }
   }
 }, p = () => {
-  let t = S.getItem(l);
-  return t || (t = d("user"), S.setItem(l, t)), t;
+  let t = m.getItem(l);
+  return t || (t = d("user"), m.setItem(l, t)), t;
 }, D = (t) => {
   const e = new Date(t), n = /* @__PURE__ */ new Date(), s = new Date(
     e.getUTCFullYear(),
@@ -35,7 +41,7 @@ const d = (t) => {
   try {
     const e = sessionStorage.getItem(h);
     if (e) {
-      const { sessionId: o, startTime: r, lastActivity: a } = JSON.parse(e), c = !D(r), i = t - a < _ * 60 * 1e3;
+      const { sessionId: o, startTime: r, lastActivity: a } = JSON.parse(e), c = !D(r), i = t - a < w * 60 * 1e3;
       if (c && i)
         return sessionStorage.setItem(
           h,
@@ -55,7 +61,7 @@ const d = (t) => {
   } catch {
     return d("session_fallback");
   }
-}, U = (t) => {
+}, $ = (t) => {
   const e = T(), n = p(), s = I();
   return t.debug && console.warn("DotCMS Analytics Identity Context:", {
     sessionId: e,
@@ -66,12 +72,12 @@ const d = (t) => {
     user_id: n,
     device: s
   };
-}, m = () => g || (g = {
+}, S = () => u || (u = {
   user_language: navigator.language,
   doc_encoding: document.characterSet || document.charset,
   screen_resolution: typeof screen < "u" && screen.width && screen.height ? `${screen.width}x${screen.height}` : ""
-}, g), I = () => {
-  const t = m(), e = window.innerWidth || document.documentElement.clientWidth || 0, n = window.innerHeight || document.documentElement.clientHeight || 0;
+}, u), I = () => {
+  const t = S(), e = window.innerWidth || document.documentElement.clientWidth || 0, n = window.innerHeight || document.documentElement.clientHeight || 0;
   return {
     screen_resolution: t.screen_resolution ?? "",
     language: t.user_language ?? "",
@@ -80,16 +86,16 @@ const d = (t) => {
   };
 }, y = (t) => {
   const e = t.search;
-  if (u && u.search === e)
-    return u.params;
+  if (g && g.search === e)
+    return g.params;
   const n = new URLSearchParams(e), s = {};
-  return f.forEach((o) => {
+  return _.forEach((o) => {
     const r = n.get(o);
     if (r) {
       const a = o.replace("utm_", "");
       s[a] = r;
     }
-  }), u = { search: e, params: s }, s;
+  }), g = { search: e, params: s }, s;
 }, E = () => {
   try {
     const t = (/* @__PURE__ */ new Date()).getTimezoneOffset(), e = t > 0 ? "-" : "+", n = Math.abs(t), s = Math.floor(n / 60), o = n % 60;
@@ -104,10 +110,10 @@ const d = (t) => {
   } catch {
     return (/* @__PURE__ */ new Date()).toISOString();
   }
-}, $ = (t, e = typeof window < "u" ? window.location : {}) => {
-  const n = C(), s = m(), { properties: o } = t, r = {};
+}, A = (t, e = typeof window < "u" ? window.location : {}) => {
+  const n = C(), s = S(), { properties: o } = t, r = {};
   Object.keys(o).forEach((i) => {
-    w.includes(i) || (r[i] = o[i]);
+    f.includes(i) || (r[i] = o[i]);
   });
   const a = {
     url: e.href,
@@ -129,12 +135,13 @@ const d = (t) => {
   };
 };
 export {
-  $ as enrichPagePayloadOptimized,
+  A as enrichPagePayloadOptimized,
   y as extractUTMParameters,
   d as generateSecureId,
-  U as getAnalyticsContext,
+  $ as getAnalyticsContext,
   I as getDeviceDataForContext,
   C as getLocalTime,
   T as getSessionId,
-  p as getUserId
+  p as getUserId,
+  U as validateAnalyticsConfig
 };

package/lib/core/shared/models/index.d.ts

@@ -5,8 +5,3 @@ export * from './data.model';
 export * from './event.model';
 export * from './request.model';
 export * from './library.model';
-declare global {
-    interface Window {
-        __dotAnalyticsCleanup?: () => void;
-    }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/analytics",
-  "version": "1.1.1-next.7",
+  "version": "1.1.1-next.8",
   "description": "Official JavaScript library for Content Analytics with DotCMS.",
   "repository": {
     "type": "git",

package/uve/src/internal/constants.js

@@ -1,3 +1,8 @@
-import { UVEEventType as n } from "../../../types/src/lib/editor/public.js";
-import { onContentletHovered as r, onIframeScroll as o, onRequestBounds as t, onPageReload as E, onContentChanges as u } from "./events.js";
-n.CONTENT_CHANGES + "", n.PAGE_RELOAD + "", n.REQUEST_BOUNDS + "", n.IFRAME_SCROLL + "", n.CONTENTLET_HOVERED + "";
+import { UVEEventType as t } from "../../../types/src/lib/editor/public.js";
+import { onContentletHovered as e, onIframeScroll as o, onRequestBounds as r, onPageReload as E, onContentChanges as _ } from "./events.js";
+t.CONTENT_CHANGES + "", t.PAGE_RELOAD + "", t.REQUEST_BOUNDS + "", t.IFRAME_SCROLL + "", t.CONTENTLET_HOVERED + "";
+const N = "__dotAnalyticsActive__", T = "__dotAnalyticsCleanup";
+export {
+  N as ANALYTICS_WINDOWS_ACTIVE_KEY,
+  T as ANALYTICS_WINDOWS_CLEANUP_KEY
+};