@dotcms/client 0.0.1-alpha.3 → 0.0.1-alpha.30

package/src/lib/editor/listeners/listeners.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listeners.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/listeners/listeners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAgC,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC1F,OAAO,EACH,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,mBAAmB,EACnB,gBAAgB,EACnB,MAAM,uBAAuB,CAAC;AAQ/B;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAmC,EAAE,CAAC;AAEhE;;;;;GAKG;AACH,SAAS,SAAS;IACd,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CACzB,QAAQ,CAAC,gBAAgB,CAAC,+BAA+B,CAAC,CACzC,CAAC;IACtB,MAAM,YAAY,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAErD,mBAAmB,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,UAAU;QACnC,OAAO,EAAE,YAAY;KACxB,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB;IAChC,MAAM,eAAe,GAAG,CAAC,KAAmB,EAAE,EAAE;QAC5C,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC;gBACtC,SAAS,EAAE,CAAC;gBACZ,MAAM;YACV,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe,CAAC,wBAAwB,EAAE,CAAC;YAC/D,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;YAEvC,IACI,CAAC,MAAM,CAAC,OAAO,KAAK,CAAC,IAAI,SAAS,KAAK,IAAI,CAAC;gBAC5C,CAAC,gBAAgB,EAAE,IAAI,SAAS,KAAK,MAAM,CAAC,EAC9C,CAAC;gBACC;;;oBAGI;gBACJ,OAAO;YACX,CAAC;YAED,MAAM,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YAChD,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACnE,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAEpD,aAAa,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,eAAe;KAC5B,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB;IACnC,MAAM,mBAAmB,GAAG,CAAC,KAAmB,EAAE,EAAE;QAChD,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAC,MAAqB,CAAC,CAAC;QAEjE,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,qBAAqB,EAAE,CAAC;QAErE,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;QAExE,MAAM,2BAA2B,GAAG;YAChC,UAAU,EAAE,uBAAuB;YACnC,KAAK,EAAE,uBAAuB;YAC9B,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,8BAA8B;YACrC,WAAW,EAAE,uBAAuB;YACpC,QAAQ,EAAE,uBAAuB;YACjC,eAAe,EAAE,CAAC;SACrB,CAAC;QAEF,MAAM,UAAU,GAAG;YACf,UAAU,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC;YACnD,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;YACzC,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;YACzC,WAAW,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC;YAC9C,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,aAAa,CAAC;YAC/C,WAAW,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC;YACrD,eAAe,EAAE,YAAY,CAAC,OAAO,EAAE,CAAC,oBAAoB,CAAC;SAChE,CAAC;QAEF,MAAM,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,iBAAiB,GAAG;YACtB,SAAS;YACL,4DAA4D;YAC5D,0CAA0C;YAC1C,YAAY,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC;gBAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;gBACpD,CAAC,CAAC,uBAAuB,CAAC,YAAY,CAAC;YAC/C,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,UAAU;YAClE,QAAQ;SACX,CAAC;QAEF,mBAAmB,CAAC;YAChB,MAAM,EAAE,gBAAgB,CAAC,cAAc;YACvC,OAAO,EAAE;gBACL,CAAC;gBACD,CAAC;gBACD,KAAK;gBACL,MAAM;gBACN,OAAO,EAAE,iBAAiB;aAC7B;SACJ,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAE9D,aAAa,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,mBAAmB;KAChC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa;IACzB,MAAM,cAAc,GAAG,GAAG,EAAE;QACxB,mBAAmB,CAAC;YAChB,MAAM,EAAE,gBAAgB,CAAC,aAAa;SACzC,CAAC,CAAC;QACH,MAAM,CAAC,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC;IAChD,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC3B,mBAAmB,CAAC;YAChB,MAAM,EAAE,gBAAgB,CAAC,iBAAiB;SAC7C,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAClD,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAExD,aAAa,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,iBAAiB;KAC9B,CAAC,CAAC;IAEH,aAAa,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,cAAc;KAC3B,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB;IAClC,MAAM,sBAAsB,GAAG,GAAG,EAAE;QAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC,CAAC;IAEF,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACxD,aAAa,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,sBAAsB;KACnC,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,QAAgB;IACvD,mBAAmB,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,aAAa;QACtC,OAAO,EAAE;YACL,QAAQ;SACX;KACJ,CAAC,CAAC;AACP,CAAC"}

package/src/lib/{postMessageToEditor.d.ts → editor/models/client.model.d.ts}

@@ -8,7 +8,7 @@ export declare enum CUSTOMER_ACTIONS {
     /**
      * Tell the dotcms editor that page change
      */
-    SET_URL = "set-url",
+    NAVIGATION_UPDATE = "set-url",
     /**
      * Send the element position of the rows, columnsm containers and contentlets
      */
@@ -21,10 +21,42 @@ export declare enum CUSTOMER_ACTIONS {
      * 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 do nothing
+     */
     NOOP = "noop"
 }
 /**

package/src/lib/editor/models/client.model.js

@@ -0,0 +1,73 @@
+/**
+ * Actions send to the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+export var CUSTOMER_ACTIONS;
+(function (CUSTOMER_ACTIONS) {
+    /**
+     * Tell the dotcms editor that page change
+     */
+    CUSTOMER_ACTIONS["NAVIGATION_UPDATE"] = "set-url";
+    /**
+     * Send the element position of the rows, columnsm containers and contentlets
+     */
+    CUSTOMER_ACTIONS["SET_BOUNDS"] = "set-bounds";
+    /**
+     * Send the information of the hovered contentlet
+     */
+    CUSTOMER_ACTIONS["SET_CONTENTLET"] = "set-contentlet";
+    /**
+     * Tell the editor that the page is being scrolled
+     */
+    CUSTOMER_ACTIONS["IFRAME_SCROLL"] = "scroll";
+    /**
+     * Tell the editor that the page has stopped scrolling
+     */
+    CUSTOMER_ACTIONS["IFRAME_SCROLL_END"] = "scroll-end";
+    /**
+     * Ping the editor to see if the page is inside the editor
+     */
+    CUSTOMER_ACTIONS["PING_EDITOR"] = "ping-editor";
+    /**
+     * Tell the editor to init the inline editing editor.
+     */
+    CUSTOMER_ACTIONS["INIT_INLINE_EDITING"] = "init-inline-editing";
+    /**
+     * Tell the editor to open the Copy-contentlet dialog
+     * To copy a content and then edit it inline.
+     */
+    CUSTOMER_ACTIONS["COPY_CONTENTLET_INLINE_EDITING"] = "copy-contentlet-inline-editing";
+    /**
+     * Tell the editor to save inline edited contentlet
+     */
+    CUSTOMER_ACTIONS["UPDATE_CONTENTLET_INLINE_EDITING"] = "update-contentlet-inline-editing";
+    /**
+     * Tell the editor to trigger a menu reorder
+     */
+    CUSTOMER_ACTIONS["REORDER_MENU"] = "reorder-menu";
+    /**
+     * Tell the editor to send the page info to iframe
+     */
+    CUSTOMER_ACTIONS["GET_PAGE_DATA"] = "get-page-data";
+    /**
+     * Tell the editor an user send a graphql query
+     */
+    CUSTOMER_ACTIONS["CLIENT_READY"] = "client-ready";
+    /**
+     * Tell the editor to do nothing
+     */
+    CUSTOMER_ACTIONS["NOOP"] = "noop";
+})(CUSTOMER_ACTIONS || (CUSTOMER_ACTIONS = {}));
+/**
+ * Post message to dotcms page editor
+ *
+ * @export
+ * @template T
+ * @param {PostMessageProps<T>} message
+ */
+export function postMessageToEditor(message) {
+    window.parent.postMessage(message, '*');
+}
+//# sourceMappingURL=client.model.js.map

package/src/lib/editor/models/client.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.model.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/models/client.model.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,gBAsDX;AAtDD,WAAY,gBAAgB;IACxB;;OAEG;IACH,iDAA6B,CAAA;IAC7B;;OAEG;IACH,6CAAyB,CAAA;IACzB;;OAEG;IACH,qDAAiC,CAAA;IACjC;;OAEG;IACH,4CAAwB,CAAA;IACxB;;OAEG;IACH,oDAAgC,CAAA;IAChC;;OAEG;IACH,+CAA2B,CAAA;IAC3B;;OAEG;IACH,+DAA2C,CAAA;IAC3C;;;OAGG;IACH,qFAAiE,CAAA;IACjE;;OAEG;IACH,yFAAqE,CAAA;IACrE;;OAEG;IACH,iDAA6B,CAAA;IAC7B;;OAEG;IACH,mDAA+B,CAAA;IAC/B;;OAEG;IACH,iDAA6B,CAAA;IAC7B;;OAEG;IACH,iCAAa,CAAA;AACjB,CAAC,EAtDW,gBAAgB,KAAhB,gBAAgB,QAsD3B;AAcD;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAc,OAA4B;IACzE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC"}

package/src/lib/editor/models/editor.model.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @description Custom client parameters for fetching data.
+ */
+export type CustomClientParams = {
+    depth: string;
+};
+/**
+ * @description Union type for fetch configurations.
+ * @typedef {GraphQLFetchConfig | PageAPIFetchConfig} DotCMSFetchConfig
+ */
+export type EditorConfig = {
+    params: CustomClientParams;
+} | {
+    query: string;
+};
+/**
+ * Represents the configuration options for the DotCMS page editor.
+ * @export
+ * @interface DotCMSPageEditorConfig
+ */
+export interface DotCMSPageEditorConfig {
+    /**
+     * The pathname of the page being edited. Optional.
+     * @type {string}
+     */
+    pathname: string;
+    /**
+     *
+     * @type {DotCMSFetchConfig}
+     * @memberof DotCMSPageEditorConfig
+     * @description The configuration custom params for data fetching on Edit Mode.
+     * @example <caption>Example with Custom GraphQL query</caption>
+     * const config: DotCMSPageEditorConfig = {
+     *   editor: { query: 'query { ... }' }
+     * };
+     *
+     * @example <caption>Example usage with Custom Page API parameters</caption>
+     * const config: DotCMSPageEditorConfig = {
+     *   editor: { params: { depth: '2' } }
+     * };
+     */
+    editor?: EditorConfig;
+    /**
+     * The reload function to call when the page is reloaded.
+     * @deprecated In future implementation we will be listening for the changes from the editor to update the page state so reload will not be needed.
+     * @type {Function}
+     */
+    onReload?: () => void;
+}

package/src/lib/editor/models/editor.model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=editor.model.js.map

package/src/lib/editor/models/editor.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.model.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/models/editor.model.ts"],"names":[],"mappings":""}

package/src/lib/editor/models/listeners.model.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Actions received from the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum NOTIFY_CUSTOMER {
+    /**
+     * Request to page to reload
+     */
+    EMA_RELOAD_PAGE = "ema-reload-page",
+    /**
+     * Request the bounds for the elements
+     */
+    EMA_REQUEST_BOUNDS = "ema-request-bounds",
+    /**
+     * Received pong from the editor
+     */
+    EMA_EDITOR_PONG = "ema-editor-pong",
+    /**
+     * Received scroll event trigger from the editor
+     */
+    EMA_SCROLL_INSIDE_IFRAME = "scroll-inside-iframe"
+}
+type ListenerCallbackMessage = (event: MessageEvent) => void;
+type ListenerCallbackPointer = (event: PointerEvent) => void;
+/**
+ * Listener for the dotcms editor
+ *
+ * @interface DotCMSPageEditorListener
+ */
+interface DotCMSPageEditorListener {
+    type: 'listener';
+    event: string;
+    callback: ListenerCallbackMessage | ListenerCallbackPointer;
+}
+/**
+ * Observer for the dotcms editor
+ *
+ * @interface DotCMSPageEditorObserver
+ */
+interface DotCMSPageEditorObserver {
+    type: 'observer';
+    observer: MutationObserver;
+}
+export type DotCMSPageEditorSubscription = DotCMSPageEditorListener | DotCMSPageEditorObserver;
+export {};

package/src/lib/editor/models/listeners.model.js

@@ -0,0 +1,26 @@
+/**
+ * Actions received from the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+export var NOTIFY_CUSTOMER;
+(function (NOTIFY_CUSTOMER) {
+    /**
+     * Request to page to reload
+     */
+    NOTIFY_CUSTOMER["EMA_RELOAD_PAGE"] = "ema-reload-page";
+    /**
+     * Request the bounds for the elements
+     */
+    NOTIFY_CUSTOMER["EMA_REQUEST_BOUNDS"] = "ema-request-bounds";
+    /**
+     * Received pong from the editor
+     */
+    NOTIFY_CUSTOMER["EMA_EDITOR_PONG"] = "ema-editor-pong";
+    /**
+     * Received scroll event trigger from the editor
+     */
+    NOTIFY_CUSTOMER["EMA_SCROLL_INSIDE_IFRAME"] = "scroll-inside-iframe";
+})(NOTIFY_CUSTOMER || (NOTIFY_CUSTOMER = {}));
+//# sourceMappingURL=listeners.model.js.map

package/src/lib/editor/models/listeners.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listeners.model.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/models/listeners.model.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,eAkBX;AAlBD,WAAY,eAAe;IACvB;;OAEG;IACH,sDAAmC,CAAA;IACnC;;OAEG;IACH,4DAAyC,CAAA;IACzC;;OAEG;IACH,sDAAmC,CAAA;IACnC;;OAEG;IAEH,oEAAiD,CAAA;AACrD,CAAC,EAlBW,eAAe,KAAf,eAAe,QAkB1B"}

package/src/lib/editor/sdk-editor-vtl.d.ts

@@ -0,0 +1,6 @@
+declare global {
+    interface Window {
+        lastScrollYPosition: number;
+    }
+}
+export {};

package/src/lib/editor/sdk-editor-vtl.js

@@ -0,0 +1,20 @@
+import { listenEditorMessages, listenHoveredContentlet, preserveScrollOnIframe, scrollHandler } from './listeners/listeners';
+import { isInsideEditor, addClassToEmptyContentlets } from './sdk-editor';
+/**
+ * This is the main entry point for the SDK VTL.
+ * This is added to VTL Script in the EditPage
+ *
+ * @remarks
+ * This module sets up the necessary listeners and functionality for the SDK VTL.
+ * It checks if the script is running inside the editor and then initializes the client by pinging the editor,
+ * listening for editor messages, hovered contentlet changes, and content changes.
+ *
+ */
+if (isInsideEditor()) {
+    listenEditorMessages();
+    scrollHandler();
+    preserveScrollOnIframe();
+    listenHoveredContentlet();
+    addClassToEmptyContentlets();
+}
+//# sourceMappingURL=sdk-editor-vtl.js.map

package/src/lib/editor/sdk-editor-vtl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-editor-vtl.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/client/src/lib/editor/sdk-editor-vtl.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAQ1E;;;;;;;;;GASG;AACH,IAAI,cAAc,EAAE,EAAE,CAAC;IACnB,oBAAoB,EAAE,CAAC;IACvB,aAAa,EAAE,CAAC;IAChB,sBAAsB,EAAE,CAAC;IACzB,uBAAuB,EAAE,CAAC;IAC1B,0BAA0B,EAAE,CAAC;AACjC,CAAC"}

package/src/lib/editor/sdk-editor.d.ts

@@ -0,0 +1,29 @@
+import { DotCMSPageEditorConfig } from './models/editor.model';
+/**
+ *
+ * Updates the navigation in the editor.
+ * @param {string} pathname - The pathname to update the navigation with.
+ * @memberof DotCMSPageEditor
+ */
+export declare function updateNavigation(pathname: string): void;
+/**
+ * Checks if the code is running inside an editor.
+ * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ */
+export declare function isInsideEditor(): boolean;
+/**
+ * Initializes the DotCMS page editor.
+ *
+ * @param conf - Optional configuration for the editor.
+ */
+export declare function initEditor(config: DotCMSPageEditorConfig): void;
+/**
+ * Destroys the editor by removing event listeners and disconnecting observers.
+ */
+export declare function destroyEditor(): void;
+/**
+ * Adds a class to empty contentlets.
+ *
+ * @export
+ */
+export declare function addClassToEmptyContentlets(): void;

package/src/lib/editor/sdk-editor.js

@@ -0,0 +1,65 @@
+import { fetchPageDataFromInsideUVE, listenEditorMessages, listenHoveredContentlet, scrollHandler, subscriptions } from './listeners/listeners';
+import { CUSTOMER_ACTIONS, postMessageToEditor } from './models/client.model';
+/**
+ *
+ * Updates the navigation in the editor.
+ * @param {string} pathname - The pathname to update the navigation with.
+ * @memberof DotCMSPageEditor
+ */
+export function updateNavigation(pathname) {
+    postMessageToEditor({
+        action: CUSTOMER_ACTIONS.NAVIGATION_UPDATE,
+        payload: {
+            url: pathname === '/' ? 'index' : pathname?.replace('/', '')
+        }
+    });
+}
+/**
+ * Checks if the code is running inside an editor.
+ * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ */
+export function isInsideEditor() {
+    if (typeof window === 'undefined') {
+        return false;
+    }
+    return window.parent !== window;
+}
+/**
+ * Initializes the DotCMS page editor.
+ *
+ * @param conf - Optional configuration for the editor.
+ */
+export function initEditor(config) {
+    fetchPageDataFromInsideUVE(config.pathname);
+    listenEditorMessages();
+    listenHoveredContentlet();
+    scrollHandler();
+}
+/**
+ * Destroys the editor by removing event listeners and disconnecting observers.
+ */
+export function destroyEditor() {
+    subscriptions.forEach((subscription) => {
+        if (subscription.type === 'listener') {
+            window.removeEventListener(subscription.event, subscription.callback);
+        }
+        if (subscription.type === 'observer') {
+            subscription.observer.disconnect();
+        }
+    });
+}
+/**
+ * Adds a class to empty contentlets.
+ *
+ * @export
+ */
+export function addClassToEmptyContentlets() {
+    const contentlets = document.querySelectorAll('[data-dot-object="contentlet"]');
+    contentlets.forEach((contentlet) => {
+        if (contentlet.clientHeight) {
+            return;
+        }
+        contentlet.classList.add('empty-contentlet');
+    });
+}
+//# sourceMappingURL=sdk-editor.js.map

package/src/lib/editor/sdk-editor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-editor.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/client/src/lib/editor/sdk-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,aAAa,EACb,aAAa,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG9E;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC7C,mBAAmB,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,iBAAiB;QAC1C,OAAO,EAAE;YACL,GAAG,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;SAC/D;KACJ,CAAC,CAAC;AACP,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC1B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC;AACpC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,MAA8B;IACrD,0BAA0B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5C,oBAAoB,EAAE,CAAC;IACvB,uBAAuB,EAAE,CAAC;IAC1B,aAAa,EAAE,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IACzB,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;QACnC,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,QAAyB,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACnC,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACvC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B;IACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAAC;IAEhF,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC/B,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAC1B,OAAO;QACX,CAAC;QAED,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC"}

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

@@ -0,0 +1,83 @@
+/**
+ * Bound information for a contentlet.
+ *
+ * @interface ContentletBound
+ */
+interface ContentletBound {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    payload: string;
+}
+/**
+ * Bound information for a container.
+ *
+ * @interface ContainerBound
+ */
+interface ContainerBound {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    payload: string;
+    contentlets: ContentletBound[];
+}
+/**
+ * Calculates the bounding information for each page element within the given containers.
+ *
+ * @export
+ * @param {HTMLDivElement[]} containers
+ * @return {*} An array of objects containing the bounding information for each page element.
+ */
+export declare function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[];
+/**
+ * An array of objects containing the bounding information for each contentlet inside a container.
+ *
+ * @export
+ * @param {DOMRect} containerRect
+ * @param {HTMLDivElement[]} contentlets
+ * @return {*}
+ */
+export declare function getContentletsBound(containerRect: DOMRect, contentlets: HTMLDivElement[]): ContentletBound[];
+/**
+ * Get container data from VTLS.
+ *
+ * @export
+ * @param {HTMLElement} container
+ * @return {*}
+ */
+export declare function getContainerData(container: HTMLElement): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+};
+/**
+ * Get the closest container data from the contentlet.
+ *
+ * @export
+ * @param {Element} element
+ * @return {*}
+ */
+export declare function getClosestContainerData(element: Element): {
+    acceptTypes: string;
+    identifier: string;
+    maxContentlets: string;
+    uuid: string;
+} | null;
+/**
+ * Find the closest contentlet element based on HTMLElement.
+ *
+ * @export
+ * @param {(HTMLElement | null)} element
+ * @return {*}
+ */
+export declare function findDotElement(element: HTMLElement | null): HTMLElement | null;
+export declare function findDotVTLElement(element: HTMLElement | null): HTMLElement | null;
+export declare function findVTLData(target: HTMLElement): {
+    inode: string | undefined;
+    name: string | undefined;
+}[] | null;
+export declare function scrollIsInBottom(): boolean;
+export {};

package/src/lib/editor/utils/editor.utils.js

@@ -0,0 +1,134 @@
+/**
+ * Calculates the bounding information for each page element within the given containers.
+ *
+ * @export
+ * @param {HTMLDivElement[]} containers
+ * @return {*} An array of objects containing the bounding information for each page element.
+ */
+export function getPageElementBound(containers) {
+    return containers.map((container) => {
+        const containerRect = container.getBoundingClientRect();
+        const contentlets = Array.from(container.querySelectorAll('[data-dot-object="contentlet"]'));
+        return {
+            x: containerRect.x,
+            y: containerRect.y,
+            width: containerRect.width,
+            height: containerRect.height,
+            payload: JSON.stringify({
+                container: getContainerData(container)
+            }),
+            contentlets: getContentletsBound(containerRect, contentlets)
+        };
+    });
+}
+/**
+ * An array of objects containing the bounding information for each contentlet inside a container.
+ *
+ * @export
+ * @param {DOMRect} containerRect
+ * @param {HTMLDivElement[]} contentlets
+ * @return {*}
+ */
+export function getContentletsBound(containerRect, contentlets) {
+    return contentlets.map((contentlet) => {
+        const contentletRect = contentlet.getBoundingClientRect();
+        return {
+            x: 0,
+            y: contentletRect.y - containerRect.y,
+            width: contentletRect.width,
+            height: contentletRect.height,
+            payload: JSON.stringify({
+                container: contentlet.dataset?.['dotContainer']
+                    ? JSON.parse(contentlet.dataset?.['dotContainer'])
+                    : getClosestContainerData(contentlet),
+                contentlet: {
+                    identifier: contentlet.dataset?.['dotIdentifier'],
+                    title: contentlet.dataset?.['dotTitle'],
+                    inode: contentlet.dataset?.['dotInode'],
+                    contentType: contentlet.dataset?.['dotType']
+                }
+            })
+        };
+    });
+}
+/**
+ * Get container data from VTLS.
+ *
+ * @export
+ * @param {HTMLElement} container
+ * @return {*}
+ */
+export function getContainerData(container) {
+    return {
+        acceptTypes: container.dataset?.['dotAcceptTypes'] || '',
+        identifier: container.dataset?.['dotIdentifier'] || '',
+        maxContentlets: container.dataset?.['maxContentlets'] || '',
+        uuid: container.dataset?.['dotUuid'] || ''
+    };
+}
+/**
+ * Get the closest container data from the contentlet.
+ *
+ * @export
+ * @param {Element} element
+ * @return {*}
+ */
+export function getClosestContainerData(element) {
+    // Find the closest ancestor element with data-dot-object="container" attribute
+    const container = element.closest('[data-dot-object="container"]');
+    // If a container element is found
+    if (container) {
+        // Return the dataset of the container element
+        return getContainerData(container);
+    }
+    else {
+        // If no container element is found, return null
+        console.warn('No container found for the contentlet');
+        return null;
+    }
+}
+/**
+ * Find the closest contentlet element based on HTMLElement.
+ *
+ * @export
+ * @param {(HTMLElement | null)} element
+ * @return {*}
+ */
+export function findDotElement(element) {
+    if (!element)
+        return null;
+    if (element?.dataset?.['dotObject'] === 'contentlet' ||
+        (element?.dataset?.['dotObject'] === 'container' && element.children.length === 0)) {
+        return element;
+    }
+    return findDotElement(element?.['parentElement']);
+}
+export function findDotVTLElement(element) {
+    if (!element)
+        return null;
+    if (element.dataset && element.dataset?.['dotObject'] === 'vtl-file') {
+        return element;
+    }
+    else {
+        return findDotElement(element?.['parentElement']);
+    }
+}
+export function findVTLData(target) {
+    const vltElements = target.querySelectorAll('[data-dot-object="vtl-file"]');
+    if (!vltElements.length) {
+        return null;
+    }
+    return Array.from(vltElements).map((vltElement) => {
+        return {
+            inode: vltElement.dataset?.['dotInode'],
+            name: vltElement.dataset?.['dotUrl']
+        };
+    });
+}
+export function scrollIsInBottom() {
+    const documentHeight = document.documentElement.scrollHeight;
+    const viewportHeight = window.innerHeight;
+    const scrollY = window.scrollY;
+    return scrollY + viewportHeight >= documentHeight;
+}
+//# sourceMappingURL=editor.utils.js.map

package/src/lib/editor/utils/editor.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.utils.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/editor/utils/editor.utils.ts"],"names":[],"mappings":"AA2BA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAA4B;IAC5D,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAChC,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxD,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAC1B,SAAS,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAC3C,CAAC;QAEtB,OAAO;YACH,CAAC,EAAE,aAAa,CAAC,CAAC;YAClB,CAAC,EAAE,aAAa,CAAC,CAAC;YAClB,KAAK,EAAE,aAAa,CAAC,KAAK;YAC1B,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC;aACzC,CAAC;YACF,WAAW,EAAE,mBAAmB,CAAC,aAAa,EAAE,WAAW,CAAC;SAC/D,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAC/B,aAAsB,EACtB,WAA6B;IAE7B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClC,MAAM,cAAc,GAAG,UAAU,CAAC,qBAAqB,EAAE,CAAC;QAE1D,OAAO;YACH,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;YACrC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,cAAc,CAAC,MAAM;YAC7B,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,SAAS,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC;oBAC3C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;oBAClD,CAAC,CAAC,uBAAuB,CAAC,UAAU,CAAC;gBACzC,UAAU,EAAE;oBACR,UAAU,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC;oBACjD,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;oBACvC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;oBACvC,WAAW,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC;iBAC/C;aACJ,CAAC;SACL,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAsB;IACnD,OAAO;QACH,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE;QACxD,UAAU,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE;QACtD,cAAc,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE;QAC3D,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE;KAC7C,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAgB;IACpD,+EAA+E;IAC/E,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAgB,CAAC;IAElF,kCAAkC;IAClC,IAAI,SAAS,EAAE,CAAC;QACZ,8CAA8C;QAC9C,OAAO,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACJ,gDAAgD;QAChD,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,OAA2B;IACtD,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAE1B,IACI,OAAO,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,YAAY;QAChD,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,EACpF,CAAC;QACC,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAA2B;IACzD,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAE1B,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QACnE,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,gBAAgB,CACvC,8BAA8B,CACN,CAAC;IAE7B,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAC9C,OAAO;YACH,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC;YACvC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC;SACvC,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC5B,MAAM,cAAc,GAAG,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC;IAC7D,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC;IAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAE/B,OAAO,OAAO,GAAG,cAAc,IAAI,cAAc,CAAC;AACtD,CAAC"}