@dotcms/uve 1.1.1 → 1.2.0

package/README.md

@@ -34,10 +34,9 @@ With `@dotcms/uve`, framework SDKs are able to:
     -   [Common Issues & Solutions](#common-issues--solutions)
     -   [Debugging Tips](#debugging-tips)
     -   [Still Having Issues?](#still-having-issues)
--   [dotCMS Support](#dotcms-support)
--   [How To Contribute](#how-to-contribute)
--   [Licensing Information](#licensing-information)
--   [Troubleshooting](#troubleshooting)
+-   [Support](#support)
+-   [Contributing](#contributing)
+-   [Licensing](#licensing)
 
 ## Before You Use @dotcms/uve
 
@@ -551,13 +550,14 @@ If you're still experiencing problems after trying these solutions:
     - Error messages
     - Code samples
 
-## dotCMS Support
+## Support
 
 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.
+-   **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/)
 
 When reporting issues, please include:
 
@@ -566,11 +566,9 @@ When reporting issues, please include:
 -   Minimal reproduction steps
 -   Expected vs. actual behavior
 
-Enterprise customers can access premium support through the [dotCMS Support Portal](https://dev.dotcms.com/docs/help).
-
-## How To Contribute
+## Contributing
 
-GitHub pull requests are the preferred method to contribute code to dotCMS. We welcome contributions to the DotCMS UVE SDK! If you'd like to contribute, please follow these steps:
+GitHub pull requests are the preferred method to contribute code to dotCMS. We welcome contributions to the dotCMS UVE SDK! If you'd like to contribute, please follow these steps:
 
 1. Fork the repository [dotCMS/core](https://github.com/dotCMS/core)
 2. Create a feature branch (`git checkout -b feature/amazing-feature`)
@@ -580,7 +578,7 @@ GitHub pull requests are the preferred method to contribute code to dotCMS. We w
 
 Please ensure your code follows the existing style and includes appropriate tests.
 
-## Licensing Information
+## Licensing
 
 dotCMS comes in multiple editions and as such is dual-licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization, and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds several enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see [the feature page](http://www.dotcms.com/cms-platform/features).
 

package/index.cjs.js

@@ -12,6 +12,7 @@ exports.enableBlockEditorInline = _public.enableBlockEditorInline;
 exports.getUVEState = _public.getUVEState;
 exports.initInlineEditing = _public.initInlineEditing;
 exports.initUVE = _public.initUVE;
+exports.isAnalyticsActive = _public.isAnalyticsActive;
 exports.reorderMenu = _public.reorderMenu;
 exports.sendMessageToUVE = _public.sendMessageToUVE;
 exports.updateNavigation = _public.updateNavigation;

package/index.esm.js

@@ -1,3 +1,3 @@
-export { c as createUVESubscription, e as editContentlet, a as enableBlockEditorInline, g as getUVEState, i as initInlineEditing, b as initUVE, r as reorderMenu, s as sendMessageToUVE, u as updateNavigation } from './public.esm.js';
+export { c as createUVESubscription, e as editContentlet, b as enableBlockEditorInline, g as getUVEState, a as initInlineEditing, d as initUVE, i as isAnalyticsActive, r as reorderMenu, s as sendMessageToUVE, u as updateNavigation } from './public.esm.js';
 import '@dotcms/types';
 import '@dotcms/types/internal';

package/internal.cjs.js

@@ -74,6 +74,8 @@ const __BASE_TINYMCE_CONFIG_WITH_NO_DEFAULT__ = {
  */
 const __TINYMCE_PATH_ON_DOTCMS__ = '/ext/tinymcev7/tinymce.min.js';
 
+exports.ANALYTICS_WINDOWS_ACTIVE_KEY = _public.ANALYTICS_WINDOWS_ACTIVE_KEY;
+exports.ANALYTICS_WINDOWS_CLEANUP_KEY = _public.ANALYTICS_WINDOWS_CLEANUP_KEY;
 exports.CUSTOM_NO_COMPONENT = _public.CUSTOM_NO_COMPONENT;
 exports.DEVELOPMENT_MODE = _public.DEVELOPMENT_MODE;
 exports.EMPTY_CONTAINER_STYLE_ANGULAR = _public.EMPTY_CONTAINER_STYLE_ANGULAR;
@@ -85,17 +87,21 @@ exports.__UVE_EVENTS__ = _public.__UVE_EVENTS__;
 exports.__UVE_EVENT_ERROR_FALLBACK__ = _public.__UVE_EVENT_ERROR_FALLBACK__;
 exports.combineClasses = _public.combineClasses;
 exports.computeScrollIsInBottom = _public.computeScrollIsInBottom;
+exports.createUVESubscription = _public.createUVESubscription;
 exports.findDotCMSElement = _public.findDotCMSElement;
 exports.findDotCMSVTLData = _public.findDotCMSVTLData;
 exports.getClosestDotCMSContainerData = _public.getClosestDotCMSContainerData;
 exports.getColumnPositionClasses = _public.getColumnPositionClasses;
 exports.getContainersData = _public.getContainersData;
 exports.getContentletsInContainer = _public.getContentletsInContainer;
+exports.getDotAnalyticsAttributes = _public.getDotAnalyticsAttributes;
 exports.getDotCMSContainerData = _public.getDotCMSContainerData;
 exports.getDotCMSContentletsBound = _public.getDotCMSContentletsBound;
 exports.getDotCMSPageBounds = _public.getDotCMSPageBounds;
 exports.getDotContainerAttributes = _public.getDotContainerAttributes;
 exports.getDotContentletAttributes = _public.getDotContentletAttributes;
+exports.getUVEState = _public.getUVEState;
+exports.isAnalyticsActive = _public.isAnalyticsActive;
 exports.isValidBlocks = _public.isValidBlocks;
 exports.setBounds = _public.setBounds;
 exports.__BASE_TINYMCE_CONFIG_WITH_NO_DEFAULT__ = __BASE_TINYMCE_CONFIG_WITH_NO_DEFAULT__;

package/internal.esm.js

@@ -1,4 +1,4 @@
-export { C as CUSTOM_NO_COMPONENT, D as DEVELOPMENT_MODE, h as EMPTY_CONTAINER_STYLE_ANGULAR, f as EMPTY_CONTAINER_STYLE_REACT, E as END_CLASS, P as PRODUCTION_MODE, S as START_CLASS, _ as __UVE_EVENTS__, d as __UVE_EVENT_ERROR_FALLBACK__, q as combineClasses, p as computeScrollIsInBottom, n as findDotCMSElement, o as findDotCMSVTLData, m as getClosestDotCMSContainerData, t as getColumnPositionClasses, w as getContainersData, x as getContentletsInContainer, l as getDotCMSContainerData, k as getDotCMSContentletsBound, j as getDotCMSPageBounds, y as getDotContainerAttributes, v as getDotContentletAttributes, A as isValidBlocks, z as setBounds } from './public.esm.js';
+export { A as ANALYTICS_WINDOWS_ACTIVE_KEY, k as ANALYTICS_WINDOWS_CLEANUP_KEY, C as CUSTOM_NO_COMPONENT, D as DEVELOPMENT_MODE, j as EMPTY_CONTAINER_STYLE_ANGULAR, h as EMPTY_CONTAINER_STYLE_REACT, E as END_CLASS, P as PRODUCTION_MODE, S as START_CLASS, _ as __UVE_EVENTS__, f as __UVE_EVENT_ERROR_FALLBACK__, v as combineClasses, t as computeScrollIsInBottom, c as createUVESubscription, p as findDotCMSElement, q as findDotCMSVTLData, o as getClosestDotCMSContainerData, w as getColumnPositionClasses, z as getContainersData, B as getContentletsInContainer, y as getDotAnalyticsAttributes, n as getDotCMSContainerData, m as getDotCMSContentletsBound, l as getDotCMSPageBounds, F as getDotContainerAttributes, x as getDotContentletAttributes, g as getUVEState, i as isAnalyticsActive, H as isValidBlocks, G as setBounds } from './public.esm.js';
 import '@dotcms/types';
 import '@dotcms/types/internal';
 

package/package.json

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

package/public.cjs.js

@@ -240,6 +240,23 @@ function getDotContentletAttributes(contentlet, container) {
     'data-dot-on-number-of-pages': contentlet?.['onNumberOfPages'] || '1'
   };
 }
+/**
+ * Helper function that returns an object containing analytics-specific data attributes.
+ * These attributes are used by the DotCMS Analytics SDK to track content interactions.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the analytics attributes for
+ * @returns {DotAnalyticsAttributes} The analytics data attributes
+ * @internal
+ */
+function getDotAnalyticsAttributes(contentlet) {
+  return {
+    'data-dot-analytics-identifier': contentlet?.identifier,
+    'data-dot-analytics-inode': contentlet?.inode,
+    'data-dot-analytics-basetype': contentlet?.baseType,
+    'data-dot-analytics-contenttype': contentlet?.contentType,
+    'data-dot-analytics-title': contentlet?.['widgetTitle'] || contentlet?.title
+  };
+}
 /**
  *
  *
@@ -597,6 +614,10 @@ const EMPTY_CONTAINER_STYLE_ANGULAR = {
  * @internal
  */
 const CUSTOM_NO_COMPONENT = 'CustomNoComponent';
+// Analytics active flag key
+const ANALYTICS_WINDOWS_ACTIVE_KEY = '__dotAnalyticsActive__';
+// Analytics cleanup function key
+const ANALYTICS_WINDOWS_CLEANUP_KEY = '__dotAnalyticsCleanup';
 
 /**
  * Gets the current state of the Universal Visual Editor (UVE).
@@ -682,6 +703,57 @@ function createUVESubscription(eventType, callback) {
   }
   return eventCallback(callback);
 }
+/**
+ * Checks if DotCMS Analytics is active by verifying the global window flag.
+ *
+ * This function checks for the presence of the `__dotAnalyticsActive__` flag on the window object,
+ * which is set by the `@dotcms/analytics` SDK when Analytics is successfully initialized.
+ *
+ * This utility can be used in any JavaScript framework (React, Angular, Vue, etc.) to conditionally
+ * enable analytics-related features or data attributes.
+ *
+ * @export
+ * @returns {boolean} true if Analytics is initialized and active, false otherwise
+ *
+ * @example
+ * ```ts
+ * // React example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * function MyComponent() {
+ *   const shouldTrack = isAnalyticsActive();
+ *
+ *   if (shouldTrack) {
+ *     // Add analytics tracking
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Angular example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   // Apply analytics attributes to elements
+ *   element.setAttribute('data-dot-object', 'contentlet');
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Vanilla JavaScript / Any framework
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   console.log('DotCMS Analytics is active');
+ * }
+ * ```
+ */
+function isAnalyticsActive() {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return typeof window !== 'undefined' && window[ANALYTICS_WINDOWS_ACTIVE_KEY] === true;
+}
 
 /**
  * Sets the bounds of the containers in the editor.
@@ -696,17 +768,20 @@ function setBounds(bounds) {
   });
 }
 /**
- * Validates the structure of a Block Editor block.
- *
- * This function checks that:
- * 1. The blocks parameter is a valid object
- * 2. The block has a 'doc' type
- * 3. The block has a valid content array that is not empty
- *
- * @param {Block} blocks - The blocks structure to validate
- * @returns {BlockEditorState} Object containing validation state and any error message
- * @property {boolean} BlockEditorState.isValid - Whether the blocks structure is valid
- * @property {string | null} BlockEditorState.error - Error message if invalid, null if valid
+ * Validates the structure of a Block Editor node.
+ *
+ * This function performs validation checks on a BlockEditorNode object to ensure:
+ * - The node exists and is a valid object
+ * - The node has a 'doc' type
+ * - The node has a valid content array containing at least one block
+ * - Each block in the content array:
+ *   - Has a valid string type property
+ *   - Has valid object attributes (if present)
+ *   - Has valid nested content (if present)
+ *
+ * @param {BlockEditorNode} blocks - The BlockEditorNode structure to validate
+ * @returns {BlockEditorState} The validation result
+ * @property {string | null} BlockEditorState.error - Error message if validation fails, null if valid
  */
 const isValidBlocks = blocks => {
   if (!blocks) {
@@ -1097,6 +1172,8 @@ function initUVE(config = {}) {
   };
 }
 
+exports.ANALYTICS_WINDOWS_ACTIVE_KEY = ANALYTICS_WINDOWS_ACTIVE_KEY;
+exports.ANALYTICS_WINDOWS_CLEANUP_KEY = ANALYTICS_WINDOWS_CLEANUP_KEY;
 exports.CUSTOM_NO_COMPONENT = CUSTOM_NO_COMPONENT;
 exports.DEVELOPMENT_MODE = DEVELOPMENT_MODE;
 exports.EMPTY_CONTAINER_STYLE_ANGULAR = EMPTY_CONTAINER_STYLE_ANGULAR;
@@ -1117,6 +1194,7 @@ exports.getClosestDotCMSContainerData = getClosestDotCMSContainerData;
 exports.getColumnPositionClasses = getColumnPositionClasses;
 exports.getContainersData = getContainersData;
 exports.getContentletsInContainer = getContentletsInContainer;
+exports.getDotAnalyticsAttributes = getDotAnalyticsAttributes;
 exports.getDotCMSContainerData = getDotCMSContainerData;
 exports.getDotCMSContentletsBound = getDotCMSContentletsBound;
 exports.getDotCMSPageBounds = getDotCMSPageBounds;
@@ -1125,6 +1203,7 @@ exports.getDotContentletAttributes = getDotContentletAttributes;
 exports.getUVEState = getUVEState;
 exports.initInlineEditing = initInlineEditing;
 exports.initUVE = initUVE;
+exports.isAnalyticsActive = isAnalyticsActive;
 exports.isValidBlocks = isValidBlocks;
 exports.reorderMenu = reorderMenu;
 exports.sendMessageToUVE = sendMessageToUVE;

package/public.esm.js

@@ -238,6 +238,23 @@ function getDotContentletAttributes(contentlet, container) {
     'data-dot-on-number-of-pages': contentlet?.['onNumberOfPages'] || '1'
   };
 }
+/**
+ * Helper function that returns an object containing analytics-specific data attributes.
+ * These attributes are used by the DotCMS Analytics SDK to track content interactions.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the analytics attributes for
+ * @returns {DotAnalyticsAttributes} The analytics data attributes
+ * @internal
+ */
+function getDotAnalyticsAttributes(contentlet) {
+  return {
+    'data-dot-analytics-identifier': contentlet?.identifier,
+    'data-dot-analytics-inode': contentlet?.inode,
+    'data-dot-analytics-basetype': contentlet?.baseType,
+    'data-dot-analytics-contenttype': contentlet?.contentType,
+    'data-dot-analytics-title': contentlet?.['widgetTitle'] || contentlet?.title
+  };
+}
 /**
  *
  *
@@ -595,6 +612,10 @@ const EMPTY_CONTAINER_STYLE_ANGULAR = {
  * @internal
  */
 const CUSTOM_NO_COMPONENT = 'CustomNoComponent';
+// Analytics active flag key
+const ANALYTICS_WINDOWS_ACTIVE_KEY = '__dotAnalyticsActive__';
+// Analytics cleanup function key
+const ANALYTICS_WINDOWS_CLEANUP_KEY = '__dotAnalyticsCleanup';
 
 /**
  * Gets the current state of the Universal Visual Editor (UVE).
@@ -680,6 +701,57 @@ function createUVESubscription(eventType, callback) {
   }
   return eventCallback(callback);
 }
+/**
+ * Checks if DotCMS Analytics is active by verifying the global window flag.
+ *
+ * This function checks for the presence of the `__dotAnalyticsActive__` flag on the window object,
+ * which is set by the `@dotcms/analytics` SDK when Analytics is successfully initialized.
+ *
+ * This utility can be used in any JavaScript framework (React, Angular, Vue, etc.) to conditionally
+ * enable analytics-related features or data attributes.
+ *
+ * @export
+ * @returns {boolean} true if Analytics is initialized and active, false otherwise
+ *
+ * @example
+ * ```ts
+ * // React example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * function MyComponent() {
+ *   const shouldTrack = isAnalyticsActive();
+ *
+ *   if (shouldTrack) {
+ *     // Add analytics tracking
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Angular example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   // Apply analytics attributes to elements
+ *   element.setAttribute('data-dot-object', 'contentlet');
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Vanilla JavaScript / Any framework
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   console.log('DotCMS Analytics is active');
+ * }
+ * ```
+ */
+function isAnalyticsActive() {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return typeof window !== 'undefined' && window[ANALYTICS_WINDOWS_ACTIVE_KEY] === true;
+}
 
 /**
  * Sets the bounds of the containers in the editor.
@@ -694,17 +766,20 @@ function setBounds(bounds) {
   });
 }
 /**
- * Validates the structure of a Block Editor block.
- *
- * This function checks that:
- * 1. The blocks parameter is a valid object
- * 2. The block has a 'doc' type
- * 3. The block has a valid content array that is not empty
- *
- * @param {Block} blocks - The blocks structure to validate
- * @returns {BlockEditorState} Object containing validation state and any error message
- * @property {boolean} BlockEditorState.isValid - Whether the blocks structure is valid
- * @property {string | null} BlockEditorState.error - Error message if invalid, null if valid
+ * Validates the structure of a Block Editor node.
+ *
+ * This function performs validation checks on a BlockEditorNode object to ensure:
+ * - The node exists and is a valid object
+ * - The node has a 'doc' type
+ * - The node has a valid content array containing at least one block
+ * - Each block in the content array:
+ *   - Has a valid string type property
+ *   - Has valid object attributes (if present)
+ *   - Has valid nested content (if present)
+ *
+ * @param {BlockEditorNode} blocks - The BlockEditorNode structure to validate
+ * @returns {BlockEditorState} The validation result
+ * @property {string | null} BlockEditorState.error - Error message if validation fails, null if valid
  */
 const isValidBlocks = blocks => {
   if (!blocks) {
@@ -1095,4 +1170,4 @@ function initUVE(config = {}) {
   };
 }
 
-export { isValidBlocks as A, CUSTOM_NO_COMPONENT as C, DEVELOPMENT_MODE as D, END_CLASS as E, PRODUCTION_MODE as P, START_CLASS as S, __UVE_EVENTS__ as _, enableBlockEditorInline as a, initUVE as b, createUVESubscription as c, __UVE_EVENT_ERROR_FALLBACK__ as d, editContentlet as e, EMPTY_CONTAINER_STYLE_REACT as f, getUVEState as g, EMPTY_CONTAINER_STYLE_ANGULAR as h, initInlineEditing as i, getDotCMSPageBounds as j, getDotCMSContentletsBound as k, getDotCMSContainerData as l, getClosestDotCMSContainerData as m, findDotCMSElement as n, findDotCMSVTLData as o, computeScrollIsInBottom as p, combineClasses as q, reorderMenu as r, sendMessageToUVE as s, getColumnPositionClasses as t, updateNavigation as u, getDotContentletAttributes as v, getContainersData as w, getContentletsInContainer as x, getDotContainerAttributes as y, setBounds as z };
+export { ANALYTICS_WINDOWS_ACTIVE_KEY as A, getContentletsInContainer as B, CUSTOM_NO_COMPONENT as C, DEVELOPMENT_MODE as D, END_CLASS as E, getDotContainerAttributes as F, setBounds as G, isValidBlocks as H, PRODUCTION_MODE as P, START_CLASS as S, __UVE_EVENTS__ as _, initInlineEditing as a, enableBlockEditorInline as b, createUVESubscription as c, initUVE as d, editContentlet as e, __UVE_EVENT_ERROR_FALLBACK__ as f, getUVEState as g, EMPTY_CONTAINER_STYLE_REACT as h, isAnalyticsActive as i, EMPTY_CONTAINER_STYLE_ANGULAR as j, ANALYTICS_WINDOWS_CLEANUP_KEY as k, getDotCMSPageBounds as l, getDotCMSContentletsBound as m, getDotCMSContainerData as n, getClosestDotCMSContainerData as o, findDotCMSElement as p, findDotCMSVTLData as q, reorderMenu as r, sendMessageToUVE as s, computeScrollIsInBottom as t, updateNavigation as u, combineClasses as v, getColumnPositionClasses as w, getDotContentletAttributes as x, getDotAnalyticsAttributes as y, getContainersData as z };

package/src/internal/constants.d.ts

@@ -74,3 +74,5 @@ export declare const EMPTY_CONTAINER_STYLE_ANGULAR: {
  * @internal
  */
 export declare const CUSTOM_NO_COMPONENT = "CustomNoComponent";
+export declare const ANALYTICS_WINDOWS_ACTIVE_KEY = "__dotAnalyticsActive__";
+export declare const ANALYTICS_WINDOWS_CLEANUP_KEY = "__dotAnalyticsCleanup";

package/src/internal.d.ts

@@ -1,3 +1,4 @@
 export * from './internal/index';
+export * from './lib/core/core.utils';
 export * from './lib/dom/dom.utils';
 export * from './lib/editor/internal';

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

@@ -1,4 +1,4 @@
-import { UVEState, UVEEventSubscription, UVEEventType, UVEEventPayloadMap } from '@dotcms/types';
+import { UVEEventPayloadMap, UVEEventSubscription, UVEEventType, UVEState } from '@dotcms/types';
 /**
  * Gets the current state of the Universal Visual Editor (UVE).
  *
@@ -47,3 +47,51 @@ export declare function getUVEState(): UVEState | undefined;
  * ```
  */
 export declare function createUVESubscription<T extends UVEEventType>(eventType: T, callback: (payload: UVEEventPayloadMap[T] extends undefined ? void : UVEEventPayloadMap[T]) => void): UVEEventSubscription;
+/**
+ * Checks if DotCMS Analytics is active by verifying the global window flag.
+ *
+ * This function checks for the presence of the `__dotAnalyticsActive__` flag on the window object,
+ * which is set by the `@dotcms/analytics` SDK when Analytics is successfully initialized.
+ *
+ * This utility can be used in any JavaScript framework (React, Angular, Vue, etc.) to conditionally
+ * enable analytics-related features or data attributes.
+ *
+ * @export
+ * @returns {boolean} true if Analytics is initialized and active, false otherwise
+ *
+ * @example
+ * ```ts
+ * // React example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * function MyComponent() {
+ *   const shouldTrack = isAnalyticsActive();
+ *
+ *   if (shouldTrack) {
+ *     // Add analytics tracking
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Angular example
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   // Apply analytics attributes to elements
+ *   element.setAttribute('data-dot-object', 'contentlet');
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Vanilla JavaScript / Any framework
+ * import { isAnalyticsActive } from '@dotcms/uve/internal';
+ *
+ * if (isAnalyticsActive()) {
+ *   console.log('DotCMS Analytics is active');
+ * }
+ * ```
+ */
+export declare function isAnalyticsActive(): boolean;

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

@@ -1,5 +1,5 @@
-import { EditableContainerData, DotCMSColumnContainer, DotCMSBasicContentlet, DotCMSPageAsset, DotPageAssetLayoutColumn } from '@dotcms/types';
-import { DotCMSContainerBound, DotCMSContentletBound, DotContainerAttributes, DotContentletAttributes } from '@dotcms/types/internal';
+import { DotCMSBasicContentlet, DotCMSColumnContainer, DotCMSPageAsset, DotPageAssetLayoutColumn, EditableContainerData } from '@dotcms/types';
+import { DotAnalyticsAttributes, DotCMSContainerBound, DotCMSContentletBound, DotContainerAttributes, DotContentletAttributes } from '@dotcms/types/internal';
 /**
  * Calculates the bounding information for each page element within the given containers.
  *
@@ -152,6 +152,15 @@ export declare const getColumnPositionClasses: (column: DotPageAssetLayoutColumn
  * @returns {DotContentletAttributes} The dotCMS data attributes
  */
 export declare function getDotContentletAttributes(contentlet: DotCMSBasicContentlet, container: string): DotContentletAttributes;
+/**
+ * Helper function that returns an object containing analytics-specific data attributes.
+ * These attributes are used by the DotCMS Analytics SDK to track content interactions.
+ *
+ * @param {DotCMSBasicContentlet} contentlet - The contentlet to get the analytics attributes for
+ * @returns {DotAnalyticsAttributes} The analytics data attributes
+ * @internal
+ */
+export declare function getDotAnalyticsAttributes(contentlet: DotCMSBasicContentlet): DotAnalyticsAttributes;
 /**
  *
  *

package/src/lib/editor/internal.d.ts

@@ -1,4 +1,4 @@
-import { BlockEditorContent } from '@dotcms/types';
+import { BlockEditorNode } from '@dotcms/types';
 import { BlockEditorState, DotCMSContainerBound } from '@dotcms/types/internal';
 /**
  * Sets the bounds of the containers in the editor.
@@ -8,16 +8,19 @@ import { BlockEditorState, DotCMSContainerBound } from '@dotcms/types/internal';
  */
 export declare function setBounds(bounds: DotCMSContainerBound[]): void;
 /**
- * Validates the structure of a Block Editor block.
+ * Validates the structure of a Block Editor node.
  *
- * This function checks that:
- * 1. The blocks parameter is a valid object
- * 2. The block has a 'doc' type
- * 3. The block has a valid content array that is not empty
+ * This function performs validation checks on a BlockEditorNode object to ensure:
+ * - The node exists and is a valid object
+ * - The node has a 'doc' type
+ * - The node has a valid content array containing at least one block
+ * - Each block in the content array:
+ *   - Has a valid string type property
+ *   - Has valid object attributes (if present)
+ *   - Has valid nested content (if present)
  *
- * @param {Block} blocks - The blocks structure to validate
- * @returns {BlockEditorState} Object containing validation state and any error message
- * @property {boolean} BlockEditorState.isValid - Whether the blocks structure is valid
- * @property {string | null} BlockEditorState.error - Error message if invalid, null if valid
+ * @param {BlockEditorNode} blocks - The BlockEditorNode structure to validate
+ * @returns {BlockEditorState} The validation result
+ * @property {string | null} BlockEditorState.error - Error message if validation fails, null if valid
  */
-export declare const isValidBlocks: (blocks: BlockEditorContent) => BlockEditorState;
+export declare const isValidBlocks: (blocks: BlockEditorNode) => BlockEditorState;