@eclipse-glsp/client 0.9.0-next.d0112315 → 0.9.0-next.f12e3d87

package/src/base/actions/edit-validation-actions.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-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,7 +14,6 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { Action, generateRequestId, RequestAction, ResponseAction } from 'sprotty';
-
 import { Args } from '../args';
 
 export class RequestEditValidationAction implements RequestAction<SetEditValidationResultAction> {
@@ -24,7 +23,8 @@ export class RequestEditValidationAction implements RequestAction<SetEditValidat
         public readonly modelElementId: string,
         public readonly text: string,
         public readonly requestId: string = generateRequestId(),
-        public readonly kind: string = RequestEditValidationAction.KIND) { }
+        public readonly kind: string = RequestEditValidationAction.KIND
+    ) {}
 }
 
 export class SetEditValidationResultAction implements ResponseAction {
@@ -33,12 +33,16 @@ export class SetEditValidationResultAction implements ResponseAction {
         public readonly status: ValidationStatus,
         public readonly responseId: string = '',
         public readonly args?: Args,
-        public readonly kind: string = SetEditValidationResultAction.KIND) { }
+        public readonly kind: string = SetEditValidationResultAction.KIND
+    ) {}
 }
 
 export function isSetEditValidationResultAction(action: Action): action is SetEditValidationResultAction {
-    return action !== undefined && (action.kind === SetEditValidationResultAction.KIND)
-        && (action as SetEditValidationResultAction).status !== undefined;
+    return (
+        action !== undefined &&
+        action.kind === SetEditValidationResultAction.KIND &&
+        (action as SetEditValidationResultAction).status !== undefined
+    );
 }
 
 export interface ValidationStatus {
@@ -76,20 +80,29 @@ export interface ResponseError {
 }
 
 export namespace ValidationStatus {
-
+    // eslint-disable-next-line no-shadow
     export enum Severity {
+        FATAL,
+        ERROR,
+        WARNING,
+        INFO,
+        OK,
         // eslint-disable-next-line no-shadow
-        FATAL, ERROR, WARNING, INFO, OK, NONE
+        NONE
     }
 
     export const NONE: ValidationStatus = {
-        severity: Severity.NONE, message: '', error: { code: -1, message: '', data: {} }
+        severity: Severity.NONE,
+        message: '',
+        error: { code: -1, message: '', data: {} }
     };
 
     export function isOk(validationStatus: ValidationStatus): boolean {
-        return validationStatus.severity === Severity.OK
-            || validationStatus.severity === Severity.INFO
-            || validationStatus.severity === Severity.NONE;
+        return (
+            validationStatus.severity === Severity.OK ||
+            validationStatus.severity === Severity.INFO ||
+            validationStatus.severity === Severity.NONE
+        );
     }
 
     export function isWarning(validationStatus: ValidationStatus): boolean {
@@ -97,7 +110,6 @@ export namespace ValidationStatus {
     }
 
     export function isError(validationStatus: ValidationStatus): boolean {
-        return validationStatus.severity === Severity.ERROR
-            || validationStatus.severity === Severity.FATAL;
+        return validationStatus.severity === Severity.ERROR || validationStatus.severity === Severity.FATAL;
     }
 }

package/src/base/actions/focus-change-action.ts

@@ -18,7 +18,7 @@ import { Action } from 'sprotty';
 export class FocusStateChangedAction implements Action {
     static KIND = 'focusStateChanged';
     readonly kind = FocusStateChangedAction.KIND;
-    constructor(public readonly hasFocus: boolean) { }
+    constructor(public readonly hasFocus: boolean) {}
 }
 
 export function isFocusStateChangedAction(action: Action): action is FocusStateChangedAction {

package/src/base/args.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-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
@@ -15,7 +15,9 @@
  ********************************************************************************/
 import { SModelElement } from 'sprotty';
 
-export interface Args { [key: string]: string | number | boolean }
+export interface Args {
+    [key: string]: string | number | boolean;
+}
 
 export interface SArgumentable {
     args: Args;

package/src/base/auto-complete/auto-complete-widget.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-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
@@ -72,12 +72,14 @@ export class AutoCompleteWidget {
         public suggestionProvider: SuggestionProvider,
         public suggestionSubmitHandler: SuggestionSubmitHandler,
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        protected notifyClose: () => void = () => { },
+        protected notifyClose: () => void = () => {},
         protected logger?: ILogger
-    ) { }
+    ) {}
 
-    configureValidation(inputValidator: InputValidator,
-        validationDecorator: IValidationDecorator = IValidationDecorator.NO_DECORATION): void {
+    configureValidation(
+        inputValidator: InputValidator,
+        validationDecorator: IValidationDecorator = IValidationDecorator.NO_DECORATION
+    ): void {
         this.inputValidator = inputValidator;
         this.validationDecorator = validationDecorator;
     }
@@ -154,25 +156,33 @@ export class AutoCompleteWidget {
             showOnFocus: this.autoSuggestionSettings.showOnFocus,
             debounceWaitMs: this.autoSuggestionSettings.debounceWaitMs,
             minLength: -1,
-            fetch: (text: string, update: (items: LabeledAction[]) => void) =>
-                this.updateSuggestions(update, text, root),
+            fetch: (text: string, update: (items: LabeledAction[]) => void) => this.updateSuggestions(update, text, root),
             onSelect: (item: LabeledAction) => this.onSelect(item),
-            render: (item: LabeledAction, currentValue: string): HTMLDivElement | undefined =>
-                this.renderSuggestions(item, currentValue),
+            render: (item: LabeledAction, currentValue: string): HTMLDivElement | undefined => this.renderSuggestions(item, currentValue),
             customize: (input: HTMLInputElement, inputRect: ClientRect | DOMRect, container: HTMLDivElement, maxHeight: number) => {
                 this.customizeInputElement(input, inputRect, container, maxHeight);
             }
         };
     }
 
-    protected customizeInputElement(input: HTMLInputElement, inputRect: ClientRect | DOMRect, container: HTMLDivElement, maxHeight: number): void {
+    protected customizeInputElement(
+        input: HTMLInputElement,
+        inputRect: ClientRect | DOMRect,
+        container: HTMLDivElement,
+        maxHeight: number
+    ): void {
         // move container into our UIExtension container as this is already positioned correctly
         if (this.containerElement) {
             this.containerElement.appendChild(container);
         }
     }
 
-    protected updateSuggestions(update: (items: LabeledAction[]) => void, text: string, root: Readonly<SModelRoot>, ...contextElementIds: string[]): void {
+    protected updateSuggestions(
+        update: (items: LabeledAction[]) => void,
+        text: string,
+        root: Readonly<SModelRoot>,
+        ...contextElementIds: string[]
+    ): void {
         this.onLoading();
         this.doUpdateSuggestions(text, root)
             .then(actions => {
@@ -230,11 +240,13 @@ export class AutoCompleteWidget {
     }
 
     protected filterActions(filterText: string, actions: LabeledAction[]): LabeledAction[] {
-        return toArray(actions.filter(action => {
-            const label = action.label.toLowerCase();
-            const searchWords = filterText.split(' ');
-            return searchWords.every(word => label.indexOf(word.toLowerCase()) !== -1);
-        }));
+        return toArray(
+            actions.filter(action => {
+                const label = action.label.toLowerCase();
+                const searchWords = filterText.split(' ');
+                return searchWords.every(word => label.indexOf(word.toLowerCase()) !== -1);
+            })
+        );
     }
 
     protected onSelect(item: LabeledAction): void {
@@ -257,10 +269,10 @@ export class AutoCompleteWidget {
     }
 
     private isNoOrExactlyOneMatchingContextAction(): boolean | undefined {
-        return !this.isSuggestionAvailable()
-            || (this.contextActions
-                && this.contextActions.length === 1
-                && this.inputElement.value.endsWith(this.contextActions[0].label));
+        return (
+            !this.isSuggestionAvailable() ||
+            (this.contextActions && this.contextActions.length === 1 && this.inputElement.value.endsWith(this.contextActions[0].label))
+        );
     }
 
     protected isSuggestionAvailable(): boolean | undefined {
@@ -269,7 +281,8 @@ export class AutoCompleteWidget {
 
     validateInput(): void {
         if (this.inputValidator) {
-            this.inputValidator.validate(this.inputElement.value)
+            this.inputValidator
+                .validate(this.inputElement.value)
                 .then(result => this.validationDecorator.decorateValidationResult(result))
                 .catch(error => this.handleErrorDuringValidation(error));
         }

package/src/base/auto-complete/validation-decorator.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-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
@@ -25,14 +25,14 @@ export interface IValidationDecorator {
 export namespace IValidationDecorator {
     export const NO_DECORATION: IValidationDecorator = {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        decorateValidationResult(_status: ValidationStatus) { },
+        decorateValidationResult(_status: ValidationStatus) {},
         isValidatedOk(): boolean {
             return false;
         },
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        invalidate() { },
+        invalidate() {},
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        dispose() { }
+        dispose() {}
     };
 }
 
@@ -47,7 +47,7 @@ export class ValidationDecorator implements IValidationDecorator {
 
     protected decorationDiv?: HTMLDivElement;
 
-    constructor(protected containerElement: HTMLElement) { }
+    constructor(protected containerElement: HTMLElement) {}
 
     decorateValidationResult(status: ValidationStatus): void {
         if (ValidationStatus.isError(status)) {

package/src/base/command-stack.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
@@ -20,7 +20,6 @@ import { RedoOperation, UndoOperation } from '../features/undo-redo/model';
 
 @injectable()
 export class GLSPCommandStack extends CommandStack {
-
     @inject(TYPES.IActionDispatcherProvider) protected actionDispatcher: () => Promise<IActionDispatcher>;
 
     undo(): Promise<SModelRoot> {
@@ -33,4 +32,3 @@ export class GLSPCommandStack extends CommandStack {
         return this.thenUpdate();
     }
 }
-

package/src/base/container-modules.ts

@@ -0,0 +1,113 @@
+/********************************************************************************
+ * Copyright (c) 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
+ * 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 { Container, ContainerModule } from 'inversify';
+import { defaultModule } from 'sprotty';
+import {
+    boundsModule,
+    buttonModule,
+    edgeIntersectionModule,
+    edgeLayoutModule,
+    expandModule,
+    exportModule,
+    fadeModule,
+    glspCommandPaletteModule,
+    glspContextMenuModule,
+    glspDecorationModule,
+    glspEditLabelModule,
+    glspHoverModule,
+    glspMouseToolModule,
+    glspSelectModule,
+    glspServerCopyPasteModule,
+    glspViewportModule,
+    labelEditUiModule,
+    layoutCommandsModule,
+    markerNavigatorModule,
+    modelHintsModule,
+    modelSourceModule,
+    modelSourceWatcherModule,
+    navigationModule,
+    openModule,
+    paletteModule,
+    routingModule,
+    toolFeedbackModule,
+    toolsModule,
+    validationModule,
+    zorderModule
+} from '../';
+import defaultGLSPModule from './di.config';
+
+export const DEFAULT_MODULES = [
+    defaultModule,
+    defaultGLSPModule,
+    boundsModule,
+    buttonModule,
+    edgeIntersectionModule,
+    edgeLayoutModule,
+    expandModule,
+    exportModule,
+    fadeModule,
+    glspCommandPaletteModule,
+    glspContextMenuModule,
+    glspDecorationModule,
+    glspEditLabelModule,
+    glspHoverModule,
+    glspMouseToolModule,
+    glspSelectModule,
+    glspServerCopyPasteModule,
+    glspViewportModule,
+    labelEditUiModule,
+    layoutCommandsModule,
+    markerNavigatorModule,
+    modelHintsModule,
+    modelSourceModule,
+    modelSourceWatcherModule,
+    navigationModule,
+    openModule,
+    paletteModule,
+    routingModule,
+    toolFeedbackModule,
+    toolsModule,
+    validationModule,
+    zorderModule
+];
+
+/**
+ * Creates a GLSP Client container with the GLSP default modules and the specified custom `modules`.
+ *
+ * You can still customize the default modules in two ways.
+ *
+ * First, you can unload default modules and load them again with your custom code.
+ *
+ * ```typescript
+ * const container = createClientContainer(myModule1, myModule2);
+ * container.unload(modelSourceWatcherModule);
+ * container.load(myModelSourceWatcherModule);
+ * ```
+ *
+ * Second, you can unbind or rebind implementations that are originally bound in one of the default modules.
+ *
+ * ```typescript
+ * rebind(NavigationTargetResolver).to(MyNavigationTargetResolver);
+ * ```
+ * @param modules Custom modules to be loaded in addition to the default modules.
+ * @returns The created container.
+ */
+export function createClientContainer(...modules: ContainerModule[]): Container {
+    const container = new Container();
+    container.load(...DEFAULT_MODULES, ...modules);
+    return container;
+}

package/src/base/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,15 +13,13 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { InitializeResult } from '@eclipse-glsp/protocol';
+import { Container, ContainerModule } from 'inversify';
+import { ActionHandlerRegistry, configureActionHandler, configureCommand, ModelSource, SetModelCommand, TYPES } from 'sprotty';
 import '../../css/glsp-sprotty.css';
-
-import { ContainerModule } from 'inversify';
-import { configureActionHandler, configureCommand, SetModelCommand, TYPES } from 'sprotty';
-
 import { GLSPActionDispatcher } from './action-dispatcher';
 import { SetEditModeAction } from './actions/edit-mode-action';
 import { FocusStateChangedAction } from './actions/focus-change-action';
-import { ConfigureServerHandlersAction, ConfigureServerHandlersActionHandler } from './actions/protocol-actions';
 import { GLSPCommandStack } from './command-stack';
 import { EditorContextService } from './editor-context';
 import { FocusTracker } from './focus-tracker';
@@ -36,13 +34,16 @@ import { GLSPViewRegistry } from './view/view-registry';
 const defaultGLSPModule = new ContainerModule((bind, _unbind, isBound, rebind) => {
     const context = { bind, _unbind, isBound, rebind };
     bind(EditorContextService).toSelf().inSingletonScope();
-    bind(GLSP_TYPES.IEditorContextServiceProvider).toProvider<EditorContextService>(ctx => () => new Promise<EditorContextService>((resolve, reject) => {
-        if (ctx.container.isBound(EditorContextService)) {
-            resolve(ctx.container.get<EditorContextService>(EditorContextService));
-        } else {
-            reject();
-        }
-    }));
+    bind(GLSP_TYPES.IEditorContextServiceProvider).toProvider<EditorContextService>(
+        ctx => () =>
+            new Promise<EditorContextService>((resolve, reject) => {
+                if (ctx.container.isBound(EditorContextService)) {
+                    resolve(ctx.container.get<EditorContextService>(EditorContextService));
+                } else {
+                    reject();
+                }
+            })
+    );
 
     configureActionHandler(context, SetEditModeAction.KIND, EditorContextService);
 
@@ -53,9 +54,6 @@ const defaultGLSPModule = new ContainerModule((bind, _unbind, isBound, rebind) =
     configureCommand(context, FeedbackAwareUpdateModelCommand);
     configureActionHandler(context, SetModelCommand.KIND, SetModelActionHandler);
 
-    // Dynamically register all server-side action/operation handlers
-    configureActionHandler(context, ConfigureServerHandlersAction.KIND, ConfigureServerHandlersActionHandler);
-
     bind(TYPES.MouseListener).to(SelectionClearingMouseListener);
 
     rebind(TYPES.ICommandStack).to(GLSPCommandStack);
@@ -73,3 +71,20 @@ const defaultGLSPModule = new ContainerModule((bind, _unbind, isBound, rebind) =
 });
 
 export default defaultGLSPModule;
+
+/**
+ * Utility function to configure the {@link ModelSource}, i.e. the `DiagramServer`, as action handler for all server actions for the given
+ * diagramType.
+ * @param result A promise that resolves after all server actions have been registered.
+ * @param diagramType The diagram type.
+ * @param container The di container.
+ */
+export async function configureServerActions(result: InitializeResult, diagramType: string, container: Container): Promise<void> {
+    const modelSource = container.get<ModelSource>(TYPES.ModelSource);
+    const actionHandlerRegistry = container.get<ActionHandlerRegistry>(ActionHandlerRegistry);
+    const serverActions = result.serverActions[diagramType];
+    if (serverActions.length === 0) {
+        throw new Error(`No server-handled actions could be derived from the initialize result for diagramType: ${diagramType}!`);
+    }
+    serverActions.forEach(actionKind => actionHandlerRegistry.register(actionKind, modelSource));
+}

package/src/base/drag-aware-mouse-listener.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
@@ -24,7 +24,6 @@ import { Action, MouseListener, SModelElement } from 'sprotty';
  * of mouse up events.
  */
 export class DragAwareMouseListener extends MouseListener {
-
     private _isMouseDown = false;
     private _isMouseDrag = false;
 
@@ -65,5 +64,4 @@ export class DragAwareMouseListener extends MouseListener {
     get isMouseDown(): boolean {
         return this._isMouseDown;
     }
-
 }

package/src/base/editor-context.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-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
@@ -51,13 +51,12 @@ export interface EditModeListener {
 
 @injectable()
 export class EditorContextService implements IActionHandler {
-
     @inject(GLSP_TYPES.SelectionService) protected selectionService: SelectionService;
     @inject(MousePositionTracker) protected mousePositionTracker: MousePositionTracker;
     @inject(TYPES.ModelSourceProvider) protected modelSource: () => Promise<ModelSource>;
     protected _editMode: string;
 
-    constructor(@multiInject(GLSP_TYPES.IEditModeListener) @optional() protected editModeListeners: EditModeListener[] = []) { }
+    constructor(@multiInject(GLSP_TYPES.IEditModeListener) @optional() protected editModeListeners: EditModeListener[] = []) {}
 
     register(editModeListener: EditModeListener): void {
         distinctAdd(this.editModeListeners, editModeListener);
@@ -121,4 +120,3 @@ export class EditorContextService implements IActionHandler {
 }
 
 export type EditorContextServiceProvider = () => Promise<EditorContextService>;
-

package/src/base/focus-tracker.ts

@@ -20,7 +20,6 @@ import { isFocusStateChangedAction } from './actions/focus-change-action';
 
 @injectable()
 export class FocusTracker implements IActionHandler {
-
     protected inActiveCssClass = 'inactive';
     protected _hasFocus = true;
 
@@ -46,5 +45,4 @@ export class FocusTracker implements IActionHandler {
             }
         }
     }
-
 }

package/src/base/model/update-model-command.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
@@ -29,13 +29,12 @@ import {
     TYPES
 } from 'sprotty';
 import { UpdateModelAction, UpdateModelCommand } from 'sprotty/lib/features/update/update-model';
-
 import { IFeedbackActionDispatcher } from '../../features/tool-feedback/feedback-action-dispatcher';
 import { FeedbackCommand } from '../../features/tool-feedback/model';
 import { GLSP_TYPES } from '../types';
 
 /* ActionHandler that transforms a SetModelAction into an (feedback-aware) UpdateModelAction. This can be done because in sprotty
-*  UpdateModel behaves the same as SetModel if no model is present yet.*/
+ *  UpdateModel behaves the same as SetModel if no model is present yet.*/
 @injectable()
 export class SetModelActionHandler implements IActionHandler {
     handle(action: Action): Action | void {
@@ -46,8 +45,7 @@ export class SetModelActionHandler implements IActionHandler {
 }
 
 export function isSetModelAction(action: Action): action is SetModelAction {
-    return action !== undefined && (action.kind === SetModelCommand.KIND)
-        && (action as SetModelAction).newRoot !== undefined;
+    return action !== undefined && action.kind === SetModelCommand.KIND && (action as SetModelAction).newRoot !== undefined;
 }
 
 export interface SModelRootListener {
@@ -55,8 +53,8 @@ export interface SModelRootListener {
 }
 
 /**
- * A special`UpdateModelCommand` that retrieves all registered `actions` from the `IFeedbackActionDispatcher` (if present) and applies their feedback
- * to the `newRoot` before performing the update
+ * A special`UpdateModelCommand` that retrieves all registered `actions` from the `IFeedbackActionDispatcher` (if present) and applies their
+ * feedback to the `newRoot` before performing the update
  */
 @injectable()
 export class FeedbackAwareUpdateModelCommand extends UpdateModelCommand {
@@ -73,7 +71,7 @@ export class FeedbackAwareUpdateModelCommand extends UpdateModelCommand {
 
     @postConstruct()
     protected initialize(): void {
-        this.actionHandlerRegistryProvider().then(registry => this.actionHandlerRegistry = registry);
+        this.actionHandlerRegistryProvider().then(registry => (this.actionHandlerRegistry = registry));
     }
 
     protected performUpdate(oldRoot: SModelRoot, newRoot: SModelRoot, context: CommandExecutionContext): CommandReturn {