@dotcms/analytics 1.0.2-next.3 → 1.0.2-next.5

package/README.md

@@ -11,9 +11,9 @@ Lightweight JavaScript SDK for tracking content-aware events in dotCMS. Works in
 ```html
 <script
     src="ca.min.js"
-    data-analytics-server="https://demo.dotcms.com"
-    data-analytics-key="SITE_KEY"
-    data-analytics-auto-page-view></script>
+    data-server="https://demo.dotcms.com"
+    data-site-key="SITE_KEY"
+    data-auto-page-view></script>
 ```
 
 **npm (ES Module)**

package/lib/react/hook/useContentAnalytics.js

@@ -1,32 +1,31 @@
-import { useContext as c, useRef as u, useCallback as a } from "react";
-import { getUVEState as i } from "../../../uve/src/lib/core/core.utils.js";
-import "../../../uve/src/internal/constants.js";
+import { useContext as c, useRef as u, useCallback as i } from "react";
 import l from "../contexts/DotContentAnalyticsContext.js";
-const S = () => {
-  const t = c(l), n = u(null);
+import { isInsideUVE as o } from "../internal/uve.utils.js";
+const w = () => {
+  const t = c(l), e = u(null);
   if (!t)
     throw new Error(
       "useContentAnalytics must be used within a DotContentAnalyticsProvider and analytics must be successfully initialized"
     );
-  const s = a(
-    (o, e = {}) => {
-      i() || t.track(o, {
-        ...e,
+  const s = i(
+    (n, r = {}) => {
+      o() || t.track(n, {
+        ...r,
         timestamp: (/* @__PURE__ */ new Date()).toISOString()
       });
     },
     [t]
-  ), r = a(() => {
-    if (!i()) {
-      const e = window.location.pathname;
-      e !== n.current && (n.current = e, t.pageView());
+  ), a = i(() => {
+    if (!o()) {
+      const n = window.location.pathname;
+      n !== e.current && (e.current = n, t.pageView());
     }
   }, [t]);
   return {
     track: s,
-    pageView: r
+    pageView: a
   };
 };
 export {
-  S as useContentAnalytics
+  w as useContentAnalytics
 };

package/lib/react/hook/useRouterTracker.js

@@ -1,12 +1,11 @@
-import { useRef as u, useEffect as i } from "react";
-import { getUVEState as a } from "../../../uve/src/lib/core/core.utils.js";
-import "../../../uve/src/internal/constants.js";
-function p(t) {
-  const n = u(null);
-  i(() => {
+import { useRef as i, useEffect as u } from "react";
+import { isInsideUVE as d } from "../internal/uve.utils.js";
+function a(t) {
+  const n = i(null);
+  u(() => {
     if (!t) return;
     function e() {
-      const o = window.location.pathname, r = a();
+      const o = window.location.pathname, r = d();
       o !== n.current && !r && t && (n.current = o, t.pageView());
     }
     return e(), window.addEventListener("popstate", e), window.addEventListener("beforeunload", e), () => {
@@ -15,5 +14,5 @@ function p(t) {
   }, [t]);
 }
 export {
-  p as useRouterTracker
+  a as useRouterTracker
 };

package/lib/react/internal/index.d.ts

@@ -0,0 +1 @@
+export * from './uve.utils';

package/lib/react/internal/uve.utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the code is running inside the DotCMS Universal Visual Editor (UVE).
+ *
+ * @returns {boolean} Returns true if running inside the editor, false otherwise.
+ *
+ * @example
+ * ```ts
+ * if (isInsideUVE()) {
+ *   // Running inside UVE editor
+ *   console.log('Inside editor');
+ * } else {
+ *   // Running in normal mode
+ *   console.log('Outside editor');
+ * }
+ * ```
+ */
+export declare function isInsideUVE(): boolean;

package/lib/react/internal/uve.utils.js

@@ -0,0 +1,6 @@
+function n() {
+  return !(typeof window > "u" || window.parent === window || !window.location);
+}
+export {
+  n as isInsideUVE
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/analytics",
-  "version": "1.0.2-next.3",
+  "version": "1.0.2-next.5",
   "description": "Official JavaScript library for Content Analytics with DotCMS.",
   "repository": {
     "type": "git",
@@ -20,23 +20,39 @@
   },
   "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/analytics/README.md",
   "dependencies": {
-    "analytics": "^0.8.14"
+    "analytics": "^0.8.0",
+    "@analytics/core": "^0.13.0",
+    "@analytics/storage-utils": "^0.4.0"
   },
   "peerDependencies": {
-    "react": "^18",
-    "@dotcms/uve": "^1.0.2"
+    "react": "^18 || ^19"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^6.1.6",
     "@testing-library/react": "^14.0.0",
     "vite": "~5.0.0"
   },
-  "main": "./index.cjs.js",
-  "module": "./index.esm.js",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "typesVersions": {
+    "*": {
+      "react": [
+        "lib/react/index.d.ts"
+      ],
+      "*": [
+        "index.d.ts"
+      ]
+    }
+  },
   "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    },
     "./react": {
       "import": "./react/index.js",
-      "types": "./src/lib/react/index.d.ts"
+      "types": "./lib/react/index.d.ts"
     }
   }
 }

package/types/src/lib/editor/public.js

@@ -1,5 +0,0 @@
-var N = /* @__PURE__ */ ((r) => (r.EDIT = "EDIT_MODE", r.PREVIEW = "PREVIEW_MODE", r.LIVE = "LIVE", r.UNKNOWN = "UNKNOWN", r))(N || {}), E = /* @__PURE__ */ ((r) => (r.CONTENT_CHANGES = "changes", r.PAGE_RELOAD = "page-reload", r.REQUEST_BOUNDS = "request-bounds", r.IFRAME_SCROLL = "iframe-scroll", r.CONTENTLET_HOVERED = "contentlet-hovered", r))(E || {});
-export {
-  E as UVEEventType,
-  N as UVE_MODE
-};

package/types/src/lib/events/internal.js

@@ -1,4 +0,0 @@
-var t = /* @__PURE__ */ ((e) => (e.UVE_RELOAD_PAGE = "uve-reload-page", e.UVE_REQUEST_BOUNDS = "uve-request-bounds", e.UVE_EDITOR_PONG = "uve-editor-pong", e.UVE_SCROLL_INSIDE_IFRAME = "uve-scroll-inside-iframe", e.UVE_SET_PAGE_DATA = "uve-set-page-data", e.UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS = "uve-copy-contentlet-inline-editing-success", e))(t || {});
-export {
-  t as __DOTCMS_UVE_EVENT__
-};

package/uve/src/internal/constants.js

@@ -1,3 +0,0 @@
-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 + "";

package/uve/src/internal/events.js

@@ -1,107 +0,0 @@
-import { UVEEventType as a } from "../../../types/src/lib/editor/public.js";
-import { __DOTCMS_UVE_EVENT__ as s } from "../../../types/src/lib/events/internal.js";
-import { findDotCMSElement as M, findDotCMSVTLData as p, getClosestDotCMSContainerData as w, getDotCMSPageBounds as S } from "../lib/dom/dom.utils.js";
-function U(o) {
-  const t = (n) => {
-    n.data.name === s.UVE_SET_PAGE_DATA && o(n.data.payload);
-  };
-  return window.addEventListener("message", t), {
-    unsubscribe: () => {
-      window.removeEventListener("message", t);
-    },
-    event: a.CONTENT_CHANGES
-  };
-}
-function V(o) {
-  const t = (n) => {
-    n.data.name === s.UVE_RELOAD_PAGE && o();
-  };
-  return window.addEventListener("message", t), {
-    unsubscribe: () => {
-      window.removeEventListener("message", t);
-    },
-    event: a.PAGE_RELOAD
-  };
-}
-function I(o) {
-  const t = (n) => {
-    if (n.data.name === s.UVE_REQUEST_BOUNDS) {
-      const e = Array.from(
-        document.querySelectorAll('[data-dot-object="container"]')
-      ), i = S(e);
-      o(i);
-    }
-  };
-  return window.addEventListener("message", t), {
-    unsubscribe: () => {
-      window.removeEventListener("message", t);
-    },
-    event: a.REQUEST_BOUNDS
-  };
-}
-function Y(o) {
-  const t = (n) => {
-    if (n.data.name === s.UVE_SCROLL_INSIDE_IFRAME) {
-      const e = n.data.direction;
-      o(e);
-    }
-  };
-  return window.addEventListener("message", t), {
-    unsubscribe: () => {
-      window.removeEventListener("message", t);
-    },
-    event: a.IFRAME_SCROLL
-  };
-}
-function B(o) {
-  const t = (n) => {
-    var d, r, E, c, T, l, m, _, u, C;
-    const e = M(n.target);
-    if (!e) return;
-    const { x: i, y: g, width: v, height: N } = e.getBoundingClientRect(), f = ((d = e.dataset) == null ? void 0 : d.dotObject) === "container", L = {
-      identifier: "TEMP_EMPTY_CONTENTLET",
-      title: "TEMP_EMPTY_CONTENTLET",
-      contentType: "TEMP_EMPTY_CONTENTLET_TYPE",
-      inode: "TEMPY_EMPTY_CONTENTLET_INODE",
-      widgetTitle: "TEMP_EMPTY_CONTENTLET",
-      baseType: "TEMP_EMPTY_CONTENTLET",
-      onNumberOfPages: 1
-    }, P = {
-      identifier: (r = e.dataset) == null ? void 0 : r.dotIdentifier,
-      title: (E = e.dataset) == null ? void 0 : E.dotTitle,
-      inode: (c = e.dataset) == null ? void 0 : c.dotInode,
-      contentType: (T = e.dataset) == null ? void 0 : T.dotType,
-      baseType: (l = e.dataset) == null ? void 0 : l.dotBasetype,
-      widgetTitle: (m = e.dataset) == null ? void 0 : m.dotWidgetTitle,
-      onNumberOfPages: (_ = e.dataset) == null ? void 0 : _.dotOnNumberOfPages
-    }, O = p(e), b = {
-      container: (
-        // Here extract dot-container from contentlet if it is Headless
-        // or search in parent container if it is VTL
-        (u = e.dataset) != null && u.dotContainer ? JSON.parse((C = e.dataset) == null ? void 0 : C.dotContainer) : w(e)
-      ),
-      contentlet: f ? L : P,
-      vtlFiles: O
-    };
-    o({
-      x: i,
-      y: g,
-      width: v,
-      height: N,
-      payload: b
-    });
-  };
-  return document.addEventListener("pointermove", t), {
-    unsubscribe: () => {
-      document.removeEventListener("pointermove", t);
-    },
-    event: a.CONTENTLET_HOVERED
-  };
-}
-export {
-  U as onContentChanges,
-  B as onContentletHovered,
-  Y as onIframeScroll,
-  V as onPageReload,
-  I as onRequestBounds
-};

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

@@ -1,21 +0,0 @@
-import { UVE_MODE as t } from "../../../../types/src/lib/editor/public.js";
-import "../../internal/constants.js";
-function p() {
-  if (typeof window > "u" || window.parent === window || !window.location)
-    return;
-  const e = new URL(window.location.href), o = Object.values(t);
-  let a = e.searchParams.get("mode") ?? t.EDIT;
-  const s = e.searchParams.get("language_id"), n = e.searchParams.get("personaId"), r = e.searchParams.get("variantName"), i = e.searchParams.get("experimentId"), c = e.searchParams.get("publishDate"), d = e.searchParams.get("dotCMSHost");
-  return o.includes(a) || (a = t.EDIT), {
-    mode: a,
-    languageId: s,
-    persona: n,
-    variantName: r,
-    experimentId: i,
-    publishDate: c,
-    dotCMSHost: d
-  };
-}
-export {
-  p as getUVEState
-};

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

@@ -1,80 +0,0 @@
-import "../../internal/constants.js";
-function C(t) {
-  return t.map((a) => {
-    const o = a.getBoundingClientRect(), n = Array.from(
-      a.querySelectorAll('[data-dot-object="contentlet"]')
-    );
-    return {
-      x: o.x,
-      y: o.y,
-      width: o.width,
-      height: o.height,
-      payload: JSON.stringify({
-        container: u(a)
-      }),
-      contentlets: f(o, n)
-    };
-  });
-}
-function f(t, a) {
-  return a.map((o) => {
-    var d, r, i, e, s, c;
-    const n = o.getBoundingClientRect();
-    return {
-      x: 0,
-      y: n.y - t.y,
-      width: n.width,
-      height: n.height,
-      payload: JSON.stringify({
-        container: (d = o.dataset) != null && d.dotContainer ? JSON.parse((r = o.dataset) == null ? void 0 : r.dotContainer) : y(o),
-        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
-        }
-      })
-    };
-  });
-}
-function u(t) {
-  var a, o, n, d;
-  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) || ""
-  };
-}
-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 g(t) {
-  var o, n, d;
-  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);
-}
-function h(t) {
-  const a = 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;
-}
-export {
-  g as findDotCMSElement,
-  h as findDotCMSVTLData,
-  y as getClosestDotCMSContainerData,
-  u as getDotCMSContainerData,
-  f as getDotCMSContentletsBound,
-  C as getDotCMSPageBounds
-};