@eclipse-glsp/client 0.10.0-next.bb1c2fd.157 → 0.10.0-next.e5fcffe.169

package/src/features/validation/marker-navigator.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2021 EclipseSource and others.
+ * Copyright (c) 2020-2022 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 { Action, CenterAction, Point } from '@eclipse-glsp/protocol';
+import { Action, CenterAction, hasArrayProp, hasStringProp, Point, SelectAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import {
     BoundsAware,
@@ -28,30 +28,47 @@ import {
     KeyListener,
     MenuItem,
     Selectable,
-    SelectAction,
     SIssueMarker,
     SIssueSeverity,
     SModelElement,
-    SModelRoot,
-    TYPES
+    SModelRoot
 } from 'sprotty';
 import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
-import { GLSP_TYPES } from '../../base/types';
+import { TYPES } from '../../base/types';
 import { collectIssueMarkers, MarkerPredicates } from '../../utils/marker';
 import { isSelectableAndBoundsAware } from '../../utils/smodel-util';
 import { SelectCommand, SelectionService } from '../select/selection-service';
 
-export class NavigateToMarkerAction implements Action {
-    static readonly KIND = 'navigateToMarker';
+export interface NavigateToMarkerAction extends Action {
+    kind: typeof NavigateToMarkerAction.KIND;
 
-    constructor(
-        public readonly direction: 'next' | 'previous' = 'next',
-        public readonly selectedElementIds?: string[],
-        public readonly severities: SIssueSeverity[] = MarkerNavigator.ALL_SEVERITIES,
-        public kind = NavigateToMarkerAction.KIND
-    ) {}
+    direction: MarkerNavigationDirection;
+    selectedElementIds?: string[];
+    severities: SIssueSeverity[];
 }
 
+export type MarkerNavigationDirection = 'next' | 'previous';
+
+export namespace NavigateToMarkerAction {
+    export const KIND = 'navigateToMarker';
+
+    export function is(object: any): object is NavigateToMarkerAction {
+        return Action.hasKind(object, KIND) && hasStringProp(object, 'direction') && hasArrayProp(object, 'severities');
+    }
+
+    export function create(options: {
+        direction?: MarkerNavigationDirection;
+        selectedElementIds?: string[];
+        severities?: SIssueSeverity[];
+    }): NavigateToMarkerAction {
+        return {
+            kind: KIND,
+            direction: 'next',
+            severities: MarkerNavigator.ALL_SEVERITIES,
+            ...options
+        };
+    }
+}
 export class SModelElementComparator {
     compare(_one: SModelElement, _other: SModelElement): number {
         return 0;
@@ -146,7 +163,7 @@ export class NavigateToMarkerCommand extends Command {
     @inject(MarkerNavigator)
     protected markerNavigator: MarkerNavigator;
 
-    @inject(GLSP_TYPES.SelectionService)
+    @inject(TYPES.SelectionService)
     protected selectionService: SelectionService;
 
     protected selectCommand: SelectCommand;
@@ -167,8 +184,11 @@ export class NavigateToMarkerCommand extends Command {
         const selectableTarget = findParentByFeature(target, isSelectable);
         if (selectableTarget) {
             const deselect = selected.map(e => e.id).filter(id => id !== selectableTarget.id);
-            this.selectCommand = new SelectCommand(new SelectAction([selectableTarget.id], deselect), this.selectionService);
-            this.centerCommand = new CenterCommand(new CenterAction([selectableTarget.id]));
+            this.selectCommand = new SelectCommand(
+                SelectAction.create({ selectedElementsIDs: [selectableTarget.id], deselectedElementsIDs: deselect }),
+                this.selectionService
+            );
+            this.centerCommand = new CenterCommand(CenterAction.create([selectableTarget.id]));
             this.centerCommand.execute(context);
             return this.selectCommand.execute(context);
         }
@@ -180,9 +200,11 @@ export class NavigateToMarkerCommand extends Command {
         if (this.action.selectedElementIds !== undefined && this.action.selectedElementIds.length > 0) {
             selectedIds = this.action.selectedElementIds;
         } else {
-            selectedIds = Array.from(this.selectionService.getSelectedElementIDs());
+            return this.selectionService.getSelectedElements();
         }
-        return selectedIds.map(id => root.index.getById(id)).filter(isSelectable);
+        return selectedIds.map(id => root.index.getById(id)).filter(element => element !== undefined && isSelectable(element)) as Array<
+            SModelElement & Selectable
+        >;
     }
 
     protected getTarget(selected: SModelElement[], root: SModelRoot): SIssueMarker | undefined {
@@ -216,7 +238,7 @@ export class NavigateToMarkerCommand extends Command {
 
 @injectable()
 export class MarkerNavigatorContextMenuItemProvider implements IContextMenuItemProvider {
-    @inject(GLSP_TYPES.SelectionService) protected selectionService: SelectionService;
+    @inject(TYPES.SelectionService) protected selectionService: SelectionService;
 
     getItems(root: Readonly<SModelRoot>, lastMousePosition?: Point): Promise<MenuItem[]> {
         const selectedElementIds = Array.from(this.selectionService.getSelectedElementIDs());
@@ -232,14 +254,14 @@ export class MarkerNavigatorContextMenuItemProvider implements IContextMenuItemP
                         id: 'next-marker',
                         label: 'Next marker',
                         group: 'marker',
-                        actions: [new NavigateToMarkerAction('next', selectedElementIds)],
+                        actions: [NavigateToMarkerAction.create({ direction: 'next', selectedElementIds })],
                         isEnabled: () => hasMarkers
                     },
                     {
                         id: 'previous-marker',
                         label: 'Previous marker',
                         group: 'marker',
-                        actions: [new NavigateToMarkerAction('previous', selectedElementIds)],
+                        actions: [NavigateToMarkerAction.create({ direction: 'previous', selectedElementIds })],
                         isEnabled: () => hasMarkers
                     }
                 ]
@@ -250,11 +272,11 @@ export class MarkerNavigatorContextMenuItemProvider implements IContextMenuItemP
 
 @injectable()
 export class MarkerNavigatorKeyListener extends KeyListener {
-    keyDown(_element: SModelElement, event: KeyboardEvent): Action[] {
+    override keyDown(_element: SModelElement, event: KeyboardEvent): Action[] {
         if (matchesKeystroke(event, 'Period', 'ctrl')) {
-            return [new NavigateToMarkerAction('next')];
+            return [NavigateToMarkerAction.create({ direction: 'next' })];
         } else if (matchesKeystroke(event, 'Comma', 'ctrl')) {
-            return [new NavigateToMarkerAction('previous')];
+            return [NavigateToMarkerAction.create({ direction: 'previous' })];
         }
         return [];
     }

package/src/features/validation/validate.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2021 EclipseSource and others.
+ * Copyright (c) 2019-2022 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 { Action, DeleteMarkersAction, Marker, SetMarkersAction } from '@eclipse-glsp/protocol';
+import { Action, DeleteMarkersAction, hasArrayProp, Marker, SetMarkersAction } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
 import {
     Command,
@@ -24,11 +24,10 @@ import {
     SIssueMarker,
     SModelElement,
     SModelRoot,
-    SParentElement,
-    TYPES
+    SParentElement
 } from 'sprotty';
 import { EditorContextService } from '../../base/editor-context-service';
-import { GLSP_TYPES } from '../../base/types';
+import { TYPES } from '../../base/types';
 import { removeCssClasses } from '../../utils/smodel-util';
 import { getSeverity } from '../hover/hover';
 import { IFeedbackActionDispatcher, IFeedbackEmitter } from '../tool-feedback/feedback-action-dispatcher';
@@ -41,11 +40,11 @@ import { createSIssue, getOrCreateSIssueMarker, getSIssueMarker } from './issue-
  */
 @injectable()
 export class ValidationFeedbackEmitter implements IFeedbackEmitter {
-    @inject(GLSP_TYPES.IFeedbackActionDispatcher) protected feedbackActionDispatcher: IFeedbackActionDispatcher;
+    @inject(TYPES.IFeedbackActionDispatcher) protected feedbackActionDispatcher: IFeedbackActionDispatcher;
 
     @inject(TYPES.IActionDispatcherProvider) protected actionDispatcher: () => Promise<IActionDispatcher>;
 
-    private registeredAction: MarkersAction;
+    private registeredAction: ApplyMarkersAction;
 
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     private constructor() {}
@@ -54,13 +53,13 @@ export class ValidationFeedbackEmitter implements IFeedbackEmitter {
      * Register the action that should be emitted for visualizing validation feedback.
      * @param action the action that should be emitted when the model is updated and that will visualize the model validation feedback.
      */
-    registerValidationFeedbackAction(action: MarkersAction): void {
+    registerValidationFeedbackAction(action: ApplyMarkersAction): void {
         // De-register old action responsible for applying markers and re-applying them when the model is updated
         this.feedbackActionDispatcher.deregisterFeedback(this, []);
 
         // Clear existing markers
         if (this.registeredAction !== undefined) {
-            const deleteMarkersAction = new DeleteMarkersAction(this.registeredAction.markers);
+            const deleteMarkersAction = DeleteMarkersAction.create(this.registeredAction.markers);
             this.actionDispatcher().then(dispatcher => dispatcher.dispatch(deleteMarkersAction));
         }
 
@@ -88,7 +87,7 @@ export abstract class ExternalMarkerManager {
 
     removeMarkers(markers: Marker[]): void {
         if (this.actionDispatcher) {
-            this.actionDispatcher.dispatch(new DeleteMarkersAction(markers));
+            this.actionDispatcher.dispatch(DeleteMarkersAction.create(markers));
         }
     }
 
@@ -116,7 +115,7 @@ export class SetMarkersCommand extends Command {
         if (this.externalMarkerManager) {
             this.externalMarkerManager.setMarkers(markers, uri);
         }
-        const applyMarkersAction: ApplyMarkersAction = new ApplyMarkersAction(markers);
+        const applyMarkersAction = ApplyMarkersAction.create(markers);
         this.validationFeedbackEmitter.registerValidationFeedbackAction(applyMarkersAction);
         return context.root;
     }
@@ -131,18 +130,26 @@ export class SetMarkersCommand extends Command {
 }
 
 /**
- * Interface for actions processing markers
+ * Action for applying makers to a model
  */
-export interface MarkersAction extends Action {
-    readonly markers: Marker[];
+export interface ApplyMarkersAction extends Action {
+    kind: typeof ApplyMarkersAction.KIND;
+    markers: Marker[];
 }
 
-/**
- * Action for applying makers to a model
- */
-@injectable()
-export class ApplyMarkersAction implements MarkersAction {
-    constructor(public readonly markers: Marker[], public readonly kind = ApplyMarkersCommand.KIND) {}
+export namespace ApplyMarkersAction {
+    export const KIND = 'applyMarkers';
+
+    export function is(object: any): object is ApplyMarkersAction {
+        return Action.hasKind(object, KIND) && hasArrayProp(object, 'markers');
+    }
+
+    export function create(markers: Marker[]): ApplyMarkersAction {
+        return {
+            kind: KIND,
+            markers
+        };
+    }
 }
 
 /**
@@ -150,8 +157,8 @@ export class ApplyMarkersAction implements MarkersAction {
  */
 @injectable()
 export class ApplyMarkersCommand extends FeedbackCommand {
-    static KIND = 'applyMarkers';
-    readonly priority = 0;
+    static KIND = ApplyMarkersAction.KIND;
+    override readonly priority = 0;
 
     constructor(@inject(TYPES.Action) protected action: ApplyMarkersAction) {
         super();
@@ -171,11 +178,11 @@ export class ApplyMarkersCommand extends FeedbackCommand {
         return context.root;
     }
 
-    undo(context: CommandExecutionContext): CommandReturn {
+    override undo(context: CommandExecutionContext): CommandReturn {
         return context.root;
     }
 
-    redo(context: CommandExecutionContext): CommandReturn {
+    override redo(context: CommandExecutionContext): CommandReturn {
         return this.execute(context);
     }
 }

package/src/features/viewport/di.config.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2021 EclipseSource and others.
+ * Copyright (c) 2021-2022 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
@@ -27,7 +27,6 @@ import {
     TYPES,
     ZoomMouseListener
 } from 'sprotty';
-
 import { GLSPScrollMouseListener } from './glsp-scroll-mouse-listener';
 
 const glspViewportModule = new ContainerModule((bind, _unbind, isBound) => {

package/src/features/viewport/glsp-scroll-mouse-listener.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2021 EclipseSource and others.
+ * Copyright (c) 2021-2022 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
@@ -23,16 +23,16 @@ export class GLSPScrollMouseListener extends ScrollMouseListener implements IAct
     preventScrolling = false;
 
     handle(action: Action): void | Action | ICommand {
-        if (action instanceof EnableToolsAction) {
-            if (action.toolIds.includes(MarqueeMouseTool.ID)) {
+        if (action.kind === EnableToolsAction.KIND) {
+            if ((action as EnableToolsAction).toolIds.includes(MarqueeMouseTool.ID)) {
                 this.preventScrolling = true;
             }
-        } else if (action instanceof EnableDefaultToolsAction) {
+        } else if (action.kind === EnableDefaultToolsAction.KIND) {
             this.preventScrolling = false;
         }
     }
 
-    mouseDown(target: SModelElement, event: MouseEvent): (Action | Promise<Action>)[] {
+    override mouseDown(target: SModelElement, event: MouseEvent): (Action | Promise<Action>)[] {
         if (this.preventScrolling) {
             return [];
         }

package/src/index.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2021 EclipseSource and others.
+ * Copyright (c) 2019-2022 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
@@ -33,7 +33,6 @@ import toolsModule from './features/tools/di.config';
 import { markerNavigatorModule, validationModule } from './features/validation/di.config';
 import glspViewportModule from './features/viewport/di.config';
 
-export * from 'sprotty';
 export * from './base/action-dispatcher';
 export * from './base/actions/focus-change-action';
 export * from './base/argumentable';
@@ -51,6 +50,7 @@ export * from './base/model/model-registry';
 export * from './base/model/update-model-command';
 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/view/view-registry';
 export * from './features/change-bounds/model';
@@ -80,22 +80,21 @@ 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/tool-palette/palette-item';
 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/node-creation-tool';
 export * from './features/tools/marquee-behavior';
+export * from './features/tools/node-creation-tool';
 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 './protocol-reexport';
+export * from './sprotty-reexport';
 export * from './utils/argument-utils';
 export * from './utils/marker';
 export * from './utils/smodel-util';

package/src/lib/model.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2022 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,13 +13,13 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { exportFeature, SGraph, SModelElement, SModelElementSchema, viewportFeature } from 'sprotty/lib';
-
+import { SModelElementSchema } from '@eclipse-glsp/protocol';
+import { exportFeature, SGraph, SModelElement, viewportFeature } from 'sprotty/lib';
 import { Containable, containerFeature } from '../features/hints/model';
 import { Saveable, saveFeature } from '../features/save/model';
 
 export class GLSPGraph extends SGraph implements Saveable, Containable {
-    static readonly DEFAULT_FEATURES = [viewportFeature, exportFeature, saveFeature, containerFeature];
+    static override readonly DEFAULT_FEATURES = [viewportFeature, exportFeature, saveFeature, containerFeature];
     dirty = false;
     isContainableElement(input: string | SModelElement | SModelElementSchema): boolean {
         return true;

package/src/model-source/glsp-diagram-server.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2021 EclipseSource and others.
+ * Copyright (c) 2019-2022 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
@@ -15,22 +15,21 @@
  ********************************************************************************/
 import {
     Action,
+    ActionMessage,
     ComputedBoundsAction,
     GLSPClient,
-    isRequestModelAction,
-    isServerMessageAction,
-    isSetEditModeAction,
+    RequestModelAction,
     ServerMessageAction,
     SetEditModeAction
 } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
-import { ActionHandlerRegistry, ActionMessage, DiagramServer, ICommand, ServerStatusAction, SwitchEditModeCommand } from 'sprotty';
+import { ActionHandlerRegistry, DiagramServerProxy, ExportSvgAction, ICommand, ServerStatusAction, SwitchEditModeCommand } from 'sprotty';
 import { SourceUriAware } from '../base/source-uri-aware';
 
 const receivedFromServerProperty = '__receivedFromServer';
 
 @injectable()
-export class GLSPDiagramServer extends DiagramServer implements SourceUriAware {
+export class GLSPDiagramServer extends DiagramServerProxy implements SourceUriAware {
     protected _sourceUri: string;
     protected _glspClient?: GLSPClient;
     protected ready = false;
@@ -54,25 +53,25 @@ export class GLSPDiagramServer extends DiagramServer implements SourceUriAware {
         }
     }
 
-    initialize(registry: ActionHandlerRegistry): void {
+    override initialize(registry: ActionHandlerRegistry): void {
         registerDefaultGLSPServerActions(registry, this);
         if (!this.clientId) {
             this.clientId = this.viewerOptions.baseDiv;
         }
     }
 
-    handle(action: Action): void | ICommand | Action {
-        if (isRequestModelAction(action) && action.options) {
+    override handle(action: Action): void | ICommand | Action {
+        if (RequestModelAction.is(action) && action.options) {
             this._sourceUri = action.options.sourceUri as string;
         }
         return super.handle(action);
     }
 
-    handleLocally(action: Action): boolean {
-        if (isServerMessageAction(action)) {
+    override handleLocally(action: Action): boolean {
+        if (ServerMessageAction.is(action)) {
             return this.handleServerMessageAction(action);
         }
-        if (isSetEditModeAction(action)) {
+        if (SetEditModeAction.is(action)) {
             return this.handleSetEditModeAction(action);
         }
         return super.handleLocally(action);
@@ -83,7 +82,7 @@ export class GLSPDiagramServer extends DiagramServer implements SourceUriAware {
         return false;
     }
 
-    protected handleComputedBounds(_action: ComputedBoundsAction): boolean {
+    protected override handleComputedBounds(_action: ComputedBoundsAction): boolean {
         return true;
     }
 
@@ -100,9 +99,10 @@ export function isReceivedFromServer(action: Action): boolean {
     return (action as any)[receivedFromServerProperty] === true;
 }
 
-export function registerDefaultGLSPServerActions(registry: ActionHandlerRegistry, diagramServer: DiagramServer): void {
+export function registerDefaultGLSPServerActions(registry: ActionHandlerRegistry, diagramServer: DiagramServerProxy): void {
     registry.register(ServerMessageAction.KIND, diagramServer);
     registry.register(ServerStatusAction.KIND, diagramServer);
+    registry.register(ExportSvgAction.KIND, diagramServer);
 
     // Register an empty handler for SwitchEditMode, to avoid runtime exceptions.
     // We don't support SwitchEditMode, but Sprotty still sends those actions, so ignore them.