GLSP-1568: Refactor MenuItem API (#450)

tortmayr · web-flow · commit eb23ff3fba72 · 2025-10-08T17:35:00.000+02:00
- Refactor `MenuItem` API - Split into `ClientMenuItem` and `ServerMenuItem` (serializable) - Deprecate original `MenuItem` - Refactor `ServerContextMenuItemProvider` to properly map `ServerMenuItem`s to the client version - Replace deprecates usage of `MenuItem` with `ClientMenuItem` Also - Fix issue in `ToolManager` that prevented proper reactivation of default tools when switching back from readonly to edit mode - Ensure that the `Delete` context menu is deactivated if the editor is readonly - Add missing i18n messages for context menu labels and sort messages.json alphabetically - Fix copy right headers and regenerate index Part of: eclipse-glsp/glsp#1586
diff --git a/package.json b/package.json
@@ -11,7 +11,7 @@
     "build": "yarn compile && yarn bundle",
     "bundle": "yarn standalone bundle",
     "check:headers": "glsp checkHeaders . -t lastCommit",
-    "check:pr": "yarn all && yarn check:format && yarn check:headers",
+    "check:pr": "yarn all && yarn format:check && yarn check:headers",
     "clean": "lerna run clean && rimraf coverage .nyc_output",
     "compile": "tsc -b",
     "format": "prettier --write .",
diff --git a/packages/client/src/base/messages.json b/packages/client/src/base/messages.json
@@ -1,87 +1,98 @@
 {
-  "navigation": {
-    "default_navigation_mode_activated": "Navigation On: Use arrow keys to select preceding (←) or succeding (→) elements. Use the up (↑) and down (↓) arrows to navigate paths. Press 'N' to exit.",
-    "default_navigation_mode_deactivated": "Navigation Off: Press 'N' for default navigation, 'ALT+N' for position based navigation.",
-    "local_navigation_mode_activated": "Position based Nav On: Navigate nearest elements using arrow keys: (↑) for above, (↓) for below, (←) for previous, (→) for next element. Press 'ALT+N' to exit.",
-    "local_navigation_mode_deactivated": "Position based Nav Off: Press 'N' for default navigation, 'ALT+N' for position based navigation.",
-    "shortcut_local_mode": "Activate local navigation mode",
-    "shortcut_global_mode": "Activate global navigation mode"
+  "autocomplete": {
+    "no_suggestions": "No suggestions available"
+  },
+  "context_menu": {
+    "copy": "Copy",
+    "cut": "Cut",
+    "delete": "Delete",
+    "marker": {
+      "navigation": "Go to",
+      "next": "Next marker",
+      "previous": "Previous marker"
+    },
+    "paste": "Paste"
+  },
+  "diagram": {
+    "label": "Diagram"
   },
   "focus": {
     "focus_not_set": "Focus not set",
-    "focus_on": "Currently focused: ",
     "focus_off": "Currently no element is focused.",
+    "focus_on": "Currently focused: ",
     "focus_within": "Within",
-    "shortcut_focus_palette": "Focus on tool palette",
-    "shortcut_focus_graph": "Focus on graph"
+    "shortcut_focus_graph": "Focus on graph",
+    "shortcut_focus_palette": "Focus on tool palette"
+  },
+  "grid": {
+    "shortcut_zoom_in": "Zoom in via grid",
+    "zoom_in_grid": "Select a digit from 1-9 to zoom in on the respective box."
+  },
+  "issue_marker": {
+    "severity_error": "ERROR",
+    "severity_info": "INFO",
+    "severity_warning": "WARNING"
+  },
+  "move": {
+    "shortcut_move": "Move element"
+  },
+  "navigation": {
+    "default_navigation_mode_activated": "Navigation On: Use arrow keys to select preceding (←) or succeding (→) elements. Use the up (↑) and down (↓) arrows to navigate paths. Press 'N' to exit.",
+    "default_navigation_mode_deactivated": "Navigation Off: Press 'N' for default navigation, 'ALT+N' for position based navigation.",
+    "local_navigation_mode_activated": "Position based Nav On: Navigate nearest elements using arrow keys: (↑) for above, (↓) for below, (←) for previous, (→) for next element. Press 'ALT+N' to exit.",
+    "local_navigation_mode_deactivated": "Position based Nav Off: Press 'N' for default navigation, 'ALT+N' for position based navigation.",
+    "shortcut_global_mode": "Activate global navigation mode",
+    "shortcut_local_mode": "Activate local navigation mode"
   },
   "resize": {
     "resize_mode_activated": "Resize On: Use plus(+) and minus(-) to resize, 'CTRL'+'0' for default size. Press 'ESC' to exit.",
     "resize_mode_deactivated": "Resize Off: Press 'ALT'+'A' for resize mode.",
     "shortcut_activate": "Activate resize mode for selected element",
     "shortcut_deactivate": "Deactivate resize handler",
-    "shortcut_increase": "Increase size of element",
     "shortcut_decrease": "Decrease size of element",
+    "shortcut_increase": "Increase size of element",
     "shortcut_reset": "Set element size to default"
   },
-  "move": {
-    "shortcut_move": "Move element"
-  },
-  "grid": {
-    "zoom_in_grid": "Select a digit from 1-9 to zoom in on the respective box.",
-    "shortcut_zoom_in": "Zoom in via grid"
-  },
   "search": {
-    "shortcut_activate": "Activate search for elements",
+    "label": "Search Field",
     "placeholder": "Search for elements...",
-    "label": "Search Field"
+    "shortcut_activate": "Activate search for elements"
+  },
+  "shortcut": {
+    "group_focus": "Focus",
+    "group_graph": "Graph",
+    "group_grid": "Grid",
+    "group_move": "Move",
+    "group_navigation": "Navigation",
+    "group_resize": "Resize",
+    "group_search": "Search",
+    "group_tool_palette": "Tool Palette",
+    "group_viewport": "Viewport",
+    "group_zoom": "Zoom",
+    "header_command": "Command",
+    "header_shortcut": "Keybinding",
+    "menu_title": "Shortcut Menu",
+    "title": "Keyboard Shortcuts"
   },
   "tool_palette": {
-    "label": "Tool Palette",
+    "debug_mode_button": "Debug Mode",
     "delete_button": "Enable deletion tool",
+    "label": "Tool Palette",
     "marquee_button": "Enable marquee tool",
     "marquee_message": "Currently marquee tool is only usable with mouse.",
-    "search_placeholder": "Search...",
+    "maximize": "Maximize palette",
+    "minimize": "Minimize palette",
+    "no_items": "No results found.",
+    "reset_viewport_button": "Reset Viewport",
     "search_button": "Filter palette entries",
+    "search_placeholder": "Search...",
     "selection_button": "Enable selection tool",
-    "validate_button": "Validate model",
-    "reset_viewport_button": "Reset Viewport",
     "toggle_grid_button": "Toggle Grid",
-    "debug_mode_button": "Debug Mode",
-    "minimize": "Minimize palette",
-    "maximize": "Maximize palette",
-    "no_items": "No results found."
+    "validate_button": "Validate model"
   },
   "viewport": {
     "shortcut_move_viewport": "Move viewport",
-    "shortcut_zoom_viewport": "Zoom viewport",
-    "shortcut_zoom_element": "Zoom element"
-  },
-  "shortcut": {
-    "title": "Keyboard Shortcuts",
-    "header_command": "Command",
-    "header_shortcut": "Keybinding",
-    "menu_title": "Shortcut Menu",
-    "group_move": "Move",
-    "group_graph": "Graph",
-    "group_resize": "Resize",
-    "group_focus": "Focus",
-    "group_zoom": "Zoom",
-    "group_navigation": "Navigation",
-    "group_grid": "Grid",
-    "group_search": "Search",
-    "group_tool_palette": "Tool Palette",
-    "group_viewport": "Viewport"
-  },
-  "diagram": {
-    "label": "Diagram"
-  },
-  "autocomplete": {
-    "no_suggestions": "No suggestions available"
-  },
-  "issue_marker": {
-    "severity_error": "ERROR",
-    "severity_warning": "WARNING",
-    "severity_info": "INFO"
+    "shortcut_zoom_element": "Zoom element",
+    "shortcut_zoom_viewport": "Zoom viewport"
   }
 }
diff --git a/packages/client/src/base/tool-manager/tool-manager.ts b/packages/client/src/base/tool-manager/tool-manager.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2024 EclipseSource and others.
+ * Copyright (c) 2019-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -133,8 +133,8 @@ export class ToolManager implements IToolManager, IDiagramStartup, IEditModeList
         this.actives.splice(0, this.actives.length);
     }
 
-    enableDefaultTools(): void {
-        if (this.defaultToolsEnabled) {
+    enableDefaultTools(force = false): void {
+        if (this.defaultToolsEnabled && !force) {
             return;
         }
         this.enable(pluck(this.defaultTools, 'id'));
@@ -171,7 +171,7 @@ export class ToolManager implements IToolManager, IDiagramStartup, IEditModeList
         if (newValue === EditMode.READONLY) {
             this.disableEditTools();
         } else if (newValue === EditMode.EDITABLE) {
-            this.enableDefaultTools();
+            this.enableDefaultTools(true);
         }
     }
 }
diff --git a/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-palette.ts b/packages/client/src/features/accessibility/edge-autocomplete/edge-autocomplete-palette.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2023-2024 Business Informatics Group (TU Wien) and others.
+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/client/src/features/accessibility/keyboard-grid/keyboard-grid-search-palette.ts b/packages/client/src/features/accessibility/keyboard-grid/keyboard-grid-search-palette.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/client/src/features/accessibility/keyboard-grid/keyboard-node-grid.ts b/packages/client/src/features/accessibility/keyboard-grid/keyboard-node-grid.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2023-2024 Business Informatics Group (TU Wien) and others.
+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/client/src/features/accessibility/keyboard/keyboard-module.ts b/packages/client/src/features/accessibility/keyboard/keyboard-module.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2023-2024 Business Informatics Group (TU Wien) and others.
+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
diff --git a/packages/client/src/features/context-menu/delete-element-context-menu.ts b/packages/client/src/features/context-menu/delete-element-context-menu.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2024 EclipseSource and others.
+ * Copyright (c) 2019-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,9 +13,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { DeleteElementOperation, GModelRoot, IContextMenuItemProvider, MenuItem, Point, TYPES } from '@eclipse-glsp/sprotty';
+import { ClientMenuItem, DeleteElementOperation, GModelRoot, IContextMenuItemProvider, Point, TYPES } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
 import { EditorContextService, EditorContextServiceProvider } from '../../base/editor-context-service';
+import { messages } from '../../base/messages';
 
 @injectable()
 export class DeleteElementContextMenuItemProvider implements IContextMenuItemProvider {
@@ -26,14 +27,17 @@ export class DeleteElementContextMenuItemProvider implements IContextMenuItemPro
     @inject(EditorContextService)
     protected editorContext: EditorContextService;
 
-    async getItems(_root: Readonly<GModelRoot>, _lastMousePosition?: Point): Promise<MenuItem[]> {
+    async getItems(_root: Readonly<GModelRoot>, _lastMousePosition?: Point): Promise<ClientMenuItem[]> {
+        if (this.editorContext.isReadonly) {
+            return [];
+        }
         return [this.createDeleteMenuItem()];
     }
 
-    protected createDeleteMenuItem(): MenuItem {
+    protected createDeleteMenuItem(): ClientMenuItem {
         return {
             id: 'delete',
-            label: 'Delete',
+            label: messages.context_menu.delete,
             sortString: 'd',
             group: 'edit',
             actions: [DeleteElementOperation.create(this.editorContext.selectedElements.map(e => e.id))],
diff --git a/packages/client/src/features/context-menu/server-context-menu-provider.ts b/packages/client/src/features/context-menu/server-context-menu-provider.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2024 EclipseSource and others.
+ * Copyright (c) 2019-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -14,11 +14,11 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import {
-    Action,
+    ClientMenuItem,
     GModelElement,
     IActionDispatcher,
     IContextMenuItemProvider,
-    LabeledAction,
+    MenuItem,
     Point,
     RequestContextActions,
     SetContextActions,
@@ -37,7 +37,7 @@ export class ServerContextMenuItemProvider implements IContextMenuItemProvider {
     @inject(TYPES.IActionDispatcher) protected actionDispatcher: IActionDispatcher;
     @inject(EditorContextService) protected editorContext: EditorContextService;
 
-    async getItems(root: Readonly<GModelElement>, _lastMousePosition?: Point): Promise<LabeledAction[]> {
+    async getItems(root: Readonly<GModelElement>, _lastMousePosition?: Point): Promise<ClientMenuItem[]> {
         const selectedElementIds = Array.from(
             root.index
                 .all()
@@ -50,10 +50,9 @@ export class ServerContextMenuItemProvider implements IContextMenuItemProvider {
         return response ? this.getContextActionsFromResponse(response) : [];
     }
 
-    getContextActionsFromResponse(action: Action): LabeledAction[] {
-        if (SetContextActions.is(action)) {
-            return action.actions;
-        }
-        return [];
+    getContextActionsFromResponse(action: SetContextActions): ClientMenuItem[] {
+        return action.actions
+            .filter(item => MenuItem.is(item)) //
+            .map(item => ClientMenuItem.convert(item));
     }
 }
diff --git a/packages/client/src/features/copy-paste/copy-paste-context-menu.ts b/packages/client/src/features/copy-paste/copy-paste-context-menu.ts
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2023 EclipseSource and others.
+ * Copyright (c) 2020-2025 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -14,21 +14,23 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 /* eslint-disable deprecation/deprecation */
-import { inject, injectable } from 'inversify';
 import {
     Action,
+    ClientMenuItem,
+    GModelRoot,
     IActionDispatcher,
     IActionHandler,
     IContextMenuItemProvider,
-    MenuItem,
-    Point,
-    GModelRoot,
     MessageAction,
+    Point,
     StatusAction,
     TYPES,
     hasStringProp,
     isSelected
 } from '@eclipse-glsp/sprotty';
+import { inject, injectable } from 'inversify';
+import { EditorContextService } from '../../base/editor-context-service';
+import { messages } from '../../base/messages';
 
 /**
  * An `InvokeCopyPasteAction` is dispatched by the client to initiate a cut, copy or paste operation.
@@ -89,39 +91,41 @@ export class InvokeCopyPasteActionHandler implements IActionHandler {
 
 @injectable()
 export class CopyPasteContextMenuItemProvider implements IContextMenuItemProvider {
-    getItems(root: Readonly<GModelRoot>, _lastMousePosition?: Point): Promise<MenuItem[]> {
+    @inject(EditorContextService)
+    protected editorContext: EditorContextService;
+
+    async getItems(root: Readonly<GModelRoot>, _lastMousePosition?: Point): Promise<ClientMenuItem[]> {
+        if (this.editorContext.isReadonly) {
+            return [];
+        }
         const hasSelectedElements = Array.from(root.index.all().filter(isSelected)).length > 0;
-        return Promise.resolve([
-            this.createCopyMenuItem(hasSelectedElements),
-            this.createCutMenuItem(hasSelectedElements),
-            this.createPasteMenuItem()
-        ]);
+        return [this.createCopyMenuItem(hasSelectedElements), this.createCutMenuItem(hasSelectedElements), this.createPasteMenuItem()];
     }
 
-    protected createPasteMenuItem(): MenuItem {
+    protected createPasteMenuItem(): ClientMenuItem {
         return {
             id: 'paste',
-            label: 'Paste',
+            label: messages.context_menu.paste,
             group: 'copy-paste',
             actions: [InvokeCopyPasteAction.create('paste')],
             isEnabled: () => true
         };
     }
 
-    protected createCutMenuItem(hasSelectedElements: boolean): MenuItem {
+    protected createCutMenuItem(hasSelectedElements: boolean): ClientMenuItem {
         return {
             id: 'cut',
-            label: 'Cut',
+            label: messages.context_menu.cut,
             group: 'copy-paste',
             actions: [InvokeCopyPasteAction.create('cut')],
             isEnabled: () => hasSelectedElements
         };
     }
 
-    protected createCopyMenuItem(hasSelectedElements: boolean): MenuItem {
+    protected createCopyMenuItem(hasSelectedElements: boolean): ClientMenuItem {
         return {
             id: 'copy',
-            label: 'Copy',
+            label: messages.context_menu.copy,
             group: 'copy-paste',
             actions: [InvokeCopyPasteAction.create('copy')],
             isEnabled: () => hasSelectedElements
diff --git a/packages/client/src/features/validation/marker-navigator.ts b/packages/client/src/features/validation/marker-navigator.ts
diff --git a/packages/client/src/index.ts b/packages/client/src/index.ts
diff --git a/packages/glsp-sprotty/src/api-override.ts b/packages/glsp-sprotty/src/api-override.ts
diff --git a/packages/glsp-sprotty/src/re-exports.ts b/packages/glsp-sprotty/src/re-exports.ts
diff --git a/packages/protocol/src/action-protocol/types.ts b/packages/protocol/src/action-protocol/types.ts

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/********************************************************************************`
`2`		`- * Copyright (c) 2019-2024 EclipseSource and others.`
	`2`	`+ * Copyright (c) 2019-2025 EclipseSource and others.`
`3`	`3`	`*`
`4`	`4`	`* This program and the accompanying materials are made available under the`
`5`	`5`	`* terms of the Eclipse Public License v. 2.0 which is available at`
`@@ -133,8 +133,8 @@ export class ToolManager implements IToolManager, IDiagramStartup, IEditModeList`
`133`	`133`	`this.actives.splice(0, this.actives.length);`
`134`	`134`	`}`
`135`	`135`
`136`		`- enableDefaultTools(): void {`
`137`		`- if (this.defaultToolsEnabled) {`
	`136`	`+ enableDefaultTools(force = false): void {`
	`137`	`+ if (this.defaultToolsEnabled && !force) {`
`138`	`138`	`return;`
`139`	`139`	`}`
`140`	`140`	`this.enable(pluck(this.defaultTools, 'id'));`
`@@ -171,7 +171,7 @@ export class ToolManager implements IToolManager, IDiagramStartup, IEditModeList`
`171`	`171`	`if (newValue === EditMode.READONLY) {`
`172`	`172`	`this.disableEditTools();`
`173`	`173`	`} else if (newValue === EditMode.EDITABLE) {`
`174`		`- this.enableDefaultTools();`
	`174`	`+ this.enableDefaultTools(true);`
`175`	`175`	`}`
`176`	`176`	`}`
`177`	`177`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/********************************************************************************`
`2`		`- * Copyright (c) 2023-2024 Business Informatics Group (TU Wien) and others.`
	`2`	`+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.`
`3`	`3`	`*`
`4`	`4`	`* This program and the accompanying materials are made available under the`
`5`	`5`	`* terms of the Eclipse Public License v. 2.0 which is available at`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/********************************************************************************`
`2`		`- * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.`
	`2`	`+ * Copyright (c) 2023-2025 Business Informatics Group (TU Wien) and others.`
`3`	`3`	`*`
`4`	`4`	`* This program and the accompanying materials are made available under the`
`5`	`5`	`* terms of the Eclipse Public License v. 2.0 which is available at`