@eclipse-glsp/client 1.1.0-next.fdfeeeb.193 → 2.1.0-next.12ca798.289

package/src/features/viewport/reposition.ts

@@ -0,0 +1,119 @@
+/********************************************************************************
+ * 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 {
+    Action,
+    Bounds,
+    BoundsAwareViewportCommand,
+    Dimension,
+    GChildElement,
+    GModelElement,
+    GModelRoot,
+    TYPES,
+    Viewport,
+    getRouteBounds,
+    hasArrayProp,
+    isViewport
+} from '@eclipse-glsp/sprotty';
+import { calcElementAndRoute } from '../../utils/gmodel-util';
+import { GEdge } from '../../model';
+
+export interface RepositionAction extends Action {
+    kind: typeof RepositionAction.KIND;
+    elementIDs: string[];
+}
+
+export namespace RepositionAction {
+    export const KIND = 'repositionAction';
+
+    export function is(object: any): object is RepositionAction {
+        return Action.hasKind(object, KIND) && hasArrayProp(object, 'elementIDs');
+    }
+
+    export function create(elementIDs: string[]): RepositionAction {
+        return {
+            kind: KIND,
+            elementIDs
+        };
+    }
+}
+
+/**
+ * Moves the viewport to an unvisible element, while maintaining the current zoom level.
+ */
+@injectable()
+export class RepositionCommand extends BoundsAwareViewportCommand {
+    static readonly KIND = RepositionAction.KIND;
+
+    constructor(@inject(TYPES.Action) protected action: RepositionAction) {
+        super(true);
+    }
+
+    protected override boundsInViewport(element: GModelElement, bounds: Bounds, viewport: GModelRoot & Viewport): Bounds {
+        if (element instanceof GChildElement && element.parent !== viewport) {
+            return this.boundsInViewport(element.parent, element.parent.localToParent(bounds) as Bounds, viewport);
+        } else if (element instanceof GEdge) {
+            const edgeBounds = getRouteBounds(calcElementAndRoute(element).newRoutingPoints ?? []);
+
+            if (element instanceof GChildElement && element.parent !== viewport) {
+                return this.boundsInViewport(element.parent, element.parent.localToParent(edgeBounds), viewport);
+            }
+
+            return edgeBounds;
+        }
+
+        return bounds;
+    }
+
+    getElementIds(): string[] {
+        return this.action.elementIDs;
+    }
+
+    getNewViewport(bounds: Bounds, model: GModelRoot): Viewport | undefined {
+        if (!Dimension.isValid(model.canvasBounds)) {
+            return undefined;
+        }
+
+        if (isViewport(model)) {
+            const zoom = model.zoom;
+            const c = Bounds.center(bounds);
+
+            if (this.isFullyVisible(bounds, model)) {
+                return undefined;
+            } else {
+                return {
+                    scroll: {
+                        x: c.x - (0.5 * model.canvasBounds.width) / zoom,
+                        y: c.y - (0.5 * model.canvasBounds.height) / zoom
+                    },
+                    zoom: zoom
+                };
+            }
+        }
+
+        return undefined;
+    }
+
+    protected isFullyVisible(bounds: Bounds, viewport: GModelRoot & Viewport): boolean {
+        return (
+            bounds.x >= viewport.scroll.x &&
+            bounds.x + bounds.width <= viewport.scroll.x + viewport.canvasBounds.width / viewport.zoom &&
+            bounds.y >= viewport.scroll.y &&
+            bounds.y + bounds.height <= viewport.scroll.y + viewport.canvasBounds.height / viewport.zoom
+        );
+    }
+}

package/src/features/viewport/viewport-handler.ts

@@ -0,0 +1,74 @@
+/********************************************************************************
+ * 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 { Action, IActionHandler, TYPES, ViewerOptions } from '@eclipse-glsp/sprotty';
+import { inject, injectable } from 'inversify';
+import { FocusTracker } from '../../base/focus/focus-tracker';
+import { IDiagramStartup } from '../../base/model/diagram-loader';
+import { EnableDefaultToolsAction } from '../../base/tool-manager/tool';
+import { FocusDomAction } from '../accessibility/actions';
+
+/**
+ * Focuses the graph on different actions.
+ */
+@injectable()
+export class RestoreViewportHandler implements IActionHandler, IDiagramStartup {
+    protected readonly graphSelector = '[data-svg-metadata-type="graph"]';
+
+    @inject(TYPES.ViewerOptions)
+    protected options: ViewerOptions;
+
+    @inject(FocusTracker)
+    protected focusTracker: FocusTracker;
+
+    handle(action: Action): void | Action {
+        if (EnableDefaultToolsAction.is(action) || (FocusDomAction.is(action) && action.id === 'graph')) {
+            this.focusGraph();
+        }
+    }
+
+    async postRequestModel(): Promise<void> {
+        await this.waitForElement(this.graphSelector);
+        this.focusGraph();
+    }
+
+    protected focusGraph(): void {
+        if (this.focusTracker.hasFocus) {
+            const container = this.focusTracker.diagramElement?.querySelector<HTMLElement>(this.graphSelector);
+            container?.focus();
+        }
+    }
+
+    // https://stackoverflow.com/questions/5525071/how-to-wait-until-an-element-exists
+    protected waitForElement(selector: string): Promise<Element | null> {
+        return new Promise(resolve => {
+            if (document.querySelector(selector)) {
+                return resolve(document.querySelector(selector));
+            }
+
+            const observer = new MutationObserver(mutations => {
+                if (document.querySelector(selector)) {
+                    observer.disconnect();
+                    resolve(document.querySelector(selector));
+                }
+            });
+
+            observer.observe(document.body, {
+                childList: true,
+                subtree: true
+            });
+        });
+    }
+}

package/src/features/viewport/viewport-modules.ts

@@ -0,0 +1,65 @@
+/********************************************************************************
+ * Copyright (c) 2021-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
+ * 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 {
+    bindAsService,
+    CenterCommand,
+    CenterKeyboardListener,
+    configureActionHandler,
+    configureCommand,
+    FeatureModule,
+    FitToScreenCommand,
+    GetViewportCommand,
+    SetViewportCommand,
+    TYPES,
+    ZoomMouseListener
+} from '@eclipse-glsp/sprotty';
+import { EnableDefaultToolsAction, EnableToolsAction } from '../../base/tool-manager/tool';
+import { GLSPScrollMouseListener } from './glsp-scroll-mouse-listener';
+import { RestoreViewportHandler } from './viewport-handler';
+import { RepositionCommand } from './reposition';
+import { FocusDomAction } from '../accessibility/actions';
+
+export const viewportModule = new FeatureModule((bind, _unbind, isBound) => {
+    const context = { bind, isBound };
+    configureCommand(context, CenterCommand);
+    configureCommand(context, FitToScreenCommand);
+    configureCommand(context, GetViewportCommand);
+    configureCommand(context, SetViewportCommand);
+    configureCommand(context, RepositionCommand);
+
+    bindAsService(context, TYPES.MouseListener, ZoomMouseListener);
+    bindAsService(context, TYPES.MouseListener, GLSPScrollMouseListener);
+
+    configureActionHandler(context, EnableToolsAction.KIND, GLSPScrollMouseListener);
+    configureActionHandler(context, EnableDefaultToolsAction.KIND, GLSPScrollMouseListener);
+
+    bindAsService(context, TYPES.IDiagramStartup, RestoreViewportHandler);
+    configureActionHandler(context, EnableDefaultToolsAction.KIND, RestoreViewportHandler);
+    configureActionHandler(context, FocusDomAction.KIND, RestoreViewportHandler);
+});
+
+/**
+ * Feature module that is intended for the standalone deployment of GLSP (i.e. plain webapp)
+ * When integrated into an application frame (e.g Theia/VS Code) this module is typically omitted and/or replaced
+ * with an application native module.
+ */
+export const standaloneViewportModule = new FeatureModule(
+    (bind, _unbind, isBound) => {
+        const context = { bind, isBound };
+        bindAsService(context, TYPES.KeyListener, CenterKeyboardListener);
+    },
+    { requires: viewportModule }
+);

package/src/index.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,114 +13,149 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import defaultGLSPModule from './base/di.config';
-import glspCommandPaletteModule from './features/command-palette/di.config';
-import glspContextMenuModule from './features/context-menu/di.config';
-import { copyPasteContextMenuModule, glspServerCopyPasteModule } from './features/copy-paste/di.config';
-import glspDecorationModule from './features/decoration/di.config';
-import glspEditLabelModule from './features/edit-label/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 saveModule from './features/save/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 paletteModule 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 * from '@eclipse-glsp/sprotty';
+
+// ------------------ Base ------------------
 export * from './base/action-dispatcher';
-export * from './base/actions/focus-change-action';
-export * from './base/argumentable';
+export * from './base/action-handler-registry';
+export * from './base/args-feature';
 export * from './base/auto-complete/auto-complete-actions';
 export * from './base/auto-complete/auto-complete-widget';
 export * from './base/auto-complete/validation-decorator';
 export * from './base/command-stack';
-export * from './base/container-modules';
-export { configureServerActions } from './base/di.config';
 export * from './base/drag-aware-mouse-listener';
 export * from './base/editor-context-service';
-export * from './base/focus-tracker';
-export * from './base/model-initialization-constraint';
+export * from './base/feedback/feedback-action-dispatcher';
+export * from './base/feedback/feedback-command';
+export * from './base/feedback/update-model-command';
+export * from './base/focus/focus-state-change-action';
+export * from './base/focus/focus-tracker';
+export * from './base/model/diagram-loader';
+export * from './base/model/glsp-model-source';
+export * from './base/model/model-initialization-constraint';
 export * from './base/model/model-registry';
-export * from './base/model/update-model-command';
+export * from './base/ranked';
 export * from './base/selection-clearing-mouse-listener';
-export * from './base/source-uri-aware';
-export * from './base/tool-manager/tool-actions';
-export * from './base/types';
+export * from './base/selection-service';
+export * from './base/tool-manager/tool';
+export * from './base/tool-manager/tool-manager';
+export * from './base/view/mouse-tool';
 export * from './base/view/view-registry';
+
+// ------------------ Features ------------------
+export * from './base/feedback/css-feedback';
+export * from './base/view/mouse-tool';
+export * from './features/accessibility/element-navigation/diagram-navigation-tool';
+export * from './features/accessibility/focus-tracker/focus-tracker-tool';
+export * from './features/accessibility/key-shortcut/accessible-key-shortcut-tool';
+export * from './features/accessibility/resize-key-tool/resize-key-tool';
+export * from './features/accessibility/toast/toast-tool';
+export * from './features/accessibility/view-key-tools/deselect-key-tool';
+export * from './features/accessibility/view-key-tools/movement-key-tool';
+export * from './features/accessibility/view-key-tools/zoom-key-tool';
+export * from './features/bounds/freeform-layout';
+export * from './features/bounds/glsp-hidden-bounds-updater';
+export * from './features/bounds/hbox-layout';
+export * from './features/bounds/layouter';
+export * from './features/bounds/vbox-layout';
 export * from './features/change-bounds/model';
 export * from './features/change-bounds/movement-restrictor';
 export * from './features/change-bounds/snap';
+export * from './features/command-palette/command-palette-tool';
 export * from './features/command-palette/server-command-palette-provider';
 export * from './features/context-menu/delete-element-context-menu';
+export * from './features/context-menu/glsp-context-menu-mouse-listener';
+export * from './features/context-menu/server-context-menu-provider';
+export * from './features/copy-paste/copy-paste-context-menu';
 export * from './features/copy-paste/copy-paste-handler';
 export * from './features/decoration/decoration-placer';
-export * from './features/edit-label/edit-label-tool';
-export * from './features/edit-label/edit-label-validator';
+export * from './features/export/glsp-svg-exporter';
 export * from './features/hints/model';
-export * from './features/hints/type-hints';
+export * from './features/hints/type-hint-provider';
 export * from './features/hover/hover';
+export * from './features/label-edit/edit-label-tool';
+export * from './features/label-edit/edit-label-validator';
 export * from './features/layout/layout-elements-action';
-export * from './features/mouse-tool/mouse-tool';
 export * from './features/navigation/navigation-action-handler';
 export * from './features/navigation/navigation-target-resolver';
-export * from './features/rank/model';
 export * from './features/reconnect/model';
-export * from './features/save/model';
+export * from './features/routing/glsp-manhattan-edge-router';
 export * from './features/save/save-keylistener';
+export * from './features/select/select-feedback-command';
+export * from './features/select/select-mouse-listener';
 export * from './features/source-model-watcher/source-model-changed-action-handler';
-export * from './features/tool-feedback/change-bounds-tool-feedback';
-export * from './features/tool-feedback/creation-tool-feedback';
-export * from './features/tool-feedback/css-feedback';
-export * from './features/tool-feedback/edge-edit-tool-feedback';
-export * from './features/tool-feedback/feedback-action-dispatcher';
-export * from './features/tool-feedback/model';
+export * from './features/status/status-overlay';
+export * from './features/svg-metadata/metadata-placer';
 export * from './features/tool-palette/tool-palette';
-export * from './features/tools/base-glsp-tool';
-export * from './features/tools/change-bounds-tool';
-export * from './features/tools/delete-tool';
-export * from './features/tools/edge-creation-tool';
-export * from './features/tools/edge-edit-tool';
-export * from './features/tools/marquee-behavior';
-export * from './features/tools/node-creation-tool';
+export * from './features/tools/base-tools';
+export * from './features/tools/change-bounds/change-bounds-tool';
+export * from './features/tools/change-bounds/change-bounds-tool-feedback';
+export * from './features/tools/change-bounds/view';
+export * from './features/tools/deletion/delete-tool';
+export * from './features/tools/edge-creation/edge-creation-tool';
+export * from './features/tools/edge-creation/edge-creation-tool-feedback';
+export * from './features/tools/edge-creation/view';
+export * from './features/tools/edge-edit/edge-edit-tool';
+export * from './features/tools/edge-edit/edge-edit-tool-feedback';
+export * from './features/tools/marquee-selection/marquee-behavior';
+export * from './features/tools/marquee-selection/marquee-mouse-tool';
+export * from './features/tools/marquee-selection/marquee-tool';
+export * from './features/tools/marquee-selection/marquee-tool-feedback';
+export * from './features/tools/marquee-selection/model';
+export * from './features/tools/marquee-selection/view';
+export * from './features/tools/node-creation/node-creation-tool';
+export * from './features/undo-redo/undo-redo-key-listener';
 export * from './features/validation/issue-marker';
 export * from './features/validation/marker-navigator';
 export * from './features/validation/validate';
 export * from './features/viewport/glsp-scroll-mouse-listener';
-export * from './lib/model';
-export * from './model-source/glsp-diagram-server';
-export * from './sprotty-reexport';
+
+// ------------------ Misc ------------------
+export * from './default-modules';
+export * from './model';
+export * from './standalone-modules';
 export * from './utils/argument-utils';
+export * from './utils/gmodel-util';
+export * from './utils/html-utils';
+export * from './utils/layout-utils';
 export * from './utils/marker';
-export * from './utils/smodel-util';
 export * from './utils/viewpoint-util';
 export * from './views';
-export {
-    validationModule,
-    saveModule,
-    paletteModule,
-    toolFeedbackModule,
-    defaultGLSPModule,
-    modelHintsModule,
-    glspCommandPaletteModule,
-    glspContextMenuModule,
-    glspServerCopyPasteModule,
-    copyPasteContextMenuModule,
-    glspSelectModule,
-    glspMouseToolModule,
-    layoutModule,
-    glspEditLabelModule,
-    glspHoverModule,
-    toolsModule,
-    enableDefaultToolsOnFocusLossModule,
-    navigationModule,
-    markerNavigatorModule,
-    glspDecorationModule,
-    sourceModelWatcherModule as modelSourceWatcherModule,
-    glspViewportModule
-};
+// ------------------ DI Modules ------------------
+export * from './base/default.module';
+export * from './features/accessibility/accessibility-module';
+export * from './features/accessibility/element-navigation/element-navigation-module';
+export * from './features/accessibility/focus-tracker/focus-tracker-module';
+export * from './features/accessibility/move-zoom/move-zoom-module';
+export * from './features/accessibility/resize-key-tool/resize-key-module';
+export * from './features/accessibility/search/search-palette-module';
+export * from './features/accessibility/toast/toast-module';
+export * from './features/accessibility/view-key-tools/view-key-tools-module';
+export * from './features/command-palette/command-palette-module';
+export * from './features/context-menu/context-menu-module';
+export * from './features/copy-paste/copy-paste-modules';
+export * from './features/decoration/decoration-module';
+export * from './features/export/export-modules';
+export * from './features/hints/type-hints-module';
+export * from './features/hover/hover-module';
+export * from './features/label-edit/label-edit-module';
+export * from './features/layout/layout-module';
+export * from './features/navigation/navigation-module';
+export * from './features/routing/routing-module';
+export * from './features/save/save-module';
+export * from './features/select/select-module';
+export * from './features/source-model-watcher/source-model-wacher-module';
+export * from './features/status/status-module';
+export * from './features/svg-metadata/svg-metadata-module';
+export * from './features/tool-palette/tool-palette-module';
+export * from './features/tools/change-bounds/change-boounds-tool-module';
+export * from './features/tools/deletion/deletion-tool-module';
+export * from './features/tools/edge-creation/edege-creation-module';
+export * from './features/tools/edge-edit/edge-edit-module';
+export * from './features/tools/marquee-selection/marquee-selection-module';
+export * from './features/tools/node-creation/node-creation-module';
+export * from './features/tools/tool-focus-loss-module';
+export * from './features/undo-redo/undo-redo-module';
+export * from './features/validation/validation-modules';
+export * from './features/viewport/viewport-modules';

package/src/model.ts

@@ -0,0 +1,72 @@
+/********************************************************************************
+ * Copyright (c) 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
+ * 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 {
+    Args,
+    Bounds,
+    GModelElementSchema,
+    GShapeElement,
+    Point,
+    SEdgeImpl,
+    SGraphImpl,
+    getRouteBounds,
+    isBounds
+} from '@eclipse-glsp/sprotty';
+import { ArgsAware, argsFeature } from './base/args-feature';
+import { Containable, containerFeature } from './features/hints/model';
+
+export class GGraph extends SGraphImpl implements Containable, ArgsAware {
+    static override readonly DEFAULT_FEATURES = [...SGraphImpl.DEFAULT_FEATURES, containerFeature, argsFeature];
+    args?: Args;
+    isContainableElement(_input: string | GShapeElement | GModelElementSchema): boolean {
+        return true;
+    }
+}
+
+export class GEdge extends SEdgeImpl implements ArgsAware {
+    static override readonly DEFAULT_FEATURES = [...SEdgeImpl.DEFAULT_FEATURES, argsFeature];
+
+    args?: Args;
+
+    override localToParent(point: Point | Bounds): Bounds {
+        const bounds = getRouteBounds(this.routingPoints);
+        const result = {
+            x: point.x + bounds.x,
+            y: point.y + bounds.y,
+            width: -1,
+            height: -1
+        };
+        if (isBounds(point)) {
+            result.width = point.width;
+            result.height = point.height;
+        }
+        return result;
+    }
+
+    override parentToLocal(point: Point | Bounds): Bounds {
+        const bounds = getRouteBounds(this.routingPoints);
+        const result = {
+            x: point.x - bounds.x,
+            y: point.y - bounds.y,
+            width: -1,
+            height: -1
+        };
+        if (isBounds(point)) {
+            result.width = point.width;
+            result.height = point.height;
+        }
+        return result;
+    }
+}