@dotcms/analytics 0.0.1-beta.41 → 0.0.1-beta.43

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

@@ -1,46 +1,131 @@
-import i from "analytics";
-import { EXPECTED_UTM_KEYS as a } from "./dot-content-analytics.constants.js";
-import { dotAnalyticsEnricherPlugin as s } from "../plugin/dot-analytics.enricher.plugin.js";
-import { dotAnalytics as c } from "../plugin/dot-analytics.plugin.js";
-const h = (e) => ({
-  utc_time: (/* @__PURE__ */ new Date()).toISOString(),
-  local_tz_offset: (/* @__PURE__ */ new Date()).getTimezoneOffset(),
-  screen_resolution: `${window.screen.width}x${window.screen.height}`,
-  vp_size: `${window.innerWidth}x${window.innerHeight}`,
-  userAgent: navigator.userAgent,
-  user_language: navigator.language,
-  doc_encoding: document.characterSet,
-  doc_path: e.pathname,
-  doc_host: e.hostname,
-  doc_protocol: e.protocol,
-  doc_hash: e.hash,
-  doc_search: e.search,
-  referrer: document.referrer,
-  page_title: document.title,
-  utm: u(window.location)
-}), u = (e) => {
-  const o = new URLSearchParams(e.search);
-  return a.reduce(
-    (t, r) => {
-      const n = o.get(r);
-      return n !== null && (t[r.replace("utm_", "")] = n), t;
-    },
-    {}
-  );
-}, m = () => {
+import { SESSION_STORAGE_KEY as l, DEFAULT_SESSION_TIMEOUT_MINUTES as S, USER_ID_KEY as h } from "./dot-content-analytics.constants.js";
+let g = null;
+const u = (t) => {
+  const e = Date.now(), n = Math.random().toString(36).substr(2, 9), o = Math.random().toString(36).substr(2, 9);
+  return `${t}_${e}_${n}${o}`;
+}, m = {
+  getItem: (t) => {
+    try {
+      return localStorage.getItem(t);
+    } catch {
+      return null;
+    }
+  },
+  setItem: (t, e) => {
+    try {
+      localStorage.setItem(t, e);
+    } catch {
+      console.warn(`DotAnalytics: Could not save ${t} to localStorage`);
+    }
+  }
+}, f = () => {
+  let t = m.getItem(h);
+  return t || (t = u("user"), m.setItem(h, t)), t;
+}, w = (t) => {
+  const e = new Date(t), n = /* @__PURE__ */ new Date(), o = new Date(
+    e.getUTCFullYear(),
+    e.getUTCMonth(),
+    e.getUTCDate()
+  ), s = new Date(n.getUTCFullYear(), n.getUTCMonth(), n.getUTCDate());
+  return o.getTime() !== s.getTime();
+}, p = () => {
+  const t = Date.now();
+  if (typeof window > "u")
+    return u("session_fallback");
   try {
-    return typeof window > "u" || !window.parent ? !1 : window.parent !== window;
+    const e = sessionStorage.getItem(l);
+    if (e) {
+      const { sessionId: s, startTime: i, lastActivity: c } = JSON.parse(e), d = !w(i), r = t - c < S * 60 * 1e3;
+      if (d && r)
+        return sessionStorage.setItem(
+          l,
+          JSON.stringify({
+            sessionId: s,
+            startTime: i,
+            lastActivity: t
+          })
+        ), s;
+    }
+    const n = u("session"), o = {
+      sessionId: n,
+      startTime: t,
+      lastActivity: t
+    };
+    return sessionStorage.setItem(l, JSON.stringify(o)), n;
+  } catch {
+    return u("session_fallback");
+  }
+}, T = (t) => {
+  const e = p(), n = f();
+  return t.debug && console.warn("DotAnalytics Identity Context:", {
+    sessionId: e,
+    userId: n
+  }), {
+    site_key: t.siteKey,
+    session_id: e,
+    user_id: n
+  };
+}, I = () => g || (g = {
+  user_language: navigator.language || void 0,
+  doc_encoding: document.characterSet || document.charset || void 0,
+  screen_resolution: typeof screen < "u" && screen.width && screen.height ? `${screen.width}x${screen.height}` : void 0
+}, g), $ = () => {
+  if (typeof window > "u")
+    return !1;
+  try {
+    const t = window.self !== window.top, e = window.location.href.includes("mode=EDIT_MODE"), n = window.location.href.includes("/vtl/");
+    return t || e || n;
   } catch {
     return !1;
   }
-}, p = (e) => e.apiKey ? e.server ? i({
-  app: "dotAnalytics",
-  debug: e.debug,
-  plugins: [s, c(e)]
-}) : (console.error('DotContentAnalytics: Missing "server" in configuration'), null) : (console.error('DotContentAnalytics: Missing "apiKey" in configuration'), null);
+}, D = () => {
+  try {
+    const t = (/* @__PURE__ */ new Date()).getTimezoneOffset(), e = t > 0 ? "-" : "+", n = Math.abs(t), o = Math.floor(n / 60), s = n % 60;
+    return `${e}${o.toString().padStart(2, "0")}:${s.toString().padStart(2, "0")}`;
+  } catch {
+    return "+00:00";
+  }
+}, y = () => {
+  try {
+    const t = /* @__PURE__ */ new Date(), e = D(), n = t.getFullYear(), o = (t.getMonth() + 1).toString().padStart(2, "0"), s = t.getDate().toString().padStart(2, "0"), i = t.getHours().toString().padStart(2, "0"), c = t.getMinutes().toString().padStart(2, "0"), d = t.getSeconds().toString().padStart(2, "0"), r = t.getMilliseconds().toString().padStart(3, "0");
+    return `${n}-${o}-${s}T${i}:${c}:${d}.${r}${e}`;
+  } catch {
+    return (/* @__PURE__ */ new Date()).toISOString();
+  }
+}, v = (t, e = typeof window < "u" ? window.location : {}) => {
+  const n = y(), o = I(), { properties: s } = t, { utm: i } = s, c = {
+    url: s.url ?? e.href,
+    path: s.path ?? e.pathname,
+    hash: s.hash ?? e.hash ?? "",
+    search: s.search ?? e.search ?? "",
+    title: s.title ?? (document == null ? void 0 : document.title),
+    width: String(s.width),
+    height: String(s.height),
+    referrer: s.referrer ?? (document == null ? void 0 : document.referrer)
+  }, d = {
+    screen_resolution: o.screen_resolution,
+    language: o.user_language,
+    viewport_width: String(s.width),
+    viewport_height: String(s.height)
+  }, r = {};
+  if (i && typeof i == "object") {
+    const a = i;
+    a.medium && (r.medium = a.medium), a.source && (r.source = a.source), a.campaign && (r.campaign = a.campaign), a.term && (r.term = a.term), a.content && (r.content = a.content);
+  }
+  return {
+    ...t,
+    page: c,
+    device: d,
+    ...Object.keys(r).length > 0 && { utm: r },
+    local_time: n
+  };
+};
 export {
-  p as createAnalyticsInstance,
-  u as extractUTMParameters,
-  h as getBrowserEventData,
-  m as isInsideEditor
+  v as enrichPagePayloadOptimized,
+  u as generateSecureId,
+  T as getAnalyticsContext,
+  y as getLocalTime,
+  p as getSessionId,
+  f as getUserId,
+  $ as isInsideEditor
 };

package/lib/react/components/DotContentAnalyticsProvider.d.ts

@@ -1,15 +1,15 @@
-import { DotContentAnalyticsConfig } from '../../dotAnalytics/shared/dot-content-analytics.model';
+import { DotCMSAnalyticsConfig } from '../../dotAnalytics/shared/dot-content-analytics.model';
 import { ReactElement, ReactNode } from 'react';
 
 interface DotContentAnalyticsProviderProps {
     children?: ReactNode;
-    config: DotContentAnalyticsConfig;
+    config: DotCMSAnalyticsConfig;
 }
 /**
- * Provider component that initializes and manages DotContentAnalytics instance.
+ * Provider component that initializes and manages DotCMSAnalytics instance.
  * It makes the analytics functionality available to all child components through React Context.
  * This component is responsible for:
- * - Initializing the DotContentAnalytics singleton instance with the provided config
+ * - Initializing the DotCMSAnalytics singleton instance with the provided config
  * - Making the instance accessible via useContext hook to child components
  * - Managing the lifecycle of the analytics instance
  *

package/lib/react/components/DotContentAnalyticsProvider.js

@@ -7,8 +7,11 @@ const f = ({
   children: r,
   config: t
 }) => {
-  const o = i(() => n(t), [t]);
-  return t.autoPageView !== !1 && m(o), /* @__PURE__ */ e(a.Provider, { value: o, children: r });
+  const o = i(
+    () => n(t),
+    [t]
+  );
+  return t.autoPageView !== !1 && o && m(o), /* @__PURE__ */ e(a.Provider, { value: o, children: r });
 };
 export {
   f as DotContentAnalyticsProvider

package/lib/react/contexts/DotContentAnalyticsContext.d.ts

@@ -1,13 +1,13 @@
-import { DotAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
+import { DotCMSAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
 
 /**
  * `DotContentAnalyticsContext` is a React context that is designed to provide an instance of
- * `DotContentAnalytics` to all of the components within its tree that are Consumers of this context.
+ * `DotCMSAnalytics` to all of the components within its tree that are Consumers of this context.
  *
  * The context is created with a default value of `null`. It is meant to be provided a real value
  * using the `DotContentAnalyticsProvider` component.
  *
  * @see {@link https://reactjs.org/docs/context.html|React Context}
  */
-declare const DotContentAnalyticsContext: import('react').Context<DotAnalytics | null>;
+declare const DotContentAnalyticsContext: import('react').Context<DotCMSAnalytics | null>;
 export default DotContentAnalyticsContext;

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

@@ -1,15 +1,14 @@
-import { DotAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
+import { DotCMSAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
 
 /**
- * Custom hook that handles analytics page view tracking.
+ * Custom hook that handles analytics tracking for anonymous users.
  *
  * @example
  * ```tsx
  * function Button({ title, urlTitle }) {
  *   const { track } = useContentAnalytics();
  *
- *   // First parameter: custom event name to identify the action
- *   // Second parameter: object with properties you want to track
+ *   // Track button click with custom properties
  *   return (
  *     <button onClick={() => track('btn-click', { title, urlTitle })}>
  *       See Details →
@@ -17,6 +16,37 @@ import { DotAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.mo
  *   );
  * }
  * ```
- * @returns {DotContentAnalyticsCustomHook} - The analytics instance used to track page views
+ *
+ * @example
+ * ```tsx
+ * // Session debugging example
+ * function AnalyticsDebugComponent() {
+ *   const { getAnonymousUserId, getSessionInfo, updateSessionActivity } = useContentAnalytics();
+ *
+ *   const handleManualActivity = () => {
+ *     updateSessionActivity();
+ *     // Manual activity updated
+ *   };
+ *
+ *   // Debug session info in development
+ *   const debugInfo = () => {
+ *     if (process.env.NODE_ENV === 'development') {
+ *       console.log('Anonymous ID:', getAnonymousUserId());
+ *       console.log('Session info:', getSessionInfo());
+ *     }
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleManualActivity}>Update Activity</button>
+ *       <button onClick={debugInfo}>Debug Session</button>
+ *       <p>User ID: {getAnonymousUserId()}</p>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @returns {DotCMSAnalytics} - The analytics instance with tracking capabilities for anonymous users
+ * @throws {Error} - Throws error if used outside of DotContentAnalyticsProvider or if analytics failed to initialize
  */
-export declare const useContentAnalytics: () => DotAnalytics;
+export declare const useContentAnalytics: () => DotCMSAnalytics;

package/lib/react/hook/useContentAnalytics.js

@@ -1,34 +1,34 @@
-import { useContext as i, useRef as s } from "react";
-import { isInsideEditor as r } from "../../dotAnalytics/shared/dot-content-analytics.utils.js";
-import a from "../contexts/DotContentAnalyticsContext.js";
-const f = () => {
-  const t = i(a), o = s(null);
+import { useContext as c, useRef as u, useCallback as o } from "react";
+import { isInsideEditor as s } from "../../dotAnalytics/shared/dot-content-analytics.utils.js";
+import l from "../contexts/DotContentAnalyticsContext.js";
+const w = () => {
+  const t = c(l), i = u(null);
   if (!t)
-    throw new Error("useContentAnalytics must be used within a DotContentAnalyticsProvider");
-  return {
-    /**
-     * Track a custom event.
-     * @param {string} eventName - The name of the event to track.
-     * @param {Record<string, unknown>} payload - The payload to track.
-     */
-    track: (n, e = {}) => {
-      r() || t == null || t.track(n, {
-        ...e,
+    throw new Error(
+      "useContentAnalytics must be used within a DotContentAnalyticsProvider and analytics must be successfully initialized"
+    );
+  const r = o(
+    (e, n = {}) => {
+      s() || t.track(e, {
+        ...n,
         timestamp: (/* @__PURE__ */ new Date()).toISOString()
       });
     },
-    /**
-     * Track a page view.
-     * @param {Record<string, unknown>} payload - The payload to track.
-     */
-    pageView: (n = {}) => {
-      if (!r()) {
-        const e = window.location.pathname;
-        e !== o.current && (o.current = e, t.pageView(n));
+    [t]
+  ), a = o(
+    (e = {}) => {
+      if (!s()) {
+        const n = window.location.pathname;
+        n !== i.current && (i.current = n, t.pageView(e));
       }
-    }
+    },
+    [t]
+  );
+  return {
+    track: r,
+    pageView: a
   };
 };
 export {
-  f as useContentAnalytics
+  w as useContentAnalytics
 };

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

@@ -1,10 +1,10 @@
-import { DotAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
+import { DotCMSAnalytics } from '../../dotAnalytics/shared/dot-content-analytics.model';
 
 /**
  * Internal custom hook that handles analytics page view tracking.
  *
- * @param {DotContentAnalytics | null} instance - The analytics instance used to track page views
+ * @param {DotCMSAnalytics | null} instance - The analytics instance used to track page views
  * @returns {void}
  *
  */
-export declare function useRouterTracker(analytics: DotAnalytics | null): void;
+export declare function useRouterTracker(analytics: DotCMSAnalytics | null): void;

package/lib/standalone.d.ts

@@ -1,8 +1,8 @@
-import { DotAnalytics } from './dotAnalytics/shared/dot-content-analytics.model';
+import { DotCMSAnalytics } from './dotAnalytics/shared/dot-content-analytics.model';
 import { ANALYTICS_WINDOWS_KEY } from './dotAnalytics/shared/dot-content-analytics.constants';
 
 declare global {
     interface Window {
-        [ANALYTICS_WINDOWS_KEY]: DotAnalytics;
+        [ANALYTICS_WINDOWS_KEY]: DotCMSAnalytics | null;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/analytics",
-  "version": "0.0.1-beta.41",
+  "version": "0.0.1-beta.43",
   "description": "Official JavaScript library for Content Analytics with DotCMS.",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
     "analytics": "^0.8.14"
   },
   "peerDependencies": {
-    "react": "^18.2.0"
+    "react": "19.1.0"
   },
   "devDependencies": {
-    "vite": "~5.0.0",
     "@testing-library/jest-dom": "^6.1.6",
-    "@testing-library/react": "^14.0.0"
+    "@testing-library/react": "^14.0.0",
+    "vite": "~5.0.0"
   },
   "main": "./index.cjs.js",
   "module": "./index.esm.js",

package/lib/dotAnalytics/plugin/dot-analytics.enricher.plugin.d.ts

@@ -1,31 +0,0 @@
-import { DotAnalyticsPayload, PageViewEvent, TrackEvent } from '../shared/dot-content-analytics.model';
-
-/**
- * Plugin that enriches the analytics payload data based on the event type.
- * For page view events, it adds browser data like viewport size, user agent, etc.
- * For track events, it adds custom event properties and standardizes the event format.
- * All events are enriched with source type and anonymous ID if available.
- */
-export declare const dotAnalyticsEnricherPlugin: {
-    name: string;
-    'page:dot-analytics': ({ payload }: {
-        payload: DotAnalyticsPayload;
-    }) => {
-        properties: PageViewEvent;
-        type: string;
-        event: string;
-        options: Record<string, unknown>;
-        userId: string | null;
-        anonymousId: string | null;
-    };
-    'track:dot-analytics': ({ payload }: {
-        payload: DotAnalyticsPayload;
-    }) => {
-        properties: TrackEvent;
-        type: string;
-        event: string;
-        options: Record<string, unknown>;
-        userId: string | null;
-        anonymousId: string | null;
-    };
-};

package/lib/dotAnalytics/plugin/dot-analytics.enricher.plugin.js

@@ -1,28 +0,0 @@
-import { EventType as n, ANALYTICS_SOURCE_TYPE as r, ANALYTICS_PAGEVIEW_EVENT as o } from "../shared/dot-content-analytics.constants.js";
-import { getBrowserEventData as i } from "../shared/dot-content-analytics.utils.js";
-const p = {
-  name: "enrich-dot-analytics",
-  "page:dot-analytics": ({ payload: e }) => {
-    const t = {
-      ...i(window.location),
-      ...e.properties,
-      event_type: o,
-      anonymousId: e.anonymousId || void 0,
-      src: r
-    };
-    return { ...e, properties: t };
-  },
-  "track:dot-analytics": ({ payload: e }) => {
-    const t = {
-      ...e.properties,
-      custom_event: e.event,
-      event_type: n.Track,
-      anonymousId: e.anonymousId || void 0,
-      src: r
-    };
-    return { ...e, properties: t };
-  }
-};
-export {
-  p as dotAnalyticsEnricherPlugin
-};