@eclipse-glsp/client 0.9.0-rc-01 → 0.10.0-next.146a812.165

package/src/features/copy-paste/copy-paste-handler.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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,14 +13,13 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { ClipboardData, CutOperation, PasteOperation, RequestClipboardDataAction, SetClipboardDataAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import { TYPES, ViewerOptions } from 'sprotty';
 import { v4 as uuid } from 'uuid';
-
 import { GLSPActionDispatcher } from '../../base/action-dispatcher';
-import { EditorContextService } from '../../base/editor-context';
+import { EditorContextService } from '../../base/editor-context-service';
 import { GLSP_TYPES } from '../../base/types';
-import { ClipboardData, CutOperation, PasteOperation, RequestClipboardDataAction } from './copy-paste-actions';
 
 export interface ICopyPasteHandler {
     handleCopy(event: ClipboardEvent): void;
@@ -91,11 +90,10 @@ function getClipboardIdFromDataTransfer(dataTransfer: DataTransfer): string | un
     return isClipboardId(jsonObject) ? jsonObject.clipboardId : undefined;
 }
 
-const CLIPBOARD_DATA_FORMAT = 'application/json';
+const CLIPBOARD_DATA_FORMAT = 'text/plain';
 
 @injectable()
 export class ServerCopyPasteHandler implements ICopyPasteHandler {
-
     @inject(TYPES.IActionDispatcher) protected actionDispatcher: GLSPActionDispatcher;
     @inject(TYPES.ViewerOptions) protected viewerOptions: ViewerOptions;
     @inject(GLSP_TYPES.IAsyncClipboardService) protected clipboadService: IAsyncClipboardService;
@@ -106,7 +104,7 @@ export class ServerCopyPasteHandler implements ICopyPasteHandler {
             const clipboardId = uuid();
             event.clipboardData.setData(CLIPBOARD_DATA_FORMAT, toClipboardId(clipboardId));
             this.actionDispatcher
-                .request(RequestClipboardDataAction.create(this.editorContext.get()))
+                .request<SetClipboardDataAction>(RequestClipboardDataAction.create(this.editorContext.get()))
                 .then(action => this.clipboadService.put(action.clipboardData, clipboardId));
             event.preventDefault();
         } else {
@@ -126,7 +124,7 @@ export class ServerCopyPasteHandler implements ICopyPasteHandler {
     }
 
     handlePaste(event: ClipboardEvent): void {
-        if (event.clipboardData) {
+        if (event.clipboardData && this.shouldPaste(event)) {
             const clipboardId = getClipboardIdFromDataTransfer(event.clipboardData);
             const clipboardData = this.clipboadService.get(clipboardId);
             if (clipboardData) {
@@ -137,8 +135,18 @@ export class ServerCopyPasteHandler implements ICopyPasteHandler {
     }
 
     protected shouldCopy(_event: ClipboardEvent): boolean | null {
-        return this.editorContext.get().selectedElementIds.length > 0 && document.activeElement instanceof SVGElement
-            && document.activeElement.parentElement && document.activeElement.parentElement.id === this.viewerOptions.baseDiv;
+        return this.editorContext.get().selectedElementIds.length > 0 && this.isDiagramActive();
     }
 
+    protected shouldPaste(_event: ClipboardEvent): boolean | null {
+        return this.isDiagramActive();
+    }
+
+    private isDiagramActive(): boolean | null {
+        return (
+            document.activeElement instanceof SVGElement &&
+            document.activeElement.parentElement &&
+            document.activeElement.parentElement.id === this.viewerOptions.baseDiv
+        );
+    }
 }

package/src/features/copy-paste/di.config.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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
@@ -14,8 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { ContainerModule } from 'inversify';
-import { configureActionHandler } from 'sprotty/lib';
-
+import { configureActionHandler } from 'sprotty';
 import { GLSP_TYPES } from '../../base/types';
 import {
     CopyPasteContextMenuItemProvider,

package/src/features/decoration/decoration-placer.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 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,24 +13,15 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Point } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
-import {
-    Decoration,
-    DecorationPlacer,
-    isSizeable,
-    ORIGIN_POINT,
-    Point,
-    SChildElement,
-    SModelElement,
-    SRoutableElement
-} from 'sprotty';
+import { Decoration, DecorationPlacer, isSizeable, ORIGIN_POINT, SChildElement, SModelElement, SRoutableElement } from 'sprotty';
 
 @injectable()
 export class GlspDecorationPlacer extends DecorationPlacer {
-
     protected static readonly DECORATION_OFFSET: Point = { x: 12, y: 10 };
 
-    protected getPosition(element: SModelElement & Decoration): Point {
+    protected override getPosition(element: SModelElement & Decoration): Point {
         if (element instanceof SChildElement && element.parent instanceof SRoutableElement) {
             return super.getPosition(element);
         }
@@ -42,5 +33,4 @@ export class GlspDecorationPlacer extends DecorationPlacer {
         }
         return ORIGIN_POINT;
     }
-
 }

package/src/features/edit-label/edit-label-validator.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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,6 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { isSetEditValidationResultAction, RequestEditValidationAction, ValidationStatus } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import {
     Action,
@@ -26,11 +27,6 @@ import {
 } from 'sprotty';
 
 import { GLSPActionDispatcher } from '../../base/action-dispatcher';
-import {
-    isSetEditValidationResultAction,
-    RequestEditValidationAction,
-    ValidationStatus
-} from '../../base/actions/edit-validation-actions';
 
 export namespace LabelEditValidation {
     export const CONTEXT_ID = 'label-edit';
@@ -55,7 +51,6 @@ export class ValidateLabelEditAction extends RequestEditValidationAction {
 
 @injectable()
 export class ServerEditLabelValidator implements IEditLabelValidator {
-
     @inject(TYPES.IActionDispatcher) protected actionDispatcher: GLSPActionDispatcher;
 
     validate(value: string, label: EditableLabel & SModelElement): Promise<EditLabelValidationResult> {
@@ -69,12 +64,10 @@ export class ServerEditLabelValidator implements IEditLabelValidator {
         }
         return { severity: 'ok' as Severity };
     }
-
 }
 
 @injectable()
 export class BalloonLabelValidationDecorator implements IEditLabelValidationDecorator {
-
     decorate(input: HTMLInputElement, result: EditLabelValidationResult): void {
         const containerElement = input.parentElement;
         if (!containerElement) {
@@ -86,9 +79,15 @@ export class BalloonLabelValidationDecorator implements IEditLabelValidationDeco
             containerElement.setAttribute('data-balloon-visible', 'true');
         }
         switch (result.severity) {
-            case 'ok': containerElement.classList.add('validation-ok'); break;
-            case 'warning': containerElement.classList.add('validation-warning'); break;
-            case 'error': containerElement.classList.add('validation-error'); break;
+            case 'ok':
+                containerElement.classList.add('validation-ok');
+                break;
+            case 'warning':
+                containerElement.classList.add('validation-warning');
+                break;
+            case 'error':
+                containerElement.classList.add('validation-error');
+                break;
         }
     }
 

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { SetTypeHintsAction } from '@eclipse-glsp/protocol';
 import { ContainerModule } from 'inversify';
 import { configureActionHandler, configureCommand } from 'sprotty';
-
 import { GLSP_TYPES } from '../../base/types';
-import { SetTypeHintsAction } from './request-type-hints-action';
 import { ApplyTypeHintsCommand, TypeHintProvider } from './type-hints';
 
 const modelHintsModule = new ContainerModule((bind, _unbind, isBound) => {

package/src/features/hints/model.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { SModelElement, SModelElementSchema, SModelExtension } from 'sprotty';
+import { SModelElementSchema } from '@eclipse-glsp/protocol';
+import { SModelElement, SModelExtension } from 'sprotty';
 
 export const containerFeature = Symbol('containable');
 
@@ -27,7 +28,7 @@ export function isContainable(element: SModelElement): element is SModelElement
 
 export const reparentFeature = Symbol('reparentFeature');
 
-export interface Reparentable extends SModelExtension { }
+export interface Reparentable extends SModelExtension {}
 
 export function isReparentable(element: SModelElement): element is SModelElement & Reparentable {
     return element.hasFeature(reparentFeature);

package/src/features/hints/type-hints.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,9 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Action, EdgeTypeHint, isSetTypeHintsAction, ShapeTypeHint, TypeHint } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import {
-    Action,
     CommandExecutionContext,
     CommandReturn,
     Connectable,
@@ -28,12 +28,10 @@ import {
     moveFeature,
     SEdge,
     SModelElement,
-    SModelElementSchema,
     SModelRoot,
     SShapeElement,
     TYPES
 } from 'sprotty';
-
 import { GLSP_TYPES } from '../../base/types';
 import { getElementTypeId, hasCompatibleType } from '../../utils/smodel-util';
 import { resizeFeature } from '../change-bounds/model';
@@ -41,68 +39,6 @@ import { reconnectFeature } from '../reconnect/model';
 import { IFeedbackActionDispatcher } from '../tool-feedback/feedback-action-dispatcher';
 import { FeedbackCommand } from '../tool-feedback/model';
 import { Containable, containerFeature, reparentFeature } from './model';
-import { isSetTypeHintsAction } from './request-type-hints-action';
-
-export abstract class TypeHint {
-    /**
-    The id of the element.
-    */
-    readonly elementTypeId: string;
-
-    /**
-    * Specifies whether the element can be relocated.
-    */
-    readonly repositionable: boolean;
-
-    /**
-     * Specifices wheter the element can be deleted
-     */
-    readonly deletable: boolean;
-}
-
-export class ShapeTypeHint extends TypeHint {
-    /**
-     * Specifies whether the element can be resized.
-     */
-    readonly resizable: boolean;
-
-    /**
-     * Specifies whether the element can be moved to another parent
-     */
-    readonly reparentable: boolean;
-
-    /**
-     * The types of elements that can be contained by this element (if any)
-     */
-    readonly containableElementTypeIds?: string[];
-}
-
-export class EdgeTypeHint extends TypeHint {
-    /**
-     * Specifies whether the routing of this element can be changed.
-     */
-    readonly routable: boolean;
-
-    /**
-     * Allowed source element types for this edge type
-     */
-    readonly sourceElementTypeIds: string[];
-
-    /**
-    * Allowed targe element types for this edge type
-    */
-    readonly targetElementTypeIds: string[];
-
-    isAllowedSource(input: SModelElement | SModelElementSchema | string): boolean {
-        const type = getElementTypeId(input);
-        return this.sourceElementTypeIds.includes(type);
-
-    }
-    isAllowedTarget(input: SModelElement | SModelElementSchema | string): boolean {
-        const type = getElementTypeId(input);
-        return this.targetElementTypeIds.includes(type);
-    }
-}
 
 @injectable()
 export class ApplyTypeHintsAction implements Action {
@@ -111,9 +47,8 @@ export class ApplyTypeHintsAction implements Action {
 
 @injectable()
 export class ApplyTypeHintsCommand extends FeedbackCommand {
-
     public static KIND = 'applyTypeHints';
-    public readonly priority = 10;
+    public override readonly priority = 10;
 
     @inject(GLSP_TYPES.ITypeHintProvider) protected typeHintProvider: ITypeHintProvider;
 
@@ -122,15 +57,13 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
     }
 
     execute(context: CommandExecutionContext): CommandReturn {
-        context.root.index.all()
-            .forEach(element => {
-                if (element instanceof SShapeElement || element instanceof SModelRoot) {
-                    this.applyShapeTypeHint(element);
-
-                } else if (element instanceof SEdge) {
-                    return this.applyEdgeTypeHint(element);
-                }
-            });
+        context.root.index.all().forEach(element => {
+            if (element instanceof SShapeElement || element instanceof SModelRoot) {
+                this.applyShapeTypeHint(element);
+            } else if (element instanceof SEdge) {
+                return this.applyEdgeTypeHint(element);
+            }
+        });
         return context.root;
     }
 
@@ -167,18 +100,14 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
 function createConnectable(validSourceEdges: string[], validTargetEdges: string[]): Connectable {
     return {
         canConnect: (routable, role) =>
-            role === 'source' ?
-                validSourceEdges.includes(routable.type) :
-                validTargetEdges.includes(routable.type)
+            role === 'source' ? validSourceEdges.includes(routable.type) : validTargetEdges.includes(routable.type)
     };
 }
 
 function createContainable(hint: ShapeTypeHint): Containable {
     return {
         isContainableElement: element =>
-            hint.containableElementTypeIds ?
-                hint.containableElementTypeIds.includes(getElementTypeId(element)) :
-                false
+            hint.containableElementTypeIds ? hint.containableElementTypeIds.includes(getElementTypeId(element)) : false
     };
 }
 
@@ -202,12 +131,11 @@ export interface ITypeHintProvider {
 
 @injectable()
 export class TypeHintProvider implements IActionHandler, ITypeHintProvider {
-
     @inject(GLSP_TYPES.IFeedbackActionDispatcher)
     protected feedbackActionDispatcher: IFeedbackActionDispatcher;
 
-    protected shapeHints: Map<string, ShapeTypeHint> = new Map;
-    protected edgeHints: Map<string, EdgeTypeHint> = new Map;
+    protected shapeHints: Map<string, ShapeTypeHint> = new Map();
+    protected edgeHints: Map<string, EdgeTypeHint> = new Map();
 
     handle(action: Action): ICommand | Action | void {
         if (isSetTypeHintsAction(action)) {
@@ -222,13 +150,19 @@ export class TypeHintProvider implements IActionHandler, ITypeHintProvider {
         if (role === 'source') {
             return Array.from(
                 Array.from(this.edgeHints.values())
-                    .filter(hint => hint.sourceElementTypeIds.some(sourceElementTypeId => hasCompatibleType(elementTypeId, sourceElementTypeId)))
-                    .map(hint => hint.elementTypeId));
+                    .filter(hint =>
+                        hint.sourceElementTypeIds.some(sourceElementTypeId => hasCompatibleType(elementTypeId, sourceElementTypeId))
+                    )
+                    .map(hint => hint.elementTypeId)
+            );
         } else {
             return Array.from(
                 Array.from(this.edgeHints.values())
-                    .filter(hint => hint.targetElementTypeIds.some(targetElementTypeId => hasCompatibleType(elementTypeId, targetElementTypeId)))
-                    .map(hint => hint.elementTypeId));
+                    .filter(hint =>
+                        hint.targetElementTypeIds.some(targetElementTypeId => hasCompatibleType(elementTypeId, targetElementTypeId))
+                    )
+                    .map(hint => hint.elementTypeId)
+            );
         }
     }
 
@@ -254,4 +188,3 @@ function getTypeHint<T extends TypeHint>(input: SModelElement | SModelElement |
     }
     return hint;
 }
-

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 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
@@ -30,13 +30,13 @@ import {
     TYPES
 } from 'sprotty';
 import { PopupPositionUpdater } from 'sprotty/lib/features/hover/popup-position-updater';
-
 import { FocusStateChangedAction } from '../../base/actions/focus-change-action';
 import { GlspHoverMouseListener } from './hover';
 
 const glspHoverModule = new ContainerModule((bind, _unbind, isBound) => {
     bind(TYPES.PopupVNodePostprocessor).to(PopupPositionUpdater).inSingletonScope();
-    bind(TYPES.MouseListener).to(GlspHoverMouseListener);
+    bind(GlspHoverMouseListener).toSelf().inSingletonScope();
+    bind(TYPES.MouseListener).toService(GlspHoverMouseListener);
     bind(TYPES.PopupMouseListener).to(PopupHoverMouseListener);
     bind(TYPES.KeyListener).to(HoverKeyListener);
     bind<HoverState>(TYPES.HoverState).toConstantValue({
@@ -56,6 +56,7 @@ const glspHoverModule = new ContainerModule((bind, _unbind, isBound) => {
     configureActionHandler(context, SetViewportCommand.KIND, ClosePopupActionHandler);
     configureActionHandler(context, MoveCommand.KIND, ClosePopupActionHandler);
     configureActionHandler(context, FocusStateChangedAction.KIND, ClosePopupActionHandler);
+    configureActionHandler(context, FocusStateChangedAction.KIND, GlspHoverMouseListener);
 });
 
 export default glspHoverModule;

package/src/features/hover/hover.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 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,28 +13,47 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { Action, Bounds, RequestPopupModelAction, SetPopupModelAction } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
 import {
-    Action,
-    Bounds,
     EMPTY_ROOT,
+    HoverFeedbackAction,
     HoverMouseListener,
+    IActionHandler,
+    ICommand,
     PreRenderedElementSchema,
-    RequestPopupModelAction,
-    SetPopupModelAction,
     SIssueMarker,
     SIssueSeverity,
     SModelElement,
     SModelElementSchema,
     SModelRootSchema
 } from 'sprotty';
-
+import { isFocusStateChangedAction } from '../../base/actions/focus-change-action';
 import { GIssueMarker } from '../validation/issue-marker';
 
 @injectable()
-export class GlspHoverMouseListener extends HoverMouseListener {
+export class GlspHoverMouseListener extends HoverMouseListener implements IActionHandler {
+    /**
+     * Stops mouse over timer and remove hover feedback, if focus is lost.
+     *
+     * This fixes strange effects that appear if the mouse left the element via e.g. a context menu,
+     * which explicitly removes the focus of the diagram.
+     * @see SelectionServiceAwareContextMenuMouseListener
+     * @param action should be a `FocusStateChangedAction`
+     * @returns a `HoverFeedbackAction` resetting the state, if the specified action indicates lost focus
+     */
+    handle(action: Action): void | Action | ICommand {
+        if (isFocusStateChangedAction(action) && !action.hasFocus) {
+            this.stopMouseOverTimer();
+            if (this.lastHoverFeedbackElementId) {
+                const previousTargetId = this.lastHoverFeedbackElementId;
+                this.lastHoverFeedbackElementId = undefined;
+                return new HoverFeedbackAction(previousTargetId, false);
+            }
+        }
+    }
 
-    protected startMouseOverTimer(target: SModelElement, event: MouseEvent): Promise<Action> {
+    protected override startMouseOverTimer(target: SModelElement, event: MouseEvent): Promise<Action> {
         this.stopMouseOverTimer();
         return new Promise(resolve => {
             this.state.mouseOverTimer = window.setTimeout(() => {

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2021 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
@@ -14,13 +14,17 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { ContainerModule } from 'inversify';
-import { configureCommand } from 'sprotty';
-
+import { configureCommand, configureLayout, VBoxLayouter } from 'sprotty';
+import { FreeFormLayouter } from './freeform-layout';
 import { AlignElementsCommand, ResizeElementsCommand } from './layout-commands';
+import { VBoxLayouterExt } from './vbox-layout';
 
-const layoutCommandsModule = new ContainerModule((bind, _unbind, isBound) => {
+const layoutCommandsModule = new ContainerModule((bind, _unbind, isBound, rebind) => {
     configureCommand({ bind, isBound }, ResizeElementsCommand);
     configureCommand({ bind, isBound }, AlignElementsCommand);
+
+    rebind(VBoxLayouter).to(VBoxLayouterExt);
+    configureLayout({ bind, isBound }, FreeFormLayouter.KIND, FreeFormLayouter);
 });
 
 export default layoutCommandsModule;