@eclipse-glsp/client 1.1.0-RC09 → 1.1.0-next.0363f0b.261

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

@@ -14,75 +14,80 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { ContainerConfiguration, initializeContainer } from '@eclipse-glsp/protocol';
 import { Container, ContainerModule } from 'inversify';
 import {
+    ContainerConfiguration,
+    FeatureModule,
     buttonModule,
-    defaultModule,
     edgeIntersectionModule,
     edgeLayoutModule,
     expandModule,
     fadeModule,
     labelEditUiModule,
     modelSourceModule,
-    openModule,
-    routingModule,
+    resolveContainerConfiguration,
     zorderModule
-} from 'sprotty';
-import svgMetadataModule from '../features/svg-metadata/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 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 { defaultModule } from './base/default.module';
+import { boundsModule } from './features/bounds/bounds-module';
+import { commandPaletteModule } from './features/command-palette/command-palette-module';
+import { contextMenuModule } from './features/context-menu/context-menu-module';
+import { copyPasteModule } from './features/copy-paste/copy-paste-modules';
+import { decorationModule } from './features/decoration/decoration-module';
+import { exportModule } from './features/export/export-modules';
+import { typeHintsModule } from './features/hints/type-hints-module';
+import { hoverModule } from './features/hover/hover-module';
+import { labelEditModule } from './features/label-edit/label-edit-module';
+import { layoutModule } from './features/layout/layout-module';
+import { navigationModule } from './features/navigation/navigation-module';
+import { routingModule } from './features/routing/routing-module';
+import { selectModule } from './features/select/select-module';
+import { sourceModelWatcherModule } from './features/source-model-watcher/source-model-wacher-module';
+import { svgMetadataModule } from './features/svg-metadata/svg-metadata-module';
+import { toolPaletteModule } from './features/tool-palette/tool-palette-module';
+import { changeBoundsToolModule } from './features/tools/change-bounds/change-boounds-tool-module';
+import { deletionToolModule } from './features/tools/deletion/deletion-tool-module';
+import { edgeCreationToolModule } from './features/tools/edge-creation/edege-creation-module';
+import { edgeEditToolModule } from './features/tools/edge-edit/edge-edit-module';
+import { marqueeSelectionToolModule } from './features/tools/marquee-selection/marquee-selection-module';
+import { nodeCreationToolModule } from './features/tools/node-creation/node-creation-module';
+import { toolFocusLossModule } from './features/tools/tool-focus-loss-module';
+import { markerNavigatorModule, validationModule } from './features/validation/validation-modules';
+import { viewportModule } from './features/viewport/viewport-modules';
 
 export const DEFAULT_MODULES = [
     defaultModule,
-    defaultGLSPModule,
     buttonModule,
     edgeIntersectionModule,
     edgeLayoutModule,
     expandModule,
-    glspExportModule,
+    exportModule,
     fadeModule,
-    glspBoundsModule,
-    glspCommandPaletteModule,
-    glspContextMenuModule,
-    glspDecorationModule,
-    glspEditLabelModule,
-    glspHoverModule,
-    glspMouseToolModule,
-    glspSelectModule,
-    glspServerCopyPasteModule,
-    glspViewportModule,
+    boundsModule,
+    commandPaletteModule,
+    contextMenuModule,
+    decorationModule,
+    labelEditModule,
+    hoverModule,
+    selectModule,
+    copyPasteModule,
+    viewportModule,
     labelEditUiModule,
     layoutModule,
     markerNavigatorModule,
-    modelHintsModule,
+    typeHintsModule,
     modelSourceModule,
     sourceModelWatcherModule,
     navigationModule,
-    openModule,
-    toolPaletteModule,
     routingModule,
-    toolFeedbackModule,
-    toolsModule,
-    enableDefaultToolsOnFocusLossModule,
+    toolPaletteModule,
+    edgeCreationToolModule,
+    edgeEditToolModule,
+    deletionToolModule,
+    nodeCreationToolModule,
+    changeBoundsToolModule,
+    marqueeSelectionToolModule,
+    toolFocusLossModule,
     validationModule,
     zorderModule,
     svgMetadataModule
@@ -110,13 +115,24 @@ export const DEFAULT_MODULES = [
  * ```typescript
  * rebind(NavigationTargetResolver).to(MyNavigationTargetResolver);
  * ```
- *
- * @param containerConfiguration
+ * @param container The container that should be initialized
+ * @param containerConfigurations
  *          Custom modules to be loaded in addition to the default modules and/or default modules that should be excluded.
+ * @throws An error if the first module to load is not the `defaultModule` (or an equivalent custom replacement module)
  * @returns The initialized container.
  */
-export function initializeDiagramContainer(container: Container, ...containerConfiguration: ContainerConfiguration): Container {
-    return initializeContainer(container, ...DEFAULT_MODULES, ...containerConfiguration);
+export function initializeDiagramContainer(container: Container, ...containerConfigurations: ContainerConfiguration): Container {
+    const modules = resolveContainerConfiguration(...DEFAULT_MODULES, ...containerConfigurations);
+    // The `defaultModule` (or a custom replacement module with the same `featureId`) should be the first module that is
+    // loaded into the container
+    const firstModule = modules[0];
+    if (!firstModule || !(firstModule instanceof FeatureModule && firstModule.featureId === defaultModule.featureId)) {
+        throw new Error(
+            'Invalid module configuration. The first module to load should be the `defaultModule` (or an equivalent replacement module)'
+        );
+    }
+    container.load(...modules);
+    return container;
 }
 
 /**

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 `accessibilityModule` 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>                                    | `searchPaletteModule` |
+| Move    |                       Move elements, edges or viewport into the directions                       |                <kbd>←</kbd> \|\| <kbd>↑</kbd> \|\| <kbd>→</kbd> \|\| <kbd>↓</kbd>                 |   `moveZoomModule`    |
+| 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>                  |   `moveZoomModule`    |
+| 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> |   `resizeKeyModule`   |
+
+## 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/accessibility/accessibility-module.ts

@@ -0,0 +1,32 @@
+/********************************************************************************
+ * 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 { FeatureModule } from '~glsp-sprotty';
+import { configureMoveZoom } from './move-zoom/move-zoom-module';
+import { configureResizeTools } from './resize-key-tool/resize-key-module';
+import { configureSearchPaletteModule } from './search/search-palette-module';
+import { configureViewKeyTools } from './view-key-tools/view-key-tools-module';
+
+/**
+ * Enables the accessibility tools for a keyboard-only-usage
+ */
+export const accessibilityModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    configureResizeTools(context);
+    configureViewKeyTools(context);
+    configureMoveZoom(context);
+    configureSearchPaletteModule(context);
+});

package/src/features/accessibility/move-zoom/move-handler.ts

@@ -0,0 +1,209 @@
+/********************************************************************************
+ * 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 { inject, injectable } from 'inversify';
+import { throttle } from 'lodash';
+import {
+    Action,
+    ChangeBoundsOperation,
+    IActionDispatcher,
+    IActionHandler,
+    ICommand,
+    Point,
+    SModelRoot,
+    SetViewportAction,
+    TYPES,
+    Viewport,
+    findParentByFeature,
+    isViewport
+} from '~glsp-sprotty';
+import { EditorContextService } from '../../../base/editor-context-service';
+import { SelectableBoundsAware, getElements, isSelectableAndBoundsAware } from '../../../utils/smodel-util';
+
+/**
+ * Action for triggering moving of the viewport.
+ */
+export interface MoveViewportAction extends Action {
+    kind: typeof MoveViewportAction.KIND;
+    /**
+     * used to specify the amount to be moved in the x-axis
+     */
+    moveX: number;
+    /**
+     * used to specify the amount to be moved in the y-axis
+     */
+    moveY: number;
+}
+
+export namespace MoveViewportAction {
+    export const KIND = 'moveViewportAction';
+
+    export function is(object: any): object is MoveViewportAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(moveX: number, moveY: number): MoveViewportAction {
+        return { kind: KIND, moveX, moveY };
+    }
+}
+
+/**
+ * Action for triggering moving of elements.
+ */
+export interface MoveElementAction extends Action {
+    kind: typeof MoveElementAction.KIND;
+    /**
+     * used to specify the elements to be zoomed in/out
+     */
+    elementIds: string[];
+    /**
+     * used to specify the amount to be moved in the x-axis
+     */
+    moveX: number;
+    /**
+     * used to specify the amount to be moved in the y-axis
+     */
+    moveY: number;
+}
+
+export namespace MoveElementAction {
+    export const KIND = 'moveElementAction';
+
+    export function is(object: any): object is MoveElementAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(elementIds: string[], moveX: number, moveY: number): MoveElementAction {
+        return { kind: KIND, elementIds, moveX, moveY };
+    }
+}
+
+/* The MoveViewportHandler class is an implementation of the IActionHandler interface that handles
+moving of the viewport. */
+@injectable()
+export class MoveViewportHandler implements IActionHandler {
+    @inject(EditorContextService)
+    protected editorContextService: EditorContextService;
+
+    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
+    protected readonly throttledHandleViewportMove = throttle((action: MoveViewportAction) => this.handleMoveViewport(action), 150);
+
+    handle(action: Action): void | Action | ICommand {
+        if (MoveViewportAction.is(action)) {
+            this.throttledHandleViewportMove(action);
+        }
+    }
+
+    handleMoveViewport(action: MoveViewportAction): void {
+        const viewport = findParentByFeature(this.editorContextService.modelRoot, isViewport);
+        if (!viewport) {
+            return;
+        }
+        this.dispatcher.dispatch(this.moveViewport(viewport, action.moveX, action.moveY));
+    }
+
+    protected moveViewport(viewport: SModelRoot & Viewport, offsetX: number, offSetY: number): SetViewportAction {
+        const newViewport: Viewport = {
+            scroll: {
+                x: viewport.scroll.x + offsetX,
+                y: viewport.scroll.y + offSetY
+            },
+            zoom: viewport.zoom
+        };
+
+        return SetViewportAction.create(viewport.id, newViewport, { animate: true });
+    }
+}
+
+/* The MoveElementHandler class is an implementation of the IActionHandler interface that handles
+moving elements. */
+@injectable()
+export class MoveElementHandler implements IActionHandler {
+    @inject(EditorContextService)
+    protected editorContextService: EditorContextService;
+    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
+    protected readonly throttledHandleElementMove = throttle((action: MoveElementAction) => this.handleMoveElement(action), 150);
+
+    handle(action: Action): void | Action | ICommand {
+        if (MoveElementAction.is(action)) {
+            this.throttledHandleElementMove(action);
+        }
+    }
+
+    handleMoveElement(action: MoveElementAction): void {
+        const viewport = findParentByFeature(this.editorContextService.modelRoot, isViewport);
+        if (!viewport) {
+            return;
+        }
+
+        const elements = getElements(this.editorContextService.modelRoot.index, action.elementIds, isSelectableAndBoundsAware);
+
+        this.dispatcher.dispatchAll(this.move(viewport, elements, action.moveX, action.moveY));
+    }
+
+    protected getBounds(element: SelectableBoundsAware, offSetX: number, offSetY: number): Point {
+        return { x: element.bounds.x + offSetX, y: element.bounds.y + offSetY };
+    }
+
+    protected adaptViewport(
+        viewport: SModelRoot & Viewport,
+        newPoint: Point,
+        moveX: number,
+        moveY: number
+    ): MoveViewportAction | undefined {
+        if (
+            newPoint.x < viewport.scroll.x ||
+            newPoint.x > viewport.scroll.x + viewport.canvasBounds.width ||
+            newPoint.y < viewport.scroll.y ||
+            newPoint.y > viewport.scroll.y + viewport.canvasBounds.height
+        ) {
+            return MoveViewportAction.create(moveX, moveY);
+        }
+        return;
+    }
+
+    protected moveElement(element: SelectableBoundsAware, offSetX: number, offSetY: number): ChangeBoundsOperation {
+        return ChangeBoundsOperation.create([
+            {
+                elementId: element.id,
+                newSize: {
+                    width: element.bounds.width,
+                    height: element.bounds.height
+                },
+                newPosition: {
+                    x: element.bounds.x + offSetX,
+                    y: element.bounds.y + offSetY
+                }
+            }
+        ]);
+    }
+
+    protected move(viewport: SModelRoot & Viewport, selectedElements: SelectableBoundsAware[], deltaX: number, deltaY: number): Action[] {
+        const results: Action[] = [];
+
+        if (selectedElements.length !== 0) {
+            selectedElements.forEach(currentElement => {
+                results.push(this.moveElement(currentElement, deltaX, deltaY));
+                const newPosition = this.getBounds(currentElement, deltaX, deltaY);
+                const viewportAction = this.adaptViewport(viewport, newPosition, deltaX, deltaY);
+                if (viewportAction) {
+                    results.push(viewportAction);
+                }
+            });
+        }
+        return results;
+    }
+}

package/src/features/accessibility/move-zoom/move-zoom-module.ts

@@ -0,0 +1,41 @@
+/********************************************************************************
+ * 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 { BindingContext, FeatureModule, 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 moveZoomModule = new FeatureModule((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);
+}