@eclipse-glsp/client 1.1.0-next.d3b810d.243 → 1.1.0-next.d81a1ea.249

package/src/features/accessibility/search/search-palette.ts

@@ -0,0 +1,181 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { Action, CenterAction, SelectAction, SelectAllAction } from '@eclipse-glsp/protocol';
+import { injectable } from 'inversify';
+import { isEqual } from 'lodash';
+import { codiconCSSString, isNameable, LabeledAction, name, SEdge, SModelElement, SModelRoot, SNode } from 'sprotty';
+import { toArray } from 'sprotty/lib/utils/iterable';
+import { AutocompleteSuggestion, IAutocompleteSuggestionProvider } from '../../autocomplete-palette/autocomplete-suggestion-providers';
+import { BaseAutocompletePalette } from '../../autocomplete-palette/base-autocomplete-palette';
+
+import { applyCssClasses, deleteCssClasses } from '../../tool-feedback/css-feedback';
+
+const CSS_SEARCH_HIDDEN = 'search-hidden';
+const CSS_SEARCH_HIGHLIGHTED = 'search-highlighted';
+
+export class RevealNamedElementAutocompleteSuggestionProvider implements IAutocompleteSuggestionProvider {
+    async retrieveSuggestions(root: Readonly<SModelRoot>, text: string): Promise<AutocompleteSuggestion[]> {
+        const nameables = toArray(root.index.all().filter(element => isNameable(element)));
+        return nameables.map(nameable => ({
+            element: nameable,
+            action: new LabeledAction(
+                `[${nameable.type}] ${name(nameable) ?? '<no-name>'}`,
+                this.getActions(nameable),
+                codiconCSSString('eye')
+            )
+        }));
+    }
+
+    protected getActions(nameable: SModelElement): Action[] {
+        return [SelectAction.create({ selectedElementsIDs: [nameable.id] }), CenterAction.create([nameable.id], { retainZoom: true })];
+    }
+}
+
+export class RevealEdgeElementAutocompleteSuggestionProvider implements IAutocompleteSuggestionProvider {
+    async retrieveSuggestions(root: Readonly<SModelRoot>, text: string): Promise<AutocompleteSuggestion[]> {
+        const edges = toArray(root.index.all().filter(element => element instanceof SEdge)) as SEdge[];
+        return edges.map(edge => ({
+            element: edge,
+            action: new LabeledAction(
+                `[${edge.type}] ` + this.getEdgeLabel(root, edge),
+                this.getActions(edge),
+                codiconCSSString('arrow-both')
+            )
+        }));
+    }
+    protected getActions(edge: SEdge): Action[] {
+        return [SelectAction.create({ selectedElementsIDs: [edge.id] }), CenterAction.create([edge.sourceId, edge.targetId])];
+    }
+    protected getEdgeLabel(root: Readonly<SModelRoot>, edge: SEdge): string {
+        let sourceName = '';
+        let targetName = '';
+
+        const sourceNode = root.index.getById(edge.sourceId);
+        const targetNode = root.index.getById(edge.targetId);
+
+        if (sourceNode !== undefined) {
+            sourceName = name(sourceNode) ?? sourceNode.type;
+        }
+        if (targetNode !== undefined) {
+            targetName = name(targetNode) ?? targetNode.type;
+        }
+
+        return sourceName + ' -> ' + targetName;
+    }
+}
+@injectable()
+export class SearchAutocompletePalette extends BaseAutocompletePalette {
+    static readonly ID = 'search-autocomplete-palette';
+
+    protected cachedSuggestions: AutocompleteSuggestion[] = [];
+
+    id(): string {
+        return SearchAutocompletePalette.ID;
+    }
+
+    protected override initializeContents(containerElement: HTMLElement): void {
+        super.initializeContents(containerElement);
+
+        this.autocompleteWidget.inputField.placeholder = 'Search for elements';
+    }
+    protected getSuggestionProviders(root: Readonly<SModelRoot>, input: string): IAutocompleteSuggestionProvider[] {
+        return [new RevealNamedElementAutocompleteSuggestionProvider(), new RevealEdgeElementAutocompleteSuggestionProvider()];
+    }
+    protected async retrieveSuggestions(root: Readonly<SModelRoot>, input: string): Promise<LabeledAction[]> {
+        const providers = this.getSuggestionProviders(root, input);
+        const suggestions = (await Promise.all(providers.map(provider => provider.retrieveSuggestions(root, input)))).flat(1);
+
+        this.cachedSuggestions = suggestions;
+
+        return suggestions.map(s => s.action);
+    }
+
+    protected override async visibleSuggestionsChanged(root: Readonly<SModelRoot>, labeledActions: LabeledAction[]): Promise<void> {
+        await this.applyCSS(this.getHiddenElements(root, this.getSuggestionsFromLabeledActions(labeledActions)), CSS_SEARCH_HIDDEN);
+        await this.deleteCSS(
+            this.getSuggestionsFromLabeledActions(labeledActions).map(s => s.element),
+            CSS_SEARCH_HIDDEN
+        );
+    }
+
+    protected override async selectedSuggestionChanged(
+        root: Readonly<SModelRoot>,
+        labeledAction?: LabeledAction | undefined
+    ): Promise<void> {
+        await this.deleteAllCSS(root, CSS_SEARCH_HIGHLIGHTED);
+        if (labeledAction !== undefined) {
+            const suggestions = this.getSuggestionsFromLabeledActions([labeledAction]);
+
+            const actions: CenterAction[] = [];
+            suggestions.map(currElem => actions.push(CenterAction.create([currElem.element.id], { animate: true, retainZoom: true })));
+
+            this.actionDispatcher.dispatchAll(actions);
+            await this.applyCSS(
+                suggestions.map(s => s.element),
+                CSS_SEARCH_HIGHLIGHTED
+            );
+        }
+    }
+
+    public override show(root: Readonly<SModelRoot>, ...contextElementIds: string[]): void {
+        this.actionDispatcher.dispatch(SelectAllAction.create(false));
+
+        super.show(root, ...contextElementIds);
+    }
+
+    public override hide(): void {
+        if (this.root !== undefined) {
+            this.deleteAllCSS(this.root, CSS_SEARCH_HIDDEN);
+            this.deleteAllCSS(this.root, CSS_SEARCH_HIGHLIGHTED);
+            this.autocompleteWidget.inputField.value = '';
+        }
+
+        super.hide();
+    }
+
+    protected applyCSS(elements: SModelElement[], cssClass: string): Promise<void> {
+        const actions = elements.map(element => applyCssClasses(element, cssClass));
+        return this.actionDispatcher.dispatchAll(actions);
+    }
+
+    protected deleteCSS(elements: SModelElement[], cssClass: string): Promise<void> {
+        const actions = elements.map(element => deleteCssClasses(element, cssClass));
+        return this.actionDispatcher.dispatchAll(actions);
+    }
+
+    protected deleteAllCSS(root: Readonly<SModelRoot>, cssClass: string): Promise<void> {
+        const actions = toArray(root.index.all().map(element => deleteCssClasses(element, cssClass)));
+        return this.actionDispatcher.dispatchAll(actions);
+    }
+
+    protected getSuggestionsFromLabeledActions(labeledActions: LabeledAction[]): AutocompleteSuggestion[] {
+        return this.cachedSuggestions.filter(c => labeledActions.find(s => isEqual(s, c.action)));
+    }
+
+    protected getHiddenSuggestionsFromLabeledActions(labeledActions: LabeledAction[]): AutocompleteSuggestion[] {
+        return this.cachedSuggestions.filter(c => !labeledActions.find(s => isEqual(s, c.action)));
+    }
+
+    protected getHiddenElements(root: Readonly<SModelRoot>, suggestions: AutocompleteSuggestion[]): SModelElement[] {
+        return toArray(
+            root.index
+                .all()
+                .filter(element => element instanceof SNode || element instanceof SEdge)
+                .filter(element => suggestions.find(suggestion => suggestion.element.id === element.id) === undefined)
+        );
+    }
+}

package/src/features/accessibility/search/search-tool.ts

@@ -0,0 +1,60 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { Action } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
+import { KeyListener, KeyTool, SetUIExtensionVisibilityAction, SModelElement, Tool } from 'sprotty';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { SearchAutocompletePalette } from './search-palette';
+
+@injectable()
+export class SearchAutocompletePaletteTool implements Tool {
+    static readonly ID = 'glsp.search-autocomplete-palette-tool';
+
+    protected readonly keyListener = new SearchAutocompletePaletteKeyListener();
+
+    @inject(KeyTool) protected keyTool: KeyTool;
+
+    get id(): string {
+        return SearchAutocompletePaletteTool.ID;
+    }
+
+    enable(): void {
+        this.keyTool.register(this.keyListener);
+    }
+
+    disable(): void {
+        this.keyTool.deregister(this.keyListener);
+    }
+}
+
+export class SearchAutocompletePaletteKeyListener extends KeyListener {
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        if (this.matchesSearchActivateKeystroke(event)) {
+            return [
+                SetUIExtensionVisibilityAction.create({
+                    extensionId: SearchAutocompletePalette.ID,
+                    visible: true
+                })
+            ];
+        }
+        return [];
+    }
+
+    protected matchesSearchActivateKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'KeyF', 'ctrl');
+    }
+}

package/src/features/accessibility/view-key-tools/deselect-key-tool.ts

@@ -0,0 +1,80 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { Action, SelectAction } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
+import { isSelectable, KeyListener, KeyTool, SModelElement, SRoutableElement, SwitchEditModeAction } from 'sprotty';
+import { toArray } from 'sprotty/lib/utils/iterable';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { GLSPTool } from '../../../base/tool-manager/glsp-tool-manager';
+import { SResizeHandle } from '../../change-bounds/model';
+
+/**
+ * Deselects the element if there is no interaction possible with element.
+ */
+@injectable()
+export class DeselectKeyTool implements GLSPTool {
+    static ID = 'glsp.deselect-key-tool';
+
+    isEditTool = true;
+
+    protected readonly deselectKeyListener = new DeselectKeyListener();
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+
+    get id(): string {
+        return DeselectKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.deselectKeyListener);
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.deselectKeyListener);
+    }
+}
+
+export class DeselectKeyListener extends KeyListener {
+    override keyDown(target: SModelElement, event: KeyboardEvent): Action[] {
+        if (this.matchesDeselectKeystroke(event)) {
+            const isResizeHandleActive = toArray(target.root.index.all().filter(el => el instanceof SResizeHandle)).length > 0;
+
+            if (isResizeHandleActive) {
+                return [];
+            }
+
+            const deselect = toArray(target.root.index.all().filter(element => isSelectable(element) && element.selected));
+            const actions: Action[] = [];
+
+            if (deselect.length > 0) {
+                actions.push(SelectAction.create({ deselectedElementsIDs: deselect.map(e => e.id) }));
+            }
+
+            const routableDeselect = deselect.filter(e => e instanceof SRoutableElement).map(e => e.id);
+            if (routableDeselect.length > 0) {
+                actions.push(SwitchEditModeAction.create({ elementsToDeactivate: routableDeselect }));
+            }
+
+            return actions;
+        }
+        return [];
+    }
+
+    protected matchesDeselectKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Escape');
+    }
+}

package/src/features/accessibility/view-key-tools/di.config.ts

@@ -0,0 +1,33 @@
+/********************************************************************************
+ * Copyright (c) 2019-2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { bindAsService, BindingContext } from '@eclipse-glsp/protocol';
+import { ContainerModule } from 'inversify';
+import { TYPES } from '../../../base/types';
+import { DeselectKeyTool } from '../view-key-tools/deselect-key-tool';
+import { MovementKeyTool } from './movement-key-tool';
+import { ZoomKeyTool } from './zoom-key-tool';
+
+export const glspViewKeyToolsModule = new ContainerModule((bind, _unbind, isBound, rebind) => {
+    const context = { bind, isBound, rebind };
+    configureViewKeyTools(context);
+});
+
+export function configureViewKeyTools(context: Pick<BindingContext, 'bind'>): void {
+    bindAsService(context, TYPES.IDefaultTool, MovementKeyTool);
+    bindAsService(context, TYPES.IDefaultTool, ZoomKeyTool);
+    bindAsService(context, TYPES.IDefaultTool, DeselectKeyTool);
+}

package/src/features/accessibility/view-key-tools/movement-key-tool.ts

@@ -0,0 +1,115 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { Action } from '@eclipse-glsp/protocol';
+import { inject, injectable, optional } from 'inversify';
+import { ISnapper, KeyListener, KeyTool, SModelElement } from 'sprotty';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { GLSPTool } from '../../../base/tool-manager/glsp-tool-manager';
+import { TYPES } from '../../../base/types';
+import { GridSnapper } from '../../change-bounds/snap';
+
+import { SelectionService } from '../../select/selection-service';
+import { MoveElementAction, MoveViewportAction } from '../move-zoom/move-handler';
+
+/**
+ * Moves viewport and elements when its focused and arrow keys are hit.
+ */
+@injectable()
+export class MovementKeyTool implements GLSPTool {
+    static ID = 'glsp.movement-key-tool';
+
+    isEditTool = true;
+
+    protected readonly movementKeyListener = new MoveKeyListener(this);
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+    @inject(TYPES.SelectionService) selectionService: SelectionService;
+    @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
+
+    get id(): string {
+        return MovementKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.movementKeyListener);
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.movementKeyListener);
+    }
+}
+
+export class MoveKeyListener extends KeyListener {
+    // Default x distance used if GridSnapper is not provided
+    static readonly defaultMoveX = 20;
+
+    // Default y distance used if GridSnapper is not provided
+    static readonly defaultMoveY = 20;
+
+    protected grid = { x: MoveKeyListener.defaultMoveX, y: MoveKeyListener.defaultMoveY };
+
+    constructor(protected readonly tool: MovementKeyTool) {
+        super();
+
+        if (this.tool.snapper instanceof GridSnapper) {
+            this.grid = this.tool.snapper.grid;
+        }
+    }
+
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        const selectedElementIds = this.tool.selectionService.getSelectedElementIDs();
+
+        if (selectedElementIds.length > 0) {
+            if (this.matchesMoveUpKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, 0, -this.grid.x)];
+            } else if (this.matchesMoveDownKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, 0, this.grid.x)];
+            } else if (this.matchesMoveRightKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, this.grid.x, 0)];
+            } else if (this.matchesMoveLeftKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, -this.grid.x, 0)];
+            }
+        } else {
+            if (this.matchesMoveUpKeystroke(event)) {
+                return [MoveViewportAction.create(0, -this.grid.x)];
+            } else if (this.matchesMoveDownKeystroke(event)) {
+                return [MoveViewportAction.create(0, this.grid.x)];
+            } else if (this.matchesMoveRightKeystroke(event)) {
+                return [MoveViewportAction.create(this.grid.x, 0)];
+            } else if (this.matchesMoveLeftKeystroke(event)) {
+                return [MoveViewportAction.create(-this.grid.x, 0)];
+            }
+        }
+        return [];
+    }
+
+    protected matchesMoveUpKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowUp');
+    }
+
+    protected matchesMoveDownKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowDown');
+    }
+
+    protected matchesMoveRightKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowRight');
+    }
+
+    protected matchesMoveLeftKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowLeft');
+    }
+}

package/src/features/accessibility/view-key-tools/zoom-key-tool.ts

@@ -0,0 +1,94 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { Action, CenterAction } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
+import { KeyListener, KeyTool, SModelElement } from 'sprotty';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { GLSPTool } from '../../../base/tool-manager/glsp-tool-manager';
+import { TYPES } from '../../../base/types';
+import { SelectionService } from '../../select/selection-service';
+import { ZoomElementAction, ZoomViewportAction } from '../move-zoom/zoom-handler';
+
+/**
+ * Zoom viewport and elements when its focused and arrow keys are hit.
+ */
+@injectable()
+export class ZoomKeyTool implements GLSPTool {
+    static ID = 'glsp.zoom-key-tool';
+
+    isEditTool = false;
+
+    protected readonly zoomKeyListener = new ZoomKeyListener(this);
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+    @inject(TYPES.SelectionService) selectionService: SelectionService;
+
+    get id(): string {
+        return ZoomKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.zoomKeyListener);
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.zoomKeyListener);
+    }
+}
+
+export class ZoomKeyListener extends KeyListener {
+    static readonly defaultZoomInFactor = 1.1;
+    static readonly defaultZoomOutFactor = 0.9;
+
+    constructor(protected tool: ZoomKeyTool) {
+        super();
+    }
+
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        const selectedElementIds = this.tool.selectionService.getSelectedElementIDs();
+
+        if (this.matchesZoomOutKeystroke(event)) {
+            if (selectedElementIds.length > 0) {
+                return [ZoomElementAction.create(selectedElementIds, ZoomKeyListener.defaultZoomOutFactor)];
+            } else {
+                return [ZoomViewportAction.create(ZoomKeyListener.defaultZoomOutFactor)];
+            }
+        } else if (this.matchesZoomInKeystroke(event)) {
+            if (selectedElementIds.length > 0) {
+                return [ZoomElementAction.create(selectedElementIds, ZoomKeyListener.defaultZoomInFactor)];
+            } else {
+                return [ZoomViewportAction.create(ZoomKeyListener.defaultZoomInFactor)];
+            }
+        } else if (this.matchesMinZoomLevelKeystroke(event)) {
+            return [CenterAction.create(selectedElementIds)];
+        }
+        return [];
+    }
+
+    protected matchesZoomInKeystroke(event: KeyboardEvent): boolean {
+        /** here event.key is used for '+', as keycode 187 is already declared for 'Equals' in {@link matchesKeystroke}.*/
+        return event.key === '+' || matchesKeystroke(event, 'NumpadAdd');
+    }
+
+    protected matchesMinZoomLevelKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Digit0', 'ctrl') || matchesKeystroke(event, 'Numpad0', 'ctrl');
+    }
+
+    protected matchesZoomOutKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Minus') || matchesKeystroke(event, 'NumpadSubtract');
+    }
+}

package/src/features/autocomplete-palette/autocomplete-suggestion-providers.ts

@@ -0,0 +1,37 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { LabeledAction, SModelElement, SModelRoot } from 'sprotty';
+
+/**
+ * Interface for a provider that provides suggestions that can be used to fill the autocomplete
+ */
+export interface IAutocompleteSuggestionProvider {
+    /**
+     * Returns the suggestions based on the provided parameters.
+     * @param root: The root model
+     * @param text: The text input provided by the user.
+     */
+    retrieveSuggestions(root: Readonly<SModelRoot>, text: string): Promise<AutocompleteSuggestion[]>;
+}
+
+/**
+ * Interface for autocomplete suggestions.
+ */
+export interface AutocompleteSuggestion {
+    element: SModelElement;
+    action: LabeledAction;
+}