@dotcms/analytics 1.5.6 → 1.6.0-next.36

package/README.md

@@ -698,7 +698,7 @@ We offer multiple channels to get help with the dotCMS Analytics SDK:
 -   **GitHub Issues**: For bug reports and feature requests, please [open an issue](https://github.com/dotCMS/core/issues/new/choose) in the GitHub repository.
 -   **Community Forum**: Join our [community discussions](https://community.dotcms.com/) to ask questions and share solutions.
 -   **Stack Overflow**: Use the tag `dotcms-analytics` when posting questions.
--   **Enterprise Support**: Enterprise customers can access premium support through the [dotCMS Support Portal](https://helpdesk.dotcms.com/support/).
+-   **Enterprise Support**: Enterprise customers can access premium support through the [dotCMS Support Portal](https://www.dotcms.com/support).
 
 When reporting issues, please include:
 

package/lib/core/shared/models/library.model.d.ts

@@ -93,7 +93,10 @@ export interface DotCMSAnalyticsConfig {
      */
     logLevel?: LogLevel;
     /**
-     * Automatically track page views when set to true.
+     * Automatically track page views. Defaults to `true` (opt-out).
+     * Set explicitly to `false` to disable automatic page view tracking.
+     * Via the HTML `data-analytics-auto-page-view` attribute, only the literal string "false"
+     * disables it (any other value, including "", enables it).
      */
     autoPageView?: boolean;
     /**

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

@@ -92,7 +92,9 @@ export interface AnalyticsConfigResult {
  * Always returns a config (with defaults if needed).
  *
  * - If no data-analytics-server attribute is found, uses the current domain as the server endpoint
- * - Both debug and autoPageView default to false (must be explicitly set to "true")
+ * - debug defaults to false (opt-in: must be explicitly set to "true")
+ * - autoPageView defaults to true (opt-out: only the literal string "false" disables it via
+ *   `data-analytics-auto-page-view="false"`)
  *
  * @returns The analytics configuration object
  */

package/lib/react/components/DotContentAnalytics.js

@@ -1,16 +1,16 @@
-import { jsx as o } from "react/jsx-runtime";
-import { Suspense as e, useMemo as i } from "react";
+import { jsx as e } from "react/jsx-runtime";
+import { Suspense as r, useMemo as a } from "react";
 import { useRouterTracker as l } from "../hook/useRouterTracker.js";
-import { initializeAnalytics as u } from "../internal/utils.js";
-function a({
+import { initializeAnalytics as i } from "../internal/utils.js";
+function u({
   config: t
 }) {
-  const n = i(() => u(t), [t]), r = !!t.debug;
-  return n && l(n, r), null;
+  const n = a(() => i(t), [t]), o = !!t.debug;
+  return l(n, o, t.autoPageView !== !1), null;
 }
-function p({ config: t }) {
-  return /* @__PURE__ */ o(e, { fallback: null, children: /* @__PURE__ */ o(a, { config: t }) });
+function f({ config: t }) {
+  return /* @__PURE__ */ e(r, { fallback: null, children: /* @__PURE__ */ e(u, { config: t }) });
 }
 export {
-  p as DotContentAnalytics
+  f as DotContentAnalytics
 };

package/lib/react/hook/useRouterTracker.d.ts

@@ -7,5 +7,6 @@ import { DotCMSAnalytics } from '../../core/shared/models';
  *
  * @param analytics Analytics singleton instance; if null, does nothing
  * @param debug When true, logs which tracking path is used
+ * @param enabled When false, tracking is disabled even if analytics is present (defaults to true)
  */
-export declare function useRouterTracker(analytics: DotCMSAnalytics | null, debug?: boolean): void;
+export declare function useRouterTracker(analytics: DotCMSAnalytics | null, debug?: boolean, enabled?: boolean): void;

package/lib/react/hook/useRouterTracker.js

@@ -1,16 +1,16 @@
-import { usePathname as f, useSearchParams as u } from "next/navigation";
-import { useRef as i, useEffect as a } from "react";
-const m = (e, t) => `${e}${t?.toString() ? "?" + t.toString() : ""}`;
-function R(e, t = !1) {
-  const r = i(null), n = f(), o = u();
-  a(() => {
-    if (!e) return;
-    const c = (s) => {
-      s !== r.current && (r.current = s, e.pageView());
+import { usePathname as c, useSearchParams as i } from "next/navigation";
+import { useRef as a, useEffect as m } from "react";
+const p = (t, e) => `${t}${e?.toString() ? "?" + e.toString() : ""}`;
+function h(t, e = !1, r = !0) {
+  const n = a(null), o = c(), u = i();
+  m(() => {
+    if (!r || !t) return;
+    const s = (f) => {
+      f !== n.current && (n.current = f, t.pageView());
     };
-    t && console.info("DotCMS Analytics [React]: using Next.js App Router tracking"), c(m(n, o));
-  }, [e, n, o, t]);
+    e && console.info("DotCMS Analytics [React]: using Next.js App Router tracking"), s(p(o, u));
+  }, [t, o, u, e, r]);
 }
 export {
-  R as useRouterTracker
+  h as useRouterTracker
 };

package/package.json

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

package/uve/src/internal/events.js

@@ -1,192 +1,196 @@
-import { UVEEventType as d } from "../../../types/src/lib/editor/public.js";
+import { UVEEventType as u } from "../../../types/src/lib/editor/public.js";
 import { __DOTCMS_UVE_EVENT__ as f } from "../../../types/src/lib/events/internal.js";
-import { DOT_SECTION_ID_PREFIX as g } from "./constants.js";
-import { TEMP_EMPTY_CONTENTLET as C, TEMP_EMPTY_CONTENTLET_TYPE as w } from "./contentlet-sentinel.constants.js";
-import { findDotCMSElement as _, readContentletDataset as b, findDotCMSVTLData as L, getClosestDotCMSContainerData as O, getDotCMSPageBounds as N } from "../lib/dom/dom.utils.js";
-function M(s) {
-  const e = (t) => {
-    t.data.name === f.UVE_SET_PAGE_DATA && s(t.data.payload);
-  };
-  return window.addEventListener("message", e), {
+import { DOT_SECTION_ID_PREFIX as S } from "./constants.js";
+import { TEMP_EMPTY_CONTENTLET as _, TEMP_EMPTY_CONTENTLET_TYPE as p } from "./contentlet-sentinel.constants.js";
+import { getNativeEventBinder as T, findDotCMSElement as L, readContentletDataset as O, findDotCMSVTLData as g, getClosestDotCMSContainerData as N, getDotCMSPageBounds as D } from "../lib/dom/dom.utils.js";
+function R(a) {
+  const e = (o) => {
+    o.data.name === f.UVE_SET_PAGE_DATA && a(o.data.payload);
+  }, t = T(window);
+  return t.addEventListener("message", e), {
     unsubscribe: () => {
-      window.removeEventListener("message", e);
+      t.removeEventListener("message", e);
     },
-    event: d.CONTENT_CHANGES
+    event: u.CONTENT_CHANGES
   };
 }
-function P(s) {
-  const e = (t) => {
-    t.data.name === f.UVE_RELOAD_PAGE && s();
-  };
-  return window.addEventListener("message", e), {
+function U(a) {
+  const e = (o) => {
+    o.data.name === f.UVE_RELOAD_PAGE && a();
+  }, t = T(window);
+  return t.addEventListener("message", e), {
     unsubscribe: () => {
-      window.removeEventListener("message", e);
+      t.removeEventListener("message", e);
     },
-    event: d.PAGE_RELOAD
+    event: u.PAGE_RELOAD
   };
 }
-const S = 100;
-function R(s) {
+const w = 100;
+function h(a) {
   let e = null, t = [];
-  const a = () => {
+  const o = () => {
     const r = Array.from(
       document.querySelectorAll('[data-dot-object="container"]')
     );
-    s(N(r));
+    a(D(r));
   }, n = () => {
     e !== null && clearTimeout(e), e = setTimeout(() => {
-      e = null, a();
-    }, S);
-  }, o = new ResizeObserver(() => {
+      e = null, o();
+    }, w);
+  }, s = new ResizeObserver(() => {
     n();
-  }), v = () => {
+  }), i = () => {
     for (const r of t)
-      o.unobserve(r);
+      s.unobserve(r);
     t = Array.from(
       document.querySelectorAll('[data-dot-object="container"]')
-    ), o.observe(document.documentElement);
+    ), s.observe(document.documentElement);
     for (const r of t)
-      o.observe(r);
+      s.observe(r);
   };
-  v();
-  const c = (r) => {
-    for (let i = 0; i < r.length; i++) {
-      const m = r[i];
-      if (m.nodeType !== Node.ELEMENT_NODE)
+  i();
+  const C = (r) => {
+    for (let c = 0; c < r.length; c++) {
+      const v = r[c];
+      if (v.nodeType !== Node.ELEMENT_NODE)
         continue;
-      const T = m;
-      if (T.matches?.('[data-dot-object="container"]') || T.querySelector?.('[data-dot-object="container"]'))
+      const b = v;
+      if (b.matches?.('[data-dot-object="container"]') || b.querySelector?.('[data-dot-object="container"]'))
         return !0;
     }
     return !1;
-  }, l = new MutationObserver((r) => {
-    for (const i of r)
-      if (i.type === "childList" && (c(i.addedNodes) || c(i.removedNodes))) {
-        v(), n();
+  }, d = new MutationObserver((r) => {
+    for (const c of r)
+      if (c.type === "childList" && (C(c.addedNodes) || C(c.removedNodes))) {
+        i(), n();
         return;
       }
   });
-  l.observe(document.body ?? document.documentElement, {
+  d.observe(document.body ?? document.documentElement, {
     childList: !0,
     subtree: !0
   });
-  const u = () => n();
-  window.addEventListener("scroll", u, { passive: !0 });
-  const E = (r) => {
-    r?.data?.name === f.UVE_FLUSH_BOUNDS && (e !== null && (clearTimeout(e), e = null), a());
+  const l = T(window), E = () => n();
+  l.addEventListener("scroll", E, { passive: !0 });
+  const m = (r) => {
+    r?.data?.name === f.UVE_FLUSH_BOUNDS && (e !== null && (clearTimeout(e), e = null), o());
   };
-  return window.addEventListener("message", E), {
+  return l.addEventListener("message", m), {
     unsubscribe: () => {
-      e !== null && (clearTimeout(e), e = null), o.disconnect(), l.disconnect(), window.removeEventListener("scroll", u), window.removeEventListener("message", E), t = [];
+      e !== null && (clearTimeout(e), e = null), s.disconnect(), d.disconnect(), l.removeEventListener("scroll", E), l.removeEventListener("message", m), t = [];
     },
-    event: d.AUTO_BOUNDS
+    event: u.AUTO_BOUNDS
   };
 }
-function U(s) {
-  const e = (t) => {
-    if (t.data.name === f.UVE_SCROLL_INSIDE_IFRAME) {
-      const a = t.data.direction;
-      s(a);
+function V(a) {
+  const e = (o) => {
+    if (o.data.name === f.UVE_SCROLL_INSIDE_IFRAME) {
+      const n = o.data.direction;
+      a(n);
     }
-  };
-  return window.addEventListener("message", e), {
+  }, t = T(window);
+  return t.addEventListener("message", e), {
     unsubscribe: () => {
-      window.removeEventListener("message", e);
+      t.removeEventListener("message", e);
     },
-    event: d.IFRAME_SCROLL
+    event: u.IFRAME_SCROLL
   };
 }
-function h(s) {
-  const e = (t) => {
-    if (t.data.name !== f.UVE_SCROLL_TO_SECTION)
+function k(a) {
+  const e = (o) => {
+    if (o.data.name !== f.UVE_SCROLL_TO_SECTION)
       return;
-    const a = t.data.sectionIndex, n = document.querySelector(`#${g}${a}`) ?? document.querySelector(`#section-${a}`);
-    n && s({ sectionIndex: a, offsetTop: n.offsetTop });
-  };
-  return window.addEventListener("message", e), {
+    const n = o.data.sectionIndex, s = document.querySelector(`#${S}${n}`) ?? document.querySelector(`#section-${n}`);
+    s && a({ sectionIndex: n, offsetTop: s.offsetTop });
+  }, t = T(window);
+  return t.addEventListener("message", e), {
     unsubscribe: () => {
-      window.removeEventListener("message", e);
+      t.removeEventListener("message", e);
     },
-    event: d.SCROLL_TO_SECTION
+    event: u.SCROLL_TO_SECTION
   };
 }
-function V(s) {
+function B(a) {
   let e = !1;
-  const t = (a) => {
-    const n = _(a.target);
+  const t = (o) => {
+    const n = L(o.target);
     if (!n) {
-      e && (e = !1, s(null));
+      e && (e = !1, a(null));
       return;
     }
-    const { x: o, y: v, width: c, height: l } = n.getBoundingClientRect(), u = n.dataset?.dotObject === "container", E = {
-      identifier: C,
-      title: C,
-      contentType: w,
+    const { x: s, y: i, width: C, height: d } = n.getBoundingClientRect(), l = n.dataset?.dotObject === "container", E = {
+      identifier: _,
+      title: _,
+      contentType: p,
       inode: "TEMPY_EMPTY_CONTENTLET_INODE",
-      widgetTitle: C,
-      baseType: C,
+      widgetTitle: _,
+      baseType: _,
       onNumberOfPages: 1
-    }, r = b(n), i = L(n), m = {
+    }, m = O(n), r = g(n), c = {
       container: (
         // Here extract dot-container from contentlet if it is Headless
         // or search in parent container if it is VTL
-        n.dataset?.dotContainer ? JSON.parse(n.dataset?.dotContainer) : O(n)
+        n.dataset?.dotContainer ? JSON.parse(n.dataset?.dotContainer) : N(n)
       ),
-      contentlet: u ? E : r,
-      vtlFiles: i
-    }, T = {
-      x: o,
-      y: v,
-      width: c,
-      height: l,
-      payload: m
+      contentlet: l ? E : m,
+      vtlFiles: r
+    }, v = {
+      x: s,
+      y: i,
+      width: C,
+      height: d,
+      payload: c
     };
-    e = !0, s(T);
+    e = !0, a(v);
   };
-  return document.addEventListener("pointermove", t), {
+  return document.documentElement.addEventListener("pointermove", t), {
     unsubscribe: () => {
-      document.removeEventListener("pointermove", t);
+      document.documentElement.removeEventListener("pointermove", t);
     },
-    event: d.CONTENTLET_HOVERED
+    event: u.CONTENTLET_HOVERED
   };
 }
-function k(s) {
+function F(a) {
   let e;
-  const t = (n) => {
-    const o = _(n.target);
-    if (!o || o.dataset?.dotObject === "container") return;
-    const c = o.dataset?.dotInode;
-    if (c && c === e)
+  const t = (s) => {
+    const i = L(s.target);
+    if (!i || i.dataset?.dotObject === "container") return;
+    const d = i.dataset?.dotInode;
+    if (d && d === e)
       return;
-    n.preventDefault(), n.stopPropagation(), e = c;
-    const { x: l, y: u, width: E, height: r } = o.getBoundingClientRect(), i = b(o), m = L(o);
-    s({
+    s.preventDefault(), s.stopPropagation(), e = d;
+    const { x: l, y: E, width: m, height: r } = i.getBoundingClientRect(), c = O(i), v = g(i);
+    a({
       x: l,
-      y: u,
-      width: E,
+      y: E,
+      width: m,
       height: r,
       payload: {
-        container: o.dataset?.dotContainer ? JSON.parse(o.dataset?.dotContainer) : O(o),
-        contentlet: i,
-        vtlFiles: m
+        container: i.dataset?.dotContainer ? JSON.parse(i.dataset?.dotContainer) : N(i),
+        contentlet: c,
+        vtlFiles: v
       }
     });
-  }, a = (n) => {
-    n?.data?.name === f.UVE_SELECTION_CLEARED && (e = void 0);
+  }, o = (s) => {
+    s?.data?.name === f.UVE_SELECTION_CLEARED && (e = void 0);
   };
-  return document.addEventListener("click", t, { capture: !0 }), window.addEventListener("message", a), {
+  document.documentElement.addEventListener("click", t, { capture: !0 });
+  const n = T(window);
+  return n.addEventListener("message", o), {
     unsubscribe: () => {
-      document.removeEventListener("click", t, { capture: !0 }), window.removeEventListener("message", a);
+      document.documentElement.removeEventListener("click", t, {
+        capture: !0
+      }), n.removeEventListener("message", o);
     },
-    event: d.CONTENTLET_CLICKED
+    event: u.CONTENTLET_CLICKED
   };
 }
 export {
-  R as onAutoBounds,
-  M as onContentChanges,
-  k as onContentletClicked,
-  V as onContentletHovered,
-  U as onIframeScroll,
-  P as onPageReload,
-  h as onScrollToSection
+  h as onAutoBounds,
+  R as onContentChanges,
+  F as onContentletClicked,
+  B as onContentletHovered,
+  V as onIframeScroll,
+  U as onPageReload,
+  k as onScrollToSection
 };

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

@@ -1,5 +1,5 @@
 import "../../internal/constants.js";
-function c(t) {
+function f(t) {
   return t.map((e) => {
     const n = e.getBoundingClientRect(), o = Array.from(
       e.querySelectorAll('[data-dot-object="contentlet"]')
@@ -10,13 +10,13 @@ function c(t) {
       width: n.width,
       height: n.height,
       payload: JSON.stringify({
-        container: a(e)
+        container: r(e)
       }),
-      contentlets: d(n, o)
+      contentlets: c(n, o)
     };
   });
 }
-function d(t, e) {
+function c(t, e) {
   return e.map((n) => {
     const o = n.getBoundingClientRect();
     return {
@@ -25,7 +25,7 @@ function d(t, e) {
       width: o.width,
       height: o.height,
       payload: JSON.stringify({
-        container: n.dataset?.dotContainer ? JSON.parse(n.dataset?.dotContainer) : r(n),
+        container: n.dataset?.dotContainer ? JSON.parse(n.dataset?.dotContainer) : l(n),
         contentlet: {
           identifier: n.dataset?.dotIdentifier,
           title: n.dataset?.dotTitle,
@@ -36,7 +36,7 @@ function d(t, e) {
     };
   });
 }
-function a(t) {
+function r(t) {
   return {
     acceptTypes: t.dataset?.dotAcceptTypes || "",
     identifier: t.dataset?.dotIdentifier || "",
@@ -44,18 +44,18 @@ function a(t) {
     uuid: t.dataset?.dotUuid || ""
   };
 }
-function r(t) {
+function l(t) {
   const e = t.closest('[data-dot-object="container"]');
-  return e ? a(e) : (console.warn("No container found for the contentlet"), null);
+  return e ? r(e) : (console.warn("No container found for the contentlet"), null);
 }
-function i(t) {
+function u(t) {
   if (!t) return null;
   const e = 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" && e || // The container inside Traditional have no content inside
-  t?.dataset?.dotObject === "container" && t.children.length === 0 ? t : i(t?.parentElement);
+  t?.dataset?.dotObject === "container" && t.children.length === 0 ? t : u(t?.parentElement);
 }
-function u(t) {
+function p(t) {
   const e = t.querySelectorAll(
     '[data-dot-object="vtl-file"]'
   );
@@ -64,7 +64,7 @@ function u(t) {
     name: n.dataset?.dotUrl
   })) : null;
 }
-function l(t) {
+function g(t) {
   const e = t.dataset ?? {};
   return {
     identifier: e.dotIdentifier,
@@ -79,12 +79,20 @@ function l(t) {
     }
   };
 }
+function b(t) {
+  const e = globalThis.Zone, n = (a) => typeof e?.__symbol__ == "function" ? e.__symbol__(a) : `__zone_symbol__${a}`, o = t, d = t, i = o[n("addEventListener")], s = o[n("removeEventListener")];
+  return {
+    addEventListener: (i ?? d.addEventListener).bind(d),
+    removeEventListener: (s ?? d.removeEventListener).bind(d)
+  };
+}
 export {
-  i as findDotCMSElement,
-  u as findDotCMSVTLData,
-  r as getClosestDotCMSContainerData,
-  a as getDotCMSContainerData,
-  d as getDotCMSContentletsBound,
-  c as getDotCMSPageBounds,
-  l as readContentletDataset
+  u as findDotCMSElement,
+  p as findDotCMSVTLData,
+  l as getClosestDotCMSContainerData,
+  r as getDotCMSContainerData,
+  c as getDotCMSContentletsBound,
+  f as getDotCMSPageBounds,
+  b as getNativeEventBinder,
+  g as readContentletDataset
 };