@dotcms/client 0.0.1-alpha.11 → 0.0.1-alpha.13

package/package.json

@@ -1,26 +1,28 @@
 {
-    "name": "@dotcms/client",
-    "version": "0.0.1-alpha.11",
-    "type": "module",
-    "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/dotCMS/core.git#master"
-    },
-    "scripts": {
-        "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
-    },
-    "keywords": [
-        "dotCMS",
-        "CMS",
-        "Content Management",
-        "API Client",
-        "REST API"
-    ],
-    "author": "dotcms <dev@dotcms.com>",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/dotCMS/core/issues"
-    },
-    "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md"
+  "name": "@dotcms/client",
+  "version": "0.0.1-alpha.13",
+  "type": "module",
+  "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dotCMS/core.git#master"
+  },
+  "scripts": {
+    "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
+  },
+  "keywords": [
+    "dotCMS",
+    "CMS",
+    "Content Management",
+    "API Client",
+    "REST API"
+  ],
+  "author": "dotcms <dev@dotcms.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dotCMS/core/issues"
+  },
+  "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md",
+  "module": "./src/index.js",
+  "main": "./src/index.js"
 }

package/src/index.js

@@ -0,0 +1,5 @@
+export * from './lib/client/sdk-js-client';
+export * from './lib/editor/sdk-editor';
+export * from './lib/editor/models/editor.model';
+export * from './lib/editor/models/client.model';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/sdk/client/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC"}

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

@@ -36,7 +36,6 @@ export interface ClientConfig {
      */
     requestOptions?: Omit<RequestInit, 'body' | 'method'>;
 }
-
 type PageApiOptions = {
     /**
      * The path of the page you want to retrieve.
@@ -81,7 +80,6 @@ type PageApiOptions = {
      */
     depth?: number;
 };
-
 type NavApiOptions = {
     /**
      * The root path to begin traversing the folder tree.
@@ -117,17 +115,6 @@ type NavApiOptions = {
      */
     languageId?: number;
 };
-
-function isValidUrl(url: string): boolean {
-    try {
-        new URL(url);
-
-        return true;
-    } catch (error) {
-        return false;
-    }
-}
-
 /**
  * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
  * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
@@ -143,37 +130,11 @@ function isValidUrl(url: string): boolean {
  * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
  *
  */
-export class DotCmsClient {
-    private config: ClientConfig;
-    private requestOptions!: Omit<RequestInit, 'body' | 'method'>;
-
-    constructor(
-        config: ClientConfig = { dotcmsUrl: '', authToken: '', requestOptions: {}, siteId: '' }
-    ) {
-        if (!config.dotcmsUrl) {
-            throw new Error("Invalid configuration - 'dotcmsUrl' is required");
-        }
-
-        if (!isValidUrl(config.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,
-            headers: {
-                Authorization: `Bearer ${this.config.authToken}`,
-                ...this.config.requestOptions?.headers
-            }
-        };
-    }
-
-    page = {
+export declare class DotCmsClient {
+    private config;
+    private requestOptions;
+    constructor(config?: ClientConfig);
+    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.
          * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
@@ -187,41 +148,9 @@ export class DotCmsClient {
          * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
          * @throws {Error} - Throws an error if the options are not valid.
          */
-        get: async (options: PageApiOptions): Promise<unknown> => {
-            this.validatePageOptions(options);
-
-            const queryParamsObj: Record<string, string> = {};
-            for (const [key, value] of Object.entries(options)) {
-                if (value === undefined || key === 'path' || key === 'siteId') continue;
-
-                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 ?? '';
-
-            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();
-        }
+        get: (options: PageApiOptions) => Promise<unknown>;
     };
-
-    nav = {
+    nav: {
         /**
          * `nav.get` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
          * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
@@ -233,47 +162,11 @@ export class DotCmsClient {
          * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
          * @throws {Error} - Throws an error if the options are not valid.
          */
-        get: async (
-            options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }
-        ): Promise<unknown> => {
-            this.validateNavOptions(options);
-
-            // Extract the 'path' from the options and prepare the rest as query parameters
-            const { path, ...queryParamsOptions } = options;
-            const queryParamsObj: Record<string, string> = {};
-            Object.entries(queryParamsOptions).forEach(([key, value]) => {
-                if (value !== undefined) {
-                    queryParamsObj[key] = String(value);
-                }
-            });
-
-            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);
-
-            return response.json();
-        }
+        get: (options?: NavApiOptions) => Promise<unknown>;
     };
-
-    private validatePageOptions(options: PageApiOptions): void {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Page API");
-        }
-    }
-
-    private validateNavOptions(options: NavApiOptions): void {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Nav API");
-        }
-    }
+    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.
@@ -282,7 +175,7 @@ export class DotCmsClient {
  *
  * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
  */
-export const dotcmsClient = {
+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.
@@ -291,7 +184,6 @@ export const dotcmsClient = {
      * @param {ClientConfig} config - The configuration object for the DotCMS client.
      * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
      */
-    init: (config: ClientConfig): DotCmsClient => {
-        return new DotCmsClient(config);
-    }
+    init: (config: ClientConfig) => DotCmsClient;
 };
+export {};

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

@@ -0,0 +1,148 @@
+function isValidUrl(url) {
+    try {
+        new URL(url);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+/**
+ * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
+ * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
+ *
+ * @class DotCmsClient
+ *
+ * @property {ClientConfig} config - The configuration object for the DotCMS client.
+ *
+ * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
+ *
+ * @method page.get(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
+ *
+ * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
+ *
+ */
+export class DotCmsClient {
+    constructor(config = { dotcmsUrl: '', authToken: '', requestOptions: {}, siteId: '' }) {
+        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.
+             * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
+             *
+             * The Page API enables you to retrieve all the elements of any Page in your dotCMS system.
+             * The elements may be retrieved in JSON format.
+             *
+             * @link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas
+             * @async
+             * @param {PageApiOptions} options - The options for the Page API call.
+             * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+             * @throws {Error} - Throws an error if the options are not valid.
+             */
+            get: async (options) => {
+                this.validatePageOptions(options);
+                const queryParamsObj = {};
+                for (const [key, value] of Object.entries(options)) {
+                    if (value === undefined || key === 'path' || key === 'siteId')
+                        continue;
+                    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 ?? '';
+                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();
+            }
+        };
+        this.nav = {
+            /**
+             * `nav.get` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
+             * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
+             *
+             * The navigation REST API enables you to retrieve information about the dotCMS file and folder tree through REST API calls.
+             * @link https://www.dotcms.com/docs/latest/navigation-rest-api
+             * @async
+             * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
+             * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+             * @throws {Error} - Throws an error if the options are not valid.
+             */
+            get: async (options = { depth: 0, path: '/', languageId: 1 }) => {
+                this.validateNavOptions(options);
+                // Extract the 'path' from the options and prepare the rest as query parameters
+                const { path, ...queryParamsOptions } = options;
+                const queryParamsObj = {};
+                Object.entries(queryParamsOptions).forEach(([key, value]) => {
+                    if (value !== undefined) {
+                        queryParamsObj[key] = String(value);
+                    }
+                });
+                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);
+                return response.json();
+            }
+        };
+        if (!config.dotcmsUrl) {
+            throw new Error("Invalid configuration - 'dotcmsUrl' is required");
+        }
+        if (!isValidUrl(config.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,
+            headers: {
+                Authorization: `Bearer ${this.config.authToken}`,
+                ...this.config.requestOptions?.headers
+            }
+        };
+    }
+    validatePageOptions(options) {
+        if (!options.path) {
+            throw new Error("The 'path' parameter is required for the Page API");
+        }
+    }
+    validateNavOptions(options) {
+        if (!options.path) {
+            throw new Error("The 'path' parameter is required for the Nav API");
+        }
+    }
+}
+/**
+ * `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);
+    }
+};
+//# 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":"AAwHA,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;IAIrB,YACI,SAAuB,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QAyB3F,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;gBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBAEvD,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;QA7GE,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;IACN,CAAC;IA0FO,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.ts → listeners.js}

@@ -1,41 +1,24 @@
 import { CUSTOMER_ACTIONS, postMessageToEditor } from '../models/client.model';
-import { DotCMSPageEditorConfig } from '../models/editor.model';
-import { DotCMSPageEditorSubscription, NOTIFY_CUSTOMER } from '../models/listeners.model';
-import {
-    findVTLData,
-    findContentletElement,
-    getClosestContainerData,
-    getPageElementBound
-} from '../utils/editor.utils';
-
-declare global {
-    interface Window {
-        lastScrollYPosition: number;
-    }
-}
-
+import { NOTIFY_CUSTOMER } from '../models/listeners.model';
+import { findVTLData, findDotElement, getClosestContainerData, getPageElementBound } from '../utils/editor.utils';
 /**
  * Default reload function that reloads the current window.
  */
 const defaultReloadFn = () => window.location.reload();
-
 /**
  * Configuration object for the DotCMSPageEditor.
  */
-let pageEditorConfig: DotCMSPageEditorConfig = {
+let pageEditorConfig = {
     onReload: defaultReloadFn
 };
-
-export function setPageEditorConfig(config: DotCMSPageEditorConfig) {
+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: DotCMSPageEditorSubscription[] = [];
-
+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.
@@ -43,24 +26,19 @@ export const subscriptions: DotCMSPageEditorSubscription[] = [];
  * @memberof DotCMSPageEditor
  */
 function setBounds() {
-    const containers = Array.from(
-        document.querySelectorAll('[data-dot-object="container"]')
-    ) as HTMLDivElement[];
+    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.
  *
@@ -68,29 +46,25 @@ function reloadPage() {
  * @memberof DotCMSPageEditor
  */
 export function listenEditorMessages() {
-    const messageCallback = (event: MessageEvent) => {
+    const messageCallback = (event) => {
         switch (event.data) {
             case NOTIFY_CUSTOMER.EMA_REQUEST_BOUNDS: {
                 setBounds();
                 break;
             }
-
             case NOTIFY_CUSTOMER.EMA_RELOAD_PAGE: {
                 reloadPage();
                 break;
             }
         }
     };
-
     window.addEventListener('message', messageCallback);
-
     subscriptions.push({
         type: 'listener',
         event: 'message',
         callback: messageCallback
     });
 }
-
 /**
  * Listens for pointer move events and extracts information about the hovered contentlet.
  *
@@ -98,29 +72,39 @@ export function listenEditorMessages() {
  * @memberof DotCMSPageEditor
  */
 export function listenHoveredContentlet() {
-    const pointerMoveCallback = (event: PointerEvent) => {
-        const target = findContentletElement(event.target as HTMLElement);
-        if (!target) return;
-        const { x, y, width, height } = target.getBoundingClientRect();
-
-        const vtlFiles = findVTLData(target);
+    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',
+            onNumberOfPages: 1
+        };
+        const contentlet = {
+            identifier: foundElement.dataset?.['dotIdentifier'],
+            title: foundElement.dataset?.['dotTitle'],
+            inode: foundElement.dataset?.['dotInode'],
+            contentType: foundElement.dataset?.['dotType'],
+            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
-                target.dataset?.['dotContainer']
-                    ? JSON.parse(target.dataset?.['dotContainer'])
-                    : getClosestContainerData(target),
-            contentlet: {
-                identifier: target.dataset?.['dotIdentifier'],
-                title: target.dataset?.['dotTitle'],
-                inode: target.dataset?.['dotInode'],
-                contentType: target.dataset?.['dotType'],
-                onNumberOfPages: target.dataset?.['dotOnNumberOfPages']
-            },
+            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: {
@@ -132,16 +116,13 @@ export function listenHoveredContentlet() {
             }
         });
     };
-
     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.
@@ -156,16 +137,13 @@ export function scrollHandler() {
         });
         window.lastScrollYPosition = window.scrollY;
     };
-
     window.addEventListener('scroll', scrollCallback);
-
     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.
@@ -175,7 +153,6 @@ export function preserveScrollOnIframe() {
     const preserveScrollCallback = () => {
         window.scrollTo(0, window.lastScrollYPosition);
     };
-
     window.addEventListener('load', preserveScrollCallback);
     subscriptions.push({
         type: 'listener',
@@ -183,7 +160,6 @@ export function preserveScrollOnIframe() {
         callback: preserveScrollCallback
     });
 }
-
 /**
  * Sends a ping message to the editor.
  *
@@ -193,3 +169,4 @@ export function pingEditor() {
         action: CUSTOMER_ACTIONS.PING_EDITOR
     });
 }
+//# sourceMappingURL=listeners.js.map