@eclipse-glsp-examples/workflow-server-bundled

Eclipse GLSP - Workflow Example Server (bundled)

Provides a bundled version of the Workflow example server for node. This example server is used as dev example in GLSP projects. Note that this package provides the bundled file. If you are looking for the unbundled source code with type definitons check out @eclipse-glsp-examples/workflow-server.

Workflow Diagram Example

The workflow diagram is a consistent example provided by all GLSP components. The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below). The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone). As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor. See our project website for an overview of the workflow example and all components implementing it.

https://user-images.githubusercontent.com/588090/154459938-849ca684-11b3-472c-8a59-98ea6cb0b4c1.mp4

More information

For more information, please visit the Eclipse GLSP Umbrella repository and the Eclipse GLSP Website. If you have questions, please raise them in the discussions and have a look at our communication and support options.

Changelog

v2.0.0 - 14/10/2023

Changes

• [elk] Fix a bug in the GLSElkLayoutEngine that skipped layouting of certain edges #23 - Contributed on behalf of STMicroelectronics
• [launch] The message sent after successful startup now also contains the effective socket port #30 - Contributed on behalf of STMicroelectronics
• [launch] Fix a bug that caused the server to not properly dispose all resources when shutdown was called #33 - Contributed on behalf of STMicroelectronics
• [diagram] Fix a bug to ensure that the copy&paste feature is working properly #35
• [api] Ensure that all Promises and MaybePromises have proper rejection handling #36- Contributed on behalf of STMicroelectronics
• [launch] Add a launcher component for starting WebSocket based GLSP servers #41
• [validation] Add explicit support and API for live and batch validation #43
• [launch] Launcher components now auto allocate a free port if the port argument is 0 #42
• [server] Add support for server progress reporting #52
• [diagram] Add support for handling reconnection requests to RequestModelActionHandler #54
• [server] Update AbstractJsonModelStorage to ensure that Windows file paths are properly converted #55
• [deps] Remove unneeded dependency to fs-extra #56
• [diagram] Provide generic reusable base operation handlers for JSON-based source models #59
• [diagram] Add support for dynamic edge type hints
  • Provide EdgeCreationChecker API. Adopters can implement this to handle dynamic edge creation validation requests. #60
• [model] Introduce new GForeignObjectElement + builder class #61

Breaking Changes

• [graph] Align GGraph model with newest changes from glsp-server #22 - Contributed on behalf of STMicroelectronics
  • Renamed interfaces:
    • EdgePlacement -> GEdgePlacement (affected classes: GEdgeLayoutable, GLabel)
    • GLayoutContainer -> GLayouting (affected classes: GCompartment, GGraph, GNode)
    • GShapePreRenderedElement -> GShapedPreRenderedElement
• [deps] Update minimum requirements for Node to >=16.11.0 #32
• [api] Restructure @eclipse-glsp/server-node package to provide entry points for both node and browser-only environments #37
  • The package has been renamed to @eclipse-glsp/server. This change affects all import namespaces.
  • New namespaces for environment specific code:
    • @eclipse-glsp/server/node
    • @eclipse-glsp/server/browser
• [operation] Implement Command API and rework OperationHandler to provide an optional command instead of direct execution to allow more execution control (including undo & redo support) #38 #59
  • This includes major breaking changes across the whole API:
    • OperationHandler has been refactored from an interface to a common abstract base class. The execute method now has to return a MaybePromise<Command|undefined>
    • Refactor CreateOperationHandler to an interface instead of a class
    • Rename the services and handlers of the direct GModel library => consistent use of GModel prefix
    • The ModelState interface no longer has an isDirty flag. Dirty state is now handled by the CommandStack
• [server] Default port has changed from 5007 (and 8081 for websocket) to 0, which implies autoassignment by the OS #42
• [server] Refactored GLSPServer and GLSPServerLauncher API #44 - Contributed on behalf of STMicroelectronics
  • Server type definitions are now consumed from @eclipse-glsp/protocol
  • GLSPServer implementation is no longer relies on json-rpc implementation details.
  • JSON-RPC setup is now done with JsonRpcGLSPServerLauncher
• [api] Provide CommandStack API to support undo/redo of model changes #38 #39 - Contributed on behalf of STMicroelectronics
  • ModelState no longer has a isDirty property
  • Breaking refactor of OperationHandler API
• [deps] Update to inversify 6.x and Typescript 5.x. #48
  • GLSP uses a synchronous inversify context this means with inversify 6.x decorator methods (e.g. @postConstruct) with asynchronous results are no longer supported
• [api] Revise model loading and client action handling #57 #58
  • Refactor ModelSubmissionHandler to enable handling of RequestModelAction as proper request action
    • Introduce a submitInitialModel method that is called by the RequestModelActionHandler
  • Remove configureClientActions from DiagramModule as client actions are now implicitly configured via InitializeClientSession request
  • Remove ClientActionHandler and replace with ClientActionForwarder
  • Rename ServerStatusAction -> StatusAction and ServerMessageAction -> MessageAction