@dotcms/types - npm Package Compare versions

Comparing version 1.5.2 to 1.5.3-next.2118

index.cjs.js

@@ -55,6 +55,18 @@ 'use strict';
   /**
-   * 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
@@ -136,6 +148,2 @@ */
   /**
-   * Triggered when the editor requests container bounds
-   */
-  UVEEventType["REQUEST_BOUNDS"] = "request-bounds";
-  /**
    * Triggered when scroll action is needed inside the iframe
@@ -149,2 +157,9 @@ */
   /**
+   * 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
@@ -154,2 +169,21 @@ * @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 = {}));
@@ -156,0 +190,0 @@

index.esm.js

@@ -53,6 +53,18 @@ const DotCMSEntityState = {
   /**
-   * 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
@@ -134,6 +146,2 @@ */
   /**
-   * Triggered when the editor requests container bounds
-   */
-  UVEEventType["REQUEST_BOUNDS"] = "request-bounds";
-  /**
    * Triggered when scroll action is needed inside the iframe
@@ -147,2 +155,9 @@ */
   /**
+   * 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
@@ -152,2 +167,21 @@ * @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 = {}));
@@ -154,0 +188,0 @@

internal.cjs.js

@@ -58,4 +58,14 @@ 'use strict';
   /**
-   * 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";
@@ -84,2 +94,9 @@ /**
   __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__ = {}));

internal.esm.js

@@ -56,4 +56,14 @@ /**
   /**
-   * 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";
@@ -82,4 +92,11 @@ /**
   __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.json

 {
   "name": "@dotcms/types",
-  "version": "1.5.2",
+  "version": "1.5.3-next.2118",
   "keywords": [
@@ -39,2 +39,2 @@ "dotCMS",
   "types": "./index.d.ts"
-}
+}

src/lib/editor/public.d.ts

@@ -97,6 +97,18 @@ import { DotCMSContainerBound } from './internal';
     /**
-     * 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
@@ -183,6 +195,2 @@ */
     /**
-     * Triggered when the editor requests container bounds
-     */
-    REQUEST_BOUNDS = "request-bounds",
-    /**
      * Triggered when scroll action is needed inside the iframe
@@ -196,6 +204,32 @@ */
     /**
+     * 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"
 }
@@ -208,8 +242,10 @@ /**
     [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[];
 };
@@ -216,0 +252,0 @@ /**

src/lib/events/internal.d.ts

@@ -13,4 +13,14 @@ /**
     /**
-     * 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",
@@ -38,3 +48,10 @@ /**
      */
-    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"
 }

src/lib/page/public.d.ts

@@ -547,2 +547,3 @@ import { DotHttpError } from '../client/public';
     canSeeRules?: boolean;
+    styleEditorSchemas?: StyleEditorFormSchema[];
 }
@@ -1110,2 +1111,3 @@ /**
     _map: Record<string, unknown>;
+    styleEditorSchemas?: StyleEditorFormSchema[] | null;
 }
@@ -1112,0 +1114,0 @@ /**

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

147721

6%

Lines of code

3746

4.37%

Worsened metrics

Number of low quality alerts

2

100%

No dependency changes