@dotcms/uve 0.0.1-beta.9 → 1.0.0

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

@@ -1,138 +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"
-}
-/**
- * Callback function for UVE events
- * @callback UVECallback
- * @param {unknown} payload - The payload of the event
- */
-export type UVECallback = (payload: unknown) => void;
-/**
- * Unsubscribe function for UVE events
- * @callback UnsubscribeUVE
- */
-export type UnsubscribeUVE = () => void;
-/**
- * UVESubscription type
- * @typedef {Object} UVESubscription
- * @property {UnsubscribeUVE} unsubscribe - The unsubscribe function for the UVE event
- * @property {string} event - The event name
- */
-export type UVESubscription = {
-    unsubscribe: UnsubscribeUVE;
-    event: string;
-};
-/**
- * UVE event type
- * @typedef {function} UVEEvent
- */
-export type UVEEvent = (callback: UVECallback) => UVESubscription;
-/**
- * Configuration type for DotCMS Editor
- * @typedef {Object} DotCMSEditoConfig
- * @property {Object} [params] - Parameters for Page API configuration
- * @property {number} [params.depth] - The depth level for fetching page data
- * @property {string} [query] - GraphQL query string for data fetching
- */
-export type DotCMSEditorConfig = {
-    params: {
-        depth: number;
-    };
-} | {
-    query: string;
-};
-/**
- * Actions send to the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export declare enum DotCMSUVEAction {
-    /**
-     * Tell the dotcms editor that page change
-     */
-    NAVIGATION_UPDATE = "set-url",
-    /**
-     * Send the element position of the rows, columnsm containers and contentlets
-     */
-    SET_BOUNDS = "set-bounds",
-    /**
-     * Send the information of the hovered contentlet
-     */
-    SET_CONTENTLET = "set-contentlet",
-    /**
-     * Tell the editor that the page is being scrolled
-     */
-    IFRAME_SCROLL = "scroll",
-    /**
-     * Tell the editor that the page has stopped scrolling
-     */
-    IFRAME_SCROLL_END = "scroll-end",
-    /**
-     * Ping the editor to see if the page is inside the editor
-     */
-    PING_EDITOR = "ping-editor",
-    /**
-     * Tell the editor to init the inline editing editor.
-     */
-    INIT_INLINE_EDITING = "init-inline-editing",
-    /**
-     * Tell the editor to open the Copy-contentlet dialog
-     * To copy a content and then edit it inline.
-     */
-    COPY_CONTENTLET_INLINE_EDITING = "copy-contentlet-inline-editing",
-    /**
-     * Tell the editor to save inline edited contentlet
-     */
-    UPDATE_CONTENTLET_INLINE_EDITING = "update-contentlet-inline-editing",
-    /**
-     * Tell the editor to trigger a menu reorder
-     */
-    REORDER_MENU = "reorder-menu",
-    /**
-     * Tell the editor to send the page info to iframe
-     */
-    GET_PAGE_DATA = "get-page-data",
-    /**
-     * Tell the editor an user send a graphql query
-     */
-    CLIENT_READY = "client-ready",
-    /**
-     * Tell the editor to edit a contentlet
-     */
-    EDIT_CONTENTLET = "edit-contentlet",
-    /**
-     * Tell the editor to do nothing
-     */
-    NOOP = "noop"
-}

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

@@ -1,32 +0,0 @@
-/**
- * Actions received from the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export declare enum __DOTCMS_UVE_EVENT__ {
-    /**
-     * Request to page to reload
-     */
-    UVE_RELOAD_PAGE = "uve-reload-page",
-    /**
-     * Request the bounds for the elements
-     */
-    UVE_REQUEST_BOUNDS = "uve-request-bounds",
-    /**
-     * Received pong from the editor
-     */
-    UVE_EDITOR_PONG = "uve-editor-pong",
-    /**
-     * Received scroll event trigger from the editor
-     */
-    UVE_SCROLL_INSIDE_IFRAME = "uve-scroll-inside-iframe",
-    /**
-     * Set the page data
-     */
-    UVE_SET_PAGE_DATA = "uve-set-page-data",
-    /**
-     * Copy contentlet inline editing success
-     */
-    UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS = "uve-copy-contentlet-inline-editing-success"
-}

package/src/lib/types/events/public.d.ts

@@ -1,18 +0,0 @@
-export type DotCMSInlineEditingType = 'BLOCK_EDITOR' | 'WYSIWYG';
-/**
- * Interface representing the data needed for inline editing in DotCMS
- *
- * @interface DotCMSInlineEditorData
- * @property {string} inode - The inode identifier of the content being edited
- * @property {number} language - The language ID of the content
- * @property {string} contentType - The content type identifier
- * @property {string} fieldName - The name of the field being edited
- * @property {Record<string, unknown>} content - The content data as key-value pairs
- */
-export interface DotCMSInlineEditingPayload {
-    inode: string;
-    language: number;
-    contentType: string;
-    fieldName: string;
-    content: Record<string, unknown>;
-}

package/src/types.d.ts

@@ -1,2 +0,0 @@
-export * from './lib/types/editor/public';
-export * from './lib/types/events/public';

package/types.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./src/types";

package/types.cjs.default.js

@@ -1 +0,0 @@
-exports._default = require('./types.cjs.js').default;

package/types.cjs.js

@@ -1,84 +0,0 @@
-'use strict';
-
-/**
- * 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
- */
-exports.UVE_MODE = void 0;
-(function (UVE_MODE) {
-  UVE_MODE["EDIT"] = "EDIT_MODE";
-  UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
-  UVE_MODE["LIVE"] = "LIVE";
-  UVE_MODE["UNKNOWN"] = "UNKNOWN";
-})(exports.UVE_MODE || (exports.UVE_MODE = {}));
-/**
- * Actions send to the dotcms editor
- *
- * @export
- * @enum {number}
- */
-exports.DotCMSUVEAction = void 0;
-(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";
-})(exports.DotCMSUVEAction || (exports.DotCMSUVEAction = {}));

package/types.cjs.mjs

@@ -1,2 +0,0 @@
-export * from './types.cjs.js';
-export { _default as default } from './types.cjs.default.js';

package/types.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/types";

package/types.esm.js

@@ -1,84 +0,0 @@
-/**
- * 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
- */
-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 || (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 = {}));
-
-export { DotCMSUVEAction, UVE_MODE };