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

package/index.cjs.js

@@ -1599,6 +1599,12 @@ const parseContentletsToUuidMap = (containerContentlets = []) => {
     }, {});
 };
 
+exports.UVE_MODE = void 0;
+(function (UVE_MODE) {
+    UVE_MODE["EDIT"] = "edit";
+    UVE_MODE["PREVIEW"] = "preview";
+})(exports.UVE_MODE || (exports.UVE_MODE = {}));
+
 /**
  * Generates the page request parameters to be used in the API call.
  *
@@ -1625,6 +1631,9 @@ const getPageRequestParams = ({ path = '', params = {} }) => {
     if (copiedParams['personaId'] || dotMarketingPersonaId) {
         finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
     }
+    if (copiedParams['publishDate']) {
+        finalParams['publishDate'] = copiedParams['publishDate'];
+    }
     return {
         path,
         ...finalParams
@@ -1637,8 +1646,8 @@ const getPageRequestParams = ({ path = '', params = {} }) => {
  */
 const isPreviewMode = () => {
     const queryParams = new URLSearchParams(window.location.search);
-    const isPreviewMode = queryParams.get('preview');
-    return isPreviewMode === 'true';
+    const editorMode = queryParams.get('editorMode');
+    return editorMode === exports.UVE_MODE.PREVIEW;
 };
 
 /**
@@ -1714,15 +1723,21 @@ function reorderMenu(config) {
     });
 }
 /**
- * Checks if the code is running inside an editor.
+ * Checks if the code is running inside the DotCMS Universal Visual Editor (UVE).
+ *
+ * The function checks three conditions:
+ * 1. If window is defined (for SSR environments)
+ * 2. If the page is not in preview mode
+ * 3. If the current window is embedded in a parent frame
  *
- * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ * @returns {boolean} Returns true if running inside the UVE editor, false if running standalone or in preview mode
  * @example
  * ```ts
+ * // Check if code is running in editor before initializing editor-specific features
  * if (isInsideEditor()) {
- *     console.log('Running inside the editor');
+ *     initEditor(config);
  * } else {
- *     console.log('Running outside the editor');
+ *     initStandaloneMode();
  * }
  * ```
  */
@@ -1730,8 +1745,7 @@ function isInsideEditor() {
     if (typeof window === 'undefined') {
         return false;
     }
-    const preview = isPreviewMode();
-    if (preview) {
+    if (isPreviewMode()) {
         return false;
     }
     return window.parent !== window;

package/index.esm.js

@@ -1597,6 +1597,12 @@ const parseContentletsToUuidMap = (containerContentlets = []) => {
     }, {});
 };
 
+var UVE_MODE;
+(function (UVE_MODE) {
+    UVE_MODE["EDIT"] = "edit";
+    UVE_MODE["PREVIEW"] = "preview";
+})(UVE_MODE || (UVE_MODE = {}));
+
 /**
  * Generates the page request parameters to be used in the API call.
  *
@@ -1623,6 +1629,9 @@ const getPageRequestParams = ({ path = '', params = {} }) => {
     if (copiedParams['personaId'] || dotMarketingPersonaId) {
         finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
     }
+    if (copiedParams['publishDate']) {
+        finalParams['publishDate'] = copiedParams['publishDate'];
+    }
     return {
         path,
         ...finalParams
@@ -1635,8 +1644,8 @@ const getPageRequestParams = ({ path = '', params = {} }) => {
  */
 const isPreviewMode = () => {
     const queryParams = new URLSearchParams(window.location.search);
-    const isPreviewMode = queryParams.get('preview');
-    return isPreviewMode === 'true';
+    const editorMode = queryParams.get('editorMode');
+    return editorMode === UVE_MODE.PREVIEW;
 };
 
 /**
@@ -1712,15 +1721,21 @@ function reorderMenu(config) {
     });
 }
 /**
- * Checks if the code is running inside an editor.
+ * Checks if the code is running inside the DotCMS Universal Visual Editor (UVE).
+ *
+ * The function checks three conditions:
+ * 1. If window is defined (for SSR environments)
+ * 2. If the page is not in preview mode
+ * 3. If the current window is embedded in a parent frame
  *
- * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ * @returns {boolean} Returns true if running inside the UVE editor, false if running standalone or in preview mode
  * @example
  * ```ts
+ * // Check if code is running in editor before initializing editor-specific features
  * if (isInsideEditor()) {
- *     console.log('Running inside the editor');
+ *     initEditor(config);
  * } else {
- *     console.log('Running outside the editor');
+ *     initStandaloneMode();
  * }
  * ```
  */
@@ -1728,8 +1743,7 @@ function isInsideEditor() {
     if (typeof window === 'undefined') {
         return false;
     }
-    const preview = isPreviewMode();
-    if (preview) {
+    if (isPreviewMode()) {
         return false;
     }
     return window.parent !== window;
@@ -2040,4 +2054,4 @@ class DotCmsClient {
 }
 _DotCmsClient_config = new WeakMap(), _DotCmsClient_requestOptions = new WeakMap(), _DotCmsClient_listeners = new WeakMap();
 
-export { CLIENT_ACTIONS, DotCmsClient, NOTIFY_CLIENT, destroyEditor, editContentlet, getPageRequestParams, graphqlToPageEntity, initEditor, initInlineEditing, isInsideEditor, postMessageToEditor, reorderMenu, updateNavigation };
+export { CLIENT_ACTIONS, DotCmsClient, NOTIFY_CLIENT, UVE_MODE, 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.55",
+  "version": "0.0.1-alpha.57",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

package/src/index.d.ts

@@ -1,8 +1,8 @@
 import { ClientConfig, DotCmsClient } from './lib/client/sdk-js-client';
 import { CLIENT_ACTIONS, postMessageToEditor } from './lib/editor/models/client.model';
-import { CustomClientParams, DotCMSPageEditorConfig, EditorConfig } from './lib/editor/models/editor.model';
+import { CustomClientParams, DotCMSPageEditorConfig, EditorConfig, UVE_MODE } from './lib/editor/models/editor.model';
 import { InlineEditorData, INLINE_EDITING_EVENT_KEY, InlineEditEventData } from './lib/editor/models/inline-event.model';
 import { NOTIFY_CLIENT } from './lib/editor/models/listeners.model';
 import { destroyEditor, editContentlet, reorderMenu, initEditor, isInsideEditor, updateNavigation, initInlineEditing } from './lib/editor/sdk-editor';
 import { getPageRequestParams, graphqlToPageEntity } from './lib/utils';
-export { graphqlToPageEntity, getPageRequestParams, isInsideEditor, editContentlet, reorderMenu, DotCmsClient, DotCMSPageEditorConfig, CLIENT_ACTIONS, NOTIFY_CLIENT, CustomClientParams, postMessageToEditor, EditorConfig, initEditor, updateNavigation, destroyEditor, ClientConfig, initInlineEditing, InlineEditEventData, InlineEditorData, INLINE_EDITING_EVENT_KEY };
+export { graphqlToPageEntity, getPageRequestParams, isInsideEditor, editContentlet, reorderMenu, DotCmsClient, DotCMSPageEditorConfig, CLIENT_ACTIONS, NOTIFY_CLIENT, CustomClientParams, postMessageToEditor, EditorConfig, initEditor, updateNavigation, destroyEditor, ClientConfig, initInlineEditing, InlineEditEventData, InlineEditorData, INLINE_EDITING_EVENT_KEY, UVE_MODE };

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

@@ -60,3 +60,7 @@ export interface ReorderMenuConfig {
      */
     depth: number;
 }
+export declare enum UVE_MODE {
+    EDIT = "edit",
+    PREVIEW = "preview"
+}

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

@@ -38,15 +38,21 @@ export declare function editContentlet<T>(contentlet: Contentlet<T>): void;
 export declare function initInlineEditing(type: INLINE_EDITING_EVENT_KEY, data?: InlineEditEventData): void;
 export declare function reorderMenu(config?: ReorderMenuConfig): void;
 /**
- * Checks if the code is running inside an editor.
+ * Checks if the code is running inside the DotCMS Universal Visual Editor (UVE).
  *
- * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
+ * The function checks three conditions:
+ * 1. If window is defined (for SSR environments)
+ * 2. If the page is not in preview mode
+ * 3. If the current window is embedded in a parent frame
+ *
+ * @returns {boolean} Returns true if running inside the UVE editor, false if running standalone or in preview mode
  * @example
  * ```ts
+ * // Check if code is running in editor before initializing editor-specific features
  * if (isInsideEditor()) {
- *     console.log('Running inside the editor');
+ *     initEditor(config);
  * } else {
- *     console.log('Running outside the editor');
+ *     initStandaloneMode();
  * }
  * ```
  */