GLSP-1022: Update to TS5 and inversify 6 (#48)

- Update to typescript 5
- Update to inversify 6. Inversify is now a peerDependency (^6.0.0). A matching version has to be provided by consuming projects.
- Adapt codebase to new inversify API
- Rework elk-layouit package to remove unnecessary dependency in `sprotty-elk`
Part of eclipse-glsp/glsp#1023
(uses locally published glsp packages. needs to be adapted once the offical packages are available)

Requires eclipse-glsp/glsp-client#253

Author: tortmayr

.eslintrc.js

@@ -9,13 +9,13 @@ module.exports = {
         project: 'tsconfig.eslint.json'
     },
     rules: {
-        'no-shadow': 'off',
+        '@typescript-eslint/no-shadow': 'off',
         'no-restricted-imports': [
             'warn',
             {
                 name: 'sprotty-protocol',
                 message:
-                    "The sprotty-protocol default exports are customized and reexported by GLSP. Please import from '@eclipse-glsp/client' instead"
+                    "The sprotty-protocol default exports are customized and reexported by GLSP. Please import from '@eclipse-glsp/protocol' instead"
             }
         ]
     }

examples/workflow-server/package.json

@@ -57,7 +57,8 @@
   },
   "dependencies": {
     "@eclipse-glsp/layout-elk": "1.1.0-next",
-    "@eclipse-glsp/server": "1.1.0-next"
+    "@eclipse-glsp/server": "1.1.0-next",
+    "inversify": "^6.0.1"
   },
   "devDependencies": {
     "source-map-loader": "^4.0.1",

examples/workflow-server/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@eclipse-glsp/ts-config/tsconfig.json",
+  "extends": "@eclipse-glsp/ts-config/",
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",

package.json

@@ -12,7 +12,6 @@
     "check:headers": "glsp checkHeaders . -t lastCommit",
     "check:pr": "yarn all && yarn check:headers",
     "clean": "lerna run clean && rimraf coverage .nyc_output",
-    "download:exampleServer": "ts-node examples/workflow-glsp/scripts/download.ts",
     "lint": "lerna run lint",
     "lint:ci": "lerna run lint:ci",
     "prepare": "lerna run prepare",
@@ -29,8 +28,10 @@
     "watch": "lerna run --parallel watch"
   },
   "devDependencies": {
-    "@eclipse-glsp/dev": "1.1.0-next.7026c40.129",
-    "@types/node": "16.x"
+    "@eclipse-glsp/dev": "next",
+    "@types/node": "16.x",
+    "lerna": "^6.6.2",
+    "typescript": "^5.0.4"
   },
   "engines": {
     "node": ">=16.11.0",

packages/graph/tsconfig.json

@@ -1,12 +1,12 @@
 {
-  "extends": "@eclipse-glsp/ts-config/tsconfig.json",
+  "extends": "@eclipse-glsp/ts-config/mocha",
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",
     "reactNamespace": "JSX",
     "baseUrl": "src",
-    "types": ["node", "mocha", "reflect-metadata"]
   },
-  "exclude": ["**/*.spec.ts"],
-  "include": ["src"]
-}
+  "include": [
+    "src"
+  ]
+}

packages/layout-elk/package.json

@@ -51,8 +51,10 @@
   },
   "dependencies": {
     "@eclipse-glsp/server": "1.1.0-next",
-    "elkjs": "^0.7.1",
-    "sprotty-elk": "0.12.0"
+    "elkjs": "^0.7.1"
+  },
+  "peerDependencies": {
+    "inversify": "^6.0.0"
   },
   "publishConfig": {
     "access": "public"

packages/layout-elk/src/di.config.ts

@@ -16,9 +16,8 @@
 import { LayoutEngine, ModelState } from '@eclipse-glsp/server';
 import ElkConstructor, { LayoutOptions } from 'elkjs/lib/elk.bundled';
 import { ContainerModule } from 'inversify';
-import { ElkFactory } from 'sprotty-elk';
 import { DefaultElementFilter, ElementFilter } from './element-filter';
-import { GlspElkLayoutEngine } from './glsp-elk-layout-engine';
+import { ElkFactory, GlspElkLayoutEngine } from './glsp-elk-layout-engine';
 import { FallbackLayoutConfigurator, LayoutConfigurator } from './layout-configurator';
 
 type Constructor<T> = new (...args: any[]) => T;

packages/layout-elk/src/glsp-elk-layout-engine.ts

@@ -32,10 +32,18 @@ import {
 } from '@eclipse-glsp/server';
 import { ELK, ElkEdge, ElkExtendedEdge, ElkGraphElement, ElkLabel, ElkNode, ElkPort, ElkPrimitiveEdge, ElkShape } from 'elkjs/lib/elk-api';
 import { injectable } from 'inversify';
-import { ElkFactory } from 'sprotty-elk';
 import { ElementFilter } from './element-filter';
 import { LayoutConfigurator } from './layout-configurator';
 
+/**
+ * Factory for ELK instances. Follow the elkjs package documentation on how to configure ELK
+ * instances. For example, the bundled version can be used by importing the ELK constructor
+ * from `"elkjs/lib/elk.bundled"`. For the webworker version, import the constructor from
+ * `"elkjs/lib/elk-api"` and add the option `workerUrl: "elk/elk-worker.min.js"`.
+ */
+export type ElkFactory = () => ELK;
+export const ElkFactory = Symbol('ElkFactory');
+
 /**
  * An implementation of GLSP's {@link LayoutEngine} interface that retrieves the graphical model from the {@link ModelState},
  * transforms this model into an ELK graph and then invokes the underlying ELK instance for layout computation.

packages/layout-elk/src/index.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022 STMicroelectronics and others.
+ * 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
@@ -13,8 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+export { LayoutOptions } from 'elkjs';
 export * from './di.config';
 export * from './element-filter';
 export * from './glsp-elk-layout-engine';
 export * from './layout-configurator';
-export * from './sprotty-elk';

packages/layout-elk/src/layout-configurator.ts

@@ -14,9 +14,8 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { GEdge, GGraph, GLabel, GModelElement, GNode, GPort, ModelState } from '@eclipse-glsp/server';
+import { LayoutOptions } from 'elkjs';
 import { inject, injectable } from 'inversify';
-import { LayoutOptions } from './sprotty-elk';
-
 export const LayoutConfigurator = Symbol('LayoutConfigurator');
 /**
  * Configurator for ELK layout algorithms; provides mappings of layout options for each model element.