GLSP-865 Update to latest protocol version (#61)

Update to latest protocol version and add gmodel class + builder for `GForeignObjectElement`

Author: tortmayr

examples/workflow-server/tsconfig.json

@@ -3,7 +3,6 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",
-    "baseUrl": ".",
     "esModuleInterop": true,
     "resolveJsonModule": true
   },

package.json

@@ -28,7 +28,7 @@
     "watch": "lerna run --parallel watch"
   },
   "devDependencies": {
-    "@eclipse-glsp/dev": "next",
+    "@eclipse-glsp/dev": "1.1.0-next.3b7f01d.144",
     "@types/node": "16.x",
     "lerna": "^6.6.2",
     "typescript": "^5.0.4"

packages/graph/src/default-types.ts

@@ -18,7 +18,7 @@ import { GButton } from './gbutton';
 import { GCompartment } from './gcompartment';
 import { GEdge } from './gedge';
 import { GGraph } from './ggraph';
-import { GHtmlRoot } from './ghtmlroot';
+import { GHtmlRoot } from './ghtml-root';
 import { GIssueMarker } from './gissue-marker';
 import { GLabel } from './glabel';
 import { GModelElementConstructor } from './gmodel-element';

packages/graph/src/gforeign-object-element.ts

@@ -0,0 +1,44 @@
+/********************************************************************************
+ * 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 { GShapePreRenderedElementBuilder, GShapedPreRenderedElement } from './gshaped-prerendered-element';
+
+/**
+ * A `foreignObject` element to be transferred to the DOM within the SVG.
+ *
+ * This can be useful to to benefit from e.g. HTML rendering features, such as line wrapping, inside of
+ * the SVG diagram.  Note that `foreignObject` is not supported by all browsers and SVG viewers may not
+ * support rendering the `foreignObject` content.
+ *
+ * If no dimensions are specified in the schema element, this element will obtain the dimension of
+ * its parent to fill the entire available room. Thus, this element requires specified bounds itself
+ * or bounds to be available for its parent.
+ */
+export class GForeignObjectElement extends GShapedPreRenderedElement {
+    static override builder(): GForeignObjectElementBuilder {
+        return new GForeignObjectElementBuilder(GForeignObjectElement);
+    }
+    namespace: string;
+}
+
+export class GForeignObjectElementBuilder<
+    G extends GForeignObjectElement = GForeignObjectElement
+> extends GShapePreRenderedElementBuilder<G> {
+    namespace(namespace: string): this {
+        this.proxy.namespace = namespace;
+        return this;
+    }
+}

packages/graph/src/ghtmlroot.ts packages/graph/src/ghtml-root.tspackages/graph/src/ghtmlroot.ts renamed to packages/graph/src/ghtml-root.ts

@@ -17,29 +17,16 @@ import {
     Args,
     Bounds,
     Dimension,
-    flatPush,
+    GModelElementSchema,
+    GModelRootSchema,
     JsonPrimitive,
     MaybeArray,
     Point,
-    SModelElementSchema,
-    SModelRootSchema
+    flatPush
 } from '@eclipse-glsp/protocol';
 import * as uuid from 'uuid';
 
 export type GModelElementConstructor<G extends GModelElement = GModelElement> = new () => G;
-/**
- * Represents a `GModeElement` serialized as plain JSON object.
- */
-export type GModelElementSchema = SModelElementSchema;
-
-export namespace GModelElementSchema {
-    /**
-     * Typeguard function to check wether the given object is an {@link GModelElementSchema}.
-     * @param object The object to check.
-     * @returns A type literal indicating wether the given object is of type {@link GModelElementSchema}.
-     */
-    export const is = SModelElementSchema.is;
-}
 
 /**
  * Base type for all elements of the graphical model.
@@ -187,9 +174,7 @@ export abstract class GModelElementBuilder<G extends GModelElement> {
     }
 }
 
-export type GModelRootSchema = SModelRootSchema;
-
-export class GModelRoot extends GModelElement implements SModelRootSchema {
+export class GModelRoot extends GModelElement implements GModelRootSchema {
     static builder(): GModelRootBuilder {
         return new GModelRootBuilder(GModelRoot);
     }

packages/graph/src/gmodel-element.ts

@@ -20,8 +20,9 @@ export * from './gbutton';
 export * from './gcompartment';
 export * from './gedge';
 export * from './gedge-layoutable';
+export * from './gforeign-object-element';
 export * from './ggraph';
-export * from './ghtmlroot';
+export * from './ghtml-root';
 export * from './gissue-marker';
 export * from './glabel';
 export * from './glayoutable';

packages/graph/src/index.ts

@@ -3,10 +3,7 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",
-    "reactNamespace": "JSX",
-    "baseUrl": "src",
+    "reactNamespace": "JSX"
   },
-  "include": [
-    "src"
-  ]
-}
+  "include": ["src"]
+}

packages/graph/tsconfig.json

@@ -4,17 +4,8 @@
     "rootDir": "src",
     "outDir": "lib",
     "reactNamespace": "JSX",
-    "baseUrl": "src",
-    "types": [
-      "node",
-      "mocha",
-      "reflect-metadata"
-    ]
+    "types": ["node", "mocha", "reflect-metadata"]
   },
-  "exclude": [
-    "**/*.spec.ts"
-  ],
-  "include": [
-    "src"
-  ]
-}
+  "exclude": ["**/*.spec.ts"],
+  "include": ["src"]
+}

packages/layout-elk/tsconfig.json

@@ -14,8 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { GModelRootSchema } from '@eclipse-glsp/graph';
-import { AnyObject, MaybePromise, SModelRootSchema } from '@eclipse-glsp/protocol';
+import { AnyObject, GModelElementSchema, GModelRootSchema, MaybePromise } from '@eclipse-glsp/protocol';
 import * as jsonPatch from 'fast-json-patch';
 import { GModelSerializer } from '../features/model/gmodel-serializer';
 import { ModelState } from '../features/model/model-state';
@@ -102,7 +101,7 @@ export class GModelRecordingCommand extends AbstractRecordingCommand<GModelRootS
         return this.serializer.createSchema(this.modelState.root);
     }
 
-    protected override postChange(newModel: SModelRootSchema): MaybePromise<void> {
+    protected override postChange(newModel: GModelElementSchema): MaybePromise<void> {
         const newRoot = this.serializer.createRoot(newModel);
         this.modelState.updateRoot(newRoot);
     }