@dotcms/types 1.5.2-next.28 → 1.5.3-next.2118

package/index.cjs.js

@@ -52,9 +52,21 @@ exports.DotCMSUVEAction = void 0;
    */
   DotCMSUVEAction["SET_BOUNDS"] = "set-bounds";
   /**
-   * Send the information of the hovered contentlet
+   * Send the information of a *hovered* contentlet (fires on pointermove).
+   * The editor uses this to render the transient hover overlay around the
+   * contentlet under the cursor. Pairs with {@link SET_SELECTED_CONTENTLET}
+   * for clicks. The name is kept as `SET_CONTENTLET` for backwards
+   * compatibility with external SDK consumers — semantically it is
+   * "set hovered contentlet".
    */
   DotCMSUVEAction["SET_CONTENTLET"] = "set-contentlet";
+  /**
+   * Send the information of a contentlet that was *clicked* inside the iframe.
+   * The editor uses this to promote the clicked contentlet to "selected"
+   * (persistent action toolbar + opens the quick-edit panel). Pairs with
+   * {@link SET_CONTENTLET} which handles hover.
+   */
+  DotCMSUVEAction["SET_SELECTED_CONTENTLET"] = "set-selected-contentlet";
   /**
    * Tell the editor that the page is being scrolled
    */
@@ -131,10 +143,6 @@ exports.UVEEventType = void 0;
    * Triggered when the page needs to be reloaded
    */
   UVEEventType["PAGE_RELOAD"] = "page-reload";
-  /**
-   * Triggered when the editor requests container bounds
-   */
-  UVEEventType["REQUEST_BOUNDS"] = "request-bounds";
   /**
    * Triggered when scroll action is needed inside the iframe
    */
@@ -143,11 +151,37 @@ exports.UVEEventType = void 0;
    * Triggered when a contentlet is hovered
    */
   UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+  /**
+   * Triggered when a contentlet is clicked (capture-phase `click` event on
+   * its element). Used by the editor to promote the clicked contentlet to
+   * "selected" without the editor having to capture pointer events on its
+   * hover overlay.
+   */
+  UVEEventType["CONTENTLET_CLICKED"] = "contentlet-clicked";
   /**
    * Triggered when the editor requests a scroll to a specific page section
    * @internal
    */
   UVEEventType["SCROLL_TO_SECTION"] = "scroll-to-section";
+  /**
+   * Triggered when the editor clears its selection (resize, scroll, navigation).
+   * The SDK uses this to reset its "last selected" tracker so a subsequent click
+   * on the same contentlet re-emits CONTENTLET_CLICKED instead of being treated
+   * as a passthrough.
+   * @internal
+   */
+  UVEEventType["SELECTION_CLEARED"] = "selection-cleared";
+  /**
+   * The single bounds-sync channel. The SDK observes the iframe document
+   * and every `[data-dot-object="container"]` with a debounced
+   * ResizeObserver and emits the full page bounds whenever the layout
+   * settles (sidebar open/close, device/zoom change, media-query
+   * reflows, image/font load shifts, scroll, etc.). The editor can
+   * also send a UVE_FLUSH_BOUNDS message to bypass the debounce when it
+   * needs an immediate snapshot (drag/drop dropzone).
+   * @internal
+   */
+  UVEEventType["AUTO_BOUNDS"] = "auto-bounds";
 })(exports.UVEEventType || (exports.UVEEventType = {}));
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/index.esm.js

@@ -50,9 +50,21 @@ var DotCMSUVEAction;
    */
   DotCMSUVEAction["SET_BOUNDS"] = "set-bounds";
   /**
-   * Send the information of the hovered contentlet
+   * Send the information of a *hovered* contentlet (fires on pointermove).
+   * The editor uses this to render the transient hover overlay around the
+   * contentlet under the cursor. Pairs with {@link SET_SELECTED_CONTENTLET}
+   * for clicks. The name is kept as `SET_CONTENTLET` for backwards
+   * compatibility with external SDK consumers — semantically it is
+   * "set hovered contentlet".
    */
   DotCMSUVEAction["SET_CONTENTLET"] = "set-contentlet";
+  /**
+   * Send the information of a contentlet that was *clicked* inside the iframe.
+   * The editor uses this to promote the clicked contentlet to "selected"
+   * (persistent action toolbar + opens the quick-edit panel). Pairs with
+   * {@link SET_CONTENTLET} which handles hover.
+   */
+  DotCMSUVEAction["SET_SELECTED_CONTENTLET"] = "set-selected-contentlet";
   /**
    * Tell the editor that the page is being scrolled
    */
@@ -129,10 +141,6 @@ var UVEEventType;
    * Triggered when the page needs to be reloaded
    */
   UVEEventType["PAGE_RELOAD"] = "page-reload";
-  /**
-   * Triggered when the editor requests container bounds
-   */
-  UVEEventType["REQUEST_BOUNDS"] = "request-bounds";
   /**
    * Triggered when scroll action is needed inside the iframe
    */
@@ -141,11 +149,37 @@ var UVEEventType;
    * Triggered when a contentlet is hovered
    */
   UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+  /**
+   * Triggered when a contentlet is clicked (capture-phase `click` event on
+   * its element). Used by the editor to promote the clicked contentlet to
+   * "selected" without the editor having to capture pointer events on its
+   * hover overlay.
+   */
+  UVEEventType["CONTENTLET_CLICKED"] = "contentlet-clicked";
   /**
    * Triggered when the editor requests a scroll to a specific page section
    * @internal
    */
   UVEEventType["SCROLL_TO_SECTION"] = "scroll-to-section";
+  /**
+   * Triggered when the editor clears its selection (resize, scroll, navigation).
+   * The SDK uses this to reset its "last selected" tracker so a subsequent click
+   * on the same contentlet re-emits CONTENTLET_CLICKED instead of being treated
+   * as a passthrough.
+   * @internal
+   */
+  UVEEventType["SELECTION_CLEARED"] = "selection-cleared";
+  /**
+   * The single bounds-sync channel. The SDK observes the iframe document
+   * and every `[data-dot-object="container"]` with a debounced
+   * ResizeObserver and emits the full page bounds whenever the layout
+   * settles (sidebar open/close, device/zoom change, media-query
+   * reflows, image/font load shifts, scroll, etc.). The editor can
+   * also send a UVE_FLUSH_BOUNDS message to bypass the debounce when it
+   * needs an immediate snapshot (drag/drop dropzone).
+   * @internal
+   */
+  UVEEventType["AUTO_BOUNDS"] = "auto-bounds";
 })(UVEEventType || (UVEEventType = {}));
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/internal.cjs.js

@@ -55,7 +55,17 @@ exports.__DOTCMS_UVE_EVENT__ = void 0;
    */
   __DOTCMS_UVE_EVENT__["UVE_RELOAD_PAGE"] = "uve-reload-page";
   /**
-   * Request the bounds for the elements
+   * Tell the SDK to emit page bounds immediately, bypassing the
+   * auto-bounds debounce. Used when the editor needs a synchronous
+   * snapshot of bounds for an interaction (drag/drop dropzone) and
+   * cannot wait the ~100ms trailing edge.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_FLUSH_BOUNDS"] = "uve-flush-bounds";
+  /**
+   * @deprecated Use UVE_FLUSH_BOUNDS instead. Kept for one release so the
+   * editor can dual-emit and SDKs in the wild that still listen for the
+   * legacy `uve-request-bounds` event continue to receive flushes. Drop
+   * after the next minor release of @dotcms/uve.
    */
   __DOTCMS_UVE_EVENT__["UVE_REQUEST_BOUNDS"] = "uve-request-bounds";
   /**
@@ -80,4 +90,11 @@ exports.__DOTCMS_UVE_EVENT__ = void 0;
    * Request the iframe to scroll to a section by 1-based row index
    */
   __DOTCMS_UVE_EVENT__["UVE_SCROLL_TO_SECTION"] = "uve-scroll-to-section";
+  /**
+   * The editor cleared its contentlet selection (e.g. after a canvas resize
+   * or scroll). The SDK uses this to reset its "last selected" tracker so a
+   * subsequent click on the same contentlet re-emits CONTENTLET_CLICKED
+   * instead of being treated as a passthrough.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SELECTION_CLEARED"] = "uve-selection-cleared";
 })(exports.__DOTCMS_UVE_EVENT__ || (exports.__DOTCMS_UVE_EVENT__ = {}));

package/internal.esm.js

@@ -53,7 +53,17 @@ var __DOTCMS_UVE_EVENT__;
    */
   __DOTCMS_UVE_EVENT__["UVE_RELOAD_PAGE"] = "uve-reload-page";
   /**
-   * Request the bounds for the elements
+   * Tell the SDK to emit page bounds immediately, bypassing the
+   * auto-bounds debounce. Used when the editor needs a synchronous
+   * snapshot of bounds for an interaction (drag/drop dropzone) and
+   * cannot wait the ~100ms trailing edge.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_FLUSH_BOUNDS"] = "uve-flush-bounds";
+  /**
+   * @deprecated Use UVE_FLUSH_BOUNDS instead. Kept for one release so the
+   * editor can dual-emit and SDKs in the wild that still listen for the
+   * legacy `uve-request-bounds` event continue to receive flushes. Drop
+   * after the next minor release of @dotcms/uve.
    */
   __DOTCMS_UVE_EVENT__["UVE_REQUEST_BOUNDS"] = "uve-request-bounds";
   /**
@@ -78,6 +88,13 @@ var __DOTCMS_UVE_EVENT__;
    * Request the iframe to scroll to a section by 1-based row index
    */
   __DOTCMS_UVE_EVENT__["UVE_SCROLL_TO_SECTION"] = "uve-scroll-to-section";
+  /**
+   * The editor cleared its contentlet selection (e.g. after a canvas resize
+   * or scroll). The SDK uses this to reset its "last selected" tracker so a
+   * subsequent click on the same contentlet re-emits CONTENTLET_CLICKED
+   * instead of being treated as a passthrough.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SELECTION_CLEARED"] = "uve-selection-cleared";
 })(__DOTCMS_UVE_EVENT__ || (__DOTCMS_UVE_EVENT__ = {}));
 
 export { BlockEditorDefaultBlocks, __DOTCMS_UVE_EVENT__ };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/types",
-  "version": "1.5.2-next.28",
+  "version": "1.5.3-next.2118",
   "keywords": [
     "dotCMS",
     "CMS",

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

@@ -94,9 +94,21 @@ export declare enum DotCMSUVEAction {
      */
     SET_BOUNDS = "set-bounds",
     /**
-     * Send the information of the hovered contentlet
+     * Send the information of a *hovered* contentlet (fires on pointermove).
+     * The editor uses this to render the transient hover overlay around the
+     * contentlet under the cursor. Pairs with {@link SET_SELECTED_CONTENTLET}
+     * for clicks. The name is kept as `SET_CONTENTLET` for backwards
+     * compatibility with external SDK consumers — semantically it is
+     * "set hovered contentlet".
      */
     SET_CONTENTLET = "set-contentlet",
+    /**
+     * Send the information of a contentlet that was *clicked* inside the iframe.
+     * The editor uses this to promote the clicked contentlet to "selected"
+     * (persistent action toolbar + opens the quick-edit panel). Pairs with
+     * {@link SET_CONTENTLET} which handles hover.
+     */
+    SET_SELECTED_CONTENTLET = "set-selected-contentlet",
     /**
      * Tell the editor that the page is being scrolled
      */
@@ -178,10 +190,6 @@ export declare enum UVEEventType {
      * Triggered when the page needs to be reloaded
      */
     PAGE_RELOAD = "page-reload",
-    /**
-     * Triggered when the editor requests container bounds
-     */
-    REQUEST_BOUNDS = "request-bounds",
     /**
      * Triggered when scroll action is needed inside the iframe
      */
@@ -190,11 +198,37 @@ export declare enum UVEEventType {
      * Triggered when a contentlet is hovered
      */
     CONTENTLET_HOVERED = "contentlet-hovered",
+    /**
+     * Triggered when a contentlet is clicked (capture-phase `click` event on
+     * its element). Used by the editor to promote the clicked contentlet to
+     * "selected" without the editor having to capture pointer events on its
+     * hover overlay.
+     */
+    CONTENTLET_CLICKED = "contentlet-clicked",
     /**
      * Triggered when the editor requests a scroll to a specific page section
      * @internal
      */
-    SCROLL_TO_SECTION = "scroll-to-section"
+    SCROLL_TO_SECTION = "scroll-to-section",
+    /**
+     * Triggered when the editor clears its selection (resize, scroll, navigation).
+     * The SDK uses this to reset its "last selected" tracker so a subsequent click
+     * on the same contentlet re-emits CONTENTLET_CLICKED instead of being treated
+     * as a passthrough.
+     * @internal
+     */
+    SELECTION_CLEARED = "selection-cleared",
+    /**
+     * The single bounds-sync channel. The SDK observes the iframe document
+     * and every `[data-dot-object="container"]` with a debounced
+     * ResizeObserver and emits the full page bounds whenever the layout
+     * settles (sidebar open/close, device/zoom change, media-query
+     * reflows, image/font load shifts, scroll, etc.). The editor can
+     * also send a UVE_FLUSH_BOUNDS message to bypass the debounce when it
+     * needs an immediate snapshot (drag/drop dropzone).
+     * @internal
+     */
+    AUTO_BOUNDS = "auto-bounds"
 }
 /**
  * Type definitions for each event's payload
@@ -202,12 +236,14 @@ export declare enum UVEEventType {
 export type UVEEventPayloadMap = {
     [UVEEventType.CONTENT_CHANGES]: DotCMSPageResponse;
     [UVEEventType.PAGE_RELOAD]: undefined;
-    [UVEEventType.REQUEST_BOUNDS]: DotCMSContainerBound[];
     [UVEEventType.IFRAME_SCROLL]: 'up' | 'down';
     [UVEEventType.CONTENTLET_HOVERED]: unknown;
+    [UVEEventType.CONTENTLET_CLICKED]: unknown;
     [UVEEventType.SCROLL_TO_SECTION]: {
         sectionIndex: number;
     };
+    [UVEEventType.SELECTION_CLEARED]: undefined;
+    [UVEEventType.AUTO_BOUNDS]: DotCMSContainerBound[];
 };
 /**
  *

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

@@ -10,7 +10,17 @@ export declare enum __DOTCMS_UVE_EVENT__ {
      */
     UVE_RELOAD_PAGE = "uve-reload-page",
     /**
-     * Request the bounds for the elements
+     * Tell the SDK to emit page bounds immediately, bypassing the
+     * auto-bounds debounce. Used when the editor needs a synchronous
+     * snapshot of bounds for an interaction (drag/drop dropzone) and
+     * cannot wait the ~100ms trailing edge.
+     */
+    UVE_FLUSH_BOUNDS = "uve-flush-bounds",
+    /**
+     * @deprecated Use UVE_FLUSH_BOUNDS instead. Kept for one release so the
+     * editor can dual-emit and SDKs in the wild that still listen for the
+     * legacy `uve-request-bounds` event continue to receive flushes. Drop
+     * after the next minor release of @dotcms/uve.
      */
     UVE_REQUEST_BOUNDS = "uve-request-bounds",
     /**
@@ -34,5 +44,12 @@ export declare enum __DOTCMS_UVE_EVENT__ {
     /**
      * Request the iframe to scroll to a section by 1-based row index
      */
-    UVE_SCROLL_TO_SECTION = "uve-scroll-to-section"
+    UVE_SCROLL_TO_SECTION = "uve-scroll-to-section",
+    /**
+     * The editor cleared its contentlet selection (e.g. after a canvas resize
+     * or scroll). The SDK uses this to reset its "last selected" tracker so a
+     * subsequent click on the same contentlet re-emits CONTENTLET_CLICKED
+     * instead of being treated as a passthrough.
+     */
+    UVE_SELECTION_CLEARED = "uve-selection-cleared"
 }

package/src/lib/page/public.d.ts

@@ -544,6 +544,7 @@ export interface DotCMSPage {
     liveInode: string;
     shortyLive: string;
     canSeeRules?: boolean;
+    styleEditorSchemas?: StyleEditorFormSchema[];
 }
 /**
  * Represents the language configuration for a DotCMS page
@@ -1106,6 +1107,7 @@ export interface DotCMSGraphQLPage {
     host: DotCMSSite;
     vanityUrl: DotCMSVanityUrl;
     _map: Record<string, unknown>;
+    styleEditorSchemas?: StyleEditorFormSchema[] | null;
 }
 /**
  * Represents a container in a page