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

package/README.md

@@ -2,7 +2,7 @@
 
 The `@dotcms/uve` SDK adds live editing to your JavaScript app using the dotCMS Universal Visual Editor (UVE). It provides low-level tools that power our framework-specific SDKs, such as [@dotcms/react](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/react/README.md) and [@dotcms/angular](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/angular/README.md).
 
-> ⚠️ We **do not recommend using this SDK directly** for most use cases, you should use a [framework SDK that handles setup](#getting-started-recommended-examples), rendering, and event wiring for you.
+> ⚠️ We **do not recommend using this SDK directly** for most use cases; you should use a [framework SDK that handles setup](#getting-started-recommended-examples), rendering, and event wiring for you.
 
 With `@dotcms/uve`, framework SDKs are able to:
 - Make pages and contentlets editable
@@ -17,11 +17,11 @@ With `@dotcms/uve`, framework SDKs are able to:
     -   [🚩 Custom Setup: Manual Rendering (Not Recommended)](#-custom-setup-manual-rendering-not-recommended)
 -   [Prerequisites & Setup](#prerequisites--setup)
     -   [Get a dotCMS Environment](#get-a-dotcms-environment)
-    -   [Create a dotCMS API Key](#create-a-dotcms-api-key)
+    -   [Configure The Universal Visual Editor App](#configure-the-universal-visual-editor-app)
     -   [Installation](#installation)
     -   [Using the SDK with TypeScript](#using-the-sdk-with-typescript)
 -   [SDK Reference](#sdk-reference)
-    -   [`initUVE()`](#inituveconfig-dotcmsuveconfig)
+    -   [`initUVE()`](#inituveconfig-dotcmspageresponse)
     -   [`getUVEState()`](#getuvestate)
     -   [`createUVESubscription()`](#createuvesubscriptioneventtype-callback)
     -   [`editContentlet()`](#editcontentletcontentlet)
@@ -49,7 +49,7 @@ With `@dotcms/uve`, framework SDKs are able to:
 We strongly recommend using one of our official framework SDKs, which are designed to handle UVE integration, routing, rendering, and more—out of the box. These examples are the best way to get started:
 
 -   [dotCMS Angular SDK: Angular Example](https://github.com/dotCMS/core/tree/main/examples/angular) – Ideal for Angular apps 🅰️
--   [dotCMS React SDK: NextJS Example](https://github.com/dotCMS/core/tree/main/examples/react) – Ideal for NextJS projects ⚛️
+-   [dotCMS React SDK: NextJS Example](https://github.com/dotCMS/core/tree/main/examples/nextjs) – Ideal for NextJS projects ⚛️
 -   [dotCMS React SDK: Astro Example](https://github.com/dotCMS/core/tree/main/examples/astro) – Ideal for Astro projects 🌌
 
 These examples handle UVE integration, routing, rendering, and more—out of the box. **If you're building a headless dotCMS front-end, start there.**
@@ -66,7 +66,7 @@ You can use `@dotcms/uve` directly, but **it’s not recommended or supported**
 
 Here's a minimal setup using `@dotcms/client` and `@dotcms/uve`:
 
-1. Initializa the Client and get the page response:
+1. Initialize the Client and get the page response:
 
 ```ts
 // getPage.ts
@@ -94,12 +94,13 @@ const getPage = async () => {
 
 ```ts
 import { initUVE, createUVESubscription } from '@dotcms/uve';
+import { UVEEventType } from '@dotcms/types';
 import { getPage } from './getPage';
 
 const pageResponse = await getPage();
 
 initUVE(pageResponse);
-createUVESubscription('changes', (newPageResponse) => {
+createUVESubscription(UVEEventType.CONTENT_CHANGES, (newPageResponse) => {
     // Handle page updates (e.g. re-render)
 });
 ```
@@ -118,7 +119,7 @@ createUVESubscription('changes', (newPageResponse) => {
 #### 🔄 How to Render a dotCMS Page
 
 > 📚 For a complete guide, here is a full tutorial:
-> 👉 [dotCMS Page Rendering Architecture]( https://dev.dotcms.com/docs/dotcms-page-rendering-architecture)
+> 👉 [dotCMS Page Rendering Architecture](https://dev.dotcms.com/docs/dotcms-page-rendering-architecture)
 
 dotCMS pages are structured as nested layout objects:
 
@@ -218,7 +219,6 @@ The SDK uses several key types from `@dotcms/types`:
 import {
     DotCMSBasicContentlet,
     DotCMSPageResponse,
-    DotCMSUVEConfig,
     DotCMSInlineEditingType,
     UVEEventType,
     UVEState
@@ -229,7 +229,7 @@ For a complete reference of all available types and interfaces, please refer to
 
 ## SDK Reference
 
-### `initUVE(config?: DotCMSUVEConfig)`
+### `initUVE(config?: DotCMSPageResponse)`
 
 `initUVE` is a function that initializes the Universal Visual Editor (UVE). It sets up the necessary communication between your app and the editor, enabling seamless integration and interaction.
 
@@ -243,7 +243,7 @@ For a complete reference of all available types and interfaces, please refer to
 const { destroyUVESubscriptions } = initUVE(pageResponse);
 ```
 
-> ⚠️ If you don't provide a `pageResponse`, we can't assure that the UVE will be initialized correctly.
+> ⚠️ If you don't provide a `pageResponse`, we cannot guarantee that the UVE will be initialized correctly.
 
 ### `getUVEState()`
 
@@ -303,14 +303,16 @@ sub.unsubscribe();
 
 -   `UVEEventType.CONTENT_CHANGES`: Triggered when the content of the page changes.
 -   `UVEEventType.PAGE_RELOAD`: Triggered when the page is reloaded.
--   `UVEEventType.REQUEST_BOUNDS`: Triggered when the editor requests the bounds of the page.
--   `UVEEventType.IFRAME_SCROLL`: Triggered when the iframe is scrolled.
--   `UVEEventType.IFRAME_SCROLL_END`: Triggered when the iframe has stopped scrolling.
+-   `UVEEventType.IFRAME_SCROLL`: Triggered when scroll action is needed inside the iframe (`'up'` or `'down'`).
 -   `UVEEventType.CONTENTLET_HOVERED`: Triggered when a contentlet is hovered.
+-   `UVEEventType.CONTENTLET_CLICKED`: Triggered when a contentlet is clicked.
+-   `UVEEventType.AUTO_BOUNDS`: Triggered when the SDK syncs page bounds after layout changes (internal SDK use).
+-   `UVEEventType.SCROLL_TO_SECTION`: Triggered when the editor requests a scroll to a specific page section (internal).
+-   `UVEEventType.SELECTION_CLEARED`: Triggered when the editor clears its selection (internal).
 
 ### `editContentlet(contentlet)`
 
-`editContentlet` is a function that opens the dotCMS modal editor for any contentlet in or out of page area.
+`editContentlet` is a function that opens the dotCMS modal editor for any contentlet in or out of the page area.
 
 | Input        | Type               | Required | Description                      |
 | ------------ | ------------------ | -------- | -------------------------------- |
@@ -340,7 +342,7 @@ const myEditButton = ({ contentlet }) => {
 | Input       | Type                         | Required | Description                                                                    |
 | ----------- | ---------------------------- | -------- | ------------------------------------------------------------------------------ |
 | `type`      | `DotCMSInlineEditingType`    | ✅       | `'BLOCK_EDITOR'` or `'WYSIWYG'`                                                |
-| `fieldData` | `DotCMSInlineEditingPayload` | ✅       | [Field content required to enable inline editing](#dotcmsinlineeditingpayload) |
+| `data`      | `DotCMSInlineEditingPayload` | ✅       | [Field content required to enable inline editing](#dotcmsinlineeditingpayload) |
 
 #### Usage
 
@@ -449,7 +451,7 @@ reorderMenu({ startLevel: 2, depth: 3 });
 
 | Input     | Type                                       | Required | Description                  |
 | --------- | ------------------------------------------ | -------- | ---------------------------- |
-| `message` | [`DotCMSUVEMessage<T>`](#dotcmsuvemessage) | ✅       | Object with action + payload |
+| `message` | [`DotCMSUVEMessage<T>`](#dotcmsuvemessaget) | ✅       | Object with action + payload |
 
 #### Usage
 
@@ -488,7 +490,7 @@ Style editor schemas are configured in the DotCMS admin UI under **Content Types
 **Key Benefits:**
 
 -   **Real-Time Visual Editing**: Modify component styles and see changes instantly in the editor
--   **Content-Specific Customization**: Different content types can have unique style schemas, and the same contentlet could have different styles depending on if it is located in a different container or page
+-   **Content-Specific Customization**: Different content types can have unique style schemas, and the same contentlet could have different styles depending on whether it is located in a different container or page
 -   **Admin-Managed**: Style schemas are defined in the DotCMS admin UI under Content Types and fetched automatically by the SDK
 
 **Use Cases:**
@@ -627,7 +629,7 @@ When **defining styles** for a contentlet within a page using **Style Editor**,
 
 > **NOTE:** (🎨 Styles are different) means the capability to define distinct styles, even when utilizing the identical Contentlet.
 
-The only known limitation is that moving a contentlet with defined styles between different container types (5th scenario), results in the loss of those styles. See the [technical details document](https://docs.google.com/document/d/1UiuJlIn8ZjybIB-0oHeoTLXZo1k-YExITEqEMfyvVlU/edit?tab=t.0) for our planned solution.
+The only known limitation is that moving a contentlet with defined styles between different container types (5th scenario) results in the loss of those styles. A fix for this scenario is on our roadmap.
 
 ## Troubleshooting
 
@@ -713,7 +715,7 @@ We offer multiple channels to get help with the dotCMS UVE 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-uve` 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/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.2180",
+  "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;
 /**
  *
  *