@eclipse-glsp/vscode-integration-webview 1.1.0-next.e3c23fc.57 → 1.1.0-next.e5a109d.70

package/lib/webview-glsp-client.js

@@ -0,0 +1,103 @@
+"use strict";
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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
+ ********************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebviewGlspClient = exports.StopRequest = exports.ShutdownServerNotification = exports.DisposeClientSessionRequest = exports.InitializeClientSessionRequest = exports.InitializeServerRequest = exports.StartRequest = exports.ActionMessageNotification = void 0;
+const client_1 = require("@eclipse-glsp/client");
+const vscode_messenger_common_1 = require("vscode-messenger-common");
+const vscode_messenger_webview_1 = require("vscode-messenger-webview");
+exports.ActionMessageNotification = { method: 'actionMessage' };
+exports.StartRequest = { method: 'start' };
+exports.InitializeServerRequest = { method: 'initializeServer' };
+exports.InitializeClientSessionRequest = { method: 'initializeClientSession' };
+exports.DisposeClientSessionRequest = { method: 'disposeClientSession' };
+exports.ShutdownServerNotification = { method: 'shutdownServer' };
+exports.StopRequest = { method: 'stop' };
+/**
+ * GLSP client implementation for the diagram webview. This is proxy implementation
+ * that  communicates with the actual GLSP client running in the host extension.
+ * via the vscode-messenger protocol
+ */
+class WebviewGlspClient {
+    get currentState() {
+        return this._currentState;
+    }
+    get initializeResult() {
+        return this._initializeResult;
+    }
+    get onServerInitialized() {
+        return this.onServerInitializedEmitter.event;
+    }
+    constructor(options) {
+        var _a;
+        this.toDispose = new client_1.DisposableCollection();
+        this.onActionMessageEmitter = new client_1.Emitter();
+        this._currentState = client_1.ClientState.Starting;
+        this.onServerInitializedEmitter = new client_1.Emitter();
+        this.id = options.id;
+        this.messenger = (_a = options.messenger) !== null && _a !== void 0 ? _a : new vscode_messenger_webview_1.Messenger();
+        this.toDispose.push(this.onActionMessageEmitter, this.onServerInitializedEmitter);
+        this.messenger.onNotification(exports.ActionMessageNotification, msg => this.onActionMessageEmitter.fire(msg));
+    }
+    async start() {
+        try {
+            this._currentState = client_1.ClientState.Starting;
+            await this.messenger.sendRequest(exports.StartRequest, vscode_messenger_common_1.HOST_EXTENSION);
+            this._currentState = client_1.ClientState.Running;
+        }
+        catch (error) {
+            console.error('Failed to start connection to server', error);
+            this._currentState = client_1.ClientState.StartFailed;
+        }
+    }
+    async initializeServer(params) {
+        if (this.initializeResult) {
+            return this.initializeResult;
+        }
+        const result = await this.messenger.sendRequest(exports.InitializeServerRequest, vscode_messenger_common_1.HOST_EXTENSION, params);
+        this._initializeResult = result;
+        this.onServerInitializedEmitter.fire(result);
+        return result;
+    }
+    initializeClientSession(params) {
+        return this.messenger.sendRequest(exports.InitializeClientSessionRequest, vscode_messenger_common_1.HOST_EXTENSION, params);
+    }
+    disposeClientSession(params) {
+        return this.messenger.sendRequest(exports.DisposeClientSessionRequest, vscode_messenger_common_1.HOST_EXTENSION, params);
+    }
+    shutdownServer() {
+        this.messenger.sendNotification(exports.ShutdownServerNotification, vscode_messenger_common_1.HOST_EXTENSION);
+    }
+    async stop() {
+        if (this._currentState === client_1.ClientState.Stopped) {
+            return;
+        }
+        this._currentState = client_1.ClientState.Stopping;
+        await this.messenger.sendRequest(exports.StopRequest, vscode_messenger_common_1.HOST_EXTENSION);
+        this._currentState = client_1.ClientState.Stopped;
+    }
+    sendActionMessage(message) {
+        this.messenger.sendNotification(exports.ActionMessageNotification, vscode_messenger_common_1.HOST_EXTENSION, message);
+    }
+    onActionMessage(handler) {
+        return this.onActionMessageEmitter.event(handler);
+    }
+    dispose() {
+        this.toDispose.dispose();
+    }
+}
+exports.WebviewGlspClient = WebviewGlspClient;
+//# sourceMappingURL=webview-glsp-client.js.map

package/lib/webview-glsp-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webview-glsp-client.js","sourceRoot":"","sources":["../src/webview-glsp-client.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAElF,iDAc8B;AAC9B,qEAAwF;AACxF,uEAAqD;AAMxC,QAAA,yBAAyB,GAAoC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;AACzF,QAAA,YAAY,GAAiC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACjE,QAAA,uBAAuB,GAAwD,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;AAC9G,QAAA,8BAA8B,GAAyD,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAC;AAC7H,QAAA,2BAA2B,GAAsD,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC;AACpH,QAAA,0BAA0B,GAA2B,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;AAClF,QAAA,WAAW,GAAiC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5E;;;;GAIG;AACH,MAAa,iBAAiB;IAO1B,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAGD,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAGD,IAAI,mBAAmB;QACnB,OAAO,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC;IACjD,CAAC;IAED,YAAY,OAAiC;;QAlBnC,cAAS,GAAG,IAAI,6BAAoB,EAAE,CAAC;QACvC,2BAAsB,GAAG,IAAI,gBAAO,EAAiB,CAAC;QAEtD,kBAAa,GAAgB,oBAAW,CAAC,QAAQ,CAAC;QAUlD,+BAA0B,GAAG,IAAI,gBAAO,EAAoB,CAAC;QAMnE,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,oCAAS,EAAE,CAAC;QACtD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAClF,IAAI,CAAC,SAAS,CAAC,cAAc,CAAgB,iCAAyB,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1H,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI;YACA,IAAI,CAAC,aAAa,GAAG,oBAAW,CAAC,QAAQ,CAAC;YAC1C,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,oBAAY,EAAE,wCAAc,CAAC,CAAC;YAC/D,IAAI,CAAC,aAAa,GAAG,oBAAW,CAAC,OAAO,CAAC;SAC5C;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YAC7D,IAAI,CAAC,aAAa,GAAG,oBAAW,CAAC,WAAW,CAAC;SAChD;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,MAA4B;QAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC;SAChC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,+BAAuB,EAAE,wCAAc,EAAE,MAAM,CAAC,CAAC;QACjG,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC;QAChC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,MAAyC;QAC7D,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,sCAA8B,EAAE,wCAAc,EAAE,MAAM,CAAC,CAAC;IAC9F,CAAC;IAED,oBAAoB,CAAC,MAAsC;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,mCAA2B,EAAE,wCAAc,EAAE,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED,cAAc;QACV,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,kCAA0B,EAAE,wCAAc,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,CAAC,IAAI;QACN,IAAI,IAAI,CAAC,aAAa,KAAK,oBAAW,CAAC,OAAO,EAAE;YAC5C,OAAO;SACV;QACD,IAAI,CAAC,aAAa,GAAG,oBAAW,CAAC,QAAQ,CAAC;QAC1C,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,mBAAW,EAAE,wCAAc,CAAC,CAAC;QAC9D,IAAI,CAAC,aAAa,GAAG,oBAAW,CAAC,OAAO,CAAC;IAC7C,CAAC;IAED,iBAAiB,CAAC,OAA8B;QAC5C,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,iCAAyB,EAAE,wCAAc,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,eAAe,CAAC,OAA6B;QACzC,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACH,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ;AAjFD,8CAiFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/vscode-integration-webview",
-  "version": "1.1.0-next.e3c23fc.57+e3c23fc",
+  "version": "1.1.0-next.e5a109d.70+e5a109d",
   "description": "Integration of a GLSP diagram in a VS Code extensions (WebView part)",
   "keywords": [
     "vscode",
@@ -42,7 +42,8 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@eclipse-glsp/client": "next"
+    "@eclipse-glsp/client": "next",
+    "vscode-messenger-webview": "^0.4.5"
   },
   "devDependencies": {
     "reflect-metadata": "^0.1.13"
@@ -50,5 +51,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e3c23fc733d533d348aed257544446409b95192d"
+  "gitHead": "e5a109d5721e55b0a67a4193b1742014c16d3414"
 }

package/src/default-modules.ts

@@ -0,0 +1,27 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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 { ModuleConfiguration } from '@eclipse-glsp/client';
+import { vscodeCopyPasteModule } from './features/copyPaste/copy-paste-module';
+import { vscodeDefaultModule } from './features/default/default-module';
+import { vscodeExportModule } from './features/export/export-module';
+import { vscodeNavigationModule } from './features/navigation/navigation-module';
+
+export const VSCODE_DEFAULT_MODULES = [vscodeDefaultModule, vscodeCopyPasteModule, vscodeExportModule, vscodeNavigationModule] as const;
+
+export const VSCODE_DEFAULT_MODULE_CONFIG: ModuleConfiguration = {
+    add: [...VSCODE_DEFAULT_MODULES]
+};

package/src/diagram-identifier.ts

@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { AnyObject, hasStringProp, InitializeResult } from '@eclipse-glsp/client';
+import { AnyObject, hasStringProp } from '@eclipse-glsp/client';
 
 export const GLSPDiagramIdentifier = Symbol('GLSPDiagramIdentifier');
 
@@ -21,7 +21,6 @@ export interface GLSPDiagramIdentifier {
     clientId: string;
     diagramType: string;
     uri: string;
-    initializeResult?: InitializeResult;
 }
 
 export function isDiagramIdentifier(object: any): object is GLSPDiagramIdentifier {

package/src/features/copyPaste/copy-paste-module.ts

@@ -0,0 +1,39 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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 {
+    FeatureModule,
+    ICopyPasteHandler,
+    RequestClipboardDataAction,
+    SetClipboardDataAction,
+    TYPES,
+    bindAsService,
+    copyPasteModule
+} from '@eclipse-glsp/client';
+import { ExtensionActionKind } from '../default/extension-action-handler';
+import { CopyPasteHandlerProvider, CopyPasteStartup } from './copy-paste-startup';
+
+export const vscodeCopyPasteModule = new FeatureModule(
+    bind => {
+        bind(CopyPasteHandlerProvider).toProvider(
+            ctx => () => new Promise<ICopyPasteHandler>(resolve => resolve(ctx.container.get<ICopyPasteHandler>(TYPES.ICopyPasteHandler)))
+        );
+        bindAsService(bind, TYPES.IDiagramStartup, CopyPasteStartup);
+        bind(ExtensionActionKind).toConstantValue(RequestClipboardDataAction.KIND);
+        bind(ExtensionActionKind).toConstantValue(SetClipboardDataAction.KIND);
+    },
+    { requires: copyPasteModule }
+);

package/src/features/copyPaste/copy-paste-startup.ts

@@ -0,0 +1,50 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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 { ICopyPasteHandler, IDiagramStartup, MaybePromise } from '@eclipse-glsp/client';
+import { inject, injectable } from 'inversify';
+
+export const CopyPasteHandlerProvider = Symbol('CopyPasteHandlerProvider');
+/**
+ * Service identifier and type definition to bind the {@link ICopyPasteHandler} to an provider.
+ * This enables asynchronous injections and can be used to bypass circular dependency issues.
+ */
+export type CopyPasteHandlerProvider = () => Promise<ICopyPasteHandler>;
+
+/**
+ * Startup service to hook up the copy&paste event handler
+ */
+@injectable()
+export class CopyPasteStartup implements IDiagramStartup {
+    @inject(CopyPasteHandlerProvider)
+    protected copyPasteHandlerProvider: CopyPasteHandlerProvider;
+
+    preInitialize(): MaybePromise<void> {
+        this.copyPasteHandlerProvider().then(copyPasteHandler => {
+            document.addEventListener('copy', (e: ClipboardEvent) => {
+                copyPasteHandler.handleCopy(e);
+            });
+
+            document.addEventListener('cut', (e: ClipboardEvent) => {
+                copyPasteHandler.handleCut(e);
+            });
+
+            document.addEventListener('paste', (e: ClipboardEvent) => {
+                copyPasteHandler.handlePaste(e);
+            });
+        });
+    }
+}

package/src/features/default/default-module.ts

@@ -0,0 +1,31 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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 { FeatureModule, GLSPModelSource, TYPES, bindAsService, defaultModule } from '@eclipse-glsp/client';
+import { GLSPDiagramWidget, GLSPDiagramWidgetFactory } from '../../glsp-diagram-widget';
+import { HostExtensionActionHandler } from './extension-action-handler';
+import { VsCodeGLSPModelSource } from './vscode-glsp-modelsource';
+
+export const vscodeDefaultModule = new FeatureModule(
+    (bind, _unbind, _isBound, rebind) => {
+        bind(GLSPDiagramWidget).toSelf().inSingletonScope();
+        bind(GLSPDiagramWidgetFactory).toFactory(context => () => context.container.get<GLSPDiagramWidget>(GLSPDiagramWidget));
+        bind(VsCodeGLSPModelSource).toSelf().inSingletonScope();
+        rebind(GLSPModelSource).toService(VsCodeGLSPModelSource);
+        bindAsService(bind, TYPES.IActionHandlerInitializer, HostExtensionActionHandler);
+    },
+    { requires: defaultModule }
+);

package/src/{extension-action-handler.ts → features/default/extension-action-handler.ts}

@@ -13,21 +13,48 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ActionHandlerRegistry, IActionHandler, IActionHandlerInitializer, ICommand } from '@eclipse-glsp/client';
-import { GLSPDiagramIdentifier } from './diagram-identifier';
-import { VsCodeApi } from './services';
+import {
+    Action,
+    ActionHandlerRegistry,
+    GLSPClient,
+    IActionHandler,
+    IActionHandlerInitializer,
+    ICommand,
+    IDiagramOptions,
+    TYPES
+} from '@eclipse-glsp/client';
+import { inject, injectable, multiInject, optional, postConstruct } from 'inversify';
 
 /**
- * Delegates actions that should be handled inside of the glsp vscode extension instead
+ * Service identifier to define action kinds that should be delegated to the vscode extension.
+ *
+ * Usage:
+ * ```ts
+ * bind(ExtensionActionKind).toConstantValue(SomeAction.KIND)
+ * ```
+ */
+export const ExtensionActionKind = Symbol('ExtensionActionKind');
+
+/**
+ * Delegates actions that should be handled inside of the glsp host extension instead
  * of the webview. This enables the implementation of action handlers that require access
  * to the vscode API and/or node backend.
  */
-export class GLSPVscodeExtensionActionHandler implements IActionHandler, IActionHandlerInitializer {
-    constructor(
-        protected readonly actionKinds: string[],
-        protected readonly diagramIdentifier: GLSPDiagramIdentifier,
-        protected vscodeApi: VsCodeApi
-    ) {}
+@injectable()
+export class HostExtensionActionHandler implements IActionHandler, IActionHandlerInitializer {
+    @multiInject(ExtensionActionKind)
+    @optional()
+    protected actionKinds: string[] = [];
+
+    @inject(TYPES.IDiagramOptions)
+    protected diagramOptions: IDiagramOptions;
+
+    protected glspClient?: GLSPClient;
+
+    @postConstruct()
+    protected postConstruct(): void {
+        this.diagramOptions.glspClientProvider().then(glspClient => (this.glspClient = glspClient));
+    }
 
     initialize(registry: ActionHandlerRegistry): void {
         this.actionKinds.forEach(kind => registry.register(kind, this));
@@ -36,11 +63,11 @@ export class GLSPVscodeExtensionActionHandler implements IActionHandler, IAction
     handle(action: Action): void | Action | ICommand {
         if (this.actionKinds.includes(action.kind)) {
             const message = {
-                clientId: this.diagramIdentifier.clientId,
+                clientId: this.diagramOptions.clientId,
                 action,
                 __localDispatch: true
             };
-            this.vscodeApi.postMessage(message);
+            this.glspClient?.sendActionMessage(message);
         }
     }
 }

package/src/features/default/vscode-glsp-modelsource.ts

@@ -0,0 +1,63 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * 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, ActionMessage, GLSPModelSource, ServerAction } from '@eclipse-glsp/client';
+import { injectable } from 'inversify';
+
+/**
+ * A helper interface that allows the webview to mark actions that have been received directly from the vscode extension
+ * (i.e. they are not forwarded to the GLSP Server).
+ */
+export interface ExtensionAction extends Action {
+    __localDispatch: true;
+}
+
+export namespace ExtensionAction {
+    export function is(object: unknown): object is ExtensionAction {
+        return Action.is(object) && '__localDispatch' in object && object.__localDispatch === true;
+    }
+
+    /**
+     * Mark the given action as {@link ServerAction} by attaching the "_receivedFromServer" property
+     * @param action The action that should be marked as server action
+     */
+    export function mark(action: Action): void {
+        (action as ExtensionAction).__localDispatch = true;
+    }
+}
+
+/**
+ * Customization of the default {@link GLSPModelSource} for the vscode integration.
+ * Also takes locally dispatched actions (i.e. actions that are originating from or intended for the host extension) into consideration.
+ */
+@injectable()
+export class VsCodeGLSPModelSource extends GLSPModelSource {
+    protected override messageReceived(message: ActionMessage): void {
+        if (this.clientId !== message.clientId) {
+            return;
+        }
+        this.checkMessageOrigin(message);
+        const action = message.action;
+        this.logger.log(this, 'receiving', action);
+        this.actionDispatcher.dispatch(action);
+    }
+
+    protected checkMessageOrigin(message: ActionMessage): void {
+        const isLocalDispatch = (message as any)['__localDispatch'] ?? false;
+        if (!isLocalDispatch) {
+            ServerAction.mark(message.action);
+        }
+    }
+}

package/src/{services.ts → features/export/export-module.ts}

@@ -1,6 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022 TypeFox and others.
- * Modifications: 2023 EclipseSource and others.
+ * Copyright (c) 2023 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -14,13 +13,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-// based on https://github.com/eclipse-sprotty/sprotty-vscode/blob/v0.3.0/sprotty-vscode-webview/src/services.ts
-export interface VsCodeApi {
-    postMessage: (message: any) => void;
-}
 
-export const VsCodeApi = Symbol('VsCodeApi');
+import { ExportSvgAction, FeatureModule } from '@eclipse-glsp/client';
+import { ExtensionActionKind } from '../default/extension-action-handler';
 
-export interface GLSPStarterServices {
-    vscodeApi?: VsCodeApi;
-}
+export const vscodeExportModule = new FeatureModule(bind => {
+    bind(ExtensionActionKind).toConstantValue(ExportSvgAction.KIND);
+});

package/src/{copy-paste-handler-provider.ts → features/navigation/navigation-module.ts}

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022 EclipseSource and others.
+ * Copyright (c) 2023 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -14,11 +14,9 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { ICopyPasteHandler } from '@eclipse-glsp/client';
+import { FeatureModule, NavigateToExternalTargetAction, navigationModule } from '@eclipse-glsp/client';
+import { ExtensionActionKind } from '../default/extension-action-handler';
 
-export const CopyPasteHandlerProvider = Symbol('CopyPasteHandlerProvider');
-/**
- * Service identifier and type definition to bind the {@link ICopyPasteHandler} to an provider.
- * This enables asynchronous injections and can be used to bypass circular dependency issues.
- */
-export type CopyPasteHandlerProvider = () => Promise<ICopyPasteHandler>;
+export const vscodeNavigationModule = new FeatureModule(bind => {
+    bind(ExtensionActionKind).toConstantValue(NavigateToExternalTargetAction.KIND);
+}, navigationModule);

package/src/glsp-diagram-widget.ts

@@ -16,44 +16,48 @@
  ********************************************************************************/
 // based on https://github.com/eclipse-sprotty/sprotty-vscode/blob/v0.3.0/sprotty-vscode-webview/src/vscode-diagram-widget.ts
 import {
-    DiagramServerProxy,
-    EnableToolPaletteAction,
+    DiagramLoader,
+    DiagramLoadingOptions,
     IActionDispatcher,
+    IDiagramOptions,
     ModelSource,
-    RequestModelAction,
-    RequestTypeHintsAction,
-    ServerStatusAction,
     TYPES,
     ViewerOptions
 } from '@eclipse-glsp/client';
 import { inject, injectable, postConstruct } from 'inversify';
-import { GLSPDiagramIdentifier } from './diagram-identifier';
 
 export const GLSPDiagramWidgetFactory = Symbol('GLSPDiagramWidgetFactory');
 export type GLSPDiagramWidgetFactory = () => GLSPDiagramWidget;
 
 @injectable()
 export abstract class GLSPDiagramWidget {
-    @inject(GLSPDiagramIdentifier)
-    protected diagramIdentifier: GLSPDiagramIdentifier;
     @inject(TYPES.IActionDispatcher)
-    readonly actionDispatcher: IActionDispatcher;
+    protected actionDispatcher: IActionDispatcher;
+
     @inject(TYPES.ModelSource)
-    readonly modelSource: ModelSource;
+    protected modelSource: ModelSource;
+
+    @inject(TYPES.IDiagramOptions)
+    protected diagramOptions: IDiagramOptions;
+
     @inject(TYPES.ViewerOptions)
     protected viewerOptions: ViewerOptions;
 
-    protected statusIconDiv: HTMLDivElement;
-    protected statusMessageDiv: HTMLDivElement;
+    @inject(DiagramLoader)
+    protected diagramLoader: DiagramLoader;
+
+    get clientId(): string {
+        return this.diagramOptions.clientId;
+    }
 
     @postConstruct()
     initialize(): void {
         this.initializeHtml();
-        this.dispatchInitialActions();
+        this.loadDiagram();
     }
 
     protected initializeHtml(): void {
-        const containerDiv = document.getElementById(this.diagramIdentifier.clientId + '_container');
+        const containerDiv = document.getElementById(this.clientId + '_container');
         if (containerDiv) {
             const svgContainer = document.createElement('div');
             svgContainer.id = this.viewerOptions.baseDiv;
@@ -62,75 +66,14 @@ export abstract class GLSPDiagramWidget {
             const hiddenContainer = document.createElement('div');
             hiddenContainer.id = this.viewerOptions.hiddenDiv;
             document.body.appendChild(hiddenContainer);
-
-            const statusDiv = document.createElement('div');
-            statusDiv.setAttribute('class', 'sprotty-status');
-            containerDiv.appendChild(statusDiv);
-
-            this.statusIconDiv = document.createElement('div');
-            statusDiv.appendChild(this.statusIconDiv);
-
-            this.statusMessageDiv = document.createElement('div');
-            this.statusMessageDiv.setAttribute('class', 'sprotty-status-message');
-            statusDiv.appendChild(this.statusMessageDiv);
         }
     }
 
-    dispatchInitialActions(): void {
-        if (this.modelSource instanceof DiagramServerProxy) {
-            this.modelSource.clientId = this.diagramIdentifier.clientId;
-        }
-        this.actionDispatcher.dispatch(
-            RequestModelAction.create({
-                options: {
-                    sourceUri: decodeURI(this.diagramIdentifier.uri),
-                    diagramType: this.diagramIdentifier.diagramType
-                }
-            })
-        );
-
-        this.actionDispatcher.dispatch(RequestTypeHintsAction.create());
-        this.actionDispatcher.dispatch(EnableToolPaletteAction.create());
-    }
-
-    setStatus(status: ServerStatusAction): void {
-        this.statusMessageDiv.textContent = status.message;
-        this.removeClasses(this.statusMessageDiv, 1);
-        this.statusMessageDiv.classList.add(status.severity.toLowerCase());
-        this.removeClasses(this.statusIconDiv, 0);
-        const classes = this.statusIconDiv.classList;
-        classes.add(status.severity.toLowerCase());
-        switch (status.severity) {
-            case 'FATAL':
-                classes.add('fa');
-                classes.add('fa-times-circle');
-                break;
-            case 'ERROR':
-                classes.add('fa');
-                classes.add('fa-exclamation-circle');
-                break;
-            case 'WARNING':
-                classes.add('fa');
-                classes.add('fa-exclamation-circle');
-                break;
-            case 'INFO':
-                classes.add('fa');
-                classes.add('fa-info-circle');
-                break;
-        }
+    protected createDiagramLoadingOptions(): DiagramLoadingOptions | undefined {
+        return undefined;
     }
 
-    protected removeClasses(element: Element, keep: number): void {
-        const classes = element.classList;
-        while (classes.length > keep) {
-            const item = classes.item(classes.length - 1);
-            if (item) {
-                classes.remove(item);
-            }
-        }
+    loadDiagram(): Promise<void> {
+        return this.diagramLoader.load(this.createDiagramLoadingOptions());
     }
 }
-
-export function decodeURI(uri: string): string {
-    return decodeURIComponent(uri.replace(/\+/g, ' '));
-}