@eclipse-glsp/server 1.1.0-RC05

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"}

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

@@ -0,0 +1,143 @@
+"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.DefaultGModelSerializer = exports.GModelSerializer = void 0;
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+/* Derived from sprotty (https://github.com/eclipse/sprotty/blob/master/packages/sprotty/src/base/model/smodel-factory.ts) */
+const graph_1 = require("@eclipse-glsp/graph");
+const inversify_1 = require("inversify");
+const diagram_configuration_1 = require("../../diagram/diagram-configuration");
+const glsp_server_error_1 = require("../../utils/glsp-server-error");
+exports.GModelSerializer = Symbol('GModelSerializer');
+let DefaultGModelSerializer = class DefaultGModelSerializer {
+    constructor() {
+        this.reservedKeys = ['children', 'parent', 'index', 'source', 'target'];
+    }
+    createRoot(schema) {
+        const constructor = this.getConfiguredConstructor(schema);
+        if (constructor) {
+            const element = new constructor();
+            if (!(element instanceof graph_1.GModelRoot)) {
+                throw new glsp_server_error_1.GLSPServerError(`Element with type '${schema.type}' is expected to be a GModelRoot!`);
+            }
+            return this.initializeRoot(element, schema);
+        }
+        throw new glsp_server_error_1.GLSPServerError(`No constructor is configured in DiagramConfiguration for type ${schema.type}`);
+    }
+    getConfiguredConstructor(schema) {
+        let key = schema.type;
+        while (!this.diagramConfiguration.typeMapping.has(key)) {
+            const i = key.lastIndexOf(':');
+            if (i > 0) {
+                key = key.substring(0, i);
+            }
+            else {
+                return undefined;
+            }
+        }
+        const constructor = this.diagramConfiguration.typeMapping.get(key);
+        if (key !== schema.type) {
+            this.diagramConfiguration.typeMapping.set(key, constructor);
+        }
+        return constructor;
+    }
+    createElement(schema, parent) {
+        const constructor = this.getConfiguredConstructor(schema);
+        if (constructor) {
+            const element = new constructor();
+            if (element instanceof graph_1.GModelRoot) {
+                throw new glsp_server_error_1.GLSPServerError(`Element with type '${schema.type}' is a GModelRoot! 'createElement()' is expected to only create child elements!`);
+            }
+            return this.initializeChild(element, schema, parent);
+        }
+        throw new glsp_server_error_1.GLSPServerError(`No constructor is configured in DiagramConfiguration for type ${schema.type}`);
+    }
+    createSchema(element) {
+        var _a;
+        const schema = {};
+        for (const key in element) {
+            if (!this.isReserved(element, key)) {
+                const value = element[key];
+                if (typeof value !== 'function') {
+                    schema[key] = value;
+                }
+            }
+        }
+        schema['children'] = ((_a = element.children) !== null && _a !== void 0 ? _a : []).map(child => this.createSchema(child));
+        return schema;
+    }
+    initializeRoot(root, schema) {
+        this.initializeParent(root, schema);
+        return root;
+    }
+    initializeElement(element, schema) {
+        for (const key in schema) {
+            if (!this.isReserved(element, key)) {
+                const value = schema[key];
+                if (typeof value !== 'function') {
+                    element[key] = value;
+                }
+            }
+        }
+        return element;
+    }
+    initializeChild(child, schema, parent) {
+        this.initializeParent(child, schema);
+        if (parent) {
+            child.parent = parent;
+        }
+        return child;
+    }
+    initializeParent(parent, schema) {
+        this.initializeElement(parent, schema);
+        if (schema.children) {
+            parent.children = schema.children.map(childSchema => this.createElement(childSchema, parent));
+        }
+        return parent;
+    }
+    isReserved(element, propertyName) {
+        if (this.reservedKeys.indexOf(propertyName) >= 0) {
+            return true;
+        }
+        let obj = element;
+        do {
+            const descriptor = Object.getOwnPropertyDescriptor(obj, propertyName);
+            if (descriptor !== undefined) {
+                return descriptor.get !== undefined;
+            }
+            obj = Object.getPrototypeOf(obj);
+        } while (obj);
+        return false;
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(diagram_configuration_1.DiagramConfiguration),
+    __metadata("design:type", Object)
+], DefaultGModelSerializer.prototype, "diagramConfiguration", void 0);
+DefaultGModelSerializer = __decorate([
+    (0, inversify_1.injectable)()
+], DefaultGModelSerializer);
+exports.DefaultGModelSerializer = DefaultGModelSerializer;
+//# sourceMappingURL=gmodel-serializer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-serializer.js","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-serializer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,6HAA6H;AAC7H,+CAAiI;AAEjI,yCAA+C;AAC/C,+EAA2E;AAC3E,qEAAgE;AAEnD,QAAA,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAyCpD,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;IAA7B;QAGH,iBAAY,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IA4GvE,CAAC;IA3GG,UAAU,CAAC,MAA2B;QAClC,MAAM,WAAW,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC1D,IAAI,WAAW,EAAE;YACb,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,IAAI,CAAC,CAAC,OAAO,YAAY,kBAAU,CAAC,EAAE;gBAClC,MAAM,IAAI,mCAAe,CAAC,sBAAsB,MAAM,CAAC,IAAI,mCAAmC,CAAC,CAAC;aACnG;YACD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SAC/C;QACD,MAAM,IAAI,mCAAe,CAAC,iEAAiE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED,wBAAwB,CAAC,MAA2B;QAChD,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACpD,MAAM,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,EAAE;gBACP,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC7B;iBAAM;gBACH,OAAO,SAAS,CAAC;aACpB;SACJ;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;QACpE,IAAI,GAAG,KAAK,MAAM,CAAC,IAAI,EAAE;YACrB,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;SAC/D;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,aAAa,CAAC,MAA2B,EAAE,MAAsB;QAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAC1D,IAAI,WAAW,EAAE;YACb,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,IAAI,OAAO,YAAY,kBAAU,EAAE;gBAC/B,MAAM,IAAI,mCAAe,CACrB,sBAAsB,MAAM,CAAC,IAAI,iFAAiF,CACrH,CAAC;aACL;YACD,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;SACxD;QACD,MAAM,IAAI,mCAAe,CAAC,iEAAiE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED,YAAY,CAAC,OAAsB;;QAC/B,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;YACvB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;gBAChC,MAAM,KAAK,GAAS,OAAe,CAAC,GAAG,CAAC,CAAC;gBACzC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC5B,MAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBAChC;aACJ;SACJ;QACA,MAAc,CAAC,UAAU,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAE9F,OAAO,MAA6B,CAAC;IACzC,CAAC;IAES,cAAc,CAAC,IAAgB,EAAE,MAAwB;QAC/D,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,iBAAiB,CAAC,OAAsB,EAAE,MAA2B;QAC3E,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACtB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;gBAChC,MAAM,KAAK,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;oBAC5B,OAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBACjC;aACJ;SACJ;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAES,eAAe,CAAC,KAAoB,EAAE,MAA2B,EAAE,MAAsB;QAC/F,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrC,IAAI,MAAM,EAAE;YACR,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;SACzB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAES,gBAAgB,CAAC,MAAqB,EAAE,MAA2B;QACzE,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvC,IAAI,MAAM,CAAC,QAAQ,EAAE;YACjB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;SACjG;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAES,UAAU,CAAC,OAAsB,EAAE,YAAoB;QAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC;SACf;QACD,IAAI,GAAG,GAAG,OAAO,CAAC;QAClB,GAAG;YACC,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YACtE,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,OAAO,UAAU,CAAC,GAAG,KAAK,SAAS,CAAC;aACvC;YACD,GAAG,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;SACpC,QAAQ,GAAG,EAAE;QACd,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ,CAAA;AA9GG;IAAC,IAAA,kBAAM,EAAC,4CAAoB,CAAC;;qEAAsD;AAD1E,uBAAuB;IADnC,IAAA,sBAAU,GAAE;GACA,uBAAuB,CA+GnC;AA/GY,0DAAuB"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gmodel-serializer.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gmodel-serializer.spec.d.ts","sourceRoot":"","sources":["../../../../src/common/features/model/gmodel-serializer.spec.ts"],"names":[],"mappings":""}