@dotcms/analytics 1.2.0 → 1.2.1-next.2

package/uve/src/lib/dom/dom.utils.js

@@ -1,80 +1,74 @@
 import "../../internal/constants.js";
-function C(t) {
-  return t.map((a) => {
-    const o = a.getBoundingClientRect(), n = Array.from(
-      a.querySelectorAll('[data-dot-object="contentlet"]')
+function c(t) {
+  return t.map((n) => {
+    const e = n.getBoundingClientRect(), o = Array.from(
+      n.querySelectorAll('[data-dot-object="contentlet"]')
     );
     return {
-      x: o.x,
-      y: o.y,
-      width: o.width,
-      height: o.height,
+      x: e.x,
+      y: e.y,
+      width: e.width,
+      height: e.height,
       payload: JSON.stringify({
-        container: u(a)
+        container: a(n)
       }),
-      contentlets: f(o, n)
+      contentlets: d(e, o)
     };
   });
 }
-function f(t, a) {
-  return a.map((o) => {
-    var d, r, i, e, s, c;
-    const n = o.getBoundingClientRect();
+function d(t, n) {
+  return n.map((e) => {
+    const o = e.getBoundingClientRect();
     return {
       x: 0,
-      y: n.y - t.y,
-      width: n.width,
-      height: n.height,
+      y: o.y - t.y,
+      width: o.width,
+      height: o.height,
       payload: JSON.stringify({
-        container: (d = o.dataset) != null && d.dotContainer ? JSON.parse((r = o.dataset) == null ? void 0 : r.dotContainer) : y(o),
+        container: e.dataset?.dotContainer ? JSON.parse(e.dataset?.dotContainer) : r(e),
         contentlet: {
-          identifier: (i = o.dataset) == null ? void 0 : i.dotIdentifier,
-          title: (e = o.dataset) == null ? void 0 : e.dotTitle,
-          inode: (s = o.dataset) == null ? void 0 : s.dotInode,
-          contentType: (c = o.dataset) == null ? void 0 : c.dotType
+          identifier: e.dataset?.dotIdentifier,
+          title: e.dataset?.dotTitle,
+          inode: e.dataset?.dotInode,
+          contentType: e.dataset?.dotType
         }
       })
     };
   });
 }
-function u(t) {
-  var a, o, n, d;
+function a(t) {
   return {
-    acceptTypes: ((a = t.dataset) == null ? void 0 : a.dotAcceptTypes) || "",
-    identifier: ((o = t.dataset) == null ? void 0 : o.dotIdentifier) || "",
-    maxContentlets: ((n = t.dataset) == null ? void 0 : n.maxContentlets) || "",
-    uuid: ((d = t.dataset) == null ? void 0 : d.dotUuid) || ""
+    acceptTypes: t.dataset?.dotAcceptTypes || "",
+    identifier: t.dataset?.dotIdentifier || "",
+    maxContentlets: t.dataset?.maxContentlets || "",
+    uuid: t.dataset?.dotUuid || ""
   };
 }
-function y(t) {
-  const a = t.closest('[data-dot-object="container"]');
-  return a ? u(a) : (console.warn("No container found for the contentlet"), null);
+function r(t) {
+  const n = t.closest('[data-dot-object="container"]');
+  return n ? a(n) : (console.warn("No container found for the contentlet"), null);
 }
-function g(t) {
-  var o, n, d;
+function i(t) {
   if (!t) return null;
-  const a = t.querySelector('[data-dot-object="empty-content"]');
-  return ((o = t == null ? void 0 : t.dataset) == null ? void 0 : o.dotObject) === "contentlet" || // The container inside Headless components have a span with the data-dot-object="container" attribute
-  ((n = t == null ? void 0 : t.dataset) == null ? void 0 : n.dotObject) === "container" && a || // The container inside Traditional have no content inside
-  ((d = t == null ? void 0 : t.dataset) == null ? void 0 : d.dotObject) === "container" && t.children.length === 0 ? t : g(t == null ? void 0 : t.parentElement);
+  const n = t.querySelector('[data-dot-object="empty-content"]');
+  return t?.dataset?.dotObject === "contentlet" || // The container inside Headless components have a span with the data-dot-object="container" attribute
+  t?.dataset?.dotObject === "container" && n || // The container inside Traditional have no content inside
+  t?.dataset?.dotObject === "container" && t.children.length === 0 ? t : i(t?.parentElement);
 }
-function h(t) {
-  const a = t.querySelectorAll(
+function u(t) {
+  const n = t.querySelectorAll(
     '[data-dot-object="vtl-file"]'
   );
-  return a.length ? Array.from(a).map((o) => {
-    var n, d;
-    return {
-      inode: (n = o.dataset) == null ? void 0 : n.dotInode,
-      name: (d = o.dataset) == null ? void 0 : d.dotUrl
-    };
-  }) : null;
+  return n.length ? Array.from(n).map((e) => ({
+    inode: e.dataset?.dotInode,
+    name: e.dataset?.dotUrl
+  })) : null;
 }
 export {
-  g as findDotCMSElement,
-  h as findDotCMSVTLData,
-  y as getClosestDotCMSContainerData,
-  u as getDotCMSContainerData,
-  f as getDotCMSContentletsBound,
-  C as getDotCMSPageBounds
+  i as findDotCMSElement,
+  u as findDotCMSVTLData,
+  r as getClosestDotCMSContainerData,
+  a as getDotCMSContainerData,
+  d as getDotCMSContentletsBound,
+  c as getDotCMSPageBounds
 };

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

@@ -1,46 +0,0 @@
-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: n.debug,
-    plugins: [
-      p(n),
-      // Inject identity context (user_id, session_id, local_tz)
-      c(),
-      // Enrich and clean payload with page, device, utm data and custom data
-      l(n)
-      // Send events to server
-    ]
-  }), 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: (t = {}) => {
-      i == null || i.page(t);
-    },
-    /**
-     * Track a custom event.
-     * Session activity is automatically updated by the identity plugin.
-     * @param eventName - The name of the event to track
-     * @param payload - Custom data to include with the event (any valid JSON object)
-     */
-    track: (t, d = {}) => {
-      i == null || i.track(t, d);
-    }
-  };
-};
-export {
-  I as initializeContentAnalytics
-};

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

@@ -1,33 +0,0 @@
-import { DotCMSAnalyticsConfig, DotCMSAnalyticsParams } from '../shared/models';
-/**
- * Analytics plugin for tracking page views and custom events in DotCMS applications.
- * This plugin handles sending analytics data to the DotCMS server, managing initialization,
- * and processing both automatic and manual tracking events.
- * Supports optional queue management for batching events before sending.
- *
- * @param {DotCMSAnalyticsConfig} config - Configuration object containing API key, server URL,
- *                                     debug mode, auto page view settings, and queue config
- * @returns {Object} Plugin object with methods for initialization and event tracking
- */
-export declare const dotAnalytics: (config: DotCMSAnalyticsConfig) => {
-    name: string;
-    config: DotCMSAnalyticsConfig;
-    /**
-     * Initialize the plugin with optional queue management
-     */
-    initialize: () => Promise<void>;
-    /**
-     * Track a page view event
-     * The enricher plugin has already built the complete request body
-     */
-    page: (params: DotCMSAnalyticsParams) => void;
-    /**
-     * Track a custom event
-     * The enricher plugin has already built the complete request body
-     */
-    track: (params: DotCMSAnalyticsParams) => void;
-    /**
-     * Check if the plugin is loaded
-     */
-    loaded: () => boolean;
-};

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

@@ -1,42 +0,0 @@
-import { sendAnalyticsEvent as u } from "../shared/dot-content-analytics.http.js";
-import { createAnalyticsQueue as d } from "../shared/queue/dot-analytics.queue.utils.js";
-const v = (t) => {
-  let n = !1;
-  const i = t.queue !== !1;
-  let e = null;
-  const o = (r) => {
-    const { config: c, payload: l } = r;
-    if (!n)
-      throw new Error("DotCMS Analytics: Plugin not initialized");
-    const a = l.events[0], s = l.context;
-    i && e ? e.enqueue(a, s) : u({
-      context: s,
-      events: [a]
-    }, c);
-  };
-  return {
-    name: "dot-analytics",
-    config: t,
-    /**
-     * Initialize the plugin with optional queue management
-     */
-    initialize: () => (n = !0, i && (e = d(t), e.initialize()), Promise.resolve()),
-    /**
-     * Track a page view event
-     * The enricher plugin has already built the complete request body
-     */
-    page: o,
-    /**
-     * Track a custom event
-     * The enricher plugin has already built the complete request body
-     */
-    track: o,
-    /**
-     * Check if the plugin is loaded
-     */
-    loaded: () => n
-  };
-};
-export {
-  v as dotAnalytics
-};

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

@@ -1,34 +0,0 @@
-const E = "/api/v1/analytics/content/event", e = {
-  PAGEVIEW: "pageview"
-}, n = [
-  "utm_source",
-  "utm_medium",
-  "utm_campaign",
-  "utm_term",
-  "utm_content"
-], c = 30, s = "dot_analytics_session_id", T = "dot_analytics_user_id", t = 15, _ = 5e3, o = ["click"], S = {
-  eventBatchSize: t,
-  // Max events per batch - auto-sends when reached
-  flushInterval: _
-  // Time between flushes - sends whatever is queued
-}, I = [
-  "title",
-  "url",
-  "path",
-  "hash",
-  "search",
-  "width",
-  "height",
-  "referrer"
-];
-export {
-  o as ACTIVITY_EVENTS,
-  E as ANALYTICS_ENDPOINT,
-  I as ANALYTICS_JS_DEFAULT_PROPERTIES,
-  S as DEFAULT_QUEUE_CONFIG,
-  c as DEFAULT_SESSION_TIMEOUT_MINUTES,
-  e as DotCMSPredefinedEventType,
-  n as EXPECTED_UTM_KEYS,
-  s as SESSION_STORAGE_KEY,
-  T as USER_ID_KEY
-};

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

@@ -1,17 +0,0 @@
-import { DotCMSAnalyticsConfig, DotCMSEvent, DotCMSRequestBody } from './models';
-/**
- * Available transport methods for sending analytics events
- */
-export declare const TRANSPORT_TYPES: {
-    readonly FETCH: "fetch";
-    readonly BEACON: "beacon";
-};
-export type TransportType = (typeof TRANSPORT_TYPES)[keyof typeof TRANSPORT_TYPES];
-/**
- * Send analytics events to the server
- * @param payload - The event payload data
- * @param config - The analytics configuration
- * @param transportType - Transport method: 'fetch' (default) or 'beacon' (for page unload)
- * @returns A promise that resolves when the request is complete (fetch only)
- */
-export declare const sendAnalyticsEvent: (payload: DotCMSRequestBody<DotCMSEvent>, config: DotCMSAnalyticsConfig, transportType?: TransportType) => Promise<void>;

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

@@ -1,41 +0,0 @@
-import { ANALYTICS_ENDPOINT as l } from "./constants/dot-content-analytics.constants.js";
-const d = async (s, n, o = "fetch") => {
-  const a = `${n.server}${l}`, c = JSON.stringify(s);
-  if (n.debug && console.warn(
-    `DotCMS Analytics: Sending ${s.events.length} event(s) via ${o}`,
-    o === "fetch" ? { payload: s } : void 0
-  ), o === "beacon") {
-    if (navigator.sendBeacon) {
-      const e = new Blob([c], { type: "application/json" });
-      !navigator.sendBeacon(a, e) && n.debug && console.warn("DotCMS Analytics: sendBeacon failed (queue might be full)");
-    } else
-      return n.debug && console.warn("DotCMS Analytics: sendBeacon not available, using fetch fallback"), d(s, n, "fetch");
-    return;
-  }
-  try {
-    const e = await fetch(a, {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: c
-    });
-    if (!e.ok) {
-      const i = e.statusText || "Unknown Error", r = `HTTP ${e.status}: ${i}`;
-      try {
-        const t = await e.json();
-        t.message ? console.warn(`DotCMS Analytics: ${t.message} (${r})`) : console.warn(
-          `DotCMS Analytics: ${r} - No error message in response`
-        );
-      } catch (t) {
-        console.warn(
-          `DotCMS Analytics: ${r} - Failed to parse error response:`,
-          t
-        );
-      }
-    }
-  } catch (e) {
-    console.error("DotCMS Analytics: Error sending event:", e);
-  }
-};
-export {
-  d as sendAnalyticsEvent
-};

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

@@ -1,147 +0,0 @@
-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}`;
-}, m = {
-  getItem: (t) => {
-    try {
-      return localStorage.getItem(t);
-    } catch {
-      return null;
-    }
-  },
-  setItem: (t, e) => {
-    try {
-      localStorage.setItem(t, e);
-    } catch {
-      console.warn(`DotCMS Analytics: Could not save ${t} to localStorage`);
-    }
-  }
-}, p = () => {
-  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(),
-    e.getUTCMonth(),
-    e.getUTCDate()
-  ), o = new Date(n.getUTCFullYear(), n.getUTCMonth(), n.getUTCDate());
-  return s.getTime() !== o.getTime();
-}, T = () => {
-  const t = Date.now();
-  if (typeof window > "u")
-    return d("session_fallback");
-  try {
-    const e = sessionStorage.getItem(h);
-    if (e) {
-      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,
-          JSON.stringify({
-            sessionId: o,
-            startTime: r,
-            lastActivity: t
-          })
-        ), o;
-    }
-    const n = d("session"), s = {
-      sessionId: n,
-      startTime: t,
-      lastActivity: t
-    };
-    return sessionStorage.setItem(h, JSON.stringify(s)), n;
-  } catch {
-    return d("session_fallback");
-  }
-}, $ = (t) => {
-  const e = T(), n = p(), s = I();
-  return t.debug && console.warn("DotCMS Analytics Identity Context:", {
-    sessionId: e,
-    userId: n
-  }), {
-    site_auth: t.siteAuth,
-    session_id: e,
-    user_id: n,
-    device: s
-  };
-}, 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}` : ""
-}, 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 ?? "",
-    viewport_width: String(e),
-    viewport_height: String(n)
-  };
-}, y = (t) => {
-  const e = t.search;
-  if (g && g.search === e)
-    return g.params;
-  const n = new URLSearchParams(e), s = {};
-  return _.forEach((o) => {
-    const r = n.get(o);
-    if (r) {
-      const a = o.replace("utm_", "");
-      s[a] = r;
-    }
-  }), 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;
-    return `${e}${s.toString().padStart(2, "0")}:${o.toString().padStart(2, "0")}`;
-  } catch {
-    return "+00:00";
-  }
-}, C = () => {
-  try {
-    const t = /* @__PURE__ */ new Date(), e = E(), n = t.getFullYear(), s = (t.getMonth() + 1).toString().padStart(2, "0"), o = t.getDate().toString().padStart(2, "0"), r = t.getHours().toString().padStart(2, "0"), a = t.getMinutes().toString().padStart(2, "0"), c = t.getSeconds().toString().padStart(2, "0");
-    return `${n}-${s}-${o}T${r}:${a}:${c}${e}`;
-  } catch {
-    return (/* @__PURE__ */ new Date()).toISOString();
-  }
-}, A = (t, e = typeof window < "u" ? window.location : {}) => {
-  const n = C(), s = S(), { properties: o } = t, r = {};
-  Object.keys(o).forEach((i) => {
-    f.includes(i) || (r[i] = o[i]);
-  });
-  const a = {
-    url: e.href,
-    doc_encoding: s.doc_encoding,
-    doc_hash: e.hash,
-    doc_protocol: e.protocol,
-    doc_search: e.search,
-    doc_host: e.hostname,
-    doc_path: e.pathname,
-    title: o.title ?? (document == null ? void 0 : document.title)
-  }, c = y(e);
-  return {
-    ...t,
-    page: a,
-    ...Object.keys(c).length > 0 && { utm: c },
-    // Only include custom if there are user-provided properties
-    ...Object.keys(r).length > 0 && { custom: r },
-    local_time: n
-  };
-};
-export {
-  A as enrichPagePayloadOptimized,
-  y as extractUTMParameters,
-  d as generateSecureId,
-  $ as getAnalyticsContext,
-  I as getDeviceDataForContext,
-  C as getLocalTime,
-  T as getSessionId,
-  p as getUserId,
-  U as validateAnalyticsConfig
-};