@eclipse-glsp/client 1.1.0-next.6efef44.226 → 1.1.0-next.7be33cd.257

package/src/base/source-uri-aware.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2022 EclipseSource and others.
+ * Copyright (c) 2020-2023 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,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { AnyObject, hasStringProp } from '@eclipse-glsp/protocol';
+import { AnyObject, hasStringProp } from '~glsp-sprotty';
 export interface SourceUriAware {
     sourceURI: string;
 }

package/src/base/tool-manager/glsp-tool-manager.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2022 EclipseSource and others.
+ * Copyright (c) 2020-2023 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,19 +13,12 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { distinctAdd, EditMode } from '@eclipse-glsp/protocol';
 import { inject, injectable, multiInject, optional, postConstruct } from 'inversify';
-import { Tool, ToolManager } from 'sprotty';
-import { EditModeListener, EditorContextService, EditorContextServiceProvider } from '../editor-context-service';
-import { TYPES } from '../types';
-
-export interface IGLSPToolManager extends ToolManager {
-    /* Disables all actives tools and activates only default tool with non-edit function*/
-    disableEditTools(): void;
-}
+import { AnyObject, EditMode, TYPES, Tool, ToolManager, distinctAdd, hasBooleanProp, hasFunctionProp, hasStringProp } from '~glsp-sprotty';
+import { EditorContextService, EditorContextServiceProvider, IEditModeListener } from '../editor-context-service';
 
 @injectable()
-export class GLSPToolManager extends ToolManager implements IGLSPToolManager, EditModeListener {
+export class GLSPToolManager extends ToolManager implements IEditModeListener {
     protected editorContext?: EditorContextService;
 
     @multiInject(TYPES.ITool) @optional() override tools: Tool[];
@@ -38,7 +31,7 @@ export class GLSPToolManager extends ToolManager implements IGLSPToolManager, Ed
         this.registerDefaultTools(...this.defaultTools);
         this.enableDefaultTools();
         this.contextServiceProvider().then(editorContext => {
-            editorContext.register(this);
+            editorContext.onEditModeChanged(change => this.editModeChanged(change.newValue, change.oldValue));
             this.editorContext = editorContext;
         });
     }
@@ -59,7 +52,7 @@ export class GLSPToolManager extends ToolManager implements IGLSPToolManager, Ed
         this.disableActiveTools();
         let tools = toolIds.map(id => this.tool(id));
         if (this.editorContext && this.editorContext.isReadonly) {
-            tools = tools.filter(tool => tool && (!isGLSPTool(tool) || tool.isEditTool === false));
+            tools = tools.filter(tool => tool && (!GLSPTool.is(tool) || tool.isEditTool === false));
         }
         tools.forEach(tool => {
             if (tool !== undefined) {
@@ -71,10 +64,10 @@ export class GLSPToolManager extends ToolManager implements IGLSPToolManager, Ed
 
     disableEditTools(): void {
         this.disableActiveTools();
-        this.enable(this.defaultTools.filter(tool => !isGLSPTool(tool) || tool.isEditTool === false).map(tool => tool.id));
+        this.enable(this.defaultTools.filter(tool => !GLSPTool.is(tool) || tool.isEditTool === false).map(tool => tool.id));
     }
 
-    editModeChanged(oldValue: string, newValue: string): void {
+    editModeChanged(newValue: string, oldValue: string): void {
         if (oldValue === newValue) {
             return;
         }
@@ -90,6 +83,14 @@ export interface GLSPTool extends Tool {
     isEditTool: boolean;
 }
 
-export function isGLSPTool(tool: any): tool is GLSPTool {
-    return 'isEditTool' in tool && typeof tool['isEditTool'] === 'boolean';
+export namespace GLSPTool {
+    export function is(object: unknown): object is GLSPTool {
+        return (
+            AnyObject.is(object) &&
+            hasStringProp(object, 'id') &&
+            hasFunctionProp(object, 'enable') &&
+            hasFunctionProp(object, 'disable') &&
+            hasBooleanProp(object, 'isEditTool')
+        );
+    }
 }

package/src/{features/mouse-tool → base/view}/mouse-tool.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2022 EclipseSource and others.
+ * Copyright (c) 2019-2023 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,16 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action } from '@eclipse-glsp/protocol';
 import { injectable, multiInject, optional } from 'inversify';
-import { MouseListener, MouseTool, SModelElement, SModelRoot } from 'sprotty';
-import { TYPES } from '../../base/types';
-import { getRank } from '../rank/model';
-
-export interface IMouseTool {
-    register(mouseListener: MouseListener): void;
-    deregister(mouseListener: MouseListener): void;
-}
+import { Action, MouseListener, MouseTool, SModelElement, SModelRoot, TYPES } from '~glsp-sprotty';
+import { Ranked } from '../ranked';
 
 /**
  * Custom helper type to declare the explicit mouse listener methods
@@ -31,22 +24,22 @@ export interface IMouseTool {
 type MouseListenerMethods = keyof Omit<MouseListener, 'decorate'>;
 
 @injectable()
-export class RankingMouseTool extends MouseTool implements IMouseTool {
+export class RankingMouseTool extends MouseTool {
     protected rankedMouseListeners: Map<number, MouseListener[]>;
 
     constructor(@multiInject(TYPES.MouseListener) @optional() protected override mouseListeners: MouseListener[] = []) {
         super(mouseListeners);
-        this.rankedMouseListeners = groupBy(mouseListeners, listener => getRank(listener));
+        this.rankedMouseListeners = groupBy(mouseListeners, listener => Ranked.getRank(listener));
     }
 
     override register(mouseListener: MouseListener): void {
         super.register(mouseListener);
-        this.rankedMouseListeners = groupBy(this.mouseListeners, listener => getRank(listener));
+        this.rankedMouseListeners = groupBy(this.mouseListeners, listener => Ranked.getRank(listener));
     }
 
     override deregister(mouseListener: MouseListener): void {
         super.deregister(mouseListener);
-        this.rankedMouseListeners = groupBy(this.mouseListeners, listener => getRank(listener));
+        this.rankedMouseListeners = groupBy(this.mouseListeners, listener => Ranked.getRank(listener));
     }
 
     protected override handleEvent<K extends MouseListenerMethods>(methodName: K, model: SModelRoot, event: MouseEvent): void {
@@ -55,13 +48,12 @@ export class RankingMouseTool extends MouseTool implements IMouseTool {
         if (!element) {
             return;
         }
-        this.notifyListenersByRank(element, methodName, model, event);
+        this.notifyListenersByRank(element, methodName, event);
     }
 
-    async notifyListenersByRank<K extends MouseListenerMethods>(
+    protected async notifyListenersByRank<K extends MouseListenerMethods>(
         element: SModelElement,
         methodName: K,
-        model: SModelRoot,
         event: MouseEvent
     ): Promise<void> {
         for (const rank of this.rankedMouseListeners) {
@@ -69,7 +61,7 @@ export class RankingMouseTool extends MouseTool implements IMouseTool {
         }
     }
 
-    async dispatchActions<K extends MouseListenerMethods>(
+    protected async dispatchActions<K extends MouseListenerMethods>(
         mouseListeners: MouseListener[],
         methodName: K,
         element: SModelElement,

package/src/base/view/view-registry.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2021-2022 EclipseSource and others.
+ * Copyright (c) 2019-2023 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,7 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { injectable } from 'inversify';
-import { IView, ViewRegistry } from 'sprotty';
+import { IView, ViewRegistry } from '~glsp-sprotty';
 
 @injectable()
 export class GLSPViewRegistry extends ViewRegistry {

package/src/{base/container-modules.ts → container-modules.ts}

@@ -14,41 +14,42 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { remove } from '@eclipse-glsp/protocol';
 import { Container, ContainerModule } from 'inversify';
 import {
+    ContainerConfiguration,
     buttonModule,
     defaultModule,
     edgeIntersectionModule,
     edgeLayoutModule,
     expandModule,
     fadeModule,
+    initializeContainer,
     labelEditUiModule,
     modelSourceModule,
     openModule,
     routingModule,
     zorderModule
-} from 'sprotty';
-import glspBoundsModule from '../features/bounds/di.config';
-import glspCommandPaletteModule from '../features/command-palette/di.config';
-import glspContextMenuModule from '../features/context-menu/di.config';
-import { glspServerCopyPasteModule } from '../features/copy-paste/di.config';
-import glspDecorationModule from '../features/decoration/di.config';
-import glspEditLabelModule from '../features/edit-label/di.config';
-import glspExportModule from '../features/export/di.config';
-import modelHintsModule from '../features/hints/di.config';
-import glspHoverModule from '../features/hover/di.config';
-import layoutModule from '../features/layout/di.config';
-import glspMouseToolModule from '../features/mouse-tool/di.config';
-import { navigationModule } from '../features/navigation/di.config';
-import glspSelectModule from '../features/select/di.config';
-import sourceModelWatcherModule from '../features/source-model-watcher/di.config';
-import toolFeedbackModule from '../features/tool-feedback/di.config';
-import toolPaletteModule from '../features/tool-palette/di.config';
-import { enableDefaultToolsOnFocusLossModule, toolsModule } from '../features/tools/di.config';
-import { markerNavigatorModule, validationModule } from '../features/validation/di.config';
-import glspViewportModule from '../features/viewport/di.config';
-import defaultGLSPModule from './di.config';
+} from '~glsp-sprotty';
+import defaultGLSPModule from './base/di.config';
+import glspBoundsModule from './features/bounds/di.config';
+import glspCommandPaletteModule from './features/command-palette/di.config';
+import glspContextMenuModule from './features/context-menu/di.config';
+import { glspServerCopyPasteModule } from './features/copy-paste/di.config';
+import glspDecorationModule from './features/decoration/di.config';
+import glspEditLabelModule from './features/edit-label/di.config';
+import glspExportModule from './features/export/di.config';
+import modelHintsModule from './features/hints/di.config';
+import glspHoverModule from './features/hover/di.config';
+import layoutModule from './features/layout/di.config';
+import navigationModule from './features/navigation/di.config';
+import glspSelectModule from './features/select/di.config';
+import sourceModelWatcherModule from './features/source-model-watcher/di.config';
+import svgMetadataModule from './features/svg-metadata/di.config';
+import toolFeedbackModule from './features/tool-feedback/di.config';
+import toolPaletteModule from './features/tool-palette/di.config';
+import { enableDefaultToolsOnFocusLossModule, toolsModule } from './features/tools/di.config';
+import { markerNavigatorModule, validationModule } from './features/validation/di.config';
+import glspViewportModule from './features/viewport/di.config';
 
 export const DEFAULT_MODULES = [
     defaultModule,
@@ -65,7 +66,6 @@ export const DEFAULT_MODULES = [
     glspDecorationModule,
     glspEditLabelModule,
     glspHoverModule,
-    glspMouseToolModule,
     glspSelectModule,
     glspServerCopyPasteModule,
     glspViewportModule,
@@ -83,19 +83,25 @@ export const DEFAULT_MODULES = [
     toolsModule,
     enableDefaultToolsOnFocusLossModule,
     validationModule,
-    zorderModule
+    zorderModule,
+    svgMetadataModule
 ] as const;
 
 /**
- *  Creates a GLSP Diagram container with the GLSP default modules and the specified custom `modules`.
- *  Default modules can be excluded using {@link ExcludeDescription}s.
- *
+ *  Initializes a GLSP Diagram container with the GLSP default modules and the specified custom `modules`.
+ *  Additional modules can be passed as direct arguments or as part of a {@link ModuleConfiguration}.
+ *  ```typescript
+ *  const container= createDiagramContainer(myModule1, myModule2)
+ *  // or
+ *  const container= createDiagramContainer({ add: [myModule1, myModule2]})
+ *  ```
+ *  Default modules can be excluded using {@link ModuleConfiguration}s.
  *  This means, you can still customize the default modules in two ways.
  *
  * First, you can exclude default modules and add a module with your custom code.
  *
  * ```typescript
- * const container = createDiagramContainer(myModule1, {exclude: modelSourceWatcherModule},myModelSourceWatcherModule );
+ * const container = createDiagramContainer({ add:myModelSourceWatcherModule, remove: modelSourceWatcherModule} );
  * ```
  *
  * Second, you can unbind or rebind implementations that are originally bound in one of the default modules.
@@ -104,30 +110,12 @@ export const DEFAULT_MODULES = [
  * rebind(NavigationTargetResolver).to(MyNavigationTargetResolver);
  * ```
  *
- * @param customModules Custom modules to be loaded in addition to the default modules and/or default modules that should be excluded.
- * @param options Options to customize the module loading
- * @returns The created container.
- */
-export function createDiagramContainer(...customModules: Array<ContainerModule | ExcludeDescription>): Container {
-    const container = new Container();
-
-    const modules = [...DEFAULT_MODULES];
-    customModules.forEach(customModule => {
-        if (customModule instanceof ContainerModule) {
-            modules.push(customModule);
-        } else {
-            remove(modules, customModule.exclude);
-        }
-    });
-    container.load(...modules);
-    return container;
-}
-
-/**
- * Can be passed to the {@link createDiagramContainer} utility function to exclude (i.e. not load) a specific default module.
+ * @param containerConfiguration
+ *          Custom modules to be loaded in addition to the default modules and/or default modules that should be excluded.
+ * @returns The initialized container.
  */
-export interface ExcludeDescription {
-    exclude: ContainerModule;
+export function initializeDiagramContainer(container: Container, ...containerConfiguration: ContainerConfiguration): Container {
+    return initializeContainer(container, ...DEFAULT_MODULES, ...containerConfiguration);
 }
 
 /**
@@ -150,8 +138,8 @@ export interface ExcludeDescription {
  * ```
  * @param modules Custom modules to be loaded in addition to the default modules.
  * @returns The created container.
- * @deprecated Please use `createDiagramContainer` from `@eclipse-glsp/client` instead
+ * @deprecated Please use `initializeDiagramContainer` from `@eclipse-glsp/client` instead
  */
 export function createClientContainer(...modules: ContainerModule[]): Container {
-    return createDiagramContainer(...modules);
+    return initializeDiagramContainer(new Container(), ...modules);
 }

package/src/features/accessibility/README.md

@@ -0,0 +1,65 @@
+# Keyboard-Only: Accessibility Features
+
+The features presented in the following are introduced for disability-aware conceptual modeling and allow basic user model interactions to be performed only with the keyboard.
+
+## Getting started
+
+In order to activate and use all of the currently provided keyboard only accessibility features, the module `glspAccessibilityModule` needs to be in use.
+To activate and use only specific accessibility features, the respective module (see list below) needs to be in use.
+
+## Features
+
+Below is a list of the keyboard only accessibility features:<br>
+
+| Feature |                                           Description                                            |                                             Shortcut                                              |          Module           |
+| ------- | :----------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: | :-----------------------: |
+| Search  | Search for elements or edges using labels, types, etc. <br> with respective diagram highlighting |                                   <kbd>CTRL</kbd>+<kbd>F</kbd>                                    | `glspSearchPaletteModule` |
+| Move    |                       Move elements, edges or viewport into the directions                       |                <kbd>←</kbd> \|\| <kbd>↑</kbd> \|\| <kbd>→</kbd> \|\| <kbd>↓</kbd>                 |   `glspMoveZoomModule`    |
+| Zoom    |         Zoom in or out gradually to elements or viewport or reset to default zoom level.         |                 <kbd>+</kbd> \|\| <kbd>-</kbd> \|\| <kbd>CTRL</kbd>+<kbd>0</kbd>                  |   `glspMoveZoomModule`    |
+| Resize  |          Increase or decrease element sizes gradually or reset to default element size.          | <kbd>ALT</kbd>+<kbd>A</kbd> then <kbd>+</kbd> \|\| <kbd>-</kbd> \|\| <kbd>CTRL</kbd>+<kbd>0</kbd> |   `glspResizeKeyModule`   |
+
+## Usage
+
+#### Search
+
+The search palette allows to search labelled elements or edges that have a labelled node as source or target. The result set will be highlighted accordingly, to also be able to visually distinguish between the searched and the remaining parts of the given diagram.
+
+#### Read / Select via Search
+
+1. <kbd>CTRL</kbd> + <kbd>F</kbd>: Open the search palette
+2. In the palette's input field enter either the **type** or the **label** of nodes or edges. The arrow keys can be used to navigate in the search result list.
+3. <kbd>ENTER</kbd>: Select the node or edge that is highlighted in the search result list.
+
+### Model Exploration
+
+#### Move
+
+The move functionality can be used to move parts of the model, such as selected nodes or edges or the whole viewport in all directions.
+
+##### Steps
+
+1. Select one or multiple elements or the viewport.
+2. Use arrow keys (<kbd>←</kbd> || <kbd>↑</kbd> || <kbd>→</kbd> || <kbd>↓</kbd>) to move element(s) or viewport to the desired location.
+
+#### Zoom
+
+This zoom functionality can be used to gradually adapt the zoom level of one element, a set of elements or the
+viewport.
+
+#### Steps
+
+1. Select one or multiple elements or the viewport.
+2. Use <kbd>+</kbd> or <kbd>-</kbd> to zoom in or out gradually.
+3. <kbd>CTRL</kbd>+<kbd>0</kbd>: Set the zoom level to default.
+
+### Resize element
+
+The resize functionality helps to set the size of the nodes, by either increasing or decreasing the size of the nodes’ shape gradually.
+
+#### Steps
+
+1. Select one or multiple elements.
+2. <kbd>ALT</kbd>+<kbd>A</kbd>: Activate the resize mode.
+3. <kbd>+</kbd> or <kbd>-</kbd> to increase or decrease the size of the element(s) gradually.
+4. <kbd>CTRL</kbd>+<kbd>0</kbd>: Set the size of the element(s) to default.
+5. <kbd>ESC</kbd>: Deactivate the resize mode.

package/src/features/{mouse-tool → accessibility}/di.config.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2022 EclipseSource and others.
+ * Copyright (c) 2023 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
@@ -13,15 +13,20 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+
 import { ContainerModule } from 'inversify';
-import { MouseTool } from 'sprotty';
-import { TYPES } from '../../base/types';
-import { RankingMouseTool } from './mouse-tool';
+import { configureMoveZoom } from './move-zoom/di.config';
+import { configureResizeTools } from './resize-key-tool/di.config';
+import { configureSearchPaletteModule } from './search/di.config';
+import { configureViewKeyTools } from './view-key-tools/di.config';
 
-const glspMouseToolModule = new ContainerModule((bind, _unbind, _isBound, rebind) => {
-    bind(RankingMouseTool).toSelf().inSingletonScope();
-    bind(TYPES.MouseTool).toService(RankingMouseTool);
-    rebind(MouseTool).toService(RankingMouseTool);
+/**
+ * Enables the accessibility tools for a keyboard-only-usage
+ */
+export const glspAccessibilityModule = new ContainerModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    configureResizeTools(context);
+    configureViewKeyTools(context);
+    configureMoveZoom(context);
+    configureSearchPaletteModule(context);
 });
-
-export default glspMouseToolModule;

package/src/features/accessibility/move-zoom/di.config.ts

@@ -0,0 +1,42 @@
+/********************************************************************************
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { ContainerModule } from 'inversify';
+import { BindingContext, configureActionHandler } from '~glsp-sprotty';
+import { MoveElementAction, MoveElementHandler, MoveViewportAction, MoveViewportHandler } from './move-handler';
+import { ZoomElementAction, ZoomElementHandler, ZoomViewportAction, ZoomViewportHandler } from './zoom-handler';
+
+/**
+ * Handles move and zoom actions.
+ */
+export const glspMoveZoomModule = new ContainerModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    configureMoveZoom(context);
+});
+
+export function configureMoveZoom(context: BindingContext): void {
+    context.bind(MoveViewportHandler).toSelf().inSingletonScope();
+    context.bind(MoveElementHandler).toSelf().inSingletonScope();
+
+    context.bind(ZoomViewportHandler).toSelf().inSingletonScope();
+    context.bind(ZoomElementHandler).toSelf().inSingletonScope();
+
+    configureActionHandler(context, MoveViewportAction.KIND, MoveViewportHandler);
+    configureActionHandler(context, MoveElementAction.KIND, MoveElementHandler);
+
+    configureActionHandler(context, ZoomViewportAction.KIND, ZoomViewportHandler);
+    configureActionHandler(context, ZoomElementAction.KIND, ZoomElementHandler);
+}