@dotcms/client 0.0.1-alpha.54 → 0.0.1-alpha.55

package/index.cjs.js

@@ -1525,6 +1525,122 @@ function fetchPageDataFromInsideUVE(pathname) {
     });
 }
 
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+const graphqlToPageEntity = (graphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
+    // If there is no page, return null
+    if (!page) {
+        return null;
+    }
+    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
+    const data = (_map || {});
+    return {
+        layout,
+        template,
+        viewAs,
+        urlContentMap,
+        site,
+        page: {
+            ...data,
+            ...pageAsset
+        },
+        containers: parseContainers(containers)
+    };
+};
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {Record<string, unknown>} The parsed containers.
+ */
+const parseContainers = (containers = []) => {
+    return containers.reduce((acc, container) => {
+        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
+        const key = (path || identifier);
+        acc[key] = {
+            containerStructures,
+            container: {
+                path,
+                identifier,
+                ...rest
+            },
+            contentlets: parseContentletsToUuidMap(containerContentlets)
+        };
+        return acc;
+    }, {});
+};
+/**
+ * Parses the contentlets from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
+ * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
+ */
+const parseContentletsToUuidMap = (containerContentlets = []) => {
+    return containerContentlets.reduce((acc, containerContentlet) => {
+        const { uuid, contentlets } = containerContentlet;
+        // TODO: This is a temporary solution, we need to find a better way to handle this.
+        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
+            return {
+                ..._map,
+                ...rest
+            };
+        });
+        return acc;
+    }, {});
+};
+
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
+const getPageRequestParams = ({ path = '', params = {} }) => {
+    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
+    const finalParams = {};
+    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
+    if (copiedParams['mode']) {
+        finalParams['mode'] = copiedParams['mode'];
+    }
+    if (copiedParams['language_id']) {
+        finalParams['language_id'] = copiedParams['language_id'];
+    }
+    if (copiedParams['variantName']) {
+        finalParams['variantName'] = copiedParams['variantName'];
+    }
+    if (copiedParams['personaId'] || dotMarketingPersonaId) {
+        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
+    }
+    return {
+        path,
+        ...finalParams
+    };
+};
+/**
+ * Checks if the code is running inside an editor.
+ *
+ * @return {*}  {boolean}
+ */
+const isPreviewMode = () => {
+    const queryParams = new URLSearchParams(window.location.search);
+    const isPreviewMode = queryParams.get('preview');
+    return isPreviewMode === 'true';
+};
+
 /**
  * Updates the navigation in the editor.
  *
@@ -1614,6 +1730,10 @@ function isInsideEditor() {
     if (typeof window === 'undefined') {
         return false;
     }
+    const preview = isPreviewMode();
+    if (preview) {
+        return false;
+    }
     return window.parent !== window;
 }
 function initDotUVE() {
@@ -1922,112 +2042,6 @@ class DotCmsClient {
 }
 _DotCmsClient_config = new WeakMap(), _DotCmsClient_requestOptions = new WeakMap(), _DotCmsClient_listeners = new WeakMap();
 
-/**
- * Transforms a GraphQL Page response to a Page Entity.
- *
- * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
- * @returns {object|null} The transformed Page Entity or null if the page is not present.
- *
- * @example
- * ```ts
- * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
- * ```
- */
-const graphqlToPageEntity = (graphQLPageResponse) => {
-    const { page } = graphQLPageResponse;
-    // If there is no page, return null
-    if (!page) {
-        return null;
-    }
-    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
-    const data = (_map || {});
-    return {
-        layout,
-        template,
-        viewAs,
-        urlContentMap,
-        site,
-        page: {
-            ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers)
-    };
-};
-/**
- * Parses the containers from the GraphQL response.
- *
- * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
- * @returns {Record<string, unknown>} The parsed containers.
- */
-const parseContainers = (containers = []) => {
-    return containers.reduce((acc, container) => {
-        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
-        const key = (path || identifier);
-        acc[key] = {
-            containerStructures,
-            container: {
-                path,
-                identifier,
-                ...rest
-            },
-            contentlets: parseContentletsToUuidMap(containerContentlets)
-        };
-        return acc;
-    }, {});
-};
-/**
- * Parses the contentlets from the GraphQL response.
- *
- * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
- * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
- */
-const parseContentletsToUuidMap = (containerContentlets = []) => {
-    return containerContentlets.reduce((acc, containerContentlet) => {
-        const { uuid, contentlets } = containerContentlet;
-        // TODO: This is a temporary solution, we need to find a better way to handle this.
-        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
-            return {
-                ..._map,
-                ...rest
-            };
-        });
-        return acc;
-    }, {});
-};
-
-/**
- * Generates the page request parameters to be used in the API call.
- *
- * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
- * @returns {PageApiOptions} The options for the page API.
- * @example
- * ```ts
- * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
- * ```
- */
-const getPageRequestParams = ({ path = '', params = {} }) => {
-    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
-    const finalParams = {};
-    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
-    if (copiedParams['mode']) {
-        finalParams['mode'] = copiedParams['mode'];
-    }
-    if (copiedParams['language_id']) {
-        finalParams['language_id'] = copiedParams['language_id'];
-    }
-    if (copiedParams['variantName']) {
-        finalParams['variantName'] = copiedParams['variantName'];
-    }
-    if (copiedParams['personaId'] || dotMarketingPersonaId) {
-        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
-    }
-    return {
-        path,
-        ...finalParams
-    };
-};
-
 exports.DotCmsClient = DotCmsClient;
 exports.destroyEditor = destroyEditor;
 exports.editContentlet = editContentlet;

package/index.esm.js

@@ -1523,6 +1523,122 @@ function fetchPageDataFromInsideUVE(pathname) {
     });
 }
 
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+const graphqlToPageEntity = (graphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
+    // If there is no page, return null
+    if (!page) {
+        return null;
+    }
+    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
+    const data = (_map || {});
+    return {
+        layout,
+        template,
+        viewAs,
+        urlContentMap,
+        site,
+        page: {
+            ...data,
+            ...pageAsset
+        },
+        containers: parseContainers(containers)
+    };
+};
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {Record<string, unknown>} The parsed containers.
+ */
+const parseContainers = (containers = []) => {
+    return containers.reduce((acc, container) => {
+        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
+        const key = (path || identifier);
+        acc[key] = {
+            containerStructures,
+            container: {
+                path,
+                identifier,
+                ...rest
+            },
+            contentlets: parseContentletsToUuidMap(containerContentlets)
+        };
+        return acc;
+    }, {});
+};
+/**
+ * Parses the contentlets from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
+ * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
+ */
+const parseContentletsToUuidMap = (containerContentlets = []) => {
+    return containerContentlets.reduce((acc, containerContentlet) => {
+        const { uuid, contentlets } = containerContentlet;
+        // TODO: This is a temporary solution, we need to find a better way to handle this.
+        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
+            return {
+                ..._map,
+                ...rest
+            };
+        });
+        return acc;
+    }, {});
+};
+
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
+const getPageRequestParams = ({ path = '', params = {} }) => {
+    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
+    const finalParams = {};
+    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
+    if (copiedParams['mode']) {
+        finalParams['mode'] = copiedParams['mode'];
+    }
+    if (copiedParams['language_id']) {
+        finalParams['language_id'] = copiedParams['language_id'];
+    }
+    if (copiedParams['variantName']) {
+        finalParams['variantName'] = copiedParams['variantName'];
+    }
+    if (copiedParams['personaId'] || dotMarketingPersonaId) {
+        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
+    }
+    return {
+        path,
+        ...finalParams
+    };
+};
+/**
+ * Checks if the code is running inside an editor.
+ *
+ * @return {*}  {boolean}
+ */
+const isPreviewMode = () => {
+    const queryParams = new URLSearchParams(window.location.search);
+    const isPreviewMode = queryParams.get('preview');
+    return isPreviewMode === 'true';
+};
+
 /**
  * Updates the navigation in the editor.
  *
@@ -1612,6 +1728,10 @@ function isInsideEditor() {
     if (typeof window === 'undefined') {
         return false;
     }
+    const preview = isPreviewMode();
+    if (preview) {
+        return false;
+    }
     return window.parent !== window;
 }
 function initDotUVE() {
@@ -1920,110 +2040,4 @@ class DotCmsClient {
 }
 _DotCmsClient_config = new WeakMap(), _DotCmsClient_requestOptions = new WeakMap(), _DotCmsClient_listeners = new WeakMap();
 
-/**
- * Transforms a GraphQL Page response to a Page Entity.
- *
- * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
- * @returns {object|null} The transformed Page Entity or null if the page is not present.
- *
- * @example
- * ```ts
- * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
- * ```
- */
-const graphqlToPageEntity = (graphQLPageResponse) => {
-    const { page } = graphQLPageResponse;
-    // If there is no page, return null
-    if (!page) {
-        return null;
-    }
-    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
-    const data = (_map || {});
-    return {
-        layout,
-        template,
-        viewAs,
-        urlContentMap,
-        site,
-        page: {
-            ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers)
-    };
-};
-/**
- * Parses the containers from the GraphQL response.
- *
- * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
- * @returns {Record<string, unknown>} The parsed containers.
- */
-const parseContainers = (containers = []) => {
-    return containers.reduce((acc, container) => {
-        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
-        const key = (path || identifier);
-        acc[key] = {
-            containerStructures,
-            container: {
-                path,
-                identifier,
-                ...rest
-            },
-            contentlets: parseContentletsToUuidMap(containerContentlets)
-        };
-        return acc;
-    }, {});
-};
-/**
- * Parses the contentlets from the GraphQL response.
- *
- * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
- * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
- */
-const parseContentletsToUuidMap = (containerContentlets = []) => {
-    return containerContentlets.reduce((acc, containerContentlet) => {
-        const { uuid, contentlets } = containerContentlet;
-        // TODO: This is a temporary solution, we need to find a better way to handle this.
-        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
-            return {
-                ..._map,
-                ...rest
-            };
-        });
-        return acc;
-    }, {});
-};
-
-/**
- * Generates the page request parameters to be used in the API call.
- *
- * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
- * @returns {PageApiOptions} The options for the page API.
- * @example
- * ```ts
- * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
- * ```
- */
-const getPageRequestParams = ({ path = '', params = {} }) => {
-    const copiedParams = params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
-    const finalParams = {};
-    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
-    if (copiedParams['mode']) {
-        finalParams['mode'] = copiedParams['mode'];
-    }
-    if (copiedParams['language_id']) {
-        finalParams['language_id'] = copiedParams['language_id'];
-    }
-    if (copiedParams['variantName']) {
-        finalParams['variantName'] = copiedParams['variantName'];
-    }
-    if (copiedParams['personaId'] || dotMarketingPersonaId) {
-        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
-    }
-    return {
-        path,
-        ...finalParams
-    };
-};
-
 export { CLIENT_ACTIONS, DotCmsClient, NOTIFY_CLIENT, destroyEditor, editContentlet, getPageRequestParams, graphqlToPageEntity, initEditor, initInlineEditing, isInsideEditor, postMessageToEditor, reorderMenu, updateNavigation };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.54",
+  "version": "0.0.1-alpha.55",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

package/src/lib/utils/page/common-utils.d.ts

@@ -31,3 +31,9 @@ export interface PageRequestParamsProps {
  * ```
  */
 export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => PageApiOptions;
+/**
+ * Checks if the code is running inside an editor.
+ *
+ * @return {*}  {boolean}
+ */
+export declare const isPreviewMode: () => boolean;