@eclipse-glsp/client 0.10.0-next.6bee8eb.163 → 0.10.0-next.82afe91.177

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
@@ -21,7 +21,7 @@ import glspDecorationModule from './features/decoration/di.config';
 import glspEditLabelModule from './features/edit-label/di.config';
 import modelHintsModule from './features/hints/di.config';
 import glspHoverModule from './features/hover/di.config';
-import layoutCommandsModule from './features/layout/di.config';
+import layoutModule from './features/layout/di.config';
 import modelSourceWatcherModule from './features/model-source-watcher/di.config';
 import glspMouseToolModule from './features/mouse-tool/di.config';
 import { navigationModule } from './features/navigation/di.config';
@@ -29,11 +29,10 @@ import saveModule from './features/save/di.config';
 import glspSelectModule from './features/select/di.config';
 import toolFeedbackModule from './features/tool-feedback/di.config';
 import paletteModule from './features/tool-palette/di.config';
-import toolsModule from './features/tools/di.config';
+import { enableDefaultToolsOnFocusLossModule, toolsModule } from './features/tools/di.config';
 import { markerNavigatorModule, validationModule } from './features/validation/di.config';
 import glspViewportModule from './features/viewport/di.config';
 
-export * from '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';
@@ -65,7 +65,7 @@ export * from './features/edit-label/edit-label-validator';
 export * from './features/hints/model';
 export * from './features/hints/type-hints';
 export * from './features/hover/hover';
-export * from './features/layout/layout-commands';
+export * from './features/layout/layout-elements-action';
 export * from './features/model-source-watcher/model-source-changed-action-handler';
 export * from './features/mouse-tool/mouse-tool';
 export * from './features/navigation/navigation-action-handler';
@@ -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';
@@ -114,10 +113,11 @@ export {
     copyPasteContextMenuModule,
     glspSelectModule,
     glspMouseToolModule,
-    layoutCommandsModule,
+    layoutModule,
     glspEditLabelModule,
     glspHoverModule,
     toolsModule,
+    enableDefaultToolsOnFocusLossModule,
     navigationModule,
     markerNavigatorModule,
     glspDecorationModule,

package/src/lib/model.ts

@@ -13,7 +13,8 @@
  *
  * 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';
 import { Containable, containerFeature } from '../features/hints/model';
 import { Saveable, saveFeature } from '../features/save/model';
 

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

@@ -15,23 +15,21 @@
  ********************************************************************************/
 import {
     Action,
+    ActionMessage,
     ComputedBoundsAction,
-    ExportSvgAction,
     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;
@@ -63,17 +61,17 @@ export class GLSPDiagramServer extends DiagramServer implements SourceUriAware {
     }
 
     override handle(action: Action): void | ICommand | Action {
-        if (isRequestModelAction(action) && action.options) {
+        if (RequestModelAction.is(action) && action.options) {
             this._sourceUri = action.options.sourceUri as string;
         }
         return super.handle(action);
     }
 
     override handleLocally(action: Action): boolean {
-        if (isServerMessageAction(action)) {
+        if (ServerMessageAction.is(action)) {
             return this.handleServerMessageAction(action);
         }
-        if (isSetEditModeAction(action)) {
+        if (SetEditModeAction.is(action)) {
             return this.handleSetEditModeAction(action);
         }
         return super.handleLocally(action);
@@ -92,7 +90,7 @@ export class GLSPDiagramServer extends DiagramServer implements SourceUriAware {
         return !isReceivedFromServer(action);
     }
 
-    public getSourceURI(): string {
+    public get sourceURI(): string {
         return this._sourceUri;
     }
 }
@@ -101,7 +99,7 @@ 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);

package/src/sprotty-reexport.ts

@@ -0,0 +1,283 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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
+ ********************************************************************************/
+/**
+ * Sprotty still keeps the old class based action definitions as deprecated API.
+ * This causes name clashes with the GLSP protocol actions when reexport sprotty.
+ * The deprecated definitions are planned to be removed with Sprotty 1.0.0.
+ * Until then we have to manually reexport the sprotty main index and exclude the clashing types.
+ */
+
+export * from '@eclipse-glsp/protocol';
+// sprotty-protocol
+export { CollapseExpandAction, CollapseExpandAllAction, ElementAndAlignment, SetBoundsAction } from 'sprotty-protocol/lib/actions';
+export { Viewport } from 'sprotty-protocol/lib/model';
+// ------------------ Base ------------------
+export * from 'sprotty/lib/base/actions/action-dispatcher';
+export * from 'sprotty/lib/base/actions/action-handler';
+export * from 'sprotty/lib/base/actions/diagram-locker';
+export * from 'sprotty/lib/base/animations/animation';
+export * from 'sprotty/lib/base/animations/animation-frame-syncer';
+export * from 'sprotty/lib/base/animations/easing';
+export * from 'sprotty/lib/base/commands/command';
+export * from 'sprotty/lib/base/commands/command-registration';
+export * from 'sprotty/lib/base/commands/command-stack';
+export * from 'sprotty/lib/base/commands/command-stack-options';
+export * from 'sprotty/lib/base/features/initialize-canvas';
+export { SetModelCommand } from 'sprotty/lib/base/features/set-model';
+export {
+    createRandomId,
+    FeatureSet,
+    IModelIndex,
+    isParent,
+    ModelIndexImpl,
+    SChildElement,
+    SModelElement,
+    SModelRoot,
+    SParentElement
+} from 'sprotty/lib/base/model/smodel';
+export * from 'sprotty/lib/base/model/smodel-extension';
+export * from 'sprotty/lib/base/model/smodel-factory';
+export {
+    containsSome,
+    findParent,
+    findParentByFeature,
+    registerModelElement,
+    translateBounds,
+    translatePoint
+} from 'sprotty/lib/base/model/smodel-utils';
+export * from 'sprotty/lib/base/tool-manager/tool';
+export * from 'sprotty/lib/base/tool-manager/tool-manager';
+export * from 'sprotty/lib/base/ui-extensions/ui-extension';
+export * from 'sprotty/lib/base/ui-extensions/ui-extension-registry';
+export * from 'sprotty/lib/base/views/key-tool';
+export * from 'sprotty/lib/base/views/mouse-tool';
+export * from 'sprotty/lib/base/views/thunk-view';
+export * from 'sprotty/lib/base/views/view';
+export * from 'sprotty/lib/base/views/viewer';
+export * from 'sprotty/lib/base/views/viewer-cache';
+export * from 'sprotty/lib/base/views/viewer-options';
+export * from 'sprotty/lib/base/views/vnode-postprocessor';
+export * from 'sprotty/lib/base/views/vnode-utils';
+// ------------------ Features ------------------
+export {
+    RequestBoundsCommand,
+    ResolvedElementAndAlignment,
+    ResolvedElementAndBounds,
+    SetBoundsCommand
+} from 'sprotty/lib/features/bounds/bounds-manipulation';
+export * from 'sprotty/lib/features/bounds/hbox-layout';
+export * from 'sprotty/lib/features/bounds/hidden-bounds-updater';
+export * from 'sprotty/lib/features/bounds/layout';
+export {
+    Alignable,
+    alignFeature,
+    BoundsAware,
+    boundsFeature,
+    findChildrenAtPosition,
+    getAbsoluteBounds,
+    getAbsoluteClientBounds,
+    isAlignable,
+    isBoundsAware,
+    isLayoutableChild,
+    isLayoutContainer,
+    isSizeable,
+    LayoutableChild,
+    layoutableChildFeature,
+    LayoutContainer,
+    layoutContainerFeature,
+    ModelLayoutOptions,
+    SShapeElement
+} from 'sprotty/lib/features/bounds/model';
+export * from 'sprotty/lib/features/bounds/stack-layout';
+export * from 'sprotty/lib/features/bounds/vbox-layout';
+export * from 'sprotty/lib/features/bounds/views';
+export * from 'sprotty/lib/features/button/button-handler';
+export * from 'sprotty/lib/features/button/model';
+export * from 'sprotty/lib/features/command-palette/action-providers';
+export * from 'sprotty/lib/features/command-palette/command-palette';
+export { Anchor, IContextMenuService, IContextMenuServiceProvider } from 'sprotty/lib/features/context-menu/context-menu-service';
+export * from 'sprotty/lib/features/context-menu/menu-providers';
+export * from 'sprotty/lib/features/context-menu/mouse-listener';
+export * from 'sprotty/lib/features/decoration/decoration-placer';
+export * from 'sprotty/lib/features/decoration/model';
+export * from 'sprotty/lib/features/decoration/views';
+export * from 'sprotty/lib/features/edge-intersection/intersection-finder';
+export * from 'sprotty/lib/features/edge-intersection/sweepline';
+export * from 'sprotty/lib/features/edge-layout/di.config';
+export * from 'sprotty/lib/features/edge-layout/edge-layout';
+export * from 'sprotty/lib/features/edge-layout/model';
+export * from 'sprotty/lib/features/edit/create';
+export * from 'sprotty/lib/features/edit/create-on-drag';
+export * from 'sprotty/lib/features/edit/delete';
+export * from 'sprotty/lib/features/edit/di.config';
+export * from 'sprotty/lib/features/edit/edit-label';
+export * from 'sprotty/lib/features/edit/edit-label-ui';
+export * from 'sprotty/lib/features/edit/edit-routing';
+export * from 'sprotty/lib/features/edit/model';
+export * from 'sprotty/lib/features/edit/reconnect';
+export * from 'sprotty/lib/features/expand/expand';
+export * from 'sprotty/lib/features/expand/model';
+export * from 'sprotty/lib/features/expand/views';
+export { ExportSvgCommand, ExportSvgKeyListener, ExportSvgPostprocessor, RequestExportSvgAction } from 'sprotty/lib/features/export/export';
+export * from 'sprotty/lib/features/export/model';
+export { SvgExporter } from 'sprotty/lib/features/export/svg-exporter';
+export * from 'sprotty/lib/features/fade/fade';
+export * from 'sprotty/lib/features/fade/model';
+export {
+    AbstractHoverMouseListener,
+    ClosePopupActionHandler,
+    HoverFeedbackAction,
+    HoverFeedbackCommand,
+    HoverKeyListener,
+    HoverMouseListener,
+    HoverState,
+    PopupHoverMouseListener,
+    SetPopupModelCommand
+} from 'sprotty/lib/features/hover/hover';
+export * from 'sprotty/lib/features/hover/model';
+export * from 'sprotty/lib/features/move/model';
+export * from 'sprotty/lib/features/move/move';
+export * from 'sprotty/lib/features/move/snap';
+export * from 'sprotty/lib/features/nameable/model';
+export * from 'sprotty/lib/features/open/model';
+export * from 'sprotty/lib/features/open/open';
+export * from 'sprotty/lib/features/projection/model';
+export * from 'sprotty/lib/features/projection/views';
+export * from 'sprotty/lib/features/routing/abstract-edge-router';
+export * from 'sprotty/lib/features/routing/anchor';
+export * from 'sprotty/lib/features/routing/bezier-anchors';
+export * from 'sprotty/lib/features/routing/bezier-edge-router';
+export * from 'sprotty/lib/features/routing/manhattan-anchors';
+export * from 'sprotty/lib/features/routing/manhattan-edge-router';
+export * from 'sprotty/lib/features/routing/model';
+export * from 'sprotty/lib/features/routing/polyline-anchors';
+export * from 'sprotty/lib/features/routing/polyline-edge-router';
+export * from 'sprotty/lib/features/routing/routing';
+export * from 'sprotty/lib/features/routing/views';
+export * from 'sprotty/lib/features/select/model';
+export {
+    GetSelectionAction,
+    GetSelectionCommand,
+    SelectAllCommand,
+    SelectCommand,
+    SelectionResult,
+    SelectKeyboardListener,
+    SelectMouseListener
+} from 'sprotty/lib/features/select/select';
+export * from 'sprotty/lib/features/undo-redo/undo-redo';
+export * from 'sprotty/lib/features/update/model-matching';
+export { UpdateAnimationData, UpdateModelCommand } from 'sprotty/lib/features/update/update-model';
+export {
+    BoundsAwareViewportCommand,
+    CenterCommand,
+    CenterKeyboardListener,
+    FitToScreenCommand
+} from 'sprotty/lib/features/viewport/center-fit';
+export * from 'sprotty/lib/features/viewport/model';
+export * from 'sprotty/lib/features/viewport/scroll';
+export {
+    GetViewportAction,
+    GetViewportCommand,
+    SetViewportCommand,
+    ViewportAnimation,
+    ViewportResult
+} from 'sprotty/lib/features/viewport/viewport';
+export * from 'sprotty/lib/features/viewport/viewport-root';
+export * from 'sprotty/lib/features/viewport/zoom';
+export * from 'sprotty/lib/features/zorder/zorder';
+export { SCompartment, SEdge, SGraph, SGraphIndex, SLabel, SNode, SPort } from 'sprotty/lib/graph/sgraph';
+// ------------------ Graph ------------------
+export * from 'sprotty/lib/graph/sgraph-factory';
+export * from 'sprotty/lib/graph/views';
+export * from 'sprotty/lib/lib/generic-views';
+export * from 'sprotty/lib/lib/html-views';
+export * from 'sprotty/lib/lib/jsx';
+export {
+    CircularNode,
+    CircularPort,
+    DiamondNode,
+    ForeignObjectElement,
+    HtmlRoot,
+    PreRenderedElement,
+    RectangularNode,
+    RectangularPort,
+    ShapedPreRenderedElement
+} from 'sprotty/lib/lib/model';
+// ------------------ Library ------------------
+export * from 'sprotty/lib/lib/modules';
+export * from 'sprotty/lib/lib/svg-views';
+// ------------------ Model Source ------------------
+export * from 'sprotty/lib/model-source/commit-model';
+export { DiagramServerProxy } from 'sprotty/lib/model-source/diagram-server';
+export * from 'sprotty/lib/model-source/local-model-source';
+export * from 'sprotty/lib/model-source/logging';
+export * from 'sprotty/lib/model-source/model-source';
+export * from 'sprotty/lib/model-source/websocket';
+// ------------------ Utilities ------------------
+export * from 'sprotty/lib/utils/browser';
+export * from 'sprotty/lib/utils/codicon';
+export * from 'sprotty/lib/utils/color';
+export { Diamond, Insets, intersection, Line, Orientation, PointToPointLine } from 'sprotty/lib/utils/geometry';
+export * from 'sprotty/lib/utils/inversify';
+export * from 'sprotty/lib/utils/logging';
+export * from 'sprotty/lib/utils/registry';
+export { defaultModule };
+export {
+    graphModule,
+    boundsModule,
+    buttonModule,
+    commandPaletteModule,
+    contextMenuModule,
+    decorationModule,
+    edgeIntersectionModule,
+    edgeLayoutModule,
+    expandModule,
+    exportModule,
+    fadeModule,
+    hoverModule,
+    moveModule,
+    openModule,
+    routingModule,
+    selectModule,
+    undoRedoModule,
+    updateModule,
+    viewportModule,
+    zorderModule
+};
+export { modelSourceModule };
+
+import defaultModule from 'sprotty/lib/base/di.config';
+import boundsModule from 'sprotty/lib/features/bounds/di.config';
+import buttonModule from 'sprotty/lib/features/button/di.config';
+import commandPaletteModule from 'sprotty/lib/features/command-palette/di.config';
+import contextMenuModule from 'sprotty/lib/features/context-menu/di.config';
+import decorationModule from 'sprotty/lib/features/decoration/di.config';
+import edgeIntersectionModule from 'sprotty/lib/features/edge-intersection/di.config';
+import edgeLayoutModule from 'sprotty/lib/features/edge-layout/di.config';
+import expandModule from 'sprotty/lib/features/expand/di.config';
+import exportModule from 'sprotty/lib/features/export/di.config';
+import fadeModule from 'sprotty/lib/features/fade/di.config';
+import hoverModule from 'sprotty/lib/features/hover/di.config';
+import moveModule from 'sprotty/lib/features/move/di.config';
+import openModule from 'sprotty/lib/features/open/di.config';
+import routingModule from 'sprotty/lib/features/routing/di.config';
+import selectModule from 'sprotty/lib/features/select/di.config';
+import undoRedoModule from 'sprotty/lib/features/undo-redo/di.config';
+import updateModule from 'sprotty/lib/features/update/di.config';
+import viewportModule from 'sprotty/lib/features/viewport/di.config';
+import zorderModule from 'sprotty/lib/features/zorder/di.config';
+import graphModule from 'sprotty/lib/graph/di.config';
+import modelSourceModule from 'sprotty/lib/model-source/di.config';

package/src/utils/layout-utils.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,8 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Point } from '@eclipse-glsp/protocol';
-import { BoundsAware, Dimension, ElementAndBounds, ElementMove, ModelLayoutOptions, SModelElement } from 'sprotty';
+import { Dimension, ElementAndBounds, Point, Writable } from '@eclipse-glsp/protocol';
+import { BoundsAware, ElementMove, ModelLayoutOptions, SModelElement } from 'sprotty';
 import { IMovementRestrictor } from '../features/change-bounds/movement-restrictor';
 
 export function minWidth(element: SModelElement & BoundsAware): number {
@@ -45,18 +45,18 @@ export function isValidSize(element: SModelElement & BoundsAware, size: Dimensio
     return size.width >= minWidth(element) && size.height >= minHeight(element);
 }
 
-export function isValidMove(element: SModelElement & BoundsAware, newPosition: Point, movementRestrictor?: IMovementRestrictor): boolean {
+export function isValidMove(element: SModelElement & BoundsAware, newPosition?: Point, movementRestrictor?: IMovementRestrictor): boolean {
     if (movementRestrictor) {
-        return movementRestrictor.validate(newPosition, element);
+        return movementRestrictor.validate(element, newPosition);
     }
     return true;
 }
 
 export function toValidElementMove(
     element: SModelElement & BoundsAware,
-    move: WriteableElementMove,
+    move: ElementMove,
     movementRestrictor?: IMovementRestrictor
-): WriteableElementMove | undefined {
+): ElementMove | undefined {
     if (!isValidMove(element, move.toPosition, movementRestrictor)) {
         return;
     }
@@ -65,9 +65,9 @@ export function toValidElementMove(
 
 export function toValidElementAndBounds(
     element: SModelElement & BoundsAware,
-    bounds: WriteableElementAndBounds,
+    bounds: Writable<ElementAndBounds>,
     movementRestrictor?: IMovementRestrictor
-): WriteableElementAndBounds | undefined {
+): ElementAndBounds | undefined {
     if (!isValidMove(element, bounds.newPosition, movementRestrictor)) {
         return;
     }
@@ -81,23 +81,3 @@ export function toValidElementAndBounds(
     }
     return bounds;
 }
-
-export interface WriteablePoint extends Point {
-    x: number;
-    y: number;
-}
-
-export interface WriteableElementMove extends ElementMove {
-    fromPosition?: WriteablePoint;
-    toPosition: WriteablePoint;
-}
-
-export interface WriteableDimension extends Dimension {
-    width: number;
-    height: number;
-}
-
-export interface WriteableElementAndBounds extends ElementAndBounds {
-    newPosition: WriteablePoint;
-    newSize: WriteableDimension;
-}

package/src/utils/smodel-util.ts

@@ -13,18 +13,16 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { distinctAdd, ElementAndRoutingPoints, remove } from '@eclipse-glsp/protocol';
+import { distinctAdd, ElementAndBounds, ElementAndRoutingPoints, remove, SModelElementSchema, TypeGuard } from '@eclipse-glsp/protocol';
 import {
     BoundsAware,
-    ElementAndBounds,
     isBoundsAware,
     isMoveable,
     isSelectable,
     isSelected,
+    ModelIndexImpl,
     Selectable,
     SModelElement,
-    SModelElementSchema,
-    SModelIndex,
     SRoutableElement,
     SRoutingHandle
 } from 'sprotty';
@@ -32,31 +30,31 @@ import { FluentIterable } from 'sprotty/lib/utils/iterable';
 
 /**
  * Helper type to represent a filter predicate for {@link SModelElement}s. This is used to retrieve
- * elements from the {@link SModelIndex} that also conform to a second type `T`. Its mainly used for
+ * elements from the {@link ModelIndexImpl} that also conform to a second type `T`. Its mainly used for
  * retrieving elements that also implement a certain model features (e.g. selectable)
  */
 export type ModelFilterPredicate<T> = (modelElement: SModelElement) => modelElement is SModelElement & T;
 
 /**
- * Retrieves all elements from the given {@link SModelIndex} that match the given {@link ModelFilterPredicate}
- * @param index The {@link SModelIndex}.
+ * Retrieves all elements from the given {@link ModelIndexImpl} that match the given {@link ModelFilterPredicate}
+ * @param index The {@link ModelIndexImpl}.
  * @param predicate The {@link ModelFilterPredicate} that should be used.
  * @returns A {@link FluentIterable} of all indexed element that match the predicate
  * (correctly casted to also include the additional type of the predicate).
  */
-export function filter<T>(index: SModelIndex<SModelElement>, predicate: ModelFilterPredicate<T>): FluentIterable<SModelElement & T> {
+export function filter<T>(index: ModelIndexImpl, predicate: ModelFilterPredicate<T>): FluentIterable<SModelElement & T> {
     return index.all().filter(predicate) as FluentIterable<SModelElement & T>;
 }
 
 /**
- * Retrieves all elements from the given {@link SModelIndex} that match the given {@link ModelFilterPredicate} and executes
+ * Retrieves all elements from the given {@link ModelIndexImpl} that match the given {@link ModelFilterPredicate} and executes
  * the given runnable for each element of the result set.
- * @param index The {@link SModelIndex}.
+ * @param index The {@link ModelIndexImpl}.
  * @param predicate The {@link ModelFilterPredicate} that should be used.
  * @param runnable The runnable that should be executed for each matching element.
  */
 export function forEachElement<T>(
-    index: SModelIndex<SModelElement>,
+    index: ModelIndexImpl,
     predicate: ModelFilterPredicate<T>,
     runnable: (modelElement: SModelElement & T) => void
 ): void {
@@ -64,33 +62,51 @@ export function forEachElement<T>(
 }
 
 /**
- * Retrieves an array of all elements that match the given {@link ModelFilterPredicate} from the given {@link SModelIndex}.
- * @param index The {@link SModelIndex}.
+ * Retrieves an array of all elements that match the given {@link ModelFilterPredicate} from the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
  * @param predicate The {@link ModelFilterPredicate} that should be used.
  * @returns An array of all indexed element that match the predicate
  * (correctly casted to also include the additional type of the predicate).
  */
-export function getMatchingElements<T>(index: SModelIndex<SModelElement>, predicate: ModelFilterPredicate<T>): (SModelElement & T)[] {
+export function getMatchingElements<T>(index: ModelIndexImpl, predicate: ModelFilterPredicate<T>): (SModelElement & T)[] {
     return Array.from(filter(index, predicate));
 }
 
 /**
- * Retrieves the amount of currently selected elements in the given {@link SModelIndex}.
- * @param index The {@link SModelIndex}.
+ * Invokes the given model index to retrieve the corresponding model elements for the given set of ids. Ids that
+ * have no corresponding element in the index will be ignored.
+ * @param index THe model index.
+ * @param elementsIDs The element ids.
+ * @param guard Optional typeguard. If defined only elements that match the guard will be returned.
+ * @returns An array of the model elements that correspond to the given ids and filter predicate.
+ */
+export function getElements<S extends SModelElement>(index: ModelIndexImpl, elementsIDs: string[], guard?: TypeGuard<S>): S[] {
+    // Internal filter function that filters out undefined model elements and runs an optional typeguard check.
+    const filterFn = (element?: SModelElement): element is S => {
+        if (element !== undefined) {
+            return guard ? guard(element) : true;
+        }
+        return false;
+    };
+    return elementsIDs.map(id => index.getById(id)).filter(filterFn);
+}
+/**
+ * Retrieves the amount of currently selected elements in the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
  * @returns The amount of selected elements.
  */
-export function getSelectedElementCount(index: SModelIndex<SModelElement>): number {
+export function getSelectedElementCount(index: ModelIndexImpl): number {
     let selected = 0;
     forEachElement(index, isSelected, element => selected++);
     return selected;
 }
 
 /**
- * Helper function to check wether an any element is selected in the given {@link SModelIndex}.
- * @param index The {@link SModelIndex}.
+ * Helper function to check wether an any element is selected in the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
  * @returns `true` if at least one element is selected, `false` otherwise.
  */
-export function hasSelectedElements(index: SModelIndex<SModelElement>): boolean {
+export function hasSelectedElements(index: ModelIndexImpl): boolean {
     return getSelectedElementCount(index) > 0;
 }