Changes

• [diagram] Fix text selection issues in chrome #425
• [example] Fix render error for new categories #426
• [api] Introduce & use ProposalString utility type #427
• [i18n] Add missing localization message for marker popups #428
• [diagram] Add missing visibility check to RoundedCornerNodeView #430
• [layout] Fix a bug in the hGrab/vGrab calculation #435

Potentially breaking changes

• [protocol] Enrich LayoutOperation with additional optional client-side information (viewport) #433 #434
  • To trigger a manual layout the new TriggerLayoutAction should be dispatched instead of a direct LayoutOperation
  • Dispatching of direct LayoutOperations will still work, but the optional information will not be present
• [layout] Introduce order-agnostic layouts #436
  • Introduce a flag for ILayouts to specify whether the layouting of children is independent of their semantic order in the model.
    The BringToFrontCommand respects this flag and only changes the ordering of order-agnostic layouts
  • zorder module now requires bounds module as we need the layout registry
• [diagram] Introduce viewport change event for EditorContextService #438
  • This change extracts the handling of model related changes into an dedicated IModelChangeService which is reused by the EditorContextService
  • The following changes to internal API might affect customizations of adopters:
    • GLSPCommandStack: 'notifyListener' method has been removed
    • EditorContextService:
      • Remove _modelRoot and onModelRootChangedEmitter properties. Corresponding getters now forward to the IModelChangeService
      • Remove notifyModelRootChanged method (Probably no side effect for adopters. Method was only callable from commandstack anyways)
• [node] Update minimum requirements for Node to >=20 #439

Full Changelog: v2.4.0...v2.5.0

Changes

• [diagram] Remove !important rules from default CSS #412 #413 #414
• [diagram] Update default styling for label texts to avoid unintended user selection #415
• [diagram] Fix behavior of ContainerManager to allow proper usage of type hints on root/graph level #417
• [diagram] Prevent unintended rendering of not-supported sprotty reconnect handles #418
• [diagram] Allow listening to selection changes in the AutoCompleteWidget #420
• [api] Introduce a lightweight adaptable message system (i18n) #421

Potentially breaking changes

• [diagram] Refactor a11y feature module and extract move,zoom,shortcut and resize features #396
  • The move, zoom, shortcut and resize features have been moved to their own modules. They are now enabled by default
  • For now the a11y module remains in experimental state and api breakages might occur in the future

Full Changelog: v2.3.0...v2.4.0

Changes

• [protocol] Ensure that the @eclipse-glsp/protocol package has no default dependency to inversify #384#387
• [diagram] Ensure that GLSPMousePositionTracker correctly calculates the current position in diagram local coordinates #391
• [api] Align ActionDispatcher interface with GLSPActionDispatcher implementation. #394
  • Directly injecting the GLSPActionDispatcher is no longer necessary use TYPES.IActionDispatcher/ActionDispatcher instead
• [standlalone] Adapt copyPasteStandalone module to ensure that copy/cut/paste listeners are scoped to the active diagram and don't trigger globally #395
• [diagram] Introduce IMovementOptions for the ChangeBoundsTool to allow configuration of movement behavior #397 - Contributed on behalf of Axon Ivy AG
• [diagram] Fix a bug that prevented the ChangeBoundsTool from working correctly if the user moved outside of the diagram during an operation #399 - Contributed on behalf of AxonIvy AG
• [api] Improve default GLSPClient implementation to be more robust when certain methods are invoked multiple times #402
• [diagram] Fix a bug in the uri handling of the NavigationTargetResolver #403
• [di] Use inversify ^6.1.3 as new baseline and update to sprotty 1.4.0 #407#408

Potentially breaking changes

• [di] Align Interface usage across *Manager classes #388
  • Change DI bindings for: GridManger to TYPES.IGridManager, ChangeBoundsManager to TYPES.IChangeBoundsManager and DebugManager to TYPES.IDebugManager.
• [api] Improved performance of diagram loading routine #398 - Contributed on behalf of Axon Ivy AG
  • Fix behavior of postRequestModel hook to actually work as descried in the documentation.
    Dispatching of long running actions in this hook can delay the initial model loading.
  • Directly calling model-aware functions in the preInitialize hook is discouraged.
    If needed dispatch an action instead.
    This ensures that the code will only be called once the model is available.

Changes

• [diagram] Fix a bug that prevented proper rendering of templates/ghost elements during node creation in Firefox #324 - Contributed on behalf of Axon Ivy AG
• [routing] Improve anchor point calculation for edge routing #325
• [validation] Fix a bug that could cause duplicate validation markers after a model update #329
• [di] Introduce a reusable LazyInjector that can be used for deferred retrial of services from the container. #330
  • Introduce preLoadDiagram hook for IDiagramStartups. This hook is invoked right before the DiagramLoader starts the model loading process
• [launch] Introduce GLSPWebWorkerProvider to simply setting up a worker connection to a in-browser GLSP-server #322
• [diagram] Improve base abstract UIExtension to allow more fine-grained definition of container and parent #333 - Contributed on behalf of Axon Ivy AG
• [protocol] Improve Geometry API. Add utility functions to Bound,Dimension and Point. Introduce Vector and Movement types #341 - Contributed on behalf of Axon Ivy AG
• [features] Introduce optional gridModule for managing and rendering grids and debugModule that allows do display additional graphical debug information during development #343 #359
• [diagram] Improve error handling of startup hooks #346
• [feature] Improve style handling in svg exporter #354
• [di] Improve ContainerConfiguration API and add additional checks to ensure that all ids of FeatureModules are unique #355
• [diagram] Update to sprotty 1.2.0. Non-breaking as all potential API breaks have been mitigated via the glsp-sprotty rexport layer #357
• [diagram] Fix a bug with the AutocompleteWidget that prevented proper application of valid suggestions #362
• [api] Improved behavior of default ToolManager to avoid unnecessary deactivation and reactivation of default tools #367
• [diagram] Add onFocusChanged event to FocusTracker and EditorContextService #380

Potentially breaking changes

• [API] Centralize most marquee selection behavior in the MarqueeUtil class which is now a singleton, injectable and needs the DOMHelper. This will cause a break if you manually created the class without injecting it. To construct it manually, you need to provide the DomHelper as a second argument #373.
• [protocol] Avoid indirect dependency to chai introduce by accidentally exporting testing modules #321
  • @eclipse-glsp/protocol no longer exports test-util.ts via main index. If needed the module can still be imported via the full path @eclipse-glsp/protocol/lib/utils/test-util.ts
• [API] Apply feedback commands already on SetModelCommand and unify rank and priority property #323.
  • Method FeedbackAwareUpdateModelCommand.getFeedbackCommands moved to IFeedbackEmitter for re-use, resulting in two new methods: getFeedbackCommands and applyFeedbackCommands.
  • Method FeedbackAwareUpdateModelCommand.getPriority is replaced by a generic rank property and the Ranked namespace.
  • The priority property (higher priority equals earlier execution) in FeedbackCommand is superseeded by a rank property (lower rank equals earlier execution).
• [DI] Introduce deferred injection for multi-injected services (listeners, action handlers etc.). Highly reduces the likelihood of circular dependency issues during container creation #330.
  No API breaks in the core API, but it introduces some minor breaks in protected methods/fields of default implementations:
  • GLSPCommandStack
    • Handling of IGModelRootListeners has moved to the EditorContextService.
    • onModelRootChanged is no deprecated. Use EditorContextService.onModelRootChanged instead
  • EditorContextService: The postRequestModel method has been removed. It was previously unused and effectively a no-op.
  • SelectionService: Injected commandStack property has been removed.
• [diagram] Introduce a reusable FeedbackEmitter base implementation that is stable across model updates and allows composing feedback before dispatching it #342
  Refactored tool implementations and related services to make use of the new FeedbackEmitter API. This can cause potential breaks for adopters that have customized the default tool implementations.
  Affected tools and services: MouseTrackingElementPositionListener, HelperLineManager, FeedbackMoveMouseListener, NodeCreationToolMouseListener, EdgeEditListener,
• [diagram] Refactor and improve ChangeBounds API by introducing a centralized ChangeBoundsManage and ChangeBoundsTracker #344 #348 #352 - Contributed on behalf of Axon Ivy AG
  This can cause potential breaks for adopters that have customized the default tool implementations
  Affected tools and services: MouseTrackingElementPositionListener, FeedbackMoveMouseListener, ChangeBoundsTool, ChangeBoundsListener,FeedbackEdgeRouteMovingMouseListener, NodeCreationTool,

Full Changelog: v2.1.0...v2.2.1

Changes:

• Align sprotty-protocol version to 1.0.0

Full Changelog: v2.1.0...v2.1.1

Changes

• [diagram] Fix a bug that prevented correct rendering of projection bars when using GLSPProjectionView #298
• [a11y] Improved responsibility and feedback when resizing or moving diagram elements with keyboard-only commands #295
• [diagram] Extends configureDiagramOptions function to also allow partial configuration of ViewerOptions #296
• [diagram] Remove unused handleSetContextActions from ToolPalette #301
• [diagram] Deprecate ISModelRootListener API in favor of IGModelRootListener #303
• [diagram] Ensure that the suggestion container position of the AutoCompleteWidget is rendered correctly #304
• [feature] Extend ToolPalette/CreateOperation API to support rendering of preview/ghost elements when creating new nodes #301
• [protocol] Fix a bug in BaseJsonRpcClient to ensure that it can handle multiple open diagram sessions #307
• [diagram] Restructure some tools to have a more common infrastructure and support helper lines #306
• [diagram] Fix a bug in SelectionService that caused issues with inversify when injecting certain services (e.g. ActionDispatcher) in SelectionChangeListener implementations #305
• [diagram] Ensure that the SelectionService does not trigger a change event if the selection did not change on model update #313

Full Changelog: v1.0.0...v2.1.0

Changes

• [layout] Improve Layouter to support more dynamic layouts and complex parent/children node structures #187 - Contributed on behalf of STMicroelectronics
• [diagram] Fix SVG export for nested root elements e.g. GLSPProjectionView #196
• [diagram] Scope the styles to not break existing application layout #209
• [routing] Ensure that routes are properly re-calculated when moving a routing point #198
• [diagram] Fix a bug in the EditLabelUIExtension where the diagram becomes dirty without an actual change. #766
• [diagram] Extend ComputedBoundsAction definition with routing information. This enables proper forwarding of client-side computed routes to the server #201
• [DI] The createClientContainer function is now deprecated. Please use initializeDiagramContainer instead. This new function can also be used with ModuleConfigurations which allow a more fine granular configuration by adding new modules and/or removing default modules. #218 #231 #236
• [diagram] Fix incorrect calculation of decorator popup positions for edges. #221
• [protocol] Introduce a reusable Disposable type #222
• [protocol] Introduce reusable utility functions for DI configuration #236#237
• [diagram] Augment diagram SVG with additional model metadata to enable easier integration tests and accessibility #239
• [validation] Add and track reason for validation markers (e.g. batch and live validation) #243
• [protocol] Introduce optional deselectAll flag for SelectActions #257
• [protocol] Provide the common interfaces and type definitions for TS-based GLSP servers #245 - Contributed on behalf of STMicroelectronics
• [diagram] Introduce a new set of accessability features for disability-aware conceptual modeling and keyboard-only diagram interactions. (experimental) #240 #241 #242 #254 #276 #279
• [API] Re-work tool and feedback structure #264 #274
  • Introduce registerListener method on GLSP mouse and key tool to return a disposable for de-registration
  • Adapt registerFeedback method from feedback dispatcher to return a disposable for de-registration
  • Introduce dedicated BaseGLSPCreationTool for tools based on trigger actions
  • Introduce toDisposeOnDisable collection in BaseGLSPTool to register disable handling during enablement
• [DI] Introduce and consistently use FeatureModules instead of plain inversify ContainerModules #267
• [diagram] Introduce statusModule that binds UI extension to handle & render GLSPStatusMessages. #272
• [diagram] Provide generic dirty state handling in EditorContextService #272
• [diagram] Fix bug that broke edge edit (routing) in certain cases #273
• [API] Introduce DiagramLoader component + life cycle management #274 #282
  • Integration projects no longer need to manually implement the initial diagram loading. Instead a set of configurationsIDiagramOptions and then the diagram loader
    is invoked and initializes the diagram.
  • Add a onServerInitialized event to the GLSPClientAPI.
  • Introduce IDiagramStartup service. Adopters can multi bind this service to hook into the diagram loading lifecycle and provide additional logic. i.e. dispatching of initial actions.
• [diagram] Fix a bug that broke edge intersection detection when using the GLSPProjectionView #275
• [diagram] Fix a bug regarding focus handling when integrated in an application frame like Theia #278

Breaking Changes

• [DI] Injecting an IButtonHandler constructor is now deprecated. Please use configureButtonHandler() instead. #195 - Contributed on behalf of STMicroelectronics
• [node] Update minimum requirements for Node to >=16.11.0 #210
• [protocol] Renamed UndoOperation and RedoOperation to UndoAction and RedoAction to match operation specification #216
• [protocol] Remove dependency to vscode-ws-jsonrpc. The protocol package now directly offers functions to create a websocket rpc connections #215
• [protocol] The elementIds property of LayoutOperation is now optional. If undefined the entire model will be layouted #232
• [API] Refactored base API #259
  • Removed the TYPES.SelectionService service identifier. Please directly use the SelectionService class as service identifier instead
  • The SelectionService binding is now part of the defaultGLSPModule. This means the SelectionService remains available even if the selectModule is not configured
  • RootModelChangeListeners are no longer tied to the FeedbackawareUpdateModelCommand instead they are managed by the GLSPCommandStack
  • IMouseTool and TYPES.IMouseTool are no longer available. Directly inject and use MouseTool instead
  • Refactored rank utility functions
    • isRanked() -> Ranked.is()
    • getRank() -> Ranked.getRank()
    • DEFAULT_RANK -> Ranked.DEFAULT_RANK
• [API] Introduce Event API to replace the old listener/notifier pattern #261
  • Reworked SelectionService, GlspCommandStack & EditorContextService to make use of this new API
  • Removed explicit (de)registration methods for listeners. Use the corresponding event property (e.g. SelectionService.onSelectionChanged) instead
  • Aligned naming of injectable interfaces & service identifiers to consistently use the I prefix
• [API] Re-work tool and feedback structure #264
  • Remove generic toolsModule and toolFeedbackModule in favor of individual tool modules
  • Rename dispatchFeedback in BaseGLSPTool to registerFeedback to align with feedback dispatcher
  • Switch arguments in deregisterFeedback in BaseGLSPTool for easier de-registration and clean up actions
• [protocol] Add messages for server-side progress reporting and remove timeout in ServerMessageAction #265
• [DI] Renamed and aligned prefixes of DI modules. #266
  • Removed glsp prefix from all modules (e.g. glspSelectModule-> selectModule)
  • In addition, the following modules have been renamed
    • defaultGLSPModule-> baseModule
    • modelHintsModule -> typeHintsModule
    • enableDefaultToolsOnFocusLossModule -> toolFocusLossModule
    • glspEditLabelModule -> labelEditModule
• [websocket] Introduce a reusable GLSPWebSocketProvider class that supports reconnect on connection loss #269
• [API] Introduce GLSPModelSource as default implementation for sprotty's ModelSourceAPI #272 #287
  • GLSPDiagramServer has been deprecated and is no longer available
  • SelectionServiceAwareContextMenuMouseListener renamed to GLSPContextMenuMouseListener
  • SourceURIAware interface has been removed. No longe required since we only have one GLSPModelSource binding now.
• [protocol] Revise TypeHints API and introduce possibility to dynamically query the server for complex connection conditions #285
  • EdgeTypeHint
    • sourceElementTypeIds and targetElementTypeIds are now optional. If not provided all connection targets are allowed
    • Introduce dynamic flag. If a hint has this flag enabled connection tools know that the have to query there server in addition
      to checking the default ...

What's Changed

• Add keyboard support for searching elements by @aylin-sarioglu in #242
• Update workflow example README by @ndoschek in #251
• Add keyboard support for resizing elements by @aylin-sarioglu in #240
• GLSP-1026 Use new bundled workflow-server package by @tortmayr in #252
• Add documentation for accessibility features by @aylin-sarioglu in #254
• GLSP-1022: Update dependencies by @tortmayr in #253

Full Changelog: v1.1.0-RC09...v1.1.0-RC10

What's Changed

• GLSP-975: Implement NodeGlspClient by @tortmayr in #247
• GLSP-813 Use Node example server instead of java variant by @tortmayr in #248
• GLSP-975: Rename NodeGLSPClient by @tortmayr in #249
• Adjust WebSocketWrapper by @tortmayr in #250

Full Changelog: v1.1.0-RC08...v1.1.0-RC09

What's Changed

• Add a reason for requesting and setting markers by @planger in #243
• Add missing reason to SetMarkersAction by @planger in #244
• Add SVGMetadata API by @haydar-metin in #239
• Fix wrong import by @tortmayr in #246

New Contributors

• @haydar-metin made their first contribution in #239

Full Changelog: v1.1.0-RC07...v1.1.0-RC08