@eclipse-glsp/server 1.1.0-next.3d7585d.42

package/lib/common/features/layout/layout-operation-handler.d.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * Copyright (c) 2022-2023 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
+ ********************************************************************************/
+import { Operation } from '@eclipse-glsp/protocol';
+import { DiagramConfiguration } from '../../diagram/diagram-configuration';
+import { OperationHandler } from '../../operations/operation-handler';
+import { Logger } from '../../utils/logger';
+import { LayoutEngine } from './layout-engine';
+export declare class LayoutOperationHandler implements OperationHandler {
+    protected logger: Logger;
+    protected layoutEngine?: LayoutEngine;
+    protected diagramConfiguration: DiagramConfiguration;
+    readonly operationType = "layout";
+    execute(operation: Operation): Promise<void>;
+}
+//# sourceMappingURL=layout-operation-handler.d.ts.map

package/lib/common/features/layout/layout-operation-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-operation-handler.d.ts","sourceRoot":"","sources":["../../../../src/common/features/layout/layout-operation-handler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAClF,OAAO,EAAmB,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEpE,OAAO,EAAE,oBAAoB,EAAoB,MAAM,qCAAqC,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,qBACa,sBAAuB,YAAW,gBAAgB;IAE3D,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAIzB,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IAGtC,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAErD,QAAQ,CAAC,aAAa,YAAwB;IACxC,OAAO,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAWrD"}

package/lib/common/features/layout/layout-operation-handler.js

@@ -0,0 +1,66 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutOperationHandler = void 0;
+/********************************************************************************
+ * Copyright (c) 2022-2023 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
+ ********************************************************************************/
+const protocol_1 = require("@eclipse-glsp/protocol");
+const inversify_1 = require("inversify");
+const diagram_configuration_1 = require("../../diagram/diagram-configuration");
+const logger_1 = require("../../utils/logger");
+const layout_engine_1 = require("./layout-engine");
+let LayoutOperationHandler = class LayoutOperationHandler {
+    constructor() {
+        this.operationType = protocol_1.LayoutOperation.KIND;
+    }
+    async execute(operation) {
+        if (operation.kind === protocol_1.LayoutOperation.KIND) {
+            if (this.diagramConfiguration.layoutKind === diagram_configuration_1.ServerLayoutKind.MANUAL) {
+                if (this.layoutEngine) {
+                    await this.layoutEngine.layout();
+                    return;
+                }
+                this.logger.warn('Could not execute layout operation. No `LayoutEngine` is bound!');
+            }
+        }
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(logger_1.Logger),
+    __metadata("design:type", logger_1.Logger)
+], LayoutOperationHandler.prototype, "logger", void 0);
+__decorate([
+    (0, inversify_1.inject)(layout_engine_1.LayoutEngine),
+    (0, inversify_1.optional)(),
+    __metadata("design:type", Object)
+], LayoutOperationHandler.prototype, "layoutEngine", void 0);
+__decorate([
+    (0, inversify_1.inject)(diagram_configuration_1.DiagramConfiguration),
+    __metadata("design:type", Object)
+], LayoutOperationHandler.prototype, "diagramConfiguration", void 0);
+LayoutOperationHandler = __decorate([
+    (0, inversify_1.injectable)()
+], LayoutOperationHandler);
+exports.LayoutOperationHandler = LayoutOperationHandler;
+//# sourceMappingURL=layout-operation-handler.js.map

package/lib/common/features/layout/layout-operation-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-operation-handler.js","sourceRoot":"","sources":["../../../../src/common/features/layout/layout-operation-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,qDAAoE;AACpE,yCAAyD;AACzD,+EAA6F;AAE7F,+CAA4C;AAC5C,mDAA+C;AAGxC,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAA5B;QAWM,kBAAa,GAAG,0BAAe,CAAC,IAAI,CAAC;IAYlD,CAAC;IAXG,KAAK,CAAC,OAAO,CAAC,SAAoB;QAC9B,IAAI,SAAS,CAAC,IAAI,KAAK,0BAAe,CAAC,IAAI,EAAE;YACzC,IAAI,IAAI,CAAC,oBAAoB,CAAC,UAAU,KAAK,wCAAgB,CAAC,MAAM,EAAE;gBAClE,IAAI,IAAI,CAAC,YAAY,EAAE;oBACnB,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;oBACjC,OAAO;iBACV;gBACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;aACvF;SACJ;IACL,CAAC;CACJ,CAAA;AAtBG;IAAC,IAAA,kBAAM,EAAC,eAAM,CAAC;8BACG,eAAM;sDAAC;AAEzB;IAAC,IAAA,kBAAM,EAAC,4BAAY,CAAC;IACpB,IAAA,oBAAQ,GAAE;;4DAC2B;AAEtC;IAAC,IAAA,kBAAM,EAAC,4CAAoB,CAAC;;oEACwB;AAT5C,sBAAsB;IADlC,IAAA,sBAAU,GAAE;GACA,sBAAsB,CAuBlC;AAvBY,wDAAsB"}

package/lib/common/features/model/gmodel-factory.d.ts

@@ -0,0 +1,39 @@
+export declare const GModelFactory: unique symbol;
+/**
+ * A graph model factory produces a graph model from the model state; typically its contained source model.
+ *
+ * The responsibility of a {@link GModelFactory} implementation is to define how a {@link ModelState} is to be
+ * translated into a {@link GModelRoot} that is sent to the client for rendering. Before a {@link GModelFactory}
+ * is invoked, the {@link SourceModelStorage} has already been executed for loading the source model into the
+ * {@link ModelState}. The {@link GModelFactory} then produces the {@link GModelRoot} from the source model in the
+ * {@link ModelState}. Implementations of {@link GModelFactory} are usually specific to the type of source model, as
+ * they need to understand the source model in order to translate it into a graph model.
+ *
+ * The graph model factory is invoked after initial load of the source model and after each operation that is applied
+ * to the source model by an {@link OperationHandler} in order to update the graph model before sending it to the client
+ * for rendering.
+ *
+ * If an index is needed for mapping between the graph model and the source model, as is typically the case for
+ * {@link ActionHandler action handlers} and {@link OperationHandler operation handlers}, it is the responsibility of
+ * the graph model factory to create such an index while producing the graph model from the source model. The index
+ * shall be put into the model state too. Typically the {@link GModelIndex} is extended for a particular model source
+ * type as well.
+ *
+ * @see SourceModelStorage
+ * @see GModelIndex
+ */
+export interface GModelFactory {
+    /**
+     * Create a {@link GModelRoot} from the specified <code>modelState</code> and puts it into the
+     * <code>modelState</code>. Optionally, this step also produces and sets a {@link GModelIndex} in the model state
+     * that allows mapping from graph model elements to source model elements and vice versa.
+     */
+    createModel(): void;
+}
+/**
+ * GModelFactory to be used if the graph model is already available from the model source.
+ */
+export declare class GModelFactoryNullImpl implements GModelFactory {
+    createModel(): void;
+}
+//# sourceMappingURL=gmodel-factory.d.ts.map

package/lib/common/features/model/gmodel-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-factory.d.ts","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-factory.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,aAAa,eAA0B,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,WAAW,IAAI,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,qBACa,qBAAsB,YAAW,aAAa;IACvD,WAAW,IAAI,IAAI;CAGtB"}

package/lib/common/features/model/gmodel-factory.js

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GModelFactoryNullImpl = exports.GModelFactory = void 0;
+/********************************************************************************
+ * Copyright (c) 2022-2023 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
+ ********************************************************************************/
+const inversify_1 = require("inversify");
+exports.GModelFactory = Symbol('GModelFactory');
+/**
+ * GModelFactory to be used if the graph model is already available from the model source.
+ */
+let GModelFactoryNullImpl = class GModelFactoryNullImpl {
+    createModel() {
+        // no-op
+    }
+};
+GModelFactoryNullImpl = __decorate([
+    (0, inversify_1.injectable)()
+], GModelFactoryNullImpl);
+exports.GModelFactoryNullImpl = GModelFactoryNullImpl;
+//# sourceMappingURL=gmodel-factory.js.map

package/lib/common/features/model/gmodel-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-factory.js","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-factory.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,yCAAuC;AAE1B,QAAA,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAkCrD;;GAEG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAC9B,WAAW;QACP,QAAQ;IACZ,CAAC;CACJ,CAAA;AAJY,qBAAqB;IADjC,IAAA,sBAAU,GAAE;GACA,qBAAqB,CAIjC;AAJY,sDAAqB"}

package/lib/common/features/model/gmodel-index.d.ts

@@ -0,0 +1,107 @@
+/********************************************************************************
+ * Copyright (c) 2022-2023 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
+ ********************************************************************************/
+import { GEdge, GModelElement, GModelElementConstructor, GModelRoot, GNode } from '@eclipse-glsp/graph';
+import { TypeGuard } from '@eclipse-glsp/protocol';
+/**
+ * Is used to index all child elements of a {@link GModelRoot} by their id. Offers a set
+ * of query methods to retrieve indexed elements.
+ */
+export declare class GModelIndex {
+    protected idToElement: Map<string, GModelElement>;
+    protected typeToElements: Map<string, GModelElement[]>;
+    constructor();
+    clear(): void;
+    indexRoot(root: GModelRoot): void;
+    protected doIndex(element: GModelElement): void;
+    find(elementId: string, predicate?: (test: GModelElement) => boolean): GModelElement | undefined;
+    findByClass<G extends GModelElement>(elementTypeId: string, constructor: GModelElementConstructor<G>): G | undefined;
+    /**
+     * Returns an optional {@link GModelElement} by its elementId.
+     *
+     * @param elementId The id of the requested {@link GModelElement}.
+     * @returns An optional instance of the {@link GModelElement}.
+     */
+    get(elementId: string): GModelElement;
+    /**
+     * Returns a set of {@link GModelElement} instances by a Collection of elementIds.
+     *
+     * @param elementIds The ids to request the {@link GModelElement} from an array of elementIds.
+     * @returns A set of {@link GModelElement}s.
+     */
+    getAll(elementIds: string[]): GModelElement[];
+    /**
+     * Returns all elements of the type constructor contained in the {@link GModelRoot}.
+     *
+     * @type Type of the elements to be returned.
+     * @param constructor The class of which the returned elements should be instances.
+     * @returns A set containing the elements of type constructor.
+     */
+    getAllByClass<G extends GModelElement>(constructor: GModelElementConstructor<G>): G[];
+    /**
+     * Returns a list of all {@link GModelElement} ids contained in this instance of the GModelIndex.
+     *
+     * @returns A list of elementIds.
+     */
+    allIds(): string[];
+    /**
+     * Returns all elements of a type {@link GModelRoot}.
+     *
+     * @param type   Type of the elements to be returned.
+     * @returns A set containing the elements of the given type.
+     */
+    getElements(type: string): GModelElement[];
+    /**
+     * Returns the current amount of type occurrences in this instance of the GModelIndex.
+     *
+     * @param eClass The EClass to be counted in this instance of the GModelIndex.
+     *
+     * @returns The amount of type occurrences.
+     */
+    typeCount(type: string): number;
+    /**
+     * Returns all incoming edges for a node.
+     *
+     * @param node The node where the edges are connected.
+     *
+     * @returns All incoming edges.
+     */
+    getIncomingEdges(node: GNode): GEdge[];
+    /**
+     * Returns all outgoing edges for a node.
+     *
+     * @param node The node where the edges are connected.
+     *
+     * @returns All outgoing edges.
+     */
+    getOutgoingEdges(node: GModelElement): GEdge[];
+    /**
+     * Returns all edges in the index.
+     *
+     * @returns All edges in the index.
+     */
+    getAllEdges(): GEdge[];
+    /**
+     * Returns the first element matching the given {@link TypeGuard} starting element with the
+     * given id and walking up the parent hierarchy.
+     *
+     * @param elementId The element to start the search from
+     * @param guard The typeguard which the element should match
+     * @return The first matching element or `undefined`.
+     */
+    findParentElement<T extends GModelElement>(elementId: string, guard: TypeGuard<T>): T | undefined;
+    protected _findElement<T>(element: GModelElement, guard: TypeGuard<T>): T | undefined;
+}
+//# sourceMappingURL=gmodel-index.d.ts.map

package/lib/common/features/model/gmodel-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-index.d.ts","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAClF,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,wBAAwB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AACxG,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAInD;;;GAGG;AACH,qBACa,WAAW;IACpB,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAClD,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;;IAOvD,KAAK,IAAI,IAAI;IAKb,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;IAKjC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAiB/C,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,GAAG,aAAa,GAAG,SAAS;IAQhG,WAAW,CAAC,CAAC,SAAS,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAQpH;;;;;OAKG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa;IAIrC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,aAAa,EAAE;IAI7C;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,SAAS,aAAa,EAAE,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;IAIrF;;;;OAIG;IACH,MAAM,IAAI,MAAM,EAAE;IAIlB;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE;IAI1C;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI/B;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,EAAE;IAItC;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,aAAa,GAAG,KAAK,EAAE;IAI9C;;;;OAIG;IACH,WAAW,IAAI,KAAK,EAAE;IAItB;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAAC,SAAS,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAKjG,SAAS,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;CAYxF"}

package/lib/common/features/model/gmodel-index.js

@@ -0,0 +1,193 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GModelIndex = void 0;
+/********************************************************************************
+ * Copyright (c) 2022-2023 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
+ ********************************************************************************/
+const graph_1 = require("@eclipse-glsp/graph");
+const inversify_1 = require("inversify");
+const glsp_server_error_1 = require("../../utils/glsp-server-error");
+/**
+ * Is used to index all child elements of a {@link GModelRoot} by their id. Offers a set
+ * of query methods to retrieve indexed elements.
+ */
+let GModelIndex = class GModelIndex {
+    constructor() {
+        this.idToElement = new Map();
+        this.typeToElements = new Map();
+    }
+    clear() {
+        this.idToElement.clear();
+        this.typeToElements.clear();
+    }
+    indexRoot(root) {
+        this.clear();
+        this.doIndex(root);
+    }
+    doIndex(element) {
+        var _a, _b;
+        if (this.idToElement.has(element.id)) {
+            throw new glsp_server_error_1.GLSPServerError('Duplicate ID in model: ' + element.id);
+        }
+        this.idToElement.set(element.id, element);
+        const typeSet = (_a = this.typeToElements.get(element.type)) !== null && _a !== void 0 ? _a : [];
+        typeSet.push(element);
+        this.typeToElements.set(element.type, typeSet);
+        ((_b = element.children) !== null && _b !== void 0 ? _b : []).forEach(child => {
+            this.doIndex(child);
+            // Double check wether the parent reference of the child is set correctly
+            if (!child.parent) {
+                child.parent = element;
+            }
+        });
+    }
+    find(elementId, predicate) {
+        const element = this.idToElement.get(elementId);
+        if (element && predicate ? predicate(element) : true) {
+            return element;
+        }
+        return undefined;
+    }
+    findByClass(elementTypeId, constructor) {
+        const element = this.find(elementTypeId);
+        if (element && element instanceof constructor) {
+            return element;
+        }
+        return undefined;
+    }
+    /**
+     * Returns an optional {@link GModelElement} by its elementId.
+     *
+     * @param elementId The id of the requested {@link GModelElement}.
+     * @returns An optional instance of the {@link GModelElement}.
+     */
+    get(elementId) {
+        return (0, glsp_server_error_1.getOrThrow)(this.find(elementId), `Could not retrieve element with id: '${elementId}'`);
+    }
+    /**
+     * Returns a set of {@link GModelElement} instances by a Collection of elementIds.
+     *
+     * @param elementIds The ids to request the {@link GModelElement} from an array of elementIds.
+     * @returns A set of {@link GModelElement}s.
+     */
+    getAll(elementIds) {
+        return elementIds.map(id => this.idToElement.get(id)).filter(element => element);
+    }
+    /**
+     * Returns all elements of the type constructor contained in the {@link GModelRoot}.
+     *
+     * @type Type of the elements to be returned.
+     * @param constructor The class of which the returned elements should be instances.
+     * @returns A set containing the elements of type constructor.
+     */
+    getAllByClass(constructor) {
+        return Array.from(this.idToElement.values()).filter(element => element instanceof constructor);
+    }
+    /**
+     * Returns a list of all {@link GModelElement} ids contained in this instance of the GModelIndex.
+     *
+     * @returns A list of elementIds.
+     */
+    allIds() {
+        return Array.from(this.idToElement.keys());
+    }
+    /**
+     * Returns all elements of a type {@link GModelRoot}.
+     *
+     * @param type   Type of the elements to be returned.
+     * @returns A set containing the elements of the given type.
+     */
+    getElements(type) {
+        var _a;
+        return (_a = this.typeToElements.get(type)) !== null && _a !== void 0 ? _a : [];
+    }
+    /**
+     * Returns the current amount of type occurrences in this instance of the GModelIndex.
+     *
+     * @param eClass The EClass to be counted in this instance of the GModelIndex.
+     *
+     * @returns The amount of type occurrences.
+     */
+    typeCount(type) {
+        return this.getElements(type).length;
+    }
+    /**
+     * Returns all incoming edges for a node.
+     *
+     * @param node The node where the edges are connected.
+     *
+     * @returns All incoming edges.
+     */
+    getIncomingEdges(node) {
+        return this.getAllEdges().filter(edge => edge.targetId === node.id);
+    }
+    /**
+     * Returns all outgoing edges for a node.
+     *
+     * @param node The node where the edges are connected.
+     *
+     * @returns All outgoing edges.
+     */
+    getOutgoingEdges(node) {
+        return this.getAllEdges().filter(edge => edge.sourceId === node.id);
+    }
+    /**
+     * Returns all edges in the index.
+     *
+     * @returns All edges in the index.
+     */
+    getAllEdges() {
+        return this.getAllByClass(graph_1.GEdge);
+    }
+    /**
+     * Returns the first element matching the given {@link TypeGuard} starting element with the
+     * given id and walking up the parent hierarchy.
+     *
+     * @param elementId The element to start the search from
+     * @param guard The typeguard which the element should match
+     * @return The first matching element or `undefined`.
+     */
+    findParentElement(elementId, guard) {
+        const element = this.get(elementId);
+        return element ? this._findElement(element, guard) : undefined;
+    }
+    _findElement(element, guard) {
+        if (!element) {
+            return undefined;
+        }
+        if (guard(element)) {
+            return element;
+        }
+        if (element instanceof graph_1.GModelRoot) {
+            return undefined;
+        }
+        return this._findElement(element.parent, guard);
+    }
+};
+GModelIndex = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [])
+], GModelIndex);
+exports.GModelIndex = GModelIndex;
+//# sourceMappingURL=gmodel-index.js.map

package/lib/common/features/model/gmodel-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-index.js","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,+CAAwG;AAExG,yCAAuC;AACvC,qEAA4E;AAE5E;;;GAGG;AAEI,IAAM,WAAW,GAAjB,MAAM,WAAW;IAIpB;QACI,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;IACpC,CAAC;IAED,KAAK;QACD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,SAAS,CAAC,IAAgB;QACtB,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAES,OAAO,CAAC,OAAsB;;QACpC,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YAClC,MAAM,IAAI,mCAAe,CAAC,yBAAyB,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACpB,yEAAyE;YACzE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;gBACf,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC;aAC1B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,CAAC,SAAiB,EAAE,SAA4C;QAChE,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,OAAO,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YAClD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,WAAW,CAA0B,aAAqB,EAAE,WAAwC;QAChG,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzC,IAAI,OAAO,IAAI,OAAO,YAAY,WAAW,EAAE;YAC3C,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,SAAiB;QACjB,OAAO,IAAA,8BAAU,EAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,wCAAwC,SAAS,GAAG,CAAC,CAAC;IAClG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAoB;QACvB,OAAO,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAoB,CAAC;IACxG,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAA0B,WAAwC;QAC3E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,YAAY,WAAW,CAAQ,CAAC;IAC1G,CAAC;IAED;;;;OAIG;IACH,MAAM;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAAY;;QACpB,OAAO,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAW;QACxB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAmB;QAChC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,aAAa,CAAC,aAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB,CAA0B,SAAiB,EAAE,KAAmB;QAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,CAAC;IAES,YAAY,CAAI,OAAsB,EAAE,KAAmB;QACjE,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,SAAS,CAAC;SACpB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;YAChB,OAAO,OAAO,CAAC;SAClB;QACD,IAAI,OAAO,YAAY,kBAAU,EAAE;YAC/B,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;CACJ,CAAA;AAzKY,WAAW;IADvB,IAAA,sBAAU,GAAE;;GACA,WAAW,CAyKvB;AAzKY,kCAAW"}

package/lib/common/features/model/gmodel-serializer.d.ts

@@ -0,0 +1,67 @@
+/********************************************************************************
+ * Copyright (c) 2017-2023 TypeFox and other
+ *
+ * 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 { GModelElement, GModelElementConstructor, GModelElementSchema, GModelRoot, GModelRootSchema } from '@eclipse-glsp/graph';
+import { SModelElementSchema, SModelRootSchema } from '@eclipse-glsp/protocol';
+import { DiagramConfiguration } from '../../diagram/diagram-configuration';
+export declare const GModelSerializer: unique symbol;
+/**
+ * The `GModelSerializer` is used to transform a graphical model received as serializable JSON schema into the ES6-class based
+ * model representation and vice versa. It has to be invoked for whenever a graphical model is received in JSON format
+ * (i.e. by the GLSP client) to derive the corresponding class based model which is used internally by the GLSP server. In addition,
+ * it has to be invoked before the graphical model is sent based to the client. This is necessary to resolve the parent-child cycles
+ * inside of the graphical model which ensures that the model is serializable.
+ */
+export interface GModelSerializer {
+    /**
+     * Transform the given {@link GModelRootSchema} into its {@link GModelRoot} representation.
+     * @throws An error if the received element cannot be transformed into a {@link GModelRoot}.
+     * @param schema The root schema that should be transformed.
+     * @returns The transformed {@link GModelRoot}.
+     */
+    createRoot(schema: GModelRootSchema): GModelRoot;
+    /**
+     * Transform the given {@link GModelRootSchema} into its {@link GModelElement} representation.
+     * @throws An error if the received element cannot be transformed into a {@link GModelElement}.
+     * @param schema The element schema that should be transformed.
+     * @returns The transformed {@link GModelElement}.
+     */
+    createElement(schema: GModelElementSchema, parent?: GModelElement): GModelElement;
+    /**
+     * Transforms the given {@link GModelElement} into its serializable {@link GModelElementSchema} representation.
+     * @param element The element that should be serialized.
+     * @returns The transformed {@link GModelElementSchema}.
+     */
+    createSchema(element: GModelElement): GModelElementSchema;
+    /**
+     * The set of reserved property keys that should be excluded from serialization. Typically
+     * this set contains at least the `children` and `parent` keys to avoid parent-child cycles.
+     */
+    reservedKeys: string[];
+}
+export declare class DefaultGModelSerializer implements GModelSerializer {
+    protected diagramConfiguration: DiagramConfiguration;
+    reservedKeys: string[];
+    createRoot(schema: SModelElementSchema): GModelRoot;
+    getConfiguredConstructor(schema: SModelElementSchema): GModelElementConstructor | undefined;
+    createElement(schema: SModelElementSchema, parent?: GModelElement): GModelElement;
+    createSchema(element: GModelElement): SModelElementSchema;
+    protected initializeRoot(root: GModelRoot, schema: SModelRootSchema): GModelRoot;
+    protected initializeElement(element: GModelElement, schema: SModelElementSchema): GModelElement;
+    protected initializeChild(child: GModelElement, schema: SModelElementSchema, parent?: GModelElement): GModelElement;
+    protected initializeParent(parent: GModelElement, schema: SModelElementSchema): GModelElement;
+    protected isReserved(element: GModelElement, propertyName: string): boolean;
+}
+//# sourceMappingURL=gmodel-serializer.d.ts.map

package/lib/common/features/model/gmodel-serializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-serializer.d.ts","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-serializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAElF,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACjI,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAG3E,eAAO,MAAM,gBAAgB,eAA6B,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,UAAU,CAAC;IAEjD;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,CAAC;IAElF;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,mBAAmB,CAAC;IAE1D;;;OAGG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,qBACa,uBAAwB,YAAW,gBAAgB;IAC9B,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAEnF,YAAY,WAAuD;IACnE,UAAU,CAAC,MAAM,EAAE,mBAAmB,GAAG,UAAU;IAYnD,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,wBAAwB,GAAG,SAAS;IAkB3F,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa;IAcjF,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,mBAAmB;IAezD,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,GAAG,UAAU;IAKhF,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,mBAAmB,GAAG,aAAa;IAY/F,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa;IAQnH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,mBAAmB,GAAG,aAAa;IAS7F,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;CAc9E"}