@dotcms/uve 1.5.5-next.2245 → 1.5.5-next.2253

package/internal.cjs.js

@@ -370,6 +370,8 @@ const styleEditorField = {
   })
 };
 
+exports.ANALYTICS_ACTIVE_WINDOW_KEY = _public.ANALYTICS_ACTIVE_WINDOW_KEY;
+exports.ANALYTICS_READY_EVENT = _public.ANALYTICS_READY_EVENT;
 exports.CUSTOM_NO_COMPONENT = _public.CUSTOM_NO_COMPONENT;
 exports.DEVELOPMENT_MODE = _public.DEVELOPMENT_MODE;
 exports.DOT_SECTION_ID_PREFIX = _public.DOT_SECTION_ID_PREFIX;
@@ -387,6 +389,7 @@ exports.computeScrollIsInBottom = _public.computeScrollIsInBottom;
 exports.createUVESubscription = _public.createUVESubscription;
 exports.findDotCMSElement = _public.findDotCMSElement;
 exports.findDotCMSVTLData = _public.findDotCMSVTLData;
+exports.getAnalyticsContentletAttributes = _public.getAnalyticsContentletAttributes;
 exports.getClosestDotCMSContainerData = _public.getClosestDotCMSContainerData;
 exports.getColumnPositionClasses = _public.getColumnPositionClasses;
 exports.getContainersData = _public.getContainersData;
@@ -397,6 +400,7 @@ exports.getDotCMSPageBounds = _public.getDotCMSPageBounds;
 exports.getDotContainerAttributes = _public.getDotContainerAttributes;
 exports.getDotContentletAttributes = _public.getDotContentletAttributes;
 exports.getUVEState = _public.getUVEState;
+exports.isDotAnalyticsActive = _public.isDotAnalyticsActive;
 exports.isValidBlocks = _public.isValidBlocks;
 exports.readContentletDataset = _public.readContentletDataset;
 exports.setBounds = _public.setBounds;

package/internal.esm.js

@@ -1,5 +1,5 @@
 import { g as getUVEState, s as sendMessageToUVE } from './public.esm.js';
-export { C as CUSTOM_NO_COMPONENT, D as DEVELOPMENT_MODE, f as DOT_SECTION_ID_PREFIX, E as EMPTY_CONTAINER_STYLE_ANGULAR, h as EMPTY_CONTAINER_STYLE_REACT, j as END_CLASS, P as PRODUCTION_MODE, S as START_CLASS, T as TEMP_EMPTY_CONTENTLET, k as TEMP_EMPTY_CONTENTLET_TYPE, _ as __UVE_EVENTS__, l as __UVE_EVENT_ERROR_FALLBACK__, m as combineClasses, n as computeScrollIsInBottom, a as createUVESubscription, o as findDotCMSElement, p as findDotCMSVTLData, q as getClosestDotCMSContainerData, t as getColumnPositionClasses, v as getContainersData, w as getContentletsInContainer, x as getDotCMSContainerData, y as getDotCMSContentletsBound, z as getDotCMSPageBounds, A as getDotContainerAttributes, B as getDotContentletAttributes, F as isValidBlocks, G as readContentletDataset, H as setBounds } from './public.esm.js';
+export { A as ANALYTICS_ACTIVE_WINDOW_KEY, f as ANALYTICS_READY_EVENT, C as CUSTOM_NO_COMPONENT, D as DEVELOPMENT_MODE, h as DOT_SECTION_ID_PREFIX, E as EMPTY_CONTAINER_STYLE_ANGULAR, j as EMPTY_CONTAINER_STYLE_REACT, k as END_CLASS, P as PRODUCTION_MODE, S as START_CLASS, T as TEMP_EMPTY_CONTENTLET, l as TEMP_EMPTY_CONTENTLET_TYPE, _ as __UVE_EVENTS__, m as __UVE_EVENT_ERROR_FALLBACK__, n as combineClasses, o as computeScrollIsInBottom, a as createUVESubscription, p as findDotCMSElement, q as findDotCMSVTLData, t as getAnalyticsContentletAttributes, v as getClosestDotCMSContainerData, w as getColumnPositionClasses, x as getContainersData, y as getContentletsInContainer, z as getDotCMSContainerData, B as getDotCMSContentletsBound, F as getDotCMSPageBounds, G as getDotContainerAttributes, H as getDotContentletAttributes, I as isDotAnalyticsActive, J as isValidBlocks, K as readContentletDataset, L as setBounds } from './public.esm.js';
 import { UVE_MODE, DotCMSUVEAction } from '@dotcms/types';
 import '@dotcms/types/internal';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/uve",
-  "version": "1.5.5-next.2245",
+  "version": "1.5.5-next.2253",
   "description": "Official JavaScript library for interacting with Universal Visual Editor (UVE)",
   "repository": {
     "type": "git",

package/public.cjs.js

@@ -257,6 +257,38 @@ function getDotContentletAttributes(contentlet, container) {
     })
   };
 }
+/**
+ *
+ * Returns the minimal set of contentlet data attributes required by DotCMS
+ * Analytics (impression & click tracking) to identify a contentlet.
+ *
+ * Used in live mode where the full editor metadata is stripped but Analytics
+ * still needs to resolve the contentlet behind an impression/click.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the attributes for
+ * @returns {DotAnalyticsContentletAttributes} The Analytics-required data attributes
+ */
+function getAnalyticsContentletAttributes(contentlet) {
+  return {
+    'data-dot-identifier': contentlet?.identifier,
+    'data-dot-inode': contentlet?.inode,
+    'data-dot-title': contentlet?.['widgetTitle'] || contentlet?.title,
+    'data-dot-type': contentlet?.contentType,
+    'data-dot-basetype': contentlet?.baseType
+  };
+}
+/**
+ *
+ * Checks whether DotCMS Analytics is initialized and active on the page.
+ *
+ * The SDKs use this in live mode to decide whether to keep the minimal
+ * contentlet attributes Analytics depends on.
+ *
+ * @returns {boolean} `true` when analytics is active, otherwise `false`
+ */
+function isDotAnalyticsActive() {
+  return typeof window !== 'undefined' && window[ANALYTICS_ACTIVE_WINDOW_KEY] === true;
+}
 /**
  *
  *
@@ -885,6 +917,29 @@ const CUSTOM_NO_COMPONENT = 'CustomNoComponent';
  * @internal
  */
 const DOT_SECTION_ID_PREFIX = 'dot-section-';
+/**
+ * Window flag set by `@dotcms/analytics` when content analytics is initialized
+ * and active on the page.
+ *
+ * @important This value is intentionally duplicated from `@dotcms/analytics`
+ * (`ANALYTICS_WINDOWS_ACTIVE_KEY` in dot-analytics.constants.ts). The SDKs read
+ * it in live mode to decide whether to keep the minimal contentlet attributes
+ * Analytics depends on. Both constants MUST stay in sync.
+ *
+ * @internal
+ */
+const ANALYTICS_ACTIVE_WINDOW_KEY = '__dotAnalyticsActive__';
+/**
+ * Event dispatched by `@dotcms/analytics` once analytics is ready. The SDKs
+ * listen for it so live-mode contentlets can re-render with the attributes
+ * Analytics needs, regardless of initialization order.
+ *
+ * @important Kept in sync with the `dotcms:analytics:ready` event dispatched by
+ * `@dotcms/analytics` (initializeContentAnalytics).
+ *
+ * @internal
+ */
+const ANALYTICS_READY_EVENT = 'dotcms:analytics:ready';
 
 /**
  * Gets the current state of the Universal Visual Editor (UVE).
@@ -1434,6 +1489,8 @@ function initUVE(config = {}) {
   };
 }
 
+exports.ANALYTICS_ACTIVE_WINDOW_KEY = ANALYTICS_ACTIVE_WINDOW_KEY;
+exports.ANALYTICS_READY_EVENT = ANALYTICS_READY_EVENT;
 exports.CUSTOM_NO_COMPONENT = CUSTOM_NO_COMPONENT;
 exports.DEVELOPMENT_MODE = DEVELOPMENT_MODE;
 exports.DOT_SECTION_ID_PREFIX = DOT_SECTION_ID_PREFIX;
@@ -1454,6 +1511,7 @@ exports.editContentlet = editContentlet;
 exports.enableBlockEditorInline = enableBlockEditorInline;
 exports.findDotCMSElement = findDotCMSElement;
 exports.findDotCMSVTLData = findDotCMSVTLData;
+exports.getAnalyticsContentletAttributes = getAnalyticsContentletAttributes;
 exports.getClosestDotCMSContainerData = getClosestDotCMSContainerData;
 exports.getColumnPositionClasses = getColumnPositionClasses;
 exports.getContainersData = getContainersData;
@@ -1466,6 +1524,7 @@ exports.getDotContentletAttributes = getDotContentletAttributes;
 exports.getUVEState = getUVEState;
 exports.initInlineEditing = initInlineEditing;
 exports.initUVE = initUVE;
+exports.isDotAnalyticsActive = isDotAnalyticsActive;
 exports.isValidBlocks = isValidBlocks;
 exports.readContentletDataset = readContentletDataset;
 exports.reorderMenu = reorderMenu;

package/public.esm.js

@@ -255,6 +255,38 @@ function getDotContentletAttributes(contentlet, container) {
     })
   };
 }
+/**
+ *
+ * Returns the minimal set of contentlet data attributes required by DotCMS
+ * Analytics (impression & click tracking) to identify a contentlet.
+ *
+ * Used in live mode where the full editor metadata is stripped but Analytics
+ * still needs to resolve the contentlet behind an impression/click.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the attributes for
+ * @returns {DotAnalyticsContentletAttributes} The Analytics-required data attributes
+ */
+function getAnalyticsContentletAttributes(contentlet) {
+  return {
+    'data-dot-identifier': contentlet?.identifier,
+    'data-dot-inode': contentlet?.inode,
+    'data-dot-title': contentlet?.['widgetTitle'] || contentlet?.title,
+    'data-dot-type': contentlet?.contentType,
+    'data-dot-basetype': contentlet?.baseType
+  };
+}
+/**
+ *
+ * Checks whether DotCMS Analytics is initialized and active on the page.
+ *
+ * The SDKs use this in live mode to decide whether to keep the minimal
+ * contentlet attributes Analytics depends on.
+ *
+ * @returns {boolean} `true` when analytics is active, otherwise `false`
+ */
+function isDotAnalyticsActive() {
+  return typeof window !== 'undefined' && window[ANALYTICS_ACTIVE_WINDOW_KEY] === true;
+}
 /**
  *
  *
@@ -883,6 +915,29 @@ const CUSTOM_NO_COMPONENT = 'CustomNoComponent';
  * @internal
  */
 const DOT_SECTION_ID_PREFIX = 'dot-section-';
+/**
+ * Window flag set by `@dotcms/analytics` when content analytics is initialized
+ * and active on the page.
+ *
+ * @important This value is intentionally duplicated from `@dotcms/analytics`
+ * (`ANALYTICS_WINDOWS_ACTIVE_KEY` in dot-analytics.constants.ts). The SDKs read
+ * it in live mode to decide whether to keep the minimal contentlet attributes
+ * Analytics depends on. Both constants MUST stay in sync.
+ *
+ * @internal
+ */
+const ANALYTICS_ACTIVE_WINDOW_KEY = '__dotAnalyticsActive__';
+/**
+ * Event dispatched by `@dotcms/analytics` once analytics is ready. The SDKs
+ * listen for it so live-mode contentlets can re-render with the attributes
+ * Analytics needs, regardless of initialization order.
+ *
+ * @important Kept in sync with the `dotcms:analytics:ready` event dispatched by
+ * `@dotcms/analytics` (initializeContentAnalytics).
+ *
+ * @internal
+ */
+const ANALYTICS_READY_EVENT = 'dotcms:analytics:ready';
 
 /**
  * Gets the current state of the Universal Visual Editor (UVE).
@@ -1432,4 +1487,4 @@ function initUVE(config = {}) {
   };
 }
 
-export { getDotContainerAttributes as A, getDotContentletAttributes as B, CUSTOM_NO_COMPONENT as C, DEVELOPMENT_MODE as D, EMPTY_CONTAINER_STYLE_ANGULAR as E, isValidBlocks as F, readContentletDataset as G, setBounds as H, PRODUCTION_MODE as P, START_CLASS as S, TEMP_EMPTY_CONTENTLET as T, __UVE_EVENTS__ as _, createUVESubscription as a, enableBlockEditorInline as b, createContentlet as c, initUVE as d, editContentlet as e, DOT_SECTION_ID_PREFIX as f, getUVEState as g, EMPTY_CONTAINER_STYLE_REACT as h, initInlineEditing as i, END_CLASS as j, TEMP_EMPTY_CONTENTLET_TYPE as k, __UVE_EVENT_ERROR_FALLBACK__ as l, combineClasses as m, computeScrollIsInBottom as n, findDotCMSElement as o, findDotCMSVTLData as p, getClosestDotCMSContainerData as q, reorderMenu as r, sendMessageToUVE as s, getColumnPositionClasses as t, updateNavigation as u, getContainersData as v, getContentletsInContainer as w, getDotCMSContainerData as x, getDotCMSContentletsBound as y, getDotCMSPageBounds as z };
+export { ANALYTICS_ACTIVE_WINDOW_KEY as A, getDotCMSContentletsBound as B, CUSTOM_NO_COMPONENT as C, DEVELOPMENT_MODE as D, EMPTY_CONTAINER_STYLE_ANGULAR as E, getDotCMSPageBounds as F, getDotContainerAttributes as G, getDotContentletAttributes as H, isDotAnalyticsActive as I, isValidBlocks as J, readContentletDataset as K, setBounds as L, PRODUCTION_MODE as P, START_CLASS as S, TEMP_EMPTY_CONTENTLET as T, __UVE_EVENTS__ as _, createUVESubscription as a, enableBlockEditorInline as b, createContentlet as c, initUVE as d, editContentlet as e, ANALYTICS_READY_EVENT as f, getUVEState as g, DOT_SECTION_ID_PREFIX as h, initInlineEditing as i, EMPTY_CONTAINER_STYLE_REACT as j, END_CLASS as k, TEMP_EMPTY_CONTENTLET_TYPE as l, __UVE_EVENT_ERROR_FALLBACK__ as m, combineClasses as n, computeScrollIsInBottom as o, findDotCMSElement as p, findDotCMSVTLData as q, reorderMenu as r, sendMessageToUVE as s, getAnalyticsContentletAttributes as t, updateNavigation as u, getClosestDotCMSContainerData as v, getColumnPositionClasses as w, getContainersData as x, getContentletsInContainer as y, getDotCMSContainerData as z };

package/src/internal/constants.d.ts

@@ -81,3 +81,26 @@ export declare const CUSTOM_NO_COMPONENT = "CustomNoComponent";
  * @internal
  */
 export declare const DOT_SECTION_ID_PREFIX = "dot-section-";
+/**
+ * Window flag set by `@dotcms/analytics` when content analytics is initialized
+ * and active on the page.
+ *
+ * @important This value is intentionally duplicated from `@dotcms/analytics`
+ * (`ANALYTICS_WINDOWS_ACTIVE_KEY` in dot-analytics.constants.ts). The SDKs read
+ * it in live mode to decide whether to keep the minimal contentlet attributes
+ * Analytics depends on. Both constants MUST stay in sync.
+ *
+ * @internal
+ */
+export declare const ANALYTICS_ACTIVE_WINDOW_KEY = "__dotAnalyticsActive__";
+/**
+ * Event dispatched by `@dotcms/analytics` once analytics is ready. The SDKs
+ * listen for it so live-mode contentlets can re-render with the attributes
+ * Analytics needs, regardless of initialization order.
+ *
+ * @important Kept in sync with the `dotcms:analytics:ready` event dispatched by
+ * `@dotcms/analytics` (initializeContentAnalytics).
+ *
+ * @internal
+ */
+export declare const ANALYTICS_READY_EVENT = "dotcms:analytics:ready";

package/src/lib/dom/dom.utils.d.ts

@@ -1,5 +1,5 @@
 import { DotCMSBasicContentlet, DotCMSColumnContainer, DotCMSPageAsset, DotPageAssetLayoutColumn, EditableContainerData } from '@dotcms/types';
-import { DotCMSContainerBound, DotCMSContentletBound, DotContainerAttributes, DotContentletAttributes } from '@dotcms/types/internal';
+import { DotAnalyticsContentletAttributes, DotCMSContainerBound, DotCMSContentletBound, DotContainerAttributes, DotContentletAttributes } from '@dotcms/types/internal';
 /**
  * Calculates the bounding information for each page element within the given containers.
  *
@@ -152,6 +152,28 @@ export declare const getColumnPositionClasses: (column: DotPageAssetLayoutColumn
  * @returns {DotContentletAttributes} The dotCMS data attributes
  */
 export declare function getDotContentletAttributes(contentlet: DotCMSBasicContentlet, container: string): DotContentletAttributes;
+/**
+ *
+ * Returns the minimal set of contentlet data attributes required by DotCMS
+ * Analytics (impression & click tracking) to identify a contentlet.
+ *
+ * Used in live mode where the full editor metadata is stripped but Analytics
+ * still needs to resolve the contentlet behind an impression/click.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the attributes for
+ * @returns {DotAnalyticsContentletAttributes} The Analytics-required data attributes
+ */
+export declare function getAnalyticsContentletAttributes(contentlet: DotCMSBasicContentlet): DotAnalyticsContentletAttributes;
+/**
+ *
+ * Checks whether DotCMS Analytics is initialized and active on the page.
+ *
+ * The SDKs use this in live mode to decide whether to keep the minimal
+ * contentlet attributes Analytics depends on.
+ *
+ * @returns {boolean} `true` when analytics is active, otherwise `false`
+ */
+export declare function isDotAnalyticsActive(): boolean;
 /**
  *
  *