@dotcms/client - npm Package Compare versions

Comparing version 0.0.1-alpha.55 to 0.0.1-alpha.56

package.json

 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.55",
+  "version": "0.0.1-alpha.56",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
@@ -5,0 +5,0 @@ "repository": {

src/index.d.ts

 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';
@@ -8,2 +8,2 @@ import { NOTIFY_CLIENT } from './lib/editor/models/listeners.model';
 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 };

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

@@ -63,1 +63,5 @@ /**
 }
+export declare enum UVE_MODE {
+    EDIT = "edit",
+    PREVIEW = "preview"
+}

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

@@ -41,11 +41,17 @@ import { DotCMSPageEditorConfig, ReorderMenuConfig } from './models/editor.model';
 /**
- * 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();
  * }
@@ -52,0 +58,0 @@ * ```

No alert changes

Improved metrics

Total package byte prevSize

227053

increased by0.65%

Lines of code

5948

increased by0.61%

No dependency changes