@eclipse-glsp/client 1.1.0-next.93fd4ec.241 → 1.1.0-next.976795c.271

package/src/features/navigation/navigation-target-resolver.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,11 +13,17 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { NavigationTarget, ResolveNavigationTargetAction, ResponseAction, SetResolvedNavigationTargetAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
-import { IActionDispatcher, ILogger } from 'sprotty';
-import { EditorContextServiceProvider } from '../../base/editor-context-service';
-import { TYPES } from '../../base/types';
+import {
+    IActionDispatcher,
+    ILogger,
+    NavigationTarget,
+    ResolveNavigationTargetAction,
+    ResponseAction,
+    SetResolvedNavigationTargetAction,
+    TYPES
+} from '~glsp-sprotty';
+import { IDiagramOptions } from '../../base/model/diagram-loader';
 
 /**
  * Resolves `NavigationTargets` to element ids.
@@ -27,14 +33,17 @@ import { TYPES } from '../../base/types';
  */
 @injectable()
 export class NavigationTargetResolver {
-    @inject(TYPES.IEditorContextServiceProvider) protected editorContextService: EditorContextServiceProvider;
-    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
-    @inject(TYPES.ILogger) protected readonly logger: ILogger;
+    @inject(TYPES.IActionDispatcher)
+    protected dispatcher: IActionDispatcher;
+
+    @inject(TYPES.ILogger)
+    protected logger: ILogger;
+
+    @inject(TYPES.IDiagramOptions)
+    protected diagramOptions: IDiagramOptions;
 
     async resolve(navigationTarget: NavigationTarget): Promise<SetResolvedNavigationTargetAction | undefined> {
-        const contextService = await this.editorContextService();
-        const sourceUri = await contextService.getSourceUri();
-        return this.resolveWithSourceUri(sourceUri, navigationTarget);
+        return this.resolveWithSourceUri(this.diagramOptions.sourceUri, navigationTarget);
     }
 
     async resolveWithSourceUri(

package/src/features/reconnect/model.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
@@ -22,7 +22,7 @@ import {
     SModelExtension,
     SRoutableElement,
     SRoutingHandle
-} from 'sprotty';
+} from '~glsp-sprotty';
 
 export const reconnectFeature = Symbol('reconnectFeature');
 

package/src/features/routing/glsp-manhattan-edge-router.ts

@@ -0,0 +1,59 @@
+/********************************************************************************
+ * Copyright (c) 2022-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 { ManhattanEdgeRouter, ResolvedHandleMove, SRoutableElement, almostEquals } from '~glsp-sprotty';
+
+export class GLSPManhattanEdgeRouter extends ManhattanEdgeRouter {
+    protected override applyInnerHandleMoves(edge: SRoutableElement, moves: ResolvedHandleMove[]): void {
+        const route = this.route(edge);
+        const routingPoints = edge.routingPoints;
+        const minimalPointDistance = this.getOptions(edge).minimalPointDistance;
+        moves.forEach(move => {
+            const handle = move.handle;
+            const index = handle.pointIndex;
+            const correctedX = this.correctX(routingPoints, index, move.toPosition.x, minimalPointDistance);
+            const correctedY = this.correctY(routingPoints, index, move.toPosition.y, minimalPointDistance);
+            switch (handle.kind) {
+                case 'manhattan-50%':
+                    if (index < 0) {
+                        if (routingPoints.length === 0) {
+                            routingPoints.push({ x: correctedX, y: correctedY });
+                            move.handle.pointIndex = 0;
+                        } else if (almostEquals(route[0].x, route[1].x)) {
+                            this.alignX(routingPoints, 0, correctedX);
+                        } else {
+                            this.alignY(routingPoints, 0, correctedY);
+                        }
+                    } else if (index < routingPoints.length - 1) {
+                        if (almostEquals(routingPoints[index].x, routingPoints[index + 1].x)) {
+                            this.alignX(routingPoints, index, correctedX);
+                            this.alignX(routingPoints, index + 1, correctedX);
+                        } else {
+                            this.alignY(routingPoints, index, correctedY);
+                            this.alignY(routingPoints, index + 1, correctedY);
+                        }
+                    } else {
+                        if (almostEquals(route[route.length - 2].x, route[route.length - 1].x)) {
+                            this.alignX(routingPoints, routingPoints.length - 1, correctedX);
+                        } else {
+                            this.alignY(routingPoints, routingPoints.length - 1, correctedY);
+                        }
+                    }
+                    break;
+            }
+        });
+    }
+}

package/src/features/routing/routing-module.ts

@@ -0,0 +1,59 @@
+/********************************************************************************
+ * 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
+ * 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 {
+    AddRemoveBezierSegmentCommand,
+    AnchorComputerRegistry,
+    BezierDiamondAnchor,
+    BezierEdgeRouter,
+    BezierEllipseAnchor,
+    BezierRectangleAnchor,
+    DiamondAnchor,
+    EdgeRouterRegistry,
+    EllipseAnchor,
+    FeatureModule,
+    ManhattanDiamondAnchor,
+    ManhattanEllipticAnchor,
+    ManhattanRectangularAnchor,
+    PolylineEdgeRouter,
+    RectangleAnchor,
+    TYPES,
+    bindAsService,
+    configureCommand
+} from '~glsp-sprotty';
+import { GLSPManhattanEdgeRouter } from './glsp-manhattan-edge-router';
+
+export const routingModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    bind(EdgeRouterRegistry).toSelf().inSingletonScope();
+    bind(AnchorComputerRegistry).toSelf().inSingletonScope();
+
+    bindAsService(context, TYPES.IEdgeRouter, GLSPManhattanEdgeRouter);
+    bindAsService(context, TYPES.IAnchorComputer, ManhattanEllipticAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, ManhattanRectangularAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, ManhattanDiamondAnchor);
+
+    bindAsService(context, TYPES.IEdgeRouter, PolylineEdgeRouter);
+    bindAsService(context, TYPES.IAnchorComputer, EllipseAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, RectangleAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, DiamondAnchor);
+
+    bindAsService(context, TYPES.IEdgeRouter, BezierEdgeRouter);
+    bindAsService(context, TYPES.IAnchorComputer, BezierEllipseAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, BezierRectangleAnchor);
+    bindAsService(context, TYPES.IAnchorComputer, BezierDiamondAnchor);
+
+    configureCommand({ bind, isBound }, AddRemoveBezierSegmentCommand);
+});

package/src/features/save/save-keylistener.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,9 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, SaveModelAction } from '@eclipse-glsp/protocol';
-import { KeyListener, SModelRoot } from 'sprotty';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { Action, KeyListener, SModelRoot, SaveModelAction, matchesKeystroke } from '~glsp-sprotty';
 
 export class SaveModelKeyboardListener extends KeyListener {
     override keyDown(_element: SModelRoot, event: KeyboardEvent): Action[] {

package/src/features/save/save-module.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * 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
+ * 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, TYPES, bindAsService } from '~glsp-sprotty';
+import { SaveModelKeyboardListener } from './save-keylistener';
+
+/**
+ * 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 saveModule = new FeatureModule(bind => {
+    bindAsService(bind, TYPES.KeyListener, SaveModelKeyboardListener);
+});

package/src/features/select/select-feedback-command.ts

@@ -0,0 +1,41 @@
+/********************************************************************************
+ * 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
+ * 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 { Command, CommandExecutionContext, SModelRoot, SelectAction, SprottySelectCommand, TYPES } from '~glsp-sprotty';
+import { SelectFeedbackAction } from '../../base/selection-service';
+
+@injectable()
+export class SelectFeedbackCommand extends Command {
+    static readonly KIND = SelectFeedbackAction.KIND;
+    private sprottySelectCommand: SprottySelectCommand;
+
+    constructor(@inject(TYPES.Action) public action: SelectFeedbackAction) {
+        super();
+        this.sprottySelectCommand = new SprottySelectCommand({ ...action, kind: SelectAction.KIND });
+    }
+
+    execute(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.execute(context);
+    }
+
+    undo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.undo(context);
+    }
+
+    redo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.redo(context);
+    }
+}

package/src/features/select/select-module.ts

@@ -0,0 +1,39 @@
+/********************************************************************************
+ * 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
+ * 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, SelectKeyboardListener, TYPES, bindAsService, configureCommand } from '~glsp-sprotty';
+import { SelectAllCommand, SelectCommand } from '../../base/selection-service';
+import { SelectFeedbackCommand } from './select-feedback-command';
+import { RankedSelectMouseListener } from './select-mouse-listener';
+
+export const selectModule = new FeatureModule((bind, _unbind, isBound) => {
+    const context = { bind, isBound };
+    configureCommand(context, SelectCommand);
+    configureCommand(context, SelectAllCommand);
+    configureCommand(context, SelectFeedbackCommand);
+    bindAsService(context, TYPES.MouseListener, RankedSelectMouseListener);
+});
+
+/**
+ * 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 standaloneSelectModule = new FeatureModule(
+    bind => {
+        bindAsService(bind, TYPES.KeyListener, SelectKeyboardListener);
+    },
+    { requires: selectModule }
+);

package/src/features/select/select-mouse-listener.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,93 +13,42 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, SelectAction } from '@eclipse-glsp/protocol';
-import {
-    findParentByFeature,
-    isCtrlOrCmd,
-    isSelectable,
-    SButton,
-    SelectMouseListener,
-    SModelElement,
-    SModelRoot,
-    SRoutableElement,
-    SRoutingHandle,
-    SwitchEditModeAction
-} from 'sprotty';
-import { BringToFrontAction } from 'sprotty-protocol/lib/actions';
-import { toArray } from 'sprotty/lib/utils/iterable';
-import { DEFAULT_RANK, Ranked } from '../rank/model';
+import { Action, BringToFrontAction, SModelElement, SelectAction, SelectMouseListener, Selectable } from '~glsp-sprotty';
+import { Ranked } from '../../base/ranked';
 
 /**
  * Ranked select mouse listener that is executed before default mouse listeners when using the RankedMouseTool.
  * This ensures that default mouse listeners are working on a model that has selection changes already applied.
  */
 export class RankedSelectMouseListener extends SelectMouseListener implements Ranked {
-    rank: number = DEFAULT_RANK - 1; /* we want to be executed before all default mouse listeners */
+    rank: number = Ranked.DEFAULT_RANK - 100; /* we want to be executed before all default mouse listeners */
 
-    override mouseDown(target: SModelElement, event: MouseEvent): (Action | Promise<Action>)[] {
+    protected override handleSelectTarget(
+        selectableTarget: SModelElement & Selectable,
+        deselectedElements: SModelElement[],
+        event: MouseEvent
+    ): (Action | Promise<Action>)[] {
         const result: Action[] = [];
-        if (this.buttonHandlerRegistry !== undefined && target instanceof SButton && target.enabled) {
-            const buttonHandler = this.buttonHandlerRegistry.get(target.type);
-            if (buttonHandler !== undefined) {
-                return buttonHandler.buttonPressed(target);
-            }
-        }
-        const selectableTarget = findParentByFeature(target, isSelectable);
-        if (selectableTarget !== undefined || target instanceof SModelRoot) {
-            this.hasDragged = false;
-            let deselect: SModelElement[] = [];
-            // multi-selection?
-            if (!isCtrlOrCmd(event)) {
-                deselect = toArray(
-                    target.root.index
-                        .all()
-                        .filter(
-                            element =>
-                                isSelectable(element) &&
-                                element.selected &&
-                                !(selectableTarget instanceof SRoutingHandle && element === (selectableTarget.parent as SModelElement))
-                        )
-                );
-            }
-            if (selectableTarget !== undefined) {
-                if (!selectableTarget.selected) {
-                    this.wasSelected = false;
-                    result.push(
-                        SelectAction.create({
-                            selectedElementsIDs: [selectableTarget.id],
-                            deselectedElementsIDs: deselect.map(e => e.id)
-                        })
-                    );
-                    result.push(BringToFrontAction.create([selectableTarget.id]));
-                    const routableDeselect = deselect.filter(e => e instanceof SRoutableElement).map(e => e.id);
-                    if (selectableTarget instanceof SRoutableElement) {
-                        result.push(
-                            SwitchEditModeAction.create({
-                                elementsToActivate: [selectableTarget.id],
-                                elementsToDeactivate: routableDeselect
-                            })
-                        );
-                    } else if (routableDeselect.length > 0) {
-                        result.push(SwitchEditModeAction.create({ elementsToDeactivate: routableDeselect }));
-                    }
-                } else if (isCtrlOrCmd(event)) {
-                    this.wasSelected = false;
-                    result.push(SelectAction.create({ deselectedElementsIDs: [selectableTarget.id] }));
-                    if (selectableTarget instanceof SRoutableElement) {
-                        result.push(SwitchEditModeAction.create({ elementsToDeactivate: [selectableTarget.id] }));
-                    }
-                } else {
-                    this.wasSelected = true;
-                }
-            } else {
-                result.push(SelectAction.create({ deselectedElementsIDs: deselect.map(e => e.id) }));
-                const routableDeselect = deselect.filter(e => e instanceof SRoutableElement).map(e => e.id);
-                if (routableDeselect.length > 0) {
-                    result.push(SwitchEditModeAction.create({ elementsToDeactivate: routableDeselect }));
-                }
-            }
-        }
+        result.push(
+            SelectAction.create({
+                selectedElementsIDs: [selectableTarget.id],
+                deselectedElementsIDs: deselectedElements.map(e => e.id)
+            })
+        );
+        result.push(BringToFrontAction.create([selectableTarget.id]));
+
+        return result;
+    }
+
+    protected override handleDeselectTarget(selectableTarget: SModelElement & Selectable, event: MouseEvent): (Action | Promise<Action>)[] {
+        const result: Action[] = [];
+        result.push(SelectAction.create({ selectedElementsIDs: [], deselectedElementsIDs: [selectableTarget.id] }));
+        return result;
+    }
+
+    protected override handleDeselectAll(deselectedElements: SModelElement[], event: MouseEvent): (Action | Promise<Action>)[] {
+        const result: Action[] = [];
+        result.push(SelectAction.create({ selectedElementsIDs: [], deselectedElementsIDs: deselectedElements.map(e => e.id) }));
         return result;
     }
 }

package/src/features/source-model-watcher/source-model-changed-action-handler.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,10 +13,17 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ServerMessageAction, ServerStatusAction, SourceModelChangedAction } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
-import { IActionDispatcher, IActionHandler, ViewerOptions } from 'sprotty';
-import { TYPES } from '../../base/types';
+import {
+    Action,
+    IActionDispatcher,
+    IActionHandler,
+    ServerMessageAction,
+    ServerStatusAction,
+    SourceModelChangedAction,
+    TYPES,
+    ViewerOptions
+} from '~glsp-sprotty';
 
 /**
  * An external handler of the source model change event.
@@ -63,7 +70,7 @@ export class SourceModelChangedActionHandler implements IActionHandler {
         const severity = 'WARNING';
         this.dispatcher.dispatchAll([
             ServerStatusAction.create(message, { severity, timeout }),
-            ServerMessageAction.create(message, { severity, timeout })
+            ServerMessageAction.create(message, { severity })
         ]);
     }
 }

package/src/features/source-model-watcher/source-model-wacher-module.ts

@@ -0,0 +1,21 @@
+/********************************************************************************
+ * 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
+ * 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, SourceModelChangedAction, configureActionHandler } from '~glsp-sprotty';
+import { SourceModelChangedActionHandler } from './source-model-changed-action-handler';
+
+export const sourceModelWatcherModule = new FeatureModule((bind, _unbind, isBound) => {
+    configureActionHandler({ bind, isBound }, SourceModelChangedAction.KIND, SourceModelChangedActionHandler);
+});

package/src/features/status/status-module.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * 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 { FeatureModule, ServerStatusAction, TYPES, bindAsService, configureActionHandler } from '~glsp-sprotty';
+import '../../../css/status-overlay.css';
+import { StatusOverlay } from './status-overlay';
+
+export const statusModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    bindAsService(context, TYPES.IUIExtension, StatusOverlay);
+    bind(TYPES.IDiagramStartup).toService(StatusOverlay);
+    configureActionHandler(context, ServerStatusAction.KIND, StatusOverlay);
+});

package/src/features/status/status-overlay.ts

@@ -0,0 +1,121 @@
+/********************************************************************************
+ * 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 { inject, injectable } from 'inversify';
+import { AbstractUIExtension, IActionHandler, ServerStatusAction, codiconCSSClasses } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../base/action-dispatcher';
+import { EditorContextService } from '../../base/editor-context-service';
+import { IDiagramStartup } from '../../base/model/diagram-loader';
+
+/**
+ * A reusable status overlay for rendering (icon + message) and handling of {@link ServerStatusAction}'s.
+ */
+@injectable()
+export class StatusOverlay extends AbstractUIExtension implements IActionHandler, IDiagramStartup {
+    static readonly ID = 'glsp.server.status.overlay';
+
+    @inject(GLSPActionDispatcher)
+    protected actionDispatcher: GLSPActionDispatcher;
+
+    @inject(EditorContextService)
+    protected editorContext: EditorContextService;
+
+    protected statusIconDiv?: HTMLDivElement;
+    protected statusMessageDiv?: HTMLDivElement;
+    protected pendingTimeout?: number;
+
+    override id(): string {
+        return StatusOverlay.ID;
+    }
+
+    override containerClass(): string {
+        return 'sprotty-status';
+    }
+    protected override initializeContents(containerElement: HTMLElement): void {
+        this.statusIconDiv = document.createElement('div');
+        containerElement.appendChild(this.statusIconDiv);
+
+        this.statusMessageDiv = document.createElement('div');
+        this.statusMessageDiv.classList.add('sprotty-status-message');
+        containerElement.appendChild(this.statusMessageDiv);
+    }
+
+    protected setStatus(status: ServerStatusAction): void {
+        if (this.statusMessageDiv) {
+            this.statusMessageDiv.textContent = status.message;
+            this.removeClasses(this.statusMessageDiv, 1);
+            this.statusMessageDiv.classList.add(status.severity.toLowerCase());
+        }
+        if (this.statusIconDiv) {
+            this.removeClasses(this.statusIconDiv, 0);
+            const classes = this.statusIconDiv.classList;
+            classes.add(status.severity.toLowerCase());
+            switch (status.severity) {
+                case 'FATAL':
+                    classes.add(...codiconCSSClasses('error'));
+                    break;
+                case 'ERROR':
+                    classes.add(...codiconCSSClasses('warning'));
+                    break;
+                case 'WARNING':
+                    classes.add(...codiconCSSClasses('warning'));
+                    break;
+                case 'INFO':
+                    classes.add(...codiconCSSClasses('info'));
+                    break;
+            }
+        }
+    }
+
+    protected clearStatus(): void {
+        this.setStatus(ServerStatusAction.create('', { severity: 'NONE' }));
+    }
+
+    protected clearTimeout(): void {
+        if (this.pendingTimeout) {
+            window.clearTimeout(this.pendingTimeout);
+            this.pendingTimeout = undefined;
+        }
+    }
+
+    protected removeClasses(element: Element, keep: number): void {
+        const classes = element.classList;
+        while (classes.length > keep) {
+            const item = classes.item(classes.length - 1);
+            if (item) {
+                classes.remove(item);
+            }
+        }
+    }
+
+    handle(action: ServerStatusAction): void {
+        this.clearTimeout();
+        if (action.severity === 'NONE') {
+            this.clearStatus();
+            return;
+        }
+        this.setStatus(action);
+
+        // Check for timeout
+        const statusTimeout = action.timeout ?? -1;
+        if (statusTimeout > 0) {
+            this.pendingTimeout = window.setTimeout(() => this.clearStatus(), statusTimeout);
+        }
+    }
+
+    preInitialize(): void {
+        this.show(this.editorContext.modelRoot);
+    }
+}