@dotcms/client 0.0.1-alpha.2 → 0.0.1-alpha.21

package/src/lib/client/content/shared/types.d.ts

@@ -0,0 +1,62 @@
+import { Equals } from '../../../query-builder/lucene-syntax';
+import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
+export type SortBy = {
+    field: string;
+    order: 'asc' | 'desc';
+};
+export type BuildQuery = (qb: QueryBuilder) => Equals;
+export interface ContentTypeMainFields {
+    hostName: string;
+    modDate: string;
+    publishDate: string;
+    title: string;
+    baseType: string;
+    inode: string;
+    archived: boolean;
+    ownerName: string;
+    host: string;
+    working: boolean;
+    locked: boolean;
+    stInode: string;
+    contentType: string;
+    live: boolean;
+    owner: string;
+    identifier: string;
+    publishUserName: string;
+    publishUser: string;
+    languageId: number;
+    creationDate: string;
+    url: string;
+    titleImage: string;
+    modUserName: string;
+    hasLiveVersion: boolean;
+    folder: string;
+    hasTitleImage: boolean;
+    sortOrder: number;
+    modUser: string;
+    __icon__: string;
+    contentTypeIcon: string;
+    variant: string;
+}
+export type Contentlet<T> = T & ContentTypeMainFields;
+export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void) | undefined | null;
+export type OnRejected = ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void) | undefined | null;
+export interface GetCollectionResponse<T> {
+    contentlets: Contentlet<T>[];
+    page: number;
+    size: number;
+    total: number;
+    sortedBy?: SortBy[];
+}
+export interface GetCollectionRawResponse<T> {
+    entity: {
+        jsonObjectView: {
+            contentlets: Contentlet<T>[];
+        };
+        resultsSize: number;
+    };
+}
+export interface GetCollectionError {
+    status: number;
+    [key: string]: unknown;
+}

package/src/lib/client/content/shared/types.js

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

package/src/lib/client/content/shared/types.js.map

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

package/src/lib/client/content/shared/utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Sanitizes the query for the given content type.
+ * It replaces the fields that are not contentType fields with the correct format.
+ * Example: +field: -> +contentTypeVar.field:
+ *
+ *
+ * @export
+ * @param {string} query
+ * @param {string} contentType
+ * @return {*}  {string}
+ */
+export declare function sanitizeQueryForContentType(query: string, contentType: string): string;

package/src/lib/client/content/shared/utils.js

@@ -0,0 +1,20 @@
+import { CONTENT_TYPE_MAIN_FIELDS } from './const';
+/**
+ * Sanitizes the query for the given content type.
+ * It replaces the fields that are not contentType fields with the correct format.
+ * Example: +field: -> +contentTypeVar.field:
+ *
+ *
+ * @export
+ * @param {string} query
+ * @param {string} contentType
+ * @return {*}  {string}
+ */
+export function sanitizeQueryForContentType(query, contentType) {
+    return query.replace(/\+([^+:]*?):/g, (original, field) => {
+        return !CONTENT_TYPE_MAIN_FIELDS.includes(field) // Fields that are not contentType fields
+            ? `+${contentType}.${field}:` // Should have this format: +contentTypeVar.field:
+            : original; // Return the field if it is a contentType field
+    });
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/client/content/shared/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../../../../libs/sdk/client/src/lib/client/content/shared/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAAa,EAAE,WAAmB;IAC1E,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QACtD,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,yCAAyC;YACtF,CAAC,CAAC,IAAI,WAAW,IAAI,KAAK,GAAG,CAAC,kDAAkD;YAChF,CAAC,CAAC,QAAQ,CAAC,CAAC,gDAAgD;IACpE,CAAC,CAAC,CAAC;AACP,CAAC"}

package/src/lib/client/models/index.d.ts

@@ -0,0 +1 @@
+export declare const ErrorMessages: Record<number, string>;

package/src/lib/client/models/index.js

@@ -0,0 +1,9 @@
+export const ErrorMessages = {
+    401: 'Unauthorized. Check the token and try again.',
+    403: 'Forbidden. Check the permissions and try again.',
+    404: 'Not Found. Check the URL and try again.',
+    500: 'Internal Server Error. Try again later.',
+    502: 'Bad Gateway. Try again later.',
+    503: 'Service Unavailable. Try again later.'
+};
+//# sourceMappingURL=index.js.map

package/src/lib/client/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/client/src/lib/client/models/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAA2B;IACjD,GAAG,EAAE,8CAA8C;IACnD,GAAG,EAAE,iDAAiD;IACtD,GAAG,EAAE,yCAAyC;IAC9C,GAAG,EAAE,yCAAyC;IAC9C,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,uCAAuC;CAC/C,CAAC"}

package/src/lib/{sdk-js-client.d.ts → client/sdk-js-client.d.ts}

@@ -1,3 +1,5 @@
+import { Content } from './content/content-api';
+export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
 export interface ClientConfig {
     /**
      * The URL of the dotCMS instance.
@@ -31,10 +33,10 @@ export interface ClientConfig {
      *
      * @description These options will be used in the fetch request. Any option can be specified except for 'body' and 'method' which are omitted.
      * @example `{ headers: { 'Content-Type': 'application/json' } }`
-     * @type {Omit<RequestInit, 'body' | 'method'>}
+     * @type {ClientOptions}
      * @optional
      */
-    requestOptions?: Omit<RequestInit, 'body' | 'method'>;
+    requestOptions?: ClientOptions;
 }
 type PageApiOptions = {
     /**
@@ -49,6 +51,12 @@ type PageApiOptions = {
      * @type {number}
      */
     siteId?: string;
+    /**
+     * The mode of the page you want to retrieve. If not provided will use the default mode of the site.
+     *
+     * @type {number}
+     */
+    mode?: string;
     /**
      * The language id of the page you want to retrieve. If not provided will use the default language of the site.
      *
@@ -127,6 +135,7 @@ type NavApiOptions = {
 export declare class DotCmsClient {
     private config;
     private requestOptions;
+    content: Content;
     constructor(config?: ClientConfig);
     page: {
         /**

package/src/lib/{sdk-js-client.js → client/sdk-js-client.js}

@@ -1,3 +1,5 @@
+import { Content } from './content/content-api';
+import { ErrorMessages } from './models';
 function isValidUrl(url) {
     try {
         new URL(url);
@@ -47,6 +49,9 @@ export class DotCmsClient {
                     if (key === 'personaId') {
                         queryParamsObj['com.dotmarketing.persona.id'] = String(value);
                     }
+                    else if (key === 'mode' && value) {
+                        queryParamsObj['mode'] = String(value);
+                    }
                     else {
                         queryParamsObj[key] = String(value);
                     }
@@ -59,6 +64,14 @@ export class DotCmsClient {
                 const formattedPath = options.path.startsWith('/') ? options.path : `/${options.path}`;
                 const url = `${this.config.dotcmsUrl}/api/v1/page/json${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
                 const response = await fetch(url, this.requestOptions);
+                if (!response.ok) {
+                    const error = {
+                        status: response.status,
+                        message: ErrorMessages[response.status] || response.statusText
+                    };
+                    console.error(error);
+                    throw error;
+                }
                 return response.json();
             }
         };
@@ -109,6 +122,7 @@ export class DotCmsClient {
                 ...this.config.requestOptions?.headers
             }
         };
+        this.content = new Content(this.requestOptions, this.config.dotcmsUrl);
     }
     validatePageOptions(options) {
         if (!options.path) {

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

@@ -0,0 +1 @@
+{"version":3,"file":"sdk-js-client.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/client/src/lib/client/sdk-js-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AA4HzC,SAAS,UAAU,CAAC,GAAW;IAC3B,IAAI,CAAC;QACD,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAEb,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,YAAY;IAMrB,YACI,SAAuB,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QA2B3F,SAAI,GAAG;YACH;;;;;;;;;;;;eAYG;YACH,GAAG,EAAE,KAAK,EAAE,OAAuB,EAAoB,EAAE;gBACrD,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;gBAElC,MAAM,cAAc,GAA2B,EAAE,CAAC;gBAClD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjD,IAAI,KAAK,KAAK,SAAS,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ;wBAAE,SAAS;oBAExE,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;wBACtB,cAAc,CAAC,6BAA6B,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;oBAClE,CAAC;yBAAM,IAAI,GAAG,KAAK,MAAM,IAAI,KAAK,EAAE,CAAC;wBACjC,cAAc,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC3C,CAAC;yBAAM,CAAC;wBACJ,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;oBACxC,CAAC;gBACL,CAAC;gBAED,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;gBAE/D,IAAI,WAAW,EAAE,CAAC;oBACd,cAAc,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;gBAC5C,CAAC;gBAED,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;gBAEnE,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;gBACvF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,oBAAoB,aAAa,GACjE,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;gBAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACf,MAAM,KAAK,GAAG;wBACV,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,UAAU;qBACjE,CAAC;oBAEF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACrB,MAAM,KAAK,CAAC;gBAChB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,CAAC;SACJ,CAAC;QAEF,QAAG,GAAG;YACF;;;;;;;;;;eAUG;YACH,GAAG,EAAE,KAAK,EACN,UAAyB,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,EAC/C,EAAE;gBAClB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBAEjC,+EAA+E;gBAC/E,MAAM,EAAE,IAAI,EAAE,GAAG,kBAAkB,EAAE,GAAG,OAAO,CAAC;gBAChD,MAAM,cAAc,GAA2B,EAAE,CAAC;gBAClD,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBACxD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACtB,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;oBACxC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC;gBAEnE,yDAAyD;gBACzD,MAAM,aAAa,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;gBACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,cAAc,aAAa,GAC3D,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;gBAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBAEvD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,CAAC;SACJ,CAAC;QAzHE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,cAAc,GAAG;YAClB,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc;YAC7B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;gBAChD,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,OAAO;aACzC;SACJ,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;IAoGO,mBAAmB,CAAC,OAAuB;QAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IAEO,kBAAkB,CAAC,OAAsB;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC,MAAoB,EAAgB,EAAE;QACzC,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ,CAAC"}

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

@@ -0,0 +1,46 @@
+import { DotCMSPageEditorConfig } from '../models/editor.model';
+import { DotCMSPageEditorSubscription } from '../models/listeners.model';
+declare global {
+    interface Window {
+        lastScrollYPosition: number;
+    }
+}
+export declare function setPageEditorConfig(config: DotCMSPageEditorConfig): void;
+/**
+ * Represents an array of DotCMSPageEditorSubscription objects.
+ * Used to store the subscriptions for the editor and unsubscribe later.
+ */
+export declare const subscriptions: DotCMSPageEditorSubscription[];
+/**
+ * Listens for editor messages and performs corresponding actions based on the received message.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export declare function listenEditorMessages(): void;
+/**
+ * Listens for pointer move events and extracts information about the hovered contentlet.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export declare function listenHoveredContentlet(): void;
+/**
+ * Attaches a scroll event listener to the window
+ * and sends a message to the editor when the window is scrolled.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export declare function scrollHandler(): void;
+/**
+ * Restores the scroll position of the window when an iframe is loaded.
+ * Only used in VTL Pages.
+ * @export
+ */
+export declare function preserveScrollOnIframe(): void;
+/**
+ * Sends a ping message to the editor.
+ *
+ */
+export declare function pingEditor(): void;

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

@@ -0,0 +1,198 @@
+import { CUSTOMER_ACTIONS, postMessageToEditor } from '../models/client.model';
+import { NOTIFY_CUSTOMER } from '../models/listeners.model';
+import { findVTLData, findDotElement, getClosestContainerData, getPageElementBound, scrollIsInBottom } from '../utils/editor.utils';
+/**
+ * Default reload function that reloads the current window.
+ */
+const defaultReloadFn = () => window.location.reload();
+/**
+ * Configuration object for the DotCMSPageEditor.
+ */
+let pageEditorConfig = {
+    onReload: defaultReloadFn
+};
+export function setPageEditorConfig(config) {
+    pageEditorConfig = config;
+}
+/**
+ * Represents an array of DotCMSPageEditorSubscription objects.
+ * Used to store the subscriptions for the editor and unsubscribe later.
+ */
+export const subscriptions = [];
+/**
+ * Sets the bounds of the containers in the editor.
+ * Retrieves the containers from the DOM and sends their position data to the editor.
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+function setBounds() {
+    const containers = Array.from(document.querySelectorAll('[data-dot-object="container"]'));
+    const positionData = getPageElementBound(containers);
+    postMessageToEditor({
+        action: CUSTOMER_ACTIONS.SET_BOUNDS,
+        payload: positionData
+    });
+}
+/**
+ * Reloads the page and triggers the onReload callback if it exists in the config object.
+ */
+function reloadPage() {
+    pageEditorConfig?.onReload();
+}
+/**
+ * Listens for editor messages and performs corresponding actions based on the received message.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export function listenEditorMessages() {
+    const messageCallback = (event) => {
+        switch (event.data) {
+            case NOTIFY_CUSTOMER.EMA_REQUEST_BOUNDS: {
+                setBounds();
+                break;
+            }
+            case NOTIFY_CUSTOMER.EMA_RELOAD_PAGE: {
+                reloadPage();
+                break;
+            }
+        }
+        if (event.data.name === NOTIFY_CUSTOMER.EMA_SCROLL_INSIDE_IFRAME) {
+            const direction = event.data.direction;
+            if ((window.scrollY === 0 && direction === 'up') ||
+                (scrollIsInBottom() && direction === 'down')) {
+                /**
+                 * If the iframe scroll is in the top of bottom, we dont send anything.
+                 * This to avoid the lost of scrollend event
+                 **/
+                return;
+            }
+            const scrollY = direction === 'up' ? -120 : 120;
+            window.scrollBy({ left: 0, top: scrollY, behavior: 'smooth' });
+        }
+    };
+    window.addEventListener('message', messageCallback);
+    subscriptions.push({
+        type: 'listener',
+        event: 'message',
+        callback: messageCallback
+    });
+}
+/**
+ * Listens for pointer move events and extracts information about the hovered contentlet.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export function listenHoveredContentlet() {
+    const pointerMoveCallback = (event) => {
+        const foundElement = findDotElement(event.target);
+        if (!foundElement)
+            return;
+        const { x, y, width, height } = foundElement.getBoundingClientRect();
+        const isContainer = foundElement.dataset?.['dotObject'] === 'container';
+        const contentletForEmptyContainer = {
+            identifier: 'TEMP_EMPTY_CONTENTLET',
+            title: 'TEMP_EMPTY_CONTENTLET',
+            contentType: 'TEMP_EMPTY_CONTENTLET_TYPE',
+            inode: 'TEMPY_EMPTY_CONTENTLET_INODE',
+            widgetTitle: 'TEMP_EMPTY_CONTENTLET',
+            baseType: 'TEMP_EMPTY_CONTENTLET',
+            onNumberOfPages: 1
+        };
+        const contentlet = {
+            identifier: foundElement.dataset?.['dotIdentifier'],
+            title: foundElement.dataset?.['dotTitle'],
+            inode: foundElement.dataset?.['dotInode'],
+            contentType: foundElement.dataset?.['dotType'],
+            baseType: foundElement.dataset?.['dotBasetype'],
+            widgetTitle: foundElement.dataset?.['dotWidgetTitle'],
+            onNumberOfPages: foundElement.dataset?.['dotOnNumberOfPages']
+        };
+        const vtlFiles = findVTLData(foundElement);
+        const contentletPayload = {
+            container: 
+            // Here extract dot-container from contentlet if is Headless
+            // or search in parent container if is VTL
+            foundElement.dataset?.['dotContainer']
+                ? JSON.parse(foundElement.dataset?.['dotContainer'])
+                : getClosestContainerData(foundElement),
+            contentlet: isContainer ? contentletForEmptyContainer : contentlet,
+            vtlFiles
+        };
+        postMessageToEditor({
+            action: CUSTOMER_ACTIONS.SET_CONTENTLET,
+            payload: {
+                x,
+                y,
+                width,
+                height,
+                payload: contentletPayload
+            }
+        });
+    };
+    document.addEventListener('pointermove', pointerMoveCallback);
+    subscriptions.push({
+        type: 'listener',
+        event: 'pointermove',
+        callback: pointerMoveCallback
+    });
+}
+/**
+ * Attaches a scroll event listener to the window
+ * and sends a message to the editor when the window is scrolled.
+ *
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export function scrollHandler() {
+    const scrollCallback = () => {
+        postMessageToEditor({
+            action: CUSTOMER_ACTIONS.IFRAME_SCROLL
+        });
+        window.lastScrollYPosition = window.scrollY;
+    };
+    const scrollEndCallback = () => {
+        postMessageToEditor({
+            action: CUSTOMER_ACTIONS.IFRAME_SCROLL_END
+        });
+    };
+    window.addEventListener('scroll', scrollCallback);
+    window.addEventListener('scrollend', scrollEndCallback);
+    subscriptions.push({
+        type: 'listener',
+        event: 'scroll',
+        callback: scrollEndCallback
+    });
+    subscriptions.push({
+        type: 'listener',
+        event: 'scroll',
+        callback: scrollCallback
+    });
+}
+/**
+ * Restores the scroll position of the window when an iframe is loaded.
+ * Only used in VTL Pages.
+ * @export
+ */
+export function preserveScrollOnIframe() {
+    const preserveScrollCallback = () => {
+        window.scrollTo(0, window.lastScrollYPosition);
+    };
+    window.addEventListener('load', preserveScrollCallback);
+    subscriptions.push({
+        type: 'listener',
+        event: 'scroll',
+        callback: preserveScrollCallback
+    });
+}
+/**
+ * Sends a ping message to the editor.
+ *
+ */
+export function pingEditor() {
+    postMessageToEditor({
+        action: CUSTOMER_ACTIONS.PING_EDITOR
+    });
+}
+//# sourceMappingURL=listeners.js.map

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;AAE/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;;GAEG;AACH,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;AAEvD;;GAEG;AACH,IAAI,gBAAgB,GAA2B;IAC3C,QAAQ,EAAE,eAAe;CAC5B,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,MAA8B;IAC9D,gBAAgB,GAAG,MAAM,CAAC;AAC9B,CAAC;AAED;;;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;;GAEG;AACH,SAAS,UAAU;IACf,gBAAgB,EAAE,QAAQ,EAAE,CAAC;AACjC,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;YAED,KAAK,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC;gBACnC,UAAU,EAAE,CAAC;gBACb,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;;;GAGG;AACH,MAAM,UAAU,UAAU;IACtB,mBAAmB,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,WAAW;KACvC,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,6 +21,31 @@ 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",
     NOOP = "noop"
 }
 /**

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

@@ -0,0 +1,62 @@
+/**
+ * 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";
+    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,gBA6CX;AA7CD,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;IAErE;;OAEG;IACH,iDAA6B,CAAA;IAE7B,iCAAa,CAAA;AACjB,CAAC,EA7CW,gBAAgB,KAAhB,gBAAgB,QA6C3B;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,16 @@
+/**
+ *
+ * Represents the configuration options for the DotCMS page editor.
+ * @export
+ * @interface DotCMSPageEditorConfig
+ */
+export interface DotCMSPageEditorConfig {
+    /**
+     * A callback function that will be called when the page editor needs to be reloaded.
+     */
+    onReload: () => void;
+    /**
+     * The pathname of the page being edited. Optional.
+     */
+    pathname?: string;
+}

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 {};