@eclipse-glsp/layout-elk 0.9.0-next.0193b16.17

package/lib/di.config.d.ts

@@ -0,0 +1,47 @@
+import { LayoutOptions } from 'elkjs/lib/elk.bundled';
+import { ContainerModule } from 'inversify';
+import { ElementFilter, LayoutConfigurator } from '.';
+declare type Constructor<T> = new (...args: any[]) => T;
+/**
+ * Configuration options for the {@link configureELKLayoutModule} function.
+ */
+export interface ElkModuleOptions {
+    /**
+     * The set of elk algorithms that is used by the {@link GlspElkLayoutEngine}.
+     */
+    algorithms: string[];
+    /**
+     * Additional default layout options. This options are passed to the underlying {@link ElkFactory}.
+     * In addition, they are used to configure the {@link FallbackGlspLayoutConfigurator}.
+     */
+    defaultLayoutOptions?: LayoutOptions;
+    /**
+     * The custom {@link LayoutConfigurator} class that should be bound. If this option is not set
+     * the {@link FallbackLayoutConfigurator} is bound instead.
+     */
+    layoutConfigurator?: Constructor<LayoutConfigurator>;
+    /**
+     * The custom {@link ElementFilter} class that should be bound. If this option is not set, the default implementation
+     * is bound.
+     */
+    elementFilter?: Constructor<ElementFilter>;
+}
+/**
+ * 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.
+ *
+ * The constructed module is not intended for standalone use cases and only works in combination with a GLSPDiagramModule.
+ *
+ * * The following bindings are provided:
+ * - {@link ILayoutConfigurator}
+ * - {@link IElementFilter}
+ * - {@link LayoutEngine}
+ * - {@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.
+ */
+export declare function configureELKLayoutModule(options: ElkModuleOptions): ContainerModule;
+export {};
+//# sourceMappingURL=di.config.d.ts.map

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

@@ -0,0 +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;AAE5C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AAKtD,aAAK,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;CAC9C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAoCnF"}

package/lib/di.config.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureELKLayoutModule = void 0;
+/********************************************************************************
+ * Copyright (c) 2022 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
+ ********************************************************************************/
+const server_node_1 = require("@eclipse-glsp/server-node");
+const elk_bundled_1 = require("elkjs/lib/elk.bundled");
+const inversify_1 = require("inversify");
+const sprotty_elk_1 = require("sprotty-elk");
+const _1 = require(".");
+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.
+ *
+ * The constructed module is not intended for standalone use cases and only works in combination with a GLSPDiagramModule.
+ *
+ * * The following bindings are provided:
+ * - {@link ILayoutConfigurator}
+ * - {@link IElementFilter}
+ * - {@link LayoutEngine}
+ * - {@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.
+ */
+function configureELKLayoutModule(options) {
+    return new inversify_1.ContainerModule(bind => {
+        if (options.elementFilter) {
+            bind(_1.ElementFilter).to(options.elementFilter).inSingletonScope();
+        }
+        else {
+            bind(_1.ElementFilter).to(element_filter_1.DefaultElementFilter).inSingletonScope();
+        }
+        if (options.layoutConfigurator) {
+            bind(_1.LayoutConfigurator).to(options.layoutConfigurator);
+        }
+        else {
+            bind(_1.LayoutConfigurator)
+                .toDynamicValue(context => new layout_configurator_1.FallbackLayoutConfigurator(options.algorithms, options.defaultLayoutOptions))
+                .inSingletonScope();
+        }
+        const elkFactory = () => new elk_bundled_1.default({
+            algorithms: options.algorithms,
+            defaultLayoutOptions: options.defaultLayoutOptions
+        });
+        bind(sprotty_elk_1.ElkFactory).toConstantValue(elkFactory);
+        bind(glsp_elk_layout_engine_1.GlspElkLayoutEngine)
+            .toDynamicValue(context => {
+            const container = context.container;
+            const factory = container.get(sprotty_elk_1.ElkFactory);
+            const filter = container.get(_1.ElementFilter);
+            const configurator = container.get(_1.LayoutConfigurator);
+            const modelState = container.get(server_node_1.ModelState);
+            return new glsp_elk_layout_engine_1.GlspElkLayoutEngine(factory, filter, configurator, modelState);
+        })
+            .inSingletonScope();
+        bind(server_node_1.LayoutEngine).toService(glsp_elk_layout_engine_1.GlspElkLayoutEngine);
+    });
+}
+exports.configureELKLayoutModule = configureELKLayoutModule;
+//# sourceMappingURL=di.config.js.map

package/lib/di.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"di.config.js","sourceRoot":"","sources":["../src/di.config.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,2DAAqE;AACrE,uDAAsE;AACtE,yCAA4C;AAC5C,6CAAyC;AACzC,wBAAsD;AACtD,qDAAwD;AACxD,qEAA+D;AAC/D,+DAAmE;AA6BnE;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,wBAAwB,CAAC,OAAyB;IAC9D,OAAO,IAAI,2BAAe,CAAC,IAAI,CAAC,EAAE;QAC9B,IAAI,OAAO,CAAC,aAAa,EAAE;YACvB,IAAI,CAAC,gBAAa,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,gBAAgB,EAAE,CAAC;SACpE;aAAM;YACH,IAAI,CAAC,gBAAa,CAAC,CAAC,EAAE,CAAC,qCAAoB,CAAC,CAAC,gBAAgB,EAAE,CAAC;SACnE;QAED,IAAI,OAAO,CAAC,kBAAkB,EAAE;YAC5B,IAAI,CAAC,qBAAkB,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;SAC3D;aAAM;YACH,IAAI,CAAC,qBAAkB,CAAC;iBACnB,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,gDAA0B,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;iBAC3G,gBAAgB,EAAE,CAAC;SAC3B;QAED,MAAM,UAAU,GAAe,GAAG,EAAE,CAChC,IAAI,qBAAc,CAAC;YACf,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;SACrD,CAAC,CAAC;QAEP,IAAI,CAAC,wBAAU,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,wBAAU,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAgB,gBAAa,CAAC,CAAC;YAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAqB,qBAAkB,CAAC,CAAC;YAC3E,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAa,wBAAU,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,0BAAY,CAAC,CAAC,SAAS,CAAC,4CAAmB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACP,CAAC;AApCD,4DAoCC"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=di.config.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"di.config.spec.d.ts","sourceRoot":"","sources":["../src/di.config.spec.ts"],"names":[],"mappings":""}

package/lib/di.config.spec.js

@@ -0,0 +1,97 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/********************************************************************************
+ * Copyright (c) 2022 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
+ ********************************************************************************/
+const server_node_1 = require("@eclipse-glsp/server-node");
+const mock_util_1 = require("@eclipse-glsp/server-node/lib/test/mock-util");
+const chai_1 = require("chai");
+const inversify_1 = require("inversify");
+const sinon = require("sinon");
+const _1 = require(".");
+const di_config_1 = require("./di.config");
+const element_filter_1 = require("./element-filter");
+const layout_configurator_1 = require("./layout-configurator");
+let CustomLayoutConfigurator = class CustomLayoutConfigurator extends _1.AbstractLayoutConfigurator {
+};
+CustomLayoutConfigurator = __decorate([
+    (0, inversify_1.injectable)()
+], CustomLayoutConfigurator);
+let CustomElementFilter = class CustomElementFilter extends element_filter_1.DefaultElementFilter {
+};
+CustomElementFilter = __decorate([
+    (0, inversify_1.injectable)()
+], CustomElementFilter);
+describe('test configureELKLayoutModule', () => {
+    const sandbox = sinon.createSandbox();
+    const mockDiagramConfiguration = new mock_util_1.StubDiagramConfiguration();
+    const typeMappings = new Map();
+    typeMappings.set('graph', server_node_1.GGraph);
+    sandbox.stub(mockDiagramConfiguration, 'typeMapping').value(typeMappings);
+    const modelState = new server_node_1.DefaultModelState();
+    const baseModule = new inversify_1.ContainerModule(bind => {
+        bind(server_node_1.ModelState).toConstantValue(modelState);
+    });
+    it('configure with minimal options', () => {
+        const algorithm = 'layered';
+        const elkModule = (0, di_config_1.configureELKLayoutModule)({ algorithms: [algorithm] });
+        const container = new inversify_1.Container();
+        container.load(baseModule, elkModule);
+        const filter = container.get(element_filter_1.ElementFilter);
+        (0, chai_1.expect)(filter).to.be.an.instanceOf(element_filter_1.DefaultElementFilter);
+        const configurator = container.get(layout_configurator_1.LayoutConfigurator);
+        (0, chai_1.expect)(configurator).to.be.an.instanceOf(layout_configurator_1.FallbackLayoutConfigurator);
+        const graphOptions = configurator.apply(new server_node_1.GGraph());
+        (0, chai_1.expect)(graphOptions).not.to.be.undefined;
+        (0, chai_1.expect)(graphOptions['elk.algorithm']).to.equal(algorithm);
+    });
+    it('configure with additional default layout options', () => {
+        const algorithm = 'layered';
+        const defaultLayoutOptions = {
+            'elk.direction': 'LEFT',
+            'elk.edgeRouting': 'POLYLINE'
+        };
+        const elkModule = (0, di_config_1.configureELKLayoutModule)({ algorithms: [algorithm], defaultLayoutOptions });
+        const container = new inversify_1.Container();
+        container.load(baseModule, elkModule);
+        const configurator = container.get(layout_configurator_1.LayoutConfigurator);
+        const graphOptions = configurator.apply(new server_node_1.GGraph());
+        (0, chai_1.expect)(graphOptions).not.to.be.undefined;
+        (0, chai_1.expect)(graphOptions).to.include(defaultLayoutOptions);
+    });
+    it('configure with custom layout configurator', () => {
+        const algorithm = 'layered';
+        const elkModule = (0, di_config_1.configureELKLayoutModule)({ algorithms: [algorithm], layoutConfigurator: CustomLayoutConfigurator });
+        const container = new inversify_1.Container();
+        container.load(baseModule, elkModule);
+        const configurator = container.get(layout_configurator_1.LayoutConfigurator);
+        (0, chai_1.expect)(configurator).to.be.an.instanceOf(CustomLayoutConfigurator);
+    });
+    it('configure with custom element filter', () => {
+        const algorithm = 'layered';
+        const elkModule = (0, di_config_1.configureELKLayoutModule)({ algorithms: [algorithm], elementFilter: CustomElementFilter });
+        const container = new inversify_1.Container();
+        container.load(baseModule, elkModule);
+        const filter = container.get(element_filter_1.ElementFilter);
+        (0, chai_1.expect)(filter).to.be.an.instanceOf(CustomElementFilter);
+    });
+});
+//# sourceMappingURL=di.config.spec.js.map

package/lib/di.config.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"di.config.spec.js","sourceRoot":"","sources":["../src/di.config.spec.ts"],"names":[],"mappings":";;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,2DAA4G;AAC5G,4EAAwF;AACxF,+BAA8B;AAC9B,yCAAmE;AACnE,+BAA+B;AAC/B,wBAA+C;AAC/C,2CAAuD;AACvD,qDAAuE;AACvE,+DAAuF;AAGvF,IAAM,wBAAwB,GAA9B,MAAM,wBAAyB,SAAQ,6BAA0B;CAAG,CAAA;AAA9D,wBAAwB;IAD7B,IAAA,sBAAU,GAAE;GACP,wBAAwB,CAAsC;AAGpE,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,qCAAoB;CAAG,CAAA;AAAnD,mBAAmB;IADxB,IAAA,sBAAU,GAAE;GACP,mBAAmB,CAAgC;AAEzD,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;IACtC,MAAM,wBAAwB,GAAG,IAAI,oCAAwB,EAAE,CAAC;IAChE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAoC,CAAC;IAEjE,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAM,CAAC,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,aAAa,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1E,MAAM,UAAU,GAAG,IAAI,+BAAiB,EAAE,CAAC;IAC3C,MAAM,UAAU,GAAG,IAAI,2BAAe,CAAC,IAAI,CAAC,EAAE;QAC1C,IAAI,CAAC,wBAAU,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACtC,MAAM,SAAS,GAAG,SAAS,CAAC;QAC5B,MAAM,SAAS,GAAG,IAAA,oCAAwB,EAAC,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAgB,8BAAa,CAAC,CAAC;QAC3D,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,qCAAoB,CAAC,CAAC;QACzD,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAqB,wCAAkB,CAAC,CAAC;QAC3E,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,gDAA0B,CAAC,CAAC;QACrE,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,oBAAM,EAAE,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,IAAA,aAAM,EAAC,YAAa,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,SAAS,GAAG,SAAS,CAAC;QAC5B,MAAM,oBAAoB,GAAG;YACzB,eAAe,EAAE,MAAM;YACvB,iBAAiB,EAAE,UAAU;SAChC,CAAC;QACF,MAAM,SAAS,GAAG,IAAA,oCAAwB,EAAC,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAC9F,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAqB,wCAAkB,CAAC,CAAC;QAC3E,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,oBAAM,EAAE,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,SAAS,GAAG,SAAS,CAAC;QAC5B,MAAM,SAAS,GAAG,IAAA,oCAAwB,EAAC,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,CAAC,CAAC;QACtH,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAqB,wCAAkB,CAAC,CAAC;QAC3E,IAAA,aAAM,EAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,SAAS,GAAG,SAAS,CAAC;QAC5B,MAAM,SAAS,GAAG,IAAA,oCAAwB,EAAC,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC5G,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAgB,8BAAa,CAAC,CAAC;QAC3D,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/element-filter.d.ts

@@ -0,0 +1,45 @@
+/********************************************************************************
+ * Copyright (c) 2018-2022 TypeFox 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 { GEdge, GLabel, GModelElement, GNode, GPort, ModelState } from '@eclipse-glsp/server-node';
+export declare const ElementFilter: unique symbol;
+/**
+ * Filter used to determine which model elements should be included in the automatic layout.
+ */
+export interface ElementFilter {
+    /**
+     * Applies the element filter on the given element,
+     * @param element The element on which the filter should be applied.
+     * @returns `true` if the element should be included in the automatic layout, `false` otherwise.
+     */
+    apply(element: GModelElement): boolean;
+}
+/**
+ * Default implementation of {@link ElementFilter}.
+ * Without further configuration this filter includes all basic model elements (nodes,edges,labels,ports) that are
+ * part of the graphical model. For each basic type a custom filter behavior is in place.
+ * Edges that have no source or target are filtered out. In addition, edges that are connected to a filtered element are filtered out
+ * as well. The filter behavior for each of the basic types can be customized by overriding the corresponding `filter` method.
+ * (e.g. {@link DefaultElementFilter.filterNode})
+ */
+export declare class DefaultElementFilter implements ElementFilter {
+    protected modelState: ModelState;
+    apply(element: GModelElement): boolean;
+    protected filterNode(node: GNode): boolean;
+    protected filterEdge(edge: GEdge): boolean;
+    protected filterLabel(label: GLabel): boolean;
+    protected filterPort(port: GPort): boolean;
+}
+//# sourceMappingURL=element-filter.d.ts.map

package/lib/element-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-filter.d.ts","sourceRoot":"","sources":["../src/element-filter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAClF,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAGnG,eAAO,MAAM,aAAa,eAA0B,CAAC;AACrD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,qBACa,oBAAqB,YAAW,aAAa;IAEtD,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IAEjC,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO;IAatC,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;IAI1C,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;IAe1C,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI7C,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;CAG7C"}

package/lib/element-filter.js

@@ -0,0 +1,84 @@
+"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.DefaultElementFilter = exports.ElementFilter = void 0;
+/********************************************************************************
+ * Copyright (c) 2018-2022 TypeFox 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
+ ********************************************************************************/
+const server_node_1 = require("@eclipse-glsp/server-node");
+const inversify_1 = require("inversify");
+exports.ElementFilter = Symbol('ElementFilter');
+/**
+ * Default implementation of {@link ElementFilter}.
+ * Without further configuration this filter includes all basic model elements (nodes,edges,labels,ports) that are
+ * part of the graphical model. For each basic type a custom filter behavior is in place.
+ * Edges that have no source or target are filtered out. In addition, edges that are connected to a filtered element are filtered out
+ * as well. The filter behavior for each of the basic types can be customized by overriding the corresponding `filter` method.
+ * (e.g. {@link DefaultElementFilter.filterNode})
+ */
+let DefaultElementFilter = class DefaultElementFilter {
+    apply(element) {
+        if (element instanceof server_node_1.GNode) {
+            return this.filterNode(element);
+        }
+        else if (element instanceof server_node_1.GEdge) {
+            return this.filterEdge(element);
+        }
+        else if (element instanceof server_node_1.GLabel) {
+            this.filterLabel(element);
+        }
+        else if (element instanceof server_node_1.GPort) {
+            this.filterPort(element);
+        }
+        return true;
+    }
+    filterNode(node) {
+        return true;
+    }
+    filterEdge(edge) {
+        const source = this.modelState.index.get(edge.sourceId);
+        if (!source || (source instanceof server_node_1.GNode && !this.filterNode(source)) || (source instanceof server_node_1.GPort && !this.filterPort(source))) {
+            return false;
+        }
+        const target = this.modelState.index.get(edge.targetId);
+        if (!target || (target instanceof server_node_1.GNode && !this.filterNode(target)) || (target instanceof server_node_1.GPort && !this.filterPort(target))) {
+            return false;
+        }
+        return true;
+    }
+    filterLabel(label) {
+        return true;
+    }
+    filterPort(port) {
+        return true;
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(server_node_1.ModelState),
+    __metadata("design:type", Object)
+], DefaultElementFilter.prototype, "modelState", void 0);
+DefaultElementFilter = __decorate([
+    (0, inversify_1.injectable)()
+], DefaultElementFilter);
+exports.DefaultElementFilter = DefaultElementFilter;
+//# sourceMappingURL=element-filter.js.map

package/lib/element-filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-filter.js","sourceRoot":"","sources":["../src/element-filter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,2DAAmG;AACnG,yCAA+C;AAElC,QAAA,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAarD;;;;;;;GAOG;AAEH,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAI7B,KAAK,CAAC,OAAsB;QACxB,IAAI,OAAO,YAAY,mBAAK,EAAE;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SACnC;aAAM,IAAI,OAAO,YAAY,mBAAK,EAAE;YACjC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SACnC;aAAM,IAAI,OAAO,YAAY,oBAAM,EAAE;YAClC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;SAC7B;aAAM,IAAI,OAAO,YAAY,mBAAK,EAAE;YACjC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,UAAU,CAAC,IAAW;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,UAAU,CAAC,IAAW;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,YAAY,mBAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,YAAY,mBAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE;YAC3H,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,YAAY,mBAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,YAAY,mBAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE;YAC3H,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,WAAW,CAAC,KAAa;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,UAAU,CAAC,IAAW;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ,CAAA;AAzCG;IADC,IAAA,kBAAM,EAAC,wBAAU,CAAC;;wDACc;AAFxB,oBAAoB;IADhC,IAAA,sBAAU,GAAE;GACA,oBAAoB,CA2ChC;AA3CY,oDAAoB"}

package/lib/glsp-elk-layout-engine.d.ts

@@ -0,0 +1,53 @@
+/********************************************************************************
+ * Copyright (c) 2018-2022 TypeFox 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 { GEdge, GGraph, GLabel, GModelElement, GModelElementConstructor, GModelRoot, GNode, GPort, GShapeElement, LayoutEngine, MaybePromise, ModelState } from '@eclipse-glsp/server-node';
+import { ELK, ElkEdge, ElkGraphElement, ElkLabel, ElkNode, ElkPort, ElkPrimitiveEdge, ElkShape } from 'elkjs/lib/elk-api';
+import { ElkFactory } from 'sprotty-elk';
+import { ElementFilter } from './element-filter';
+import { LayoutConfigurator } from './layout-configurator';
+/**
+ * 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.
+ */
+export declare class GlspElkLayoutEngine implements LayoutEngine {
+    protected readonly filter: ElementFilter;
+    protected readonly configurator: LayoutConfigurator;
+    protected modelState: ModelState;
+    protected readonly elk: ELK;
+    protected elkEdges: ElkEdge[];
+    protected idToElkElement: Map<string, ElkGraphElement>;
+    constructor(elkFactory: ElkFactory, filter: ElementFilter, configurator: LayoutConfigurator, modelState: ModelState);
+    layout(): MaybePromise<GModelRoot>;
+    protected transformToElk(model: GModelElement): ElkGraphElement;
+    /**
+     * Searches for all children of the given element that are an instance of the given {@link GModelElementConstructor}
+     * and are included by the {@link ElementFilter}. Also considers children that are nested inside of {@link GCompartment}s.
+     * @param element The element whose children should be queried.
+     * @param constructor The class instance that should be matched
+     * @returns A list of all matching children.
+     */
+    protected findChildren<G extends GModelElement>(element: GModelElement, constructor: GModelElementConstructor<G>): G[];
+    protected findCommonAncestor(elkEdge: ElkPrimitiveEdge): ElkNode | undefined;
+    protected transformGraph(graph: GGraph): ElkGraphElement;
+    protected transformNode(node: GNode): ElkNode;
+    protected transformShape(elkShape: ElkShape, shape: GShapeElement): void;
+    protected transformEdge(edge: GEdge): ElkEdge;
+    protected transformLabel(label: GLabel): ElkLabel;
+    protected transformPort(port: GPort): ElkPort;
+    protected applyLayout(elkNode: ElkNode): void;
+    protected applyShape(shape: GShapeElement, elkShape: ElkShape): void;
+    protected applyEdge(edge: GEdge, elkEdge: ElkEdge): void;
+}
+//# sourceMappingURL=glsp-elk-layout-engine.d.ts.map

package/lib/glsp-elk-layout-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glsp-elk-layout-engine.d.ts","sourceRoot":"","sources":["../src/glsp-elk-layout-engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;kFAakF;AAClF,OAAO,EAIH,KAAK,EACL,MAAM,EACN,MAAM,EACN,aAAa,EACb,wBAAwB,EACxB,UAAU,EACV,KAAK,EACL,KAAK,EACL,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,UAAU,EAEb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAmB,eAAe,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE3I,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;GAGG;AACH,qBACa,mBAAoB,YAAW,YAAY;IAQhD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa;IACxC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,kBAAkB;IACnD,SAAS,CAAC,UAAU,EAAE,UAAU;IATpC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAE5B,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAC9B,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;gBAGnD,UAAU,EAAE,UAAU,EACH,MAAM,EAAE,aAAa,EACrB,YAAY,EAAE,kBAAkB,EACzC,UAAU,EAAE,UAAU;IAIpC,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC;IAelC,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,eAAe;IAuB/D;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,CAAC,SAAS,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;IAatH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,GAAG,SAAS;IAwB5E,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe;IAexD,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;IAqB7C,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAWxE,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;IAsC7C,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAWjD,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO;IAa7C,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IA6B7C,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAkBpE,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;CAoC3D"}