@dotcms/client 0.0.1-alpha.47 → 0.0.1-alpha.49

package/index.cjs.js

@@ -1100,6 +1100,7 @@ exports.NOTIFY_CLIENT = void 0;
 
 const INITIAL_DOT_UVE = {
     editContentlet,
+    reorderMenu,
     lastScrollYPosition: 0
 };
 /**
@@ -1163,6 +1164,10 @@ exports.CLIENT_ACTIONS = void 0;
      * Tell the editor to edit a contentlet
      */
     CLIENT_ACTIONS["EDIT_CONTENTLET"] = "edit-contentlet";
+    /**
+     * Tell the editor to open the block editor sidebar
+     */
+    CLIENT_ACTIONS["INIT_BLOCK_EDITOR_INLINE_EDITING"] = "init-editor-inline-editing";
     /**
      * Tell the editor to do nothing
      */
@@ -1554,6 +1559,23 @@ function editContentlet(contentlet) {
         payload: contentlet
     });
 }
+/**
+ * Reorders the menu based on the provided configuration.
+ *
+ * @param {ReorderMenuConfig} [config] - Optional configuration for reordering the menu.
+ * @param {number} [config.startLevel=1] - The starting level of the menu to reorder.
+ * @param {number} [config.depth=2] - The depth of the menu to reorder.
+ *
+ * This function constructs a URL for the reorder menu page with the specified
+ * start level and depth, and sends a message to the editor to perform the reorder action.
+ */
+function reorderMenu(config) {
+    const { startLevel = 1, depth = 2 } = config || {};
+    postMessageToEditor({
+        action: exports.CLIENT_ACTIONS.REORDER_MENU,
+        payload: { startLevel, depth }
+    });
+}
 /**
  * Checks if the code is running inside an editor.
  *
@@ -1993,4 +2015,5 @@ exports.graphqlToPageEntity = graphqlToPageEntity;
 exports.initEditor = initEditor;
 exports.isInsideEditor = isInsideEditor;
 exports.postMessageToEditor = postMessageToEditor;
+exports.reorderMenu = reorderMenu;
 exports.updateNavigation = updateNavigation;

package/index.esm.js

@@ -1098,6 +1098,7 @@ var NOTIFY_CLIENT;
 
 const INITIAL_DOT_UVE = {
     editContentlet,
+    reorderMenu,
     lastScrollYPosition: 0
 };
 /**
@@ -1161,6 +1162,10 @@ var CLIENT_ACTIONS;
      * Tell the editor to edit a contentlet
      */
     CLIENT_ACTIONS["EDIT_CONTENTLET"] = "edit-contentlet";
+    /**
+     * Tell the editor to open the block editor sidebar
+     */
+    CLIENT_ACTIONS["INIT_BLOCK_EDITOR_INLINE_EDITING"] = "init-editor-inline-editing";
     /**
      * Tell the editor to do nothing
      */
@@ -1552,6 +1557,23 @@ function editContentlet(contentlet) {
         payload: contentlet
     });
 }
+/**
+ * Reorders the menu based on the provided configuration.
+ *
+ * @param {ReorderMenuConfig} [config] - Optional configuration for reordering the menu.
+ * @param {number} [config.startLevel=1] - The starting level of the menu to reorder.
+ * @param {number} [config.depth=2] - The depth of the menu to reorder.
+ *
+ * This function constructs a URL for the reorder menu page with the specified
+ * start level and depth, and sends a message to the editor to perform the reorder action.
+ */
+function reorderMenu(config) {
+    const { startLevel = 1, depth = 2 } = config || {};
+    postMessageToEditor({
+        action: CLIENT_ACTIONS.REORDER_MENU,
+        payload: { startLevel, depth }
+    });
+}
 /**
  * Checks if the code is running inside an editor.
  *
@@ -1983,4 +2005,4 @@ const getPageRequestParams = ({ path = '', params = {} }) => {
     };
 };
 
-export { CLIENT_ACTIONS, DotCmsClient, NOTIFY_CLIENT, destroyEditor, editContentlet, getPageRequestParams, graphqlToPageEntity, initEditor, isInsideEditor, postMessageToEditor, updateNavigation };
+export { CLIENT_ACTIONS, DotCmsClient, NOTIFY_CLIENT, destroyEditor, editContentlet, getPageRequestParams, graphqlToPageEntity, initEditor, isInsideEditor, postMessageToEditor, reorderMenu, updateNavigation };

package/package.json

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

package/src/index.d.ts

@@ -2,6 +2,6 @@ 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 { NOTIFY_CLIENT } from './lib/editor/models/listeners.model';
-import { destroyEditor, editContentlet, initEditor, isInsideEditor, updateNavigation } from './lib/editor/sdk-editor';
+import { destroyEditor, editContentlet, reorderMenu, initEditor, isInsideEditor, updateNavigation } from './lib/editor/sdk-editor';
 import { getPageRequestParams, graphqlToPageEntity } from './lib/utils';
-export { graphqlToPageEntity, getPageRequestParams, isInsideEditor, editContentlet, DotCmsClient, DotCMSPageEditorConfig, CLIENT_ACTIONS, NOTIFY_CLIENT, CustomClientParams, postMessageToEditor, EditorConfig, initEditor, updateNavigation, destroyEditor, ClientConfig };
+export { graphqlToPageEntity, getPageRequestParams, isInsideEditor, editContentlet, reorderMenu, DotCmsClient, DotCMSPageEditorConfig, CLIENT_ACTIONS, NOTIFY_CLIENT, CustomClientParams, postMessageToEditor, EditorConfig, initEditor, updateNavigation, destroyEditor, ClientConfig };

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

@@ -1,4 +1,4 @@
-import { editContentlet } from '../sdk-editor';
+import { editContentlet, reorderMenu } from '../sdk-editor';
 declare global {
     interface Window {
         dotUVE: DotUVE;
@@ -65,6 +65,10 @@ export declare enum CLIENT_ACTIONS {
      * Tell the editor to edit a contentlet
      */
     EDIT_CONTENTLET = "edit-contentlet",
+    /**
+     * Tell the editor to open the block editor sidebar
+     */
+    INIT_BLOCK_EDITOR_INLINE_EDITING = "init-editor-inline-editing",
     /**
      * Tell the editor to do nothing
      */
@@ -91,6 +95,7 @@ type PostMessageProps<T> = {
 export declare function postMessageToEditor<T = unknown>(message: PostMessageProps<T>): void;
 export interface DotUVE {
     editContentlet: typeof editContentlet;
+    reorderMenu: typeof reorderMenu;
     lastScrollYPosition: number;
 }
 export {};

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

@@ -47,3 +47,16 @@ export interface DotCMSPageEditorConfig {
      */
     onReload?: () => void;
 }
+/**
+ * Configuration for reordering a menu.
+ */
+export interface ReorderMenuConfig {
+    /**
+     * The starting level of the menu to be reordered.
+     */
+    startLevel: number;
+    /**
+     * The depth of the menu levels to be reordered.
+     */
+    depth: number;
+}

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

@@ -1,4 +1,4 @@
-import { DotCMSPageEditorConfig } from './models/editor.model';
+import { DotCMSPageEditorConfig, ReorderMenuConfig } from './models/editor.model';
 import { Contentlet } from '../client/content/shared/types';
 /**
  * Updates the navigation in the editor.
@@ -19,6 +19,17 @@ export declare function updateNavigation(pathname: string): void;
  * @param {Contentlet<T>} contentlet - The contentlet to edit.
  */
 export declare function editContentlet<T>(contentlet: Contentlet<T>): void;
+/**
+ * Reorders the menu based on the provided configuration.
+ *
+ * @param {ReorderMenuConfig} [config] - Optional configuration for reordering the menu.
+ * @param {number} [config.startLevel=1] - The starting level of the menu to reorder.
+ * @param {number} [config.depth=2] - The depth of the menu to reorder.
+ *
+ * This function constructs a URL for the reorder menu page with the specified
+ * start level and depth, and sends a message to the editor to perform the reorder action.
+ */
+export declare function reorderMenu(config?: ReorderMenuConfig): void;
 /**
  * Checks if the code is running inside an editor.
  *

package/src/lib/editor/utils/traditional-vtl.utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Listen for block editor inline event.
+ *
+ */
+export declare const listenBlockEditorInlineEvent: () => void;