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

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

@@ -0,0 +1 @@
+{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../../../../../../../libs/sdk/client/src/lib/client/content/shared/const.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAE5C,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAa,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;AAEnG,MAAM,CAAC,MAAM,eAAe,GAAG,sBAAsB,CAAC"}

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/client/models/types.d.ts

@@ -0,0 +1,5 @@
+export type DotcmsClientListener = {
+    action: string;
+    event: string;
+    callback: (...args: any[]) => void;
+};

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

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

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

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

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.
      *
@@ -125,8 +133,10 @@ type NavApiOptions = {
  *
  */
 export declare class DotCmsClient {
-    private config;
-    private requestOptions;
+    #private;
+    static instance: DotCmsClient;
+    dotcmsUrl?: string;
+    content: Content;
     constructor(config?: ClientConfig);
     page: {
         /**
@@ -144,6 +154,23 @@ export declare class DotCmsClient {
          */
         get: (options: PageApiOptions) => Promise<unknown>;
     };
+    editor: {
+        /**
+         * `editor.on` is an asynchronous method of the `DotCmsClient` class that allows you to react to actions issued by the UVE.
+         *
+         *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
+         * @param action - The name of the name emitted by UVE
+         * @param callbackFn - The function to execute when the UVE emits the action
+         */
+        on: (action: string, callbackFn: (payload: unknown) => void) => void;
+        /**
+         * `editor.off` is an synchronous method of the `DotCmsClient` class that allows you to stop listening and reacting to an action issued by UVE.
+         *
+         *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
+         * @param action
+         */
+        off: (action: string) => void;
+    };
     nav: {
         /**
          * `nav.get` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
@@ -158,26 +185,9 @@ export declare class DotCmsClient {
          */
         get: (options?: NavApiOptions) => Promise<unknown>;
     };
+    static init(config: ClientConfig): DotCmsClient;
+    static get dotcmsUrl(): string;
     private validatePageOptions;
     private validateNavOptions;
 }
-/**
- * `dotcmsClient` is an object that provides a method to initialize the DotCMS SDK client.
- * It has a single method `init` which takes a configuration object and returns an instance of the `DotCmsClient` class.
- *
- * @namespace dotcmsClient
- *
- * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
- */
-export declare const dotcmsClient: {
-    /**
-     * `init` is a method of the `dotcmsClient` object that initializes the SDK client.
-     * It takes a configuration object as a parameter and returns an instance of the `DotCmsClient` class.
-     *
-     * @method init
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
-     */
-    init: (config: ClientConfig) => DotCmsClient;
-};
 export {};

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

@@ -1,10 +1,14 @@
-function isValidUrl(url) {
+var _DotCmsClient_config, _DotCmsClient_requestOptions, _DotCmsClient_listeners;
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
+import { Content } from './content/content-api';
+import { ErrorMessages } from './models';
+import { isInsideEditor } from '../editor/sdk-editor';
+function getHostURL(url) {
     try {
-        new URL(url);
-        return true;
+        return new URL(url);
     }
     catch (error) {
-        return false;
+        return undefined;
     }
 }
 /**
@@ -24,6 +28,9 @@ function isValidUrl(url) {
  */
 export class DotCmsClient {
     constructor(config = { dotcmsUrl: '', authToken: '', requestOptions: {}, siteId: '' }) {
+        _DotCmsClient_config.set(this, void 0);
+        _DotCmsClient_requestOptions.set(this, void 0);
+        _DotCmsClient_listeners.set(this, []);
         this.page = {
             /**
              * `page.get` is an asynchronous method of the `DotCmsClient` class that retrieves all the elements of any Page in your dotCMS system in JSON format.
@@ -47,19 +54,67 @@ 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);
                     }
                 }
-                const queryHostId = options.siteId ?? this.config.siteId ?? '';
+                const queryHostId = options.siteId ?? __classPrivateFieldGet(this, _DotCmsClient_config, "f").siteId ?? '';
                 if (queryHostId) {
                     queryParamsObj['host_id'] = queryHostId;
                 }
                 const queryParams = new URLSearchParams(queryParamsObj).toString();
                 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);
-                return response.json();
+                const url = `${__classPrivateFieldGet(this, _DotCmsClient_config, "f").dotcmsUrl}/api/v1/page/json${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
+                const response = await fetch(url, __classPrivateFieldGet(this, _DotCmsClient_requestOptions, "f"));
+                if (!response.ok) {
+                    const error = {
+                        status: response.status,
+                        message: ErrorMessages[response.status] || response.statusText
+                    };
+                    console.error(error);
+                    throw error;
+                }
+                return response.json().then((data) => data.entity);
+            }
+        };
+        this.editor = {
+            /**
+             * `editor.on` is an asynchronous method of the `DotCmsClient` class that allows you to react to actions issued by the UVE.
+             *
+             *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
+             * @param action - The name of the name emitted by UVE
+             * @param callbackFn - The function to execute when the UVE emits the action
+             */
+            on: (action, callbackFn) => {
+                if (!isInsideEditor()) {
+                    return;
+                }
+                if (action === 'changes') {
+                    const messageCallback = (event) => {
+                        if (event.data.name === 'SET_PAGE_DATA') {
+                            callbackFn(event.data.payload);
+                        }
+                    };
+                    window.addEventListener('message', messageCallback);
+                    __classPrivateFieldGet(this, _DotCmsClient_listeners, "f").push({ event: 'message', callback: messageCallback, action });
+                }
+            },
+            /**
+             * `editor.off` is an synchronous method of the `DotCmsClient` class that allows you to stop listening and reacting to an action issued by UVE.
+             *
+             *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
+             * @param action
+             */
+            off: (action) => {
+                const listenerIndex = __classPrivateFieldGet(this, _DotCmsClient_listeners, "f").findIndex((listener) => listener.action === action);
+                if (listenerIndex !== -1) {
+                    const listener = __classPrivateFieldGet(this, _DotCmsClient_listeners, "f")[listenerIndex];
+                    window.removeEventListener(listener.event, listener.callback);
+                    __classPrivateFieldGet(this, _DotCmsClient_listeners, "f").splice(listenerIndex, 1);
+                }
             }
         };
         this.nav = {
@@ -87,28 +142,42 @@ export class DotCmsClient {
                 const queryParams = new URLSearchParams(queryParamsObj).toString();
                 // Format the URL correctly depending on the 'path' value
                 const formattedPath = path === '/' ? '/' : `/${path}`;
-                const url = `${this.config.dotcmsUrl}/api/v1/nav${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
-                const response = await fetch(url, this.requestOptions);
+                const url = `${__classPrivateFieldGet(this, _DotCmsClient_config, "f").dotcmsUrl}/api/v1/nav${formattedPath}${queryParams ? `?${queryParams}` : ''}`;
+                const response = await fetch(url, __classPrivateFieldGet(this, _DotCmsClient_requestOptions, "f"));
                 return response.json();
             }
         };
         if (!config.dotcmsUrl) {
             throw new Error("Invalid configuration - 'dotcmsUrl' is required");
         }
-        if (!isValidUrl(config.dotcmsUrl)) {
+        this.dotcmsUrl = getHostURL(config.dotcmsUrl)?.origin;
+        if (!this.dotcmsUrl) {
             throw new Error("Invalid configuration - 'dotcmsUrl' must be a valid URL");
         }
         if (!config.authToken) {
             throw new Error("Invalid configuration - 'authToken' is required");
         }
-        this.config = config;
-        this.requestOptions = {
-            ...this.config.requestOptions,
+        __classPrivateFieldSet(this, _DotCmsClient_config, {
+            ...config,
+            dotcmsUrl: this.dotcmsUrl
+        }, "f");
+        __classPrivateFieldSet(this, _DotCmsClient_requestOptions, {
+            ...__classPrivateFieldGet(this, _DotCmsClient_config, "f").requestOptions,
             headers: {
-                Authorization: `Bearer ${this.config.authToken}`,
-                ...this.config.requestOptions?.headers
+                Authorization: `Bearer ${__classPrivateFieldGet(this, _DotCmsClient_config, "f").authToken}`,
+                ...__classPrivateFieldGet(this, _DotCmsClient_config, "f").requestOptions?.headers
             }
-        };
+        }, "f");
+        this.content = new Content(__classPrivateFieldGet(this, _DotCmsClient_requestOptions, "f"), __classPrivateFieldGet(this, _DotCmsClient_config, "f").dotcmsUrl);
+    }
+    static init(config) {
+        if (this.instance) {
+            console.warn('DotCmsClient has already been initialized. Please use the instance to interact with the DotCMS API.');
+        }
+        return this.instance ?? (this.instance = new DotCmsClient(config));
+    }
+    static get dotcmsUrl() {
+        return (this.instance && __classPrivateFieldGet(this.instance, _DotCmsClient_config, "f").dotcmsUrl) || '';
     }
     validatePageOptions(options) {
         if (!options.path) {
@@ -121,25 +190,5 @@ export class DotCmsClient {
         }
     }
 }
-/**
- * `dotcmsClient` is an object that provides a method to initialize the DotCMS SDK client.
- * It has a single method `init` which takes a configuration object and returns an instance of the `DotCmsClient` class.
- *
- * @namespace dotcmsClient
- *
- * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
- */
-export const dotcmsClient = {
-    /**
-     * `init` is a method of the `dotcmsClient` object that initializes the SDK client.
-     * It takes a configuration object as a parameter and returns an instance of the `DotCmsClient` class.
-     *
-     * @method init
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
-     */
-    init: (config) => {
-        return new DotCmsClient(config);
-    }
-};
+_DotCmsClient_config = new WeakMap(), _DotCmsClient_requestOptions = new WeakMap(), _DotCmsClient_listeners = new WeakMap();
 //# sourceMappingURL=sdk-js-client.js.map

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;AAGzC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AA4HtD,SAAS,UAAU,CAAC,GAAW;IAC3B,IAAI,CAAC;QACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,YAAY;IASrB,YACI,SAAuB,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QAR3F,uCAAsB;QACtB,+CAAgC;QAChC,kCAAqC,EAAE,EAAC;QAsCxC,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,uBAAA,IAAI,4BAAQ,CAAC,MAAM,IAAI,EAAE,CAAC;gBAEhE,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,uBAAA,IAAI,4BAAQ,CAAC,SAAS,oBAAoB,aAAa,GAClE,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;gBAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,uBAAA,IAAI,oCAAgB,CAAC,CAAC;gBACxD,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,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,CAAC;SACJ,CAAC;QAEF,WAAM,GAAG;YACL;;;;;;eAMG;YACH,EAAE,EAAE,CAAC,MAAc,EAAE,UAAsC,EAAE,EAAE;gBAC3D,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBACpB,OAAO;gBACX,CAAC;gBAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACvB,MAAM,eAAe,GAAG,CAAC,KAAmB,EAAE,EAAE;wBAC5C,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;4BACtC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBACnC,CAAC;oBACL,CAAC,CAAC;oBAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;oBACpD,uBAAA,IAAI,+BAAW,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC;gBAClF,CAAC;YACL,CAAC;YACD;;;;;eAKG;YACH,GAAG,EAAE,CAAC,MAAc,EAAE,EAAE;gBACpB,MAAM,aAAa,GAAG,uBAAA,IAAI,+BAAW,CAAC,SAAS,CAC3C,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAC3C,CAAC;gBACF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;oBACvB,MAAM,QAAQ,GAAG,uBAAA,IAAI,+BAAW,CAAC,aAAa,CAAC,CAAC;oBAChD,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC9D,uBAAA,IAAI,+BAAW,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACL,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,uBAAA,IAAI,4BAAQ,CAAC,SAAS,cAAc,aAAa,GAC5D,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EACtC,EAAE,CAAC;gBAEH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,uBAAA,IAAI,oCAAgB,CAAC,CAAC;gBAExD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC3B,CAAC;SACJ,CAAC;QAxKE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,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,uBAAA,IAAI,wBAAW;YACX,GAAG,MAAM;YACT,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,MAAA,CAAC;QAEF,uBAAA,IAAI,gCAAmB;YACnB,GAAG,uBAAA,IAAI,4BAAQ,CAAC,cAAc;YAC9B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,uBAAA,IAAI,4BAAQ,CAAC,SAAS,EAAE;gBACjD,GAAG,uBAAA,IAAI,4BAAQ,CAAC,cAAc,EAAE,OAAO;aAC1C;SACJ,MAAA,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAA,IAAI,oCAAgB,EAAE,uBAAA,IAAI,4BAAQ,CAAC,SAAS,CAAC,CAAC;IAC7E,CAAC;IA8ID,MAAM,CAAC,IAAI,CAAC,MAAoB;QAC5B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CACR,qGAAqG,CACxG,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,KAAK,SAAS;QAChB,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,uBAAA,IAAI,CAAC,QAAQ,4BAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACpE,CAAC;IAEO,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"}

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

@@ -0,0 +1,46 @@
+import { DotCMSPageEditorSubscription } from '../models/listeners.model';
+declare global {
+    interface Window {
+        lastScrollYPosition: number;
+    }
+}
+/**
+ * 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 corresding 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 message to the editor to get the page data.
+ * @param {string} pathname - The pathname of the page.
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export declare function fetchPageDataFromInsideUVE(pathname: string): void;

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

@@ -0,0 +1,180 @@
+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';
+/**
+ * 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
+    });
+}
+/**
+ * Listens for editor messages and performs corresding 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;
+            }
+        }
+        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 message to the editor to get the page data.
+ * @param {string} pathname - The pathname of the page.
+ * @private
+ * @memberof DotCMSPageEditor
+ */
+export function fetchPageDataFromInsideUVE(pathname) {
+    postMessageToEditor({
+        action: CUSTOMER_ACTIONS.GET_PAGE_DATA,
+        payload: {
+            pathname
+        }
+    });
+}
+//# sourceMappingURL=listeners.js.map