@dotcms/uve 0.0.1-beta.2 → 0.0.1-beta.21

package/types.esm.js

@@ -9,10 +9,103 @@
  */
 var UVE_MODE;
 (function (UVE_MODE) {
-    UVE_MODE["EDIT"] = "EDIT_MODE";
-    UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
-    UVE_MODE["LIVE"] = "LIVE";
-    UVE_MODE["UNKNOWN"] = "UNKNOWN";
+  UVE_MODE["EDIT"] = "EDIT_MODE";
+  UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
+  UVE_MODE["LIVE"] = "LIVE";
+  UVE_MODE["UNKNOWN"] = "UNKNOWN";
 })(UVE_MODE || (UVE_MODE = {}));
+/**
+ * Actions send to the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+var DotCMSUVEAction;
+(function (DotCMSUVEAction) {
+  /**
+   * Tell the dotcms editor that page change
+   */
+  DotCMSUVEAction["NAVIGATION_UPDATE"] = "set-url";
+  /**
+   * Send the element position of the rows, columnsm containers and contentlets
+   */
+  DotCMSUVEAction["SET_BOUNDS"] = "set-bounds";
+  /**
+   * Send the information of the hovered contentlet
+   */
+  DotCMSUVEAction["SET_CONTENTLET"] = "set-contentlet";
+  /**
+   * Tell the editor that the page is being scrolled
+   */
+  DotCMSUVEAction["IFRAME_SCROLL"] = "scroll";
+  /**
+   * Tell the editor that the page has stopped scrolling
+   */
+  DotCMSUVEAction["IFRAME_SCROLL_END"] = "scroll-end";
+  /**
+   * Ping the editor to see if the page is inside the editor
+   */
+  DotCMSUVEAction["PING_EDITOR"] = "ping-editor";
+  /**
+   * Tell the editor to init the inline editing editor.
+   */
+  DotCMSUVEAction["INIT_INLINE_EDITING"] = "init-inline-editing";
+  /**
+   * Tell the editor to open the Copy-contentlet dialog
+   * To copy a content and then edit it inline.
+   */
+  DotCMSUVEAction["COPY_CONTENTLET_INLINE_EDITING"] = "copy-contentlet-inline-editing";
+  /**
+   * Tell the editor to save inline edited contentlet
+   */
+  DotCMSUVEAction["UPDATE_CONTENTLET_INLINE_EDITING"] = "update-contentlet-inline-editing";
+  /**
+   * Tell the editor to trigger a menu reorder
+   */
+  DotCMSUVEAction["REORDER_MENU"] = "reorder-menu";
+  /**
+   * Tell the editor to send the page info to iframe
+   */
+  DotCMSUVEAction["GET_PAGE_DATA"] = "get-page-data";
+  /**
+   * Tell the editor an user send a graphql query
+   */
+  DotCMSUVEAction["CLIENT_READY"] = "client-ready";
+  /**
+   * Tell the editor to edit a contentlet
+   */
+  DotCMSUVEAction["EDIT_CONTENTLET"] = "edit-contentlet";
+  /**
+   * Tell the editor to do nothing
+   */
+  DotCMSUVEAction["NOOP"] = "noop";
+})(DotCMSUVEAction || (DotCMSUVEAction = {}));
+/**
+ * Available events in the Universal Visual Editor
+ * @enum {string}
+ */
+var UVEEventType;
+(function (UVEEventType) {
+  /**
+   * Triggered when page data changes from the editor
+   */
+  UVEEventType["CONTENT_CHANGES"] = "changes";
+  /**
+   * 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
+   */
+  UVEEventType["IFRAME_SCROLL"] = "iframe-scroll";
+  /**
+   * Triggered when a contentlet is hovered
+   */
+  UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+})(UVEEventType || (UVEEventType = {}));
 
-export { UVE_MODE };
+export { DotCMSUVEAction, UVEEventType, UVE_MODE };

package/src/lib/types.d.ts

@@ -1,33 +0,0 @@
-/**
- * Represents the state of the Universal Visual Editor (UVE)
- * @interface
- * @property {UVE_MODE} mode - The current mode of operation for UVE (EDIT, PREVIEW, LIVE, or UNKNOWN)
- * @property {string | null} persona - The selected persona for content personalization
- * @property {string | null} variantName - The name of the current content variant
- * @property {string | null} experimentId - The identifier for the current A/B testing experiment
- * @property {string | null} publishDate - The scheduled publish date for content
- * @property {string | null} languageId - The identifier for the current language selection
- */
-export interface UVEState {
-    mode: UVE_MODE;
-    persona: string | null;
-    variantName: string | null;
-    experimentId: string | null;
-    publishDate: string | null;
-    languageId: string | null;
-}
-/**
- * Possible modes of UVE (Universal Visual Editor)
- * @enum {string}
- *
- * @property {string} LIVE - Shows published and future content
- * @property {string} PREVIEW - Shows published and working content
- * @property {string} EDIT - Enables content editing functionality in UVE
- * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
- */
-export declare enum UVE_MODE {
-    EDIT = "EDIT_MODE",
-    PREVIEW = "PREVIEW_MODE",
-    LIVE = "LIVE",
-    UNKNOWN = "UNKNOWN"
-}

package/src/public/index.d.ts

@@ -1,2 +0,0 @@
-import { getUVEState } from '../lib/utils';
-export { getUVEState };

package/src/public/types.d.ts

@@ -1,2 +0,0 @@
-import { UVE_MODE, UVEState } from '../lib/types';
-export { UVE_MODE, UVEState };