@eclipse-glsp/layout-elk 2.6.0 → 2.7.0-next.11

package/lib/di.config.d.ts

@@ -1,10 +1,27 @@
+/********************************************************************************
+ * Copyright (c) 2022-2026 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 { BindingTarget, GLSPModule } from '@eclipse-glsp/server';
 import { LayoutOptions } from 'elkjs/lib/elk.bundled';
-import { ContainerModule } from 'inversify';
+import { ContainerModule, interfaces } from 'inversify';
 import { ElementFilter } from './element-filter';
+import { ElkFactory, GlspElkLayoutEngine } from './glsp-elk-layout-engine';
 import { LayoutConfigurator } from './layout-configurator';
 type Constructor<T> = new (...args: any[]) => T;
 /**
- * Configuration options for the {@link configureELKLayoutModule} function.
+ * Configuration options for the {@link ElkLayoutModule} (and the legacy {@link configureELKLayoutModule} factory).
  */
 export interface ElkModuleOptions {
     /**
@@ -33,20 +50,33 @@ export interface ElkModuleOptions {
     isWebWorker?: boolean;
 }
 /**
- * Utility method to create a DI module that provides all necessary bindings to use the {@link GlspElkLayoutEngine} in a node GLSP server
- * implementation. A set of configuration options is provided to enable easy customization. In most cases at least
- * the custom {@link layoutConfigurator} binding should be provided (in addition to the required `algorithms' property) via these options.
+ * DI module that provides the bindings needed to use the {@link GlspElkLayoutEngine} in a node GLSP server.
  *
- * The constructed module is not intended for standalone use cases and only works in combination with a GLSPDiagramModule.
+ * Subclass and override the `bindXxx()` hooks to customize individual bindings — e.g. to swap the
+ * layout configurator or element filter without re-implementing the whole module. The module is
+ * only meaningful in combination with a `GLSPDiagramModule`.
  *
- * * The following bindings are provided:
- * - {@link ILayoutConfigurator}
- * - {@link IElementFilter}
- * - {@link LayoutEngine}
+ * Bindings provided:
+ * - {@link ElementFilter}
+ * - {@link LayoutConfigurator}
  * - {@link ElkFactory}
- *
- * @param options The configuration options
- * @returns A DI module that can be loaded as additional module when configuring a diagram module for a GLSP server.
+ * - {@link GlspElkLayoutEngine} + {@link LayoutEngine} (toService)
+ * - Fallback bindings for {@link Logger} and {@link LoggerFactory} if absent.
+ */
+export declare class ElkLayoutModule extends GLSPModule {
+    protected readonly options: ElkModuleOptions;
+    constructor(options: ElkModuleOptions);
+    protected configure(bind: interfaces.Bind, unbind: interfaces.Unbind, isBound: interfaces.IsBound, rebind: interfaces.Rebind): void;
+    protected bindElementFilter(): BindingTarget<ElementFilter>;
+    protected bindLayoutConfigurator(): BindingTarget<LayoutConfigurator>;
+    protected bindElkFactory(): BindingTarget<ElkFactory>;
+    protected bindGlspElkLayoutEngine(): BindingTarget<GlspElkLayoutEngine>;
+    /** Provide fallbacks so the module works standalone in tests/specs that don't preconfigure logging. */
+    protected bindLoggerFallbacks(bind: interfaces.Bind, isBound: interfaces.IsBound): void;
+}
+/**
+ * Utility wrapper around {@link ElkLayoutModule} for the common case where no override is needed.
+ * Prefer subclassing {@link ElkLayoutModule} when individual bindings need to be customized.
  */
 export declare function configureELKLayoutModule(options: ElkModuleOptions): ContainerModule;
 export {};

package/lib/di.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"di.config.d.ts","sourceRoot":"","sources":["../src/di.config.ts"],"names":[],"mappings":"AAgBA,OAAuB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAwB,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,EAA8B,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEvF,KAAK,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,aAAa,CAAC;IACrC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACrD;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3C;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAoDnF"}
+{"version":3,"file":"di.config.d.ts","sourceRoot":"","sources":["../src/di.config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAClF,OAAO,EACH,aAAa,EACb,UAAU,EAOb,MAAM,sBAAsB,CAAC;AAC9B,OAAuB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,eAAe,EAAc,UAAU,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAwB,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAA8B,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEvF,KAAK,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,aAAa,CAAC;IACrC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACrD;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC3C;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;;;;;GAaG;AACH,qBACa,eAAgB,SAAQ,UAAU;IAC/B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,gBAAgB;gBAAzB,OAAO,EAAE,gBAAgB;IAIxD,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI;IAUnI,SAAS,CAAC,iBAAiB,IAAI,aAAa,CAAC,aAAa,CAAC;IAI3D,SAAS,CAAC,sBAAsB,IAAI,aAAa,CAAC,kBAAkB,CAAC;IAOrE,SAAS,CAAC,cAAc,IAAI,aAAa,CAAC,UAAU,CAAC;IAarD,SAAS,CAAC,uBAAuB,IAAI,aAAa,CAAC,mBAAmB,CAAC;IAYvE,uGAAuG;IACvG,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI;CAY1F;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAEnF"}

package/lib/di.config.js

@@ -1,8 +1,18 @@
 "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.ElkLayoutModule = void 0;
 exports.configureELKLayoutModule = configureELKLayoutModule;
 /********************************************************************************
- * Copyright (c) 2022-2025 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 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
@@ -23,57 +33,67 @@ const element_filter_1 = require("./element-filter");
 const glsp_elk_layout_engine_1 = require("./glsp-elk-layout-engine");
 const layout_configurator_1 = require("./layout-configurator");
 /**
- * Utility method to create a DI module that provides all necessary bindings to use the {@link GlspElkLayoutEngine} in a node GLSP server
- * implementation. A set of configuration options is provided to enable easy customization. In most cases at least
- * the custom {@link layoutConfigurator} binding should be provided (in addition to the required `algorithms' property) via these options.
+ * DI module that provides the bindings needed to use the {@link GlspElkLayoutEngine} in a node GLSP server.
  *
- * The constructed module is not intended for standalone use cases and only works in combination with a GLSPDiagramModule.
+ * Subclass and override the `bindXxx()` hooks to customize individual bindings — e.g. to swap the
+ * layout configurator or element filter without re-implementing the whole module. The module is
+ * only meaningful in combination with a `GLSPDiagramModule`.
  *
- * * The following bindings are provided:
- * - {@link ILayoutConfigurator}
- * - {@link IElementFilter}
- * - {@link LayoutEngine}
+ * Bindings provided:
+ * - {@link ElementFilter}
+ * - {@link LayoutConfigurator}
  * - {@link ElkFactory}
- *
- * @param options The configuration options
- * @returns A DI module that can be loaded as additional module when configuring a diagram module for a GLSP server.
+ * - {@link GlspElkLayoutEngine} + {@link LayoutEngine} (toService)
+ * - Fallback bindings for {@link Logger} and {@link LoggerFactory} if absent.
  */
-function configureELKLayoutModule(options) {
-    return new inversify_1.ContainerModule((bind, unbind, isBound, rebind) => {
-        if (options.elementFilter) {
-            bind(element_filter_1.ElementFilter).to(options.elementFilter).inSingletonScope();
-        }
-        else {
-            bind(element_filter_1.ElementFilter).to(element_filter_1.DefaultElementFilter).inSingletonScope();
-        }
-        if (options.layoutConfigurator) {
-            bind(layout_configurator_1.LayoutConfigurator).to(options.layoutConfigurator);
-        }
-        else {
-            bind(layout_configurator_1.LayoutConfigurator)
-                .toDynamicValue(context => new layout_configurator_1.FallbackLayoutConfigurator(options.algorithms, options.defaultLayoutOptions))
-                .inSingletonScope();
+let ElkLayoutModule = class ElkLayoutModule extends server_1.GLSPModule {
+    constructor(options) {
+        super();
+        this.options = options;
+    }
+    configure(bind, unbind, isBound, rebind) {
+        const context = { bind, unbind, isBound, rebind };
+        (0, server_1.applyBindingTarget)(context, element_filter_1.ElementFilter, this.bindElementFilter()).inSingletonScope();
+        (0, server_1.applyBindingTarget)(context, layout_configurator_1.LayoutConfigurator, this.bindLayoutConfigurator()).inSingletonScope();
+        (0, server_1.applyBindingTarget)(context, glsp_elk_layout_engine_1.ElkFactory, this.bindElkFactory());
+        (0, server_1.applyBindingTarget)(context, glsp_elk_layout_engine_1.GlspElkLayoutEngine, this.bindGlspElkLayoutEngine()).inSingletonScope();
+        bind(server_1.LayoutEngine).toService(glsp_elk_layout_engine_1.GlspElkLayoutEngine);
+        this.bindLoggerFallbacks(bind, isBound);
+    }
+    bindElementFilter() {
+        var _a;
+        return (_a = this.options.elementFilter) !== null && _a !== void 0 ? _a : element_filter_1.DefaultElementFilter;
+    }
+    bindLayoutConfigurator() {
+        if (this.options.layoutConfigurator) {
+            return this.options.layoutConfigurator;
         }
-        const elkFactory = () => new elk_bundled_1.default({
-            algorithms: options.algorithms,
-            defaultLayoutOptions: options.defaultLayoutOptions,
-            // The node implementation relied on elkjs' `FakeWorker` to set the `workerFactory`.
-            // However, since the required file is dynamically loaded and not available in a web-worker context,
-            // it needs to be mocked manually.
-            workerFactory: options.isWebWorker ? () => ({ postMessage: () => { } }) : undefined
+        return { dynamicValue: () => new layout_configurator_1.FallbackLayoutConfigurator(this.options.algorithms, this.options.defaultLayoutOptions) };
+    }
+    bindElkFactory() {
+        const { algorithms, defaultLayoutOptions, isWebWorker } = this.options;
+        const factory = () => new elk_bundled_1.default({
+            algorithms,
+            defaultLayoutOptions,
+            // The node implementation relies on elkjs' `FakeWorker` to set the `workerFactory`. The required file is
+            // dynamically loaded and not available in a web-worker context, so it has to be mocked manually there.
+            workerFactory: isWebWorker ? () => ({ postMessage: () => { } }) : undefined
         });
-        bind(glsp_elk_layout_engine_1.ElkFactory).toConstantValue(elkFactory);
-        bind(glsp_elk_layout_engine_1.GlspElkLayoutEngine)
-            .toDynamicValue(context => {
-            const container = context.container;
-            const factory = container.get(glsp_elk_layout_engine_1.ElkFactory);
-            const filter = container.get(element_filter_1.ElementFilter);
-            const configurator = container.get(layout_configurator_1.LayoutConfigurator);
-            const modelState = container.get(server_1.ModelState);
-            return new glsp_elk_layout_engine_1.GlspElkLayoutEngine(factory, filter, configurator, modelState);
-        })
-            .inSingletonScope();
-        bind(server_1.LayoutEngine).toService(glsp_elk_layout_engine_1.GlspElkLayoutEngine);
+        return { constantValue: factory };
+    }
+    bindGlspElkLayoutEngine() {
+        return {
+            dynamicValue: ctx => {
+                const factory = ctx.container.get(glsp_elk_layout_engine_1.ElkFactory);
+                const filter = ctx.container.get(element_filter_1.ElementFilter);
+                const configurator = ctx.container.get(layout_configurator_1.LayoutConfigurator);
+                const modelState = ctx.container.get(server_1.ModelState);
+                return new glsp_elk_layout_engine_1.GlspElkLayoutEngine(factory, filter, configurator, modelState);
+            }
+        };
+    }
+    /** Provide fallbacks so the module works standalone in tests/specs that don't preconfigure logging. */
+    bindLoggerFallbacks(bind, isBound) {
         if (!isBound(server_1.Logger)) {
             bind(server_1.Logger).to(server_1.NullLogger).inSingletonScope();
         }
@@ -84,6 +104,18 @@ function configureELKLayoutModule(options) {
                 return logger;
             });
         }
-    });
+    }
+};
+exports.ElkLayoutModule = ElkLayoutModule;
+exports.ElkLayoutModule = ElkLayoutModule = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [Object])
+], ElkLayoutModule);
+/**
+ * Utility wrapper around {@link ElkLayoutModule} for the common case where no override is needed.
+ * Prefer subclassing {@link ElkLayoutModule} when individual bindings need to be customized.
+ */
+function configureELKLayoutModule(options) {
+    return new ElkLayoutModule(options);
 }
 //# sourceMappingURL=di.config.js.map

package/lib/di.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"di.config.js","sourceRoot":"","sources":["../src/di.config.ts"],"names":[],"mappings":";;AAsEA,4DAoDC;AA1HD;;;;;;;;;;;;;;kFAckF;AAClF,iDAAmG;AACnG,uDAAsE;AACtE,yCAA4C;AAC5C,qDAAuE;AACvE,qEAA2E;AAC3E,+DAAuF;AAkCvF;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,wBAAwB,CAAC,OAAyB;IAC9D,OAAO,IAAI,2BAAe,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QACzD,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,8BAAa,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrE,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,8BAAa,CAAC,CAAC,EAAE,CAAC,qCAAoB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACpE,CAAC;QAED,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,wCAAkB,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,wCAAkB,CAAC;iBACnB,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,gDAA0B,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;iBAC3G,gBAAgB,EAAE,CAAC;QAC5B,CAAC;QAED,MAAM,UAAU,GAAe,GAAG,EAAE,CAChC,IAAI,qBAAc,CAAC;YACf,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;YAClD,oFAAoF;YACpF,oGAAoG;YACpG,kCAAkC;YAClC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAsB,CAAC,CAAC,CAAC,SAAS;SAC1G,CAAC,CAAC;QAEP,IAAI,CAAC,mCAAU,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,4CAAmB,CAAC;aACpB,cAAc,CAAC,OAAO,CAAC,EAAE;YACtB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YACpC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAa,mCAAU,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAgB,8BAAa,CAAC,CAAC;YAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAqB,wCAAkB,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAa,mBAAU,CAAC,CAAC;YACzD,OAAO,IAAI,4CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QAC9E,CAAC,CAAC;aACD,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,qBAAY,CAAC,CAAC,SAAS,CAAC,4CAAmB,CAAC,CAAC;QAElD,IAAI,CAAC,OAAO,CAAC,eAAM,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,eAAM,CAAC,CAAC,EAAE,CAAC,mBAAU,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,sBAAa,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,sBAAa,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,MAAc,EAAE,EAAE;gBAC/D,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,eAAM,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,OAAO,MAAM,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"di.config.js","sourceRoot":"","sources":["../src/di.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAoJA,4DAEC;AAtJD;;;;;;;;;;;;;;kFAckF;AAClF,iDAS8B;AAC9B,uDAAsE;AACtE,yCAAoE;AACpE,qDAAuE;AACvE,qEAA2E;AAC3E,+DAAuF;AAkCvF;;;;;;;;;;;;;GAaG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAgB,SAAQ,mBAAU;IAC3C,YAA+B,OAAyB;QACpD,KAAK,EAAE,CAAC;QADmB,YAAO,GAAP,OAAO,CAAkB;IAExD,CAAC;IAES,SAAS,CAAC,IAAqB,EAAE,MAAyB,EAAE,OAA2B,EAAE,MAAyB;QACxH,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAClD,IAAA,2BAAkB,EAAC,OAAO,EAAE,8BAAa,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACxF,IAAA,2BAAkB,EAAC,OAAO,EAAE,wCAAkB,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClG,IAAA,2BAAkB,EAAC,OAAO,EAAE,mCAAU,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QAC/D,IAAA,2BAAkB,EAAC,OAAO,EAAE,4CAAmB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACpG,IAAI,CAAC,qBAAY,CAAC,CAAC,SAAS,CAAC,4CAAmB,CAAC,CAAC;QAClD,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAES,iBAAiB;;QACvB,OAAO,MAAA,IAAI,CAAC,OAAO,CAAC,aAAa,mCAAI,qCAAoB,CAAC;IAC9D,CAAC;IAES,sBAAsB;QAC5B,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC3C,CAAC;QACD,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,gDAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;IAC9H,CAAC;IAES,cAAc;QACpB,MAAM,EAAE,UAAU,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACvE,MAAM,OAAO,GAAe,GAAG,EAAE,CAC7B,IAAI,qBAAc,CAAC;YACf,UAAU;YACV,oBAAoB;YACpB,yGAAyG;YACzG,uGAAuG;YACvG,aAAa,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAsB,CAAC,CAAC,CAAC,SAAS;SAClG,CAAC,CAAC;QACP,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;IACtC,CAAC;IAES,uBAAuB;QAC7B,OAAO;YACH,YAAY,EAAE,GAAG,CAAC,EAAE;gBAChB,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAa,mCAAU,CAAC,CAAC;gBAC1D,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAgB,8BAAa,CAAC,CAAC;gBAC/D,MAAM,YAAY,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAqB,wCAAkB,CAAC,CAAC;gBAC/E,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAa,mBAAU,CAAC,CAAC;gBAC7D,OAAO,IAAI,4CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;YAC9E,CAAC;SACJ,CAAC;IACN,CAAC;IAED,uGAAuG;IAC7F,mBAAmB,CAAC,IAAqB,EAAE,OAA2B;QAC5E,IAAI,CAAC,OAAO,CAAC,eAAM,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,eAAM,CAAC,CAAC,EAAE,CAAC,mBAAU,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,sBAAa,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,sBAAa,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,MAAc,EAAE,EAAE;gBAC/D,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,eAAM,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,OAAO,MAAM,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;CACJ,CAAA;AAhEY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,sBAAU,GAAE;;GACA,eAAe,CAgE3B;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,OAAyB;IAC9D,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/layout-elk",
-  "version": "2.6.0",
+  "version": "2.7.0-next.11+ea5b153",
   "description": "Integration of ELK graph layout algorithms in GLSP Node Server",
   "keywords": [
     "eclipse",
@@ -42,14 +42,14 @@
     "build": "tsc -b",
     "clean": "rimraf lib *.tsbuildinfo coverage .nyc_output",
     "generate:index": "glsp generateIndex src -f -s",
-    "lint": "eslint --ext .ts,.tsx ./src",
+    "lint": "eslint ./src",
     "test": "mocha --config ../../.mocharc \"./src/**/*.spec.?(ts|tsx)\"",
     "test:ci": "yarn test --reporter mocha-ctrf-json-reporter",
     "test:coverage": "nyc yarn test",
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@eclipse-glsp/server": "2.6.0",
+    "@eclipse-glsp/server": "2.7.0-next.11+ea5b153",
     "elkjs": "^0.10.1"
   },
   "peerDependencies": {
@@ -58,5 +58,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "88356089bae7527c2df6c5331f75504495fe2aa4"
+  "gitHead": "ea5b15366a194a2cca2522f3b2011b03c9c85e6e"
 }

package/src/di.config.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2022-2025 STMicroelectronics and others.
+ * Copyright (c) 2022-2026 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,9 +13,18 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { LayoutEngine, Logger, LoggerFactory, ModelState, NullLogger } from '@eclipse-glsp/server';
+import {
+    BindingTarget,
+    GLSPModule,
+    LayoutEngine,
+    Logger,
+    LoggerFactory,
+    ModelState,
+    NullLogger,
+    applyBindingTarget
+} from '@eclipse-glsp/server';
 import ElkConstructor, { LayoutOptions } from 'elkjs/lib/elk.bundled';
-import { ContainerModule } from 'inversify';
+import { ContainerModule, injectable, interfaces } from 'inversify';
 import { DefaultElementFilter, ElementFilter } from './element-filter';
 import { ElkFactory, GlspElkLayoutEngine } from './glsp-elk-layout-engine';
 import { FallbackLayoutConfigurator, LayoutConfigurator } from './layout-configurator';
@@ -23,7 +32,7 @@ import { FallbackLayoutConfigurator, LayoutConfigurator } from './layout-configu
 type Constructor<T> = new (...args: any[]) => T;
 
 /**
- * Configuration options for the {@link configureELKLayoutModule} function.
+ * Configuration options for the {@link ElkLayoutModule} (and the legacy {@link configureELKLayoutModule} factory).
  */
 export interface ElkModuleOptions {
     /**
@@ -53,65 +62,76 @@ export interface ElkModuleOptions {
 }
 
 /**
- * Utility method to create a DI module that provides all necessary bindings to use the {@link GlspElkLayoutEngine} in a node GLSP server
- * implementation. A set of configuration options is provided to enable easy customization. In most cases at least
- * the custom {@link layoutConfigurator} binding should be provided (in addition to the required `algorithms' property) via these options.
+ * DI module that provides the bindings needed to use the {@link GlspElkLayoutEngine} in a node GLSP server.
  *
- * The constructed module is not intended for standalone use cases and only works in combination with a GLSPDiagramModule.
+ * Subclass and override the `bindXxx()` hooks to customize individual bindings — e.g. to swap the
+ * layout configurator or element filter without re-implementing the whole module. The module is
+ * only meaningful in combination with a `GLSPDiagramModule`.
  *
- * * The following bindings are provided:
- * - {@link ILayoutConfigurator}
- * - {@link IElementFilter}
- * - {@link LayoutEngine}
+ * Bindings provided:
+ * - {@link ElementFilter}
+ * - {@link LayoutConfigurator}
  * - {@link ElkFactory}
- *
- * @param options The configuration options
- * @returns A DI module that can be loaded as additional module when configuring a diagram module for a GLSP server.
+ * - {@link GlspElkLayoutEngine} + {@link LayoutEngine} (toService)
+ * - Fallback bindings for {@link Logger} and {@link LoggerFactory} if absent.
  */
-export function configureELKLayoutModule(options: ElkModuleOptions): ContainerModule {
-    return new ContainerModule((bind, unbind, isBound, rebind) => {
-        if (options.elementFilter) {
-            bind(ElementFilter).to(options.elementFilter).inSingletonScope();
-        } else {
-            bind(ElementFilter).to(DefaultElementFilter).inSingletonScope();
-        }
+@injectable()
+export class ElkLayoutModule extends GLSPModule {
+    constructor(protected readonly options: ElkModuleOptions) {
+        super();
+    }
 
-        if (options.layoutConfigurator) {
-            bind(LayoutConfigurator).to(options.layoutConfigurator);
-        } else {
-            bind(LayoutConfigurator)
-                .toDynamicValue(context => new FallbackLayoutConfigurator(options.algorithms, options.defaultLayoutOptions))
-                .inSingletonScope();
+    protected configure(bind: interfaces.Bind, unbind: interfaces.Unbind, isBound: interfaces.IsBound, rebind: interfaces.Rebind): void {
+        const context = { bind, unbind, isBound, rebind };
+        applyBindingTarget(context, ElementFilter, this.bindElementFilter()).inSingletonScope();
+        applyBindingTarget(context, LayoutConfigurator, this.bindLayoutConfigurator()).inSingletonScope();
+        applyBindingTarget(context, ElkFactory, this.bindElkFactory());
+        applyBindingTarget(context, GlspElkLayoutEngine, this.bindGlspElkLayoutEngine()).inSingletonScope();
+        bind(LayoutEngine).toService(GlspElkLayoutEngine);
+        this.bindLoggerFallbacks(bind, isBound);
+    }
+
+    protected bindElementFilter(): BindingTarget<ElementFilter> {
+        return this.options.elementFilter ?? DefaultElementFilter;
+    }
+
+    protected bindLayoutConfigurator(): BindingTarget<LayoutConfigurator> {
+        if (this.options.layoutConfigurator) {
+            return this.options.layoutConfigurator;
         }
+        return { dynamicValue: () => new FallbackLayoutConfigurator(this.options.algorithms, this.options.defaultLayoutOptions) };
+    }
 
-        const elkFactory: ElkFactory = () =>
+    protected bindElkFactory(): BindingTarget<ElkFactory> {
+        const { algorithms, defaultLayoutOptions, isWebWorker } = this.options;
+        const factory: ElkFactory = () =>
             new ElkConstructor({
-                algorithms: options.algorithms,
-                defaultLayoutOptions: options.defaultLayoutOptions,
-                // The node implementation relied on elkjs' `FakeWorker` to set the `workerFactory`.
-                // However, since the required file is dynamically loaded and not available in a web-worker context,
-                // it needs to be mocked manually.
-                workerFactory: options.isWebWorker ? () => ({ postMessage: () => {} }) as unknown as Worker : undefined
+                algorithms,
+                defaultLayoutOptions,
+                // The node implementation relies on elkjs' `FakeWorker` to set the `workerFactory`. The required file is
+                // dynamically loaded and not available in a web-worker context, so it has to be mocked manually there.
+                workerFactory: isWebWorker ? () => ({ postMessage: () => {} }) as unknown as Worker : undefined
             });
+        return { constantValue: factory };
+    }
 
-        bind(ElkFactory).toConstantValue(elkFactory);
-
-        bind(GlspElkLayoutEngine)
-            .toDynamicValue(context => {
-                const container = context.container;
-                const factory = container.get<ElkFactory>(ElkFactory);
-                const filter = container.get<ElementFilter>(ElementFilter);
-                const configurator = container.get<LayoutConfigurator>(LayoutConfigurator);
-                const modelState = container.get<ModelState>(ModelState);
+    protected bindGlspElkLayoutEngine(): BindingTarget<GlspElkLayoutEngine> {
+        return {
+            dynamicValue: ctx => {
+                const factory = ctx.container.get<ElkFactory>(ElkFactory);
+                const filter = ctx.container.get<ElementFilter>(ElementFilter);
+                const configurator = ctx.container.get<LayoutConfigurator>(LayoutConfigurator);
+                const modelState = ctx.container.get<ModelState>(ModelState);
                 return new GlspElkLayoutEngine(factory, filter, configurator, modelState);
-            })
-            .inSingletonScope();
-        bind(LayoutEngine).toService(GlspElkLayoutEngine);
+            }
+        };
+    }
 
+    /** Provide fallbacks so the module works standalone in tests/specs that don't preconfigure logging. */
+    protected bindLoggerFallbacks(bind: interfaces.Bind, isBound: interfaces.IsBound): void {
         if (!isBound(Logger)) {
             bind(Logger).to(NullLogger).inSingletonScope();
         }
-
         if (!isBound(LoggerFactory)) {
             bind(LoggerFactory).toFactory(dynamicContext => (caller: string) => {
                 const logger = dynamicContext.container.get(Logger);
@@ -119,5 +139,13 @@ export function configureELKLayoutModule(options: ElkModuleOptions): ContainerMo
                 return logger;
             });
         }
-    });
+    }
+}
+
+/**
+ * Utility wrapper around {@link ElkLayoutModule} for the common case where no override is needed.
+ * Prefer subclassing {@link ElkLayoutModule} when individual bindings need to be customized.
+ */
+export function configureELKLayoutModule(options: ElkModuleOptions): ContainerModule {
+    return new ElkLayoutModule(options);
 }