@eclipse-glsp/client 1.1.0-next.0d35bd0.205 → 1.1.0-next.0e4a7fc.263

package/src/features/validation/marker-navigator.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,29 +13,34 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, CenterAction, hasArrayProp, hasStringProp, Point, SelectAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import {
-    ActionDispatcher,
+    Action,
     BoundsAware,
-    findParentByFeature,
+    CenterAction,
     IActionHandler,
     IContextMenuItemProvider,
-    isBoundsAware,
-    isSelectable,
     KeyListener,
     MenuItem,
-    Selectable,
+    Point,
     SIssueMarker,
     SIssueSeverity,
     SModelElement,
-    SModelRoot
-} from 'sprotty';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
-import { TYPES } from '../../base/types';
-import { collectIssueMarkers, MarkerPredicates } from '../../utils/marker';
+    SModelRoot,
+    SelectAction,
+    Selectable,
+    TYPES,
+    findParentByFeature,
+    hasArrayProp,
+    hasStringProp,
+    isBoundsAware,
+    isSelectable,
+    matchesKeystroke
+} from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../base/action-dispatcher';
+import { SelectionService } from '../../base/selection-service';
+import { MarkerPredicates, collectIssueMarkers } from '../../utils/marker';
 import { getElements, isSelectableAndBoundsAware } from '../../utils/smodel-util';
-import { SelectionService } from '../select/selection-service';
 
 export interface NavigateToMarkerAction extends Action {
     kind: typeof NavigateToMarkerAction.KIND;
@@ -159,11 +164,11 @@ export class NavigateToMarkerActionHandler implements IActionHandler {
     @inject(MarkerNavigator)
     protected markerNavigator: MarkerNavigator;
 
-    @inject(TYPES.SelectionService)
+    @inject(SelectionService)
     protected selectionService: SelectionService;
 
     @inject(TYPES.IActionDispatcher)
-    protected actionDispatcher: ActionDispatcher;
+    protected actionDispatcher: GLSPActionDispatcher;
 
     handle(action: NavigateToMarkerAction): void {
         const selected = this.getSelectedElements(action);
@@ -201,7 +206,7 @@ export class NavigateToMarkerActionHandler implements IActionHandler {
 
 @injectable()
 export class MarkerNavigatorContextMenuItemProvider implements IContextMenuItemProvider {
-    @inject(TYPES.SelectionService) protected selectionService: SelectionService;
+    @inject(SelectionService) protected selectionService: SelectionService;
 
     getItems(root: Readonly<SModelRoot>, lastMousePosition?: Point): Promise<MenuItem[]> {
         const selectedElementIds = Array.from(this.selectionService.getSelectedElementIDs());

package/src/features/validation/validate.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,15 +13,27 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, DeleteMarkersAction, hasArrayProp, Marker, SetMarkersAction } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
-import { CommandExecutionContext, CommandReturn, IActionDispatcher, IActionHandler, ICommand, SIssueMarker, SParentElement } from 'sprotty';
+import {
+    Action,
+    CommandExecutionContext,
+    CommandReturn,
+    DeleteMarkersAction,
+    IActionDispatcher,
+    IActionHandler,
+    ICommand,
+    Marker,
+    SIssueMarker,
+    SParentElement,
+    SetMarkersAction,
+    TYPES,
+    hasArrayProp
+} from '~glsp-sprotty';
 import { EditorContextService } from '../../base/editor-context-service';
-import { TYPES } from '../../base/types';
+import { IFeedbackActionDispatcher, IFeedbackEmitter } from '../../base/feedback/feedback-action-dispatcher';
+import { FeedbackCommand } from '../../base/feedback/feedback-command';
 import { removeCssClasses } from '../../utils/smodel-util';
-import { IFeedbackActionDispatcher, IFeedbackEmitter } from '../tool-feedback/feedback-action-dispatcher';
-import { FeedbackCommand } from '../tool-feedback/model';
-import { createSIssue, getOrCreateSIssueMarker, getSeverity, getSIssueMarker, GIssueMarker } from './issue-marker';
+import { GIssueMarker, createSIssue, getOrCreateSIssueMarker, getSIssueMarker, getSeverity } from './issue-marker';
 
 /**
  * Feedback emitter sending actions for visualizing model validation feedback and
@@ -33,28 +45,25 @@ export class ValidationFeedbackEmitter implements IFeedbackEmitter {
 
     @inject(TYPES.IActionDispatcherProvider) protected actionDispatcher: () => Promise<IActionDispatcher>;
 
-    private registeredAction: ApplyMarkersAction;
-
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    private constructor() {}
+    protected registeredFeedbackByReason: Map<string, ApplyMarkersAction> = new Map();
 
     /**
      * 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.
+     * @param reason the reason for this validation feedback.
      */
-    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 = DeleteMarkersAction.create(this.registeredAction.markers);
+    registerValidationFeedbackAction(action: ApplyMarkersAction, reason = ''): void {
+        // De-register feedback and clear existing markers with the same reason
+        const previousFeedbackWithSameReason = this.registeredFeedbackByReason.get(reason);
+        if (previousFeedbackWithSameReason) {
+            this.feedbackActionDispatcher.deregisterFeedback(this, [previousFeedbackWithSameReason]);
+            const deleteMarkersAction = DeleteMarkersAction.create(previousFeedbackWithSameReason.markers);
             this.actionDispatcher().then(dispatcher => dispatcher.dispatch(deleteMarkersAction));
         }
 
         // Register new action responsible for applying markers and re-applying them when the model is updated
-        this.feedbackActionDispatcher.registerFeedback(this, [action]);
-        this.registeredAction = action;
+        this.registeredFeedbackByReason.set(reason, action);
+        this.feedbackActionDispatcher.registerFeedback(this, [...this.registeredFeedbackByReason.values()]);
     }
 }
 
@@ -80,7 +89,7 @@ export abstract class ExternalMarkerManager {
         }
     }
 
-    abstract setMarkers(markers: Marker[], sourceUri?: string): void;
+    abstract setMarkers(markers: Marker[], reason?: string, sourceUri?: string): void;
 }
 
 @injectable()
@@ -97,14 +106,14 @@ export class SetMarkersActionHandler implements IActionHandler {
 
     handle(action: SetMarkersAction): void | Action | ICommand {
         const markers: Marker[] = action.markers;
-        this.setMarkers(markers);
+        this.setMarkers(markers, action.reason);
     }
 
-    async setMarkers(markers: Marker[]): Promise<void> {
+    async setMarkers(markers: Marker[], reason: string | undefined): Promise<void> {
         const uri = await this.editorContextService.getSourceUri();
-        this.externalMarkerManager?.setMarkers(markers, uri);
+        this.externalMarkerManager?.setMarkers(markers, reason, uri);
         const applyMarkersAction = ApplyMarkersAction.create(markers);
-        this.validationFeedbackEmitter.registerValidationFeedbackAction(applyMarkersAction);
+        this.validationFeedbackEmitter.registerValidationFeedbackAction(applyMarkersAction, reason);
     }
 }
 

package/src/features/validation/{di.config.ts → validation-modules.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,10 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { SetMarkersAction } from '@eclipse-glsp/protocol';
-import { ContainerModule } from 'inversify';
-import { configureActionHandler, configureCommand } from 'sprotty';
-import { TYPES } from '../../base/types';
+import { FeatureModule, SetMarkersAction, TYPES, bindAsService, configureActionHandler, configureCommand } from '~glsp-sprotty';
 import {
     LeftToRightTopToBottomComparator,
     MarkerNavigator,
@@ -28,7 +25,7 @@ import {
 } from './marker-navigator';
 import { ApplyMarkersCommand, DeleteMarkersCommand, SetMarkersActionHandler, ValidationFeedbackEmitter } from './validate';
 
-export const validationModule = new ContainerModule((bind, _unbind, isBound) => {
+export const validationModule = new FeatureModule((bind, _unbind, isBound) => {
     const context = { bind, isBound };
     configureActionHandler(context, SetMarkersAction.KIND, SetMarkersActionHandler);
     configureCommand(context, ApplyMarkersCommand);
@@ -36,18 +33,21 @@ export const validationModule = new ContainerModule((bind, _unbind, isBound) =>
     bind(ValidationFeedbackEmitter).toSelf().inSingletonScope();
 });
 
-export const markerNavigatorModule = new ContainerModule((bind, _unbind, isBound) => {
+export const markerNavigatorModule = new FeatureModule((bind, _unbind, isBound) => {
     bind(SModelElementComparator).to(LeftToRightTopToBottomComparator).inSingletonScope();
     bind(MarkerNavigator).toSelf().inSingletonScope();
     configureActionHandler({ bind, isBound }, NavigateToMarkerAction.KIND, NavigateToMarkerActionHandler);
 });
 
 /**
- * This module is not required if the diagram is deployed in Theia but only intended to be used
- * in a standalone deployment of GLSP. If the GLSP diagram is in Theia use the Theia-native
- * `registerMarkerNavigationCommands()` in `glsp-theia-integration` instead.
+ * 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 markerNavigatorContextMenuModule = new ContainerModule((bind, _unbind, isBound) => {
-    bind(TYPES.IContextMenuProvider).to(MarkerNavigatorContextMenuItemProvider).inSingletonScope();
-    bind(TYPES.KeyListener).to(MarkerNavigatorKeyListener).inSingletonScope();
-});
+export const standaloneMarkerNavigatorModule = new FeatureModule(
+    bind => {
+        bindAsService(bind, TYPES.IContextMenuProvider, MarkerNavigatorContextMenuItemProvider);
+        bindAsService(bind, TYPES.KeyListener, MarkerNavigatorKeyListener);
+    },
+    { requires: markerNavigatorModule }
+);

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2021-2022 EclipseSource and others.
+ * 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
@@ -13,10 +13,17 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
-import { EnableDefaultToolsAction, EnableToolsAction, IActionHandler, ICommand, ScrollMouseListener, SModelElement } from 'sprotty';
-import { MarqueeMouseTool } from '../tools/marquee-mouse-tool';
+import {
+    Action,
+    EnableDefaultToolsAction,
+    EnableToolsAction,
+    IActionHandler,
+    ICommand,
+    ScrollMouseListener,
+    SModelElement
+} from '~glsp-sprotty';
+import { MarqueeMouseTool } from '../tools/marquee-selection/marquee-mouse-tool';
 
 @injectable()
 export class GLSPScrollMouseListener extends ScrollMouseListener implements IActionHandler {

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

@@ -0,0 +1,58 @@
+/********************************************************************************
+ * 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,
+    EnableDefaultToolsAction,
+    EnableToolsAction,
+    FeatureModule,
+    FitToScreenCommand,
+    GetViewportCommand,
+    SetViewportCommand,
+    TYPES,
+    ZoomMouseListener
+} from '~glsp-sprotty';
+import { GLSPScrollMouseListener } from './glsp-scroll-mouse-listener';
+
+export const viewportModule = new FeatureModule((bind, _unbind, isBound) => {
+    const context = { bind, isBound };
+    configureCommand(context, CenterCommand);
+    configureCommand(context, FitToScreenCommand);
+    configureCommand(context, GetViewportCommand);
+    configureCommand(context, SetViewportCommand);
+
+    bindAsService(context, TYPES.MouseListener, ZoomMouseListener);
+    bindAsService(context, TYPES.MouseListener, GLSPScrollMouseListener);
+
+    configureActionHandler(context, EnableToolsAction.KIND, GLSPScrollMouseListener);
+    configureActionHandler(context, EnableDefaultToolsAction.KIND, GLSPScrollMouseListener);
+});
+
+/**
+ * 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/{base/tool-manager/tool-actions.ts → glsp-sprotty/augmented-actions.ts}

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022 STMicroelectronics and others.
+ * 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
@@ -13,13 +13,24 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+/* eslint-disable @typescript-eslint/no-shadow */
+/* eslint-disable-next-line no-restricted-imports*/
 import { Action, hasArrayProp } from '@eclipse-glsp/protocol';
+import { SetBoundsAction } from 'sprotty-protocol/lib/actions';
 import { EnableDefaultToolsAction, EnableToolsAction } from 'sprotty/lib/base/tool-manager/tool';
-/* eslint-disable no-shadow */
 
 /**
- * Use module augmentation to add the `is` utility function to the tool action namespaces provided by sprotty
+ * Use module augmentation to add namespaces and  the `is` utility function to sprotty actions that directly reused by GLSP
  */
+declare module 'sprotty-protocol/lib/actions' {
+    namespace SetBoundsAction {
+        export function is(object: any): object is SetBoundsAction;
+    }
+}
+
+SetBoundsAction.is = (object: any): object is SetBoundsAction =>
+    Action.hasKind(object, SetBoundsAction.KIND) && hasArrayProp(object, 'bounds');
+
 declare module 'sprotty/lib/base/tool-manager/tool' {
     export namespace EnableDefaultToolsAction {
         export function is(object: any): object is EnableDefaultToolsAction;