@dotcms/types 1.4.0-next.2 → 1.4.0-next.3

package/index.cjs.js

@@ -100,6 +100,10 @@ exports.DotCMSUVEAction = void 0;
    * Tell the editor to register style schemas
    */
   DotCMSUVEAction["REGISTER_STYLE_SCHEMAS"] = "register-style-schemas";
+  /**
+   * Tell the editor to report the iframe height
+   */
+  DotCMSUVEAction["IFRAME_HEIGHT"] = "iframe-height";
   /**
    * Tell the editor to create a contentlet without adding it to the page
    */
@@ -108,6 +112,10 @@ exports.DotCMSUVEAction = void 0;
    * Tell the editor to do nothing
    */
   DotCMSUVEAction["NOOP"] = "noop";
+  /**
+   * Report the offsetTop of a page section so the editor can scroll to it
+   */
+  DotCMSUVEAction["SECTION_OFFSET"] = "section-offset";
 })(exports.DotCMSUVEAction || (exports.DotCMSUVEAction = {}));
 /**
  * Available events in the Universal Visual Editor
@@ -135,6 +143,11 @@ exports.UVEEventType = void 0;
    * Triggered when a contentlet is hovered
    */
   UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+  /**
+   * Triggered when the editor requests a scroll to a specific page section
+   * @internal
+   */
+  UVEEventType["SCROLL_TO_SECTION"] = "scroll-to-section";
 })(exports.UVEEventType || (exports.UVEEventType = {}));
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/index.esm.js

@@ -98,6 +98,10 @@ var DotCMSUVEAction;
    * Tell the editor to register style schemas
    */
   DotCMSUVEAction["REGISTER_STYLE_SCHEMAS"] = "register-style-schemas";
+  /**
+   * Tell the editor to report the iframe height
+   */
+  DotCMSUVEAction["IFRAME_HEIGHT"] = "iframe-height";
   /**
    * Tell the editor to create a contentlet without adding it to the page
    */
@@ -106,6 +110,10 @@ var DotCMSUVEAction;
    * Tell the editor to do nothing
    */
   DotCMSUVEAction["NOOP"] = "noop";
+  /**
+   * Report the offsetTop of a page section so the editor can scroll to it
+   */
+  DotCMSUVEAction["SECTION_OFFSET"] = "section-offset";
 })(DotCMSUVEAction || (DotCMSUVEAction = {}));
 /**
  * Available events in the Universal Visual Editor
@@ -133,6 +141,11 @@ var UVEEventType;
    * Triggered when a contentlet is hovered
    */
   UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+  /**
+   * Triggered when the editor requests a scroll to a specific page section
+   * @internal
+   */
+  UVEEventType["SCROLL_TO_SECTION"] = "scroll-to-section";
 })(UVEEventType || (UVEEventType = {}));
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/internal.cjs.js

@@ -76,4 +76,8 @@ exports.__DOTCMS_UVE_EVENT__ = void 0;
    * Copy contentlet inline editing success
    */
   __DOTCMS_UVE_EVENT__["UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS"] = "uve-copy-contentlet-inline-editing-success";
+  /**
+   * Request the iframe to scroll to a section by 1-based row index
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SCROLL_TO_SECTION"] = "uve-scroll-to-section";
 })(exports.__DOTCMS_UVE_EVENT__ || (exports.__DOTCMS_UVE_EVENT__ = {}));

package/internal.esm.js

@@ -74,6 +74,10 @@ var __DOTCMS_UVE_EVENT__;
    * Copy contentlet inline editing success
    */
   __DOTCMS_UVE_EVENT__["UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS"] = "uve-copy-contentlet-inline-editing-success";
+  /**
+   * Request the iframe to scroll to a section by 1-based row index
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SCROLL_TO_SECTION"] = "uve-scroll-to-section";
 })(__DOTCMS_UVE_EVENT__ || (__DOTCMS_UVE_EVENT__ = {}));
 
 export { BlockEditorDefaultBlocks, __DOTCMS_UVE_EVENT__ };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/types",
-  "version": "1.4.0-next.2",
+  "version": "1.4.0-next.3",
   "keywords": [
     "dotCMS",
     "CMS",

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

@@ -142,6 +142,10 @@ export declare enum DotCMSUVEAction {
      * Tell the editor to register style schemas
      */
     REGISTER_STYLE_SCHEMAS = "register-style-schemas",
+    /**
+     * Tell the editor to report the iframe height
+     */
+    IFRAME_HEIGHT = "iframe-height",
     /**
      * Tell the editor to create a contentlet without adding it to the page
      */
@@ -149,7 +153,11 @@ export declare enum DotCMSUVEAction {
     /**
      * Tell the editor to do nothing
      */
-    NOOP = "noop"
+    NOOP = "noop",
+    /**
+     * Report the offsetTop of a page section so the editor can scroll to it
+     */
+    SECTION_OFFSET = "section-offset"
 }
 /**
  * The contentlet has the main fields and the custom fields of the content type.
@@ -181,7 +189,12 @@ export declare enum UVEEventType {
     /**
      * Triggered when a contentlet is hovered
      */
-    CONTENTLET_HOVERED = "contentlet-hovered"
+    CONTENTLET_HOVERED = "contentlet-hovered",
+    /**
+     * Triggered when the editor requests a scroll to a specific page section
+     * @internal
+     */
+    SCROLL_TO_SECTION = "scroll-to-section"
 }
 /**
  * Type definitions for each event's payload
@@ -192,6 +205,9 @@ export type UVEEventPayloadMap = {
     [UVEEventType.REQUEST_BOUNDS]: DotCMSContainerBound[];
     [UVEEventType.IFRAME_SCROLL]: 'up' | 'down';
     [UVEEventType.CONTENTLET_HOVERED]: unknown;
+    [UVEEventType.SCROLL_TO_SECTION]: {
+        sectionIndex: number;
+    };
 };
 /**
  *

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

@@ -30,5 +30,9 @@ export declare enum __DOTCMS_UVE_EVENT__ {
     /**
      * Copy contentlet inline editing success
      */
-    UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS = "uve-copy-contentlet-inline-editing-success"
+    UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS = "uve-copy-contentlet-inline-editing-success",
+    /**
+     * Request the iframe to scroll to a section by 1-based row index
+     */
+    UVE_SCROLL_TO_SECTION = "uve-scroll-to-section"
 }

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

@@ -74,6 +74,7 @@ export interface DotPageAssetLayoutRow {
     id?: string;
     columns: DotPageAssetLayoutColumn[];
     styleClass?: string;
+    metadata?: Record<string, unknown>;
 }
 /**
  * Represents a vanity URL configuration for URL redirection and forwarding
@@ -126,6 +127,7 @@ export interface DotPageAssetLayoutColumn {
     leftOffset: number;
     left: number;
     styleClass?: string;
+    metadata?: Record<string, unknown>;
 }
 /**
  * Represents a container within a column in a page layout