@eclipse-glsp/server 1.1.0-RC05

package/lib/common/utils/layout-util.js

@@ -0,0 +1,166 @@
+"use strict";
+/********************************************************************************
+ * Copyright (c) 2022-2023 EclipseSource 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
+ ********************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.absoluteToRelative = exports.getRelativeLocation = exports.applyRoutingPoints = exports.getRoute = exports.applyRoute = exports.applyAlignment = exports.applyBounds = void 0;
+const graph_1 = require("@eclipse-glsp/graph");
+const args_util_1 = require("./args-util");
+const glsp_server_error_1 = require("./glsp-server-error");
+/**
+ * Applies the new bounds to the model.
+ *
+ * @param bounds The new bounds.
+ * @param index  The model index.
+ * @returns The changed element.
+ */
+function applyBounds(bounds, index) {
+    const element = (0, glsp_server_error_1.getOrThrow)(index.get(bounds.elementId), 'Model element not found! ID: ' + bounds.elementId);
+    if ((0, graph_1.isGBoundsAware)(element)) {
+        if (bounds.newPosition !== undefined) {
+            element.position = bounds.newPosition;
+        }
+        element.size = bounds.newSize;
+        return element;
+    }
+    return undefined;
+}
+exports.applyBounds = applyBounds;
+/**
+ * Applies the new alignment to the model.
+ *
+ * @param alignment The new alignment.
+ * @param index     The model index.
+ * @returns The changed element.
+ */
+function applyAlignment(alignment, index) {
+    const element = (0, glsp_server_error_1.getOrThrow)(index.get(alignment.elementId), 'Model element not found! ID: ' + alignment.elementId);
+    if ((0, graph_1.isGAlignable)(element)) {
+        element.alignment = alignment.newAlignment;
+        return element;
+    }
+    return undefined;
+}
+exports.applyAlignment = applyAlignment;
+/**
+ * Applies the new route to the model.
+ *
+ * @param route The new route.
+ * @param index The model index.
+ * @returns The changed element.
+ */
+function applyRoute(route, index) {
+    var _a, _b;
+    const routingPoints = (_a = route.newRoutingPoints) !== null && _a !== void 0 ? _a : [];
+    if (routingPoints.length < 2) {
+        throw new glsp_server_error_1.GLSPServerError('Invalid Route!');
+    }
+    // first and last point mark the source and target point
+    const edge = applyRoutingPoints(route, index);
+    const edgeRoutingPoints = edge.routingPoints;
+    const args = (_b = edge.args) !== null && _b !== void 0 ? _b : {};
+    const source = edgeRoutingPoints.shift();
+    const target = edgeRoutingPoints.pop();
+    args[args_util_1.ArgsUtil.KEY_EDGE_SOURCE_POINT_X] = source.x;
+    args[args_util_1.ArgsUtil.KEY_EDGE_SOURCE_POINT_Y] = source.y;
+    args[args_util_1.ArgsUtil.KEY_EDGE_TARGET_POINT_X] = target.x;
+    args[args_util_1.ArgsUtil.KEY_EDGE_TARGET_POINT_Y] = target.y;
+    return edge;
+}
+exports.applyRoute = applyRoute;
+/**
+ * Returns the complete route of the given edge. The route, as opposed to the routing points, also contain the source
+ * and target point.
+ *
+ * @param edge The edge from which we get the route
+ * @returns complete edge route
+ */
+function getRoute(edge) {
+    const sourcePoint = args_util_1.ArgsUtil.getEdgeSourcePoint(edge.args);
+    if (!sourcePoint) {
+        throw new glsp_server_error_1.GLSPServerError('Cannot get route without source point!');
+    }
+    const targetPoint = args_util_1.ArgsUtil.getEdgeTargetPoint(edge.args);
+    if (!targetPoint) {
+        throw new glsp_server_error_1.GLSPServerError('Cannot get route without target point!');
+    }
+    const route = [];
+    route.push(sourcePoint);
+    route.push(...edge.routingPoints);
+    route.push(targetPoint);
+    return { elementId: edge.id, newRoutingPoints: route };
+}
+exports.getRoute = getRoute;
+function applyRoutingPoints(routingPoints, index) {
+    var _a;
+    const edge = (0, glsp_server_error_1.getOrThrow)(index.findByClass(routingPoints.elementId, graph_1.GEdge), 'Model element not found! ID: ' + routingPoints.elementId);
+    edge.routingPoints = (_a = routingPoints.newRoutingPoints) !== null && _a !== void 0 ? _a : [];
+    return edge;
+}
+exports.applyRoutingPoints = applyRoutingPoints;
+/**
+ * Returns the relative location of the given absolute location within the container.
+ *
+ * @param absoluteLocation absolute location
+ * @param container        container
+ * @return relative location if it can be determined, absolute location in case of error and null if the container
+ *         cannot contain any location.
+ */
+function getRelativeLocation(absoluteLocation, container) {
+    const allowNegativeCoordinates = container instanceof graph_1.GGraph;
+    if ((0, graph_1.isGBoundsAware)(container)) {
+        const relativePosition = absoluteToRelative(absoluteLocation, container);
+        const relativeLocation = allowNegativeCoordinates
+            ? relativePosition
+            : { x: Math.max(0, relativePosition.x), y: Math.max(0, relativePosition.y) };
+        return relativeLocation;
+    }
+    return undefined;
+}
+exports.getRelativeLocation = getRelativeLocation;
+/**
+ * Convert a point in absolute coordinates to a point relative to the specified GBoundsAware.
+ * Note: this method only works if the specified {@link GBoundsAware} is part of a
+ * hierarchy of {@link GBoundsAware}. If any of its parents (recursively) does not implement
+ * {@link GBoundsAware}, this method will throw an exception.
+ *
+ * @param absolutePoint
+ * @param modelElement
+ * @returns
+ *         A new point, relative to the coordinates space of the specified {@link GBoundsAware}
+ * @throws Error if the modelElement is not part of a {@link GBoundsAware} hierarchy
+ */
+function absoluteToRelative(absolutePoint, modelElement) {
+    var _a, _b, _c, _d;
+    let parentElement;
+    if (!(modelElement instanceof graph_1.GModelRoot)) {
+        parentElement = modelElement.parent;
+    }
+    let relativeToParent;
+    if (!parentElement) {
+        relativeToParent = { x: absolutePoint.x, y: absolutePoint.y };
+    }
+    else {
+        if (!(0, graph_1.isGBoundsAware)(parentElement)) {
+            throw new Error(`The element is not part of a GBoundsAware hierarchy: ${modelElement}`);
+        }
+        relativeToParent = absoluteToRelative(absolutePoint, parentElement);
+    }
+    const x = (_b = (_a = modelElement.position) === null || _a === void 0 ? void 0 : _a.x) !== null && _b !== void 0 ? _b : 0;
+    const y = (_d = (_c = modelElement.position) === null || _c === void 0 ? void 0 : _c.y) !== null && _d !== void 0 ? _d : 0;
+    return { x: relativeToParent.x - x, y: relativeToParent.y - y };
+}
+exports.absoluteToRelative = absoluteToRelative;
+//# sourceMappingURL=layout-util.js.map

package/lib/common/utils/layout-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-util.js","sourceRoot":"","sources":["../../../src/common/utils/layout-util.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAElF,+CAAuI;AAGvI,2CAAuC;AACvC,2DAAkE;AAElE;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,MAAwB,EAAE,KAAkB;IACpE,MAAM,OAAO,GAAG,IAAA,8BAAU,EAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,+BAA+B,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC5G,IAAI,IAAA,sBAAc,EAAC,OAAO,CAAC,EAAE;QACzB,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC;SACzC;QACD,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,OAAO,OAAO,CAAC;KAClB;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAVD,kCAUC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,SAA8B,EAAE,KAAkB;IAC7E,MAAM,OAAO,GAAG,IAAA,8BAAU,EAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IAClH,IAAI,IAAA,oBAAY,EAAC,OAAO,CAAC,EAAE;QACvB,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC;QAC3C,OAAO,OAAO,CAAC;KAClB;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAPD,wCAOC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,KAA8B,EAAE,KAAkB;;IACzE,MAAM,aAAa,GAAG,MAAA,KAAK,CAAC,gBAAgB,mCAAI,EAAE,CAAC;IACnD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,MAAM,IAAI,mCAAe,CAAC,gBAAgB,CAAC,CAAC;KAC/C;IACD,wDAAwD;IACxD,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC;IAE7C,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAG,CAAC;IAC1C,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAG,CAAC;IACxC,IAAI,CAAC,oBAAQ,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClD,IAAI,CAAC,oBAAQ,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClD,IAAI,CAAC,oBAAQ,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClD,IAAI,CAAC,oBAAQ,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC;AAChB,CAAC;AAjBD,gCAiBC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAW;IAChC,MAAM,WAAW,GAAG,oBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE;QACd,MAAM,IAAI,mCAAe,CAAC,wCAAwC,CAAC,CAAC;KACvE;IACD,MAAM,WAAW,GAAG,oBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE;QACd,MAAM,IAAI,mCAAe,CAAC,wCAAwC,CAAC,CAAC;KACvE;IACD,MAAM,KAAK,GAAY,EAAE,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;AAC3D,CAAC;AAdD,4BAcC;AAED,SAAgB,kBAAkB,CAAC,aAAsC,EAAE,KAAkB;;IACzF,MAAM,IAAI,GAAG,IAAA,8BAAU,EAAC,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,SAAS,EAAE,aAAK,CAAC,EAAE,+BAA+B,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACtI,IAAI,CAAC,aAAa,GAAG,MAAA,aAAa,CAAC,gBAAgB,mCAAI,EAAE,CAAC;IAC1D,OAAO,IAAI,CAAC;AAChB,CAAC;AAJD,gDAIC;AACD;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,gBAAuB,EAAE,SAAwB;IACjF,MAAM,wBAAwB,GAAG,SAAS,YAAY,cAAM,CAAC;IAC7D,IAAI,IAAA,sBAAc,EAAC,SAAS,CAAC,EAAE;QAC3B,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,gBAAgB,GAAG,wBAAwB;YAC7C,CAAC,CAAC,gBAAgB;YAClB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,OAAO,gBAAgB,CAAC;KAC3B;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAVD,kDAUC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,kBAAkB,CAAC,aAAoB,EAAE,YAA0C;;IAC/F,IAAI,aAAa,CAAC;IAClB,IAAI,CAAC,CAAC,YAAY,YAAY,kBAAU,CAAC,EAAE;QACvC,aAAa,GAAG,YAAY,CAAC,MAAM,CAAC;KACvC;IAED,IAAI,gBAAuB,CAAC;IAC5B,IAAI,CAAC,aAAa,EAAE;QAChB,gBAAgB,GAAG,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;KACjE;SAAM;QACH,IAAI,CAAC,IAAA,sBAAc,EAAC,aAAa,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,wDAAwD,YAAY,EAAE,CAAC,CAAC;SAC3F;QACD,gBAAgB,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;KACvE;IAED,MAAM,CAAC,GAAG,MAAA,MAAA,YAAY,CAAC,QAAQ,0CAAE,CAAC,mCAAI,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,MAAA,MAAA,YAAY,CAAC,QAAQ,0CAAE,CAAC,mCAAI,CAAC,CAAC;IAExC,OAAO,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;AACpE,CAAC;AApBD,gDAoBC"}

package/lib/common/utils/logger.d.ts

@@ -0,0 +1,27 @@
+export declare abstract class Logger {
+    abstract logLevel: LogLevel;
+    abstract caller?: string;
+    abstract info(message: string, ...params: any[]): void;
+    abstract warn(message: string, ...params: any[]): void;
+    abstract error(message: string, ...params: any[]): void;
+    abstract debug(message: string, ...params: any[]): void;
+}
+export declare class NullLogger extends Logger {
+    logLevel: LogLevel;
+    caller?: string | undefined;
+    info(message: string, ...params: any[]): void;
+    warn(message: string, ...params: any[]): void;
+    error(message: string, ...params: any[]): void;
+    debug(message: string, ...params: any[]): void;
+}
+export declare const LoggerFactory: unique symbol;
+export type LoggerFactory = (caller: string) => Logger;
+export declare enum LogLevel {
+    none = 0,
+    error = 1,
+    warn = 2,
+    info = 3,
+    debug = 4
+}
+export declare function asLogLevel(level: string | number): LogLevel | undefined;
+//# sourceMappingURL=logger.d.ts.map

package/lib/common/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/common/utils/logger.ts"],"names":[],"mappings":"AAiBA,8BACsB,MAAM;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAEtD,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAEtD,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAEvD,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;CAC1D;AAED,qBAAa,UAAW,SAAQ,MAAM;IAClC,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAG7C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAG7C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;IAG9C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI;CAGjD;AAED,eAAO,MAAM,aAAa,eAA0B,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AAEvD,oBAAY,QAAQ;IAChB,IAAI,IAAI;IACR,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;CACZ;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAUvE"}

package/lib/common/utils/logger.js

@@ -0,0 +1,67 @@
+"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 });
+exports.asLogLevel = exports.LogLevel = exports.LoggerFactory = exports.NullLogger = exports.Logger = void 0;
+/********************************************************************************
+ * 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
+ * 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 inversify_1 = require("inversify");
+let Logger = class Logger {
+};
+Logger = __decorate([
+    (0, inversify_1.injectable)()
+], Logger);
+exports.Logger = Logger;
+class NullLogger extends Logger {
+    info(message, ...params) {
+        // no-op
+    }
+    warn(message, ...params) {
+        // no-op
+    }
+    error(message, ...params) {
+        // no-op
+    }
+    debug(message, ...params) {
+        // no-op
+    }
+}
+exports.NullLogger = NullLogger;
+exports.LoggerFactory = Symbol('LoggerFactory');
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["none"] = 0] = "none";
+    LogLevel[LogLevel["error"] = 1] = "error";
+    LogLevel[LogLevel["warn"] = 2] = "warn";
+    LogLevel[LogLevel["info"] = 3] = "info";
+    LogLevel[LogLevel["debug"] = 4] = "debug";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+function asLogLevel(level) {
+    let levelKey = level;
+    if (typeof levelKey === 'string') {
+        levelKey = levelKey.toLowerCase();
+    }
+    if (levelKey in LogLevel) {
+        return LogLevel[level];
+    }
+    return undefined;
+}
+exports.asLogLevel = asLogLevel;
+//# sourceMappingURL=logger.js.map

package/lib/common/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/common/utils/logger.ts"],"names":[],"mappings":";;;;;;;;;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,yCAAuC;AAGhC,IAAe,MAAM,GAArB,MAAe,MAAM;CAY3B,CAAA;AAZqB,MAAM;IAD3B,IAAA,sBAAU,GAAE;GACS,MAAM,CAY3B;AAZqB,wBAAM;AAc5B,MAAa,UAAW,SAAQ,MAAM;IAGlC,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa;QAClC,QAAQ;IACZ,CAAC;IACD,IAAI,CAAC,OAAe,EAAE,GAAG,MAAa;QAClC,QAAQ;IACZ,CAAC;IACD,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa;QACnC,QAAQ;IACZ,CAAC;IACD,KAAK,CAAC,OAAe,EAAE,GAAG,MAAa;QACnC,QAAQ;IACZ,CAAC;CACJ;AAfD,gCAeC;AAEY,QAAA,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAIrD,IAAY,QAMX;AAND,WAAY,QAAQ;IAChB,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,uCAAQ,CAAA;IACR,uCAAQ,CAAA;IACR,yCAAS,CAAA;AACb,CAAC,EANW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMnB;AAED,SAAgB,UAAU,CAAC,KAAsB;IAC7C,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QAC9B,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;KACrC;IAED,IAAI,QAAQ,IAAI,QAAQ,EAAE;QACtB,OAAQ,QAAgB,CAAC,KAAK,CAAC,CAAC;KACnC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAVD,gCAUC"}

package/lib/common/utils/promise-queue.d.ts

@@ -0,0 +1,48 @@
+/********************************************************************************
+ * 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
+ * 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
+ ********************************************************************************/
+/**
+ * Description for promises that are put into a queue and
+ * resolved once dequeued.
+ */
+export interface PromiseQueueElement<T = void> {
+    promise: () => Promise<T>;
+    resolve: (value: T) => void;
+    reject: (reason?: any) => void;
+}
+/**
+ * A data structure that enables controlled,sequential resolving
+ * of promises. Promises that are put in this queue are processed one by one.
+ * i.e. After the first promise in the queue is resolved, it will be removed from the queue and the resolving of the
+ * the next promise (if present) will start. The queue can only resolve one promise at a given time.
+ */
+export declare class PromiseQueue<T = void> {
+    protected queue: PromiseQueueElement<T>[];
+    protected busy: boolean;
+    /**
+     * Add a {@link PromiseQueueElement} to the queue
+     * @param promise The element that should be queued
+     * @param atStart if `true` the element is added to the start of queue, otherwise it's added at queue end.
+     * @returns A promise of the queued promise that resolves once dequeued.
+     */
+    enqueue(promise: () => Promise<T>): Promise<T>;
+    protected dequeue(): boolean;
+    protected resolveQueuedPromise(element: PromiseQueueElement<T>): Promise<void>;
+    get isBusy(): boolean;
+    get size(): number;
+    get isEmpty(): boolean;
+    clear(): void;
+}
+//# sourceMappingURL=promise-queue.d.ts.map

package/lib/common/utils/promise-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-queue.d.ts","sourceRoot":"","sources":["../../../src/common/utils/promise-queue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAElF;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,GAAG,IAAI;IACzC,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1B,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAClC;AAED;;;;;GAKG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,IAAI;IAC9B,SAAS,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAM;IAC/C,SAAS,CAAC,IAAI,UAAS;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAY9C,SAAS,CAAC,OAAO,IAAI,OAAO;cAqBZ,oBAAoB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAYpF,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,KAAK,IAAI,IAAI;CAGhB"}

package/lib/common/utils/promise-queue.js

@@ -0,0 +1,93 @@
+"use strict";
+/********************************************************************************
+ * 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
+ * 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
+ ********************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromiseQueue = void 0;
+/**
+ * A data structure that enables controlled,sequential resolving
+ * of promises. Promises that are put in this queue are processed one by one.
+ * i.e. After the first promise in the queue is resolved, it will be removed from the queue and the resolving of the
+ * the next promise (if present) will start. The queue can only resolve one promise at a given time.
+ */
+class PromiseQueue {
+    constructor() {
+        this.queue = [];
+        this.busy = false;
+    }
+    /**
+     * Add a {@link PromiseQueueElement} to the queue
+     * @param promise The element that should be queued
+     * @param atStart if `true` the element is added to the start of queue, otherwise it's added at queue end.
+     * @returns A promise of the queued promise that resolves once dequeued.
+     */
+    enqueue(promise) {
+        return new Promise((resolve, reject) => {
+            const element = {
+                promise,
+                resolve,
+                reject
+            };
+            this.queue.push(element);
+            this.dequeue();
+        });
+    }
+    dequeue() {
+        if (this.busy) {
+            return false;
+        }
+        const element = this.queue.shift();
+        if (!element) {
+            return false;
+        }
+        try {
+            this.busy = true;
+            this.resolveQueuedPromise(element);
+        }
+        catch (error) {
+            element.reject(error);
+            this.busy = false;
+            this.dequeue();
+        }
+        return true;
+    }
+    async resolveQueuedPromise(element) {
+        try {
+            const value = await element.promise();
+            return element.resolve(value);
+        }
+        catch (error) {
+            element.reject(error);
+        }
+        finally {
+            this.busy = false;
+            this.dequeue();
+        }
+    }
+    get isBusy() {
+        return this.busy;
+    }
+    get size() {
+        return this.queue.length;
+    }
+    get isEmpty() {
+        return this.queue.length === 0;
+    }
+    clear() {
+        this.queue = [];
+    }
+}
+exports.PromiseQueue = PromiseQueue;
+//# sourceMappingURL=promise-queue.js.map

package/lib/common/utils/promise-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-queue.js","sourceRoot":"","sources":["../../../src/common/utils/promise-queue.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;kFAckF;;;AAYlF;;;;;GAKG;AACH,MAAa,YAAY;IAAzB;QACc,UAAK,GAA6B,EAAE,CAAC;QACrC,SAAI,GAAG,KAAK,CAAC;IAoE3B,CAAC;IAlEG;;;;;OAKG;IACH,OAAO,CAAC,OAAyB;QAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG;gBACZ,OAAO;gBACP,OAAO;gBACP,MAAM;aACT,CAAC;YACF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAES,OAAO;QACb,IAAI,IAAI,CAAC,IAAI,EAAE;YACX,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;QAED,IAAI;YACA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;YAClB,IAAI,CAAC,OAAO,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,oBAAoB,CAAC,OAA+B;QAChE,IAAI;YACA,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACtC,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACjC;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACzB;gBAAS;YACN,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;YAClB,IAAI,CAAC,OAAO,EAAE,CAAC;SAClB;IACL,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,KAAK;QACD,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IACpB,CAAC;CACJ;AAtED,oCAsEC"}

package/lib/common/utils/promise-queue.spec.d.ts

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

package/lib/common/utils/promise-queue.spec.d.ts.map

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

package/lib/common/utils/promise-queue.spec.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/********************************************************************************
+ * 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
+ * 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 mock_util_1 = require("../test/mock-util");
+const promise_queue_1 = require("./promise-queue");
+const chai_1 = require("chai");
+// Helper types and functions that are needed for test setup
+/**
+ * Helper class to inspect the state of promise during its resolve() execution.
+ */
+class PromiseState {
+    constructor() {
+        this._started = false;
+        this._stopped = false;
+    }
+    start() {
+        this._started = true;
+        if (this.onStartRunnable) {
+            this.onStartRunnable();
+        }
+    }
+    stop() {
+        this._stopped = true;
+        if (this.onStopRunnable) {
+            this.onStopRunnable();
+        }
+    }
+    onStart(runnable) {
+        this.onStartRunnable = runnable;
+    }
+    onStop(runnable) {
+        this.onStopRunnable = runnable;
+    }
+    get started() {
+        return this._started;
+    }
+    get stopped() {
+        return this._stopped;
+    }
+}
+function newTestPromise(resolveTime) {
+    const state = new PromiseState();
+    const promise = async () => {
+        state.start();
+        await (0, mock_util_1.delay)(resolveTime);
+        state.stop();
+    };
+    return { state, promise };
+}
+let queue = new promise_queue_1.PromiseQueue();
+// Test execution
+describe('test PromiseQueue', () => {
+    beforeEach(() => {
+        queue = new promise_queue_1.PromiseQueue();
+    });
+    it('enqueue - one element', async () => {
+        const { state, promise } = newTestPromise(100);
+        state.onStart(() => {
+            (0, chai_1.expect)(queue.isBusy).true;
+        });
+        const queEnd = queue.enqueue(promise);
+        (0, chai_1.expect)(queue.isEmpty).true;
+        await queEnd;
+    });
+    it('enqueue - two elements', async () => {
+        const p1 = newTestPromise(100);
+        p1.state.onStop(() => (0, chai_1.expect)(p2.state.started).false);
+        const p2 = newTestPromise(100);
+        p2.state.onStart(() => {
+            (0, chai_1.expect)(queue.isEmpty).true;
+            (0, chai_1.expect)(p1.state.stopped).true;
+        });
+        queue.enqueue(p1.promise);
+        const queEnd = queue.enqueue(p2.promise);
+        (0, chai_1.expect)(queue.size).to.be.equal(1);
+        await queEnd;
+    });
+    it('enqueue - three elements (first promise in queue has longest resolve time)', async () => {
+        const p1 = newTestPromise(300);
+        p1.state.onStop(() => {
+            (0, chai_1.expect)(p2.state.started).false;
+            (0, chai_1.expect)(p3.state.started).false;
+        });
+        const p2 = newTestPromise(200);
+        p2.state.onStart(() => {
+            (0, chai_1.expect)(queue.size).to.be.equal(1);
+            (0, chai_1.expect)(p1.state.stopped).true;
+            (0, chai_1.expect)(p3.state.started).false;
+        });
+        const p3 = newTestPromise(100);
+        p3.state.onStart(() => {
+            (0, chai_1.expect)(queue.isEmpty).true;
+            (0, chai_1.expect)(p2.state.stopped).true;
+        });
+        queue.enqueue(p1.promise);
+        queue.enqueue(p2.promise);
+        (0, chai_1.expect)(queue.size).to.be.equal(1);
+        const queueEnd = queue.enqueue(p3.promise);
+        (0, chai_1.expect)(queue.size).to.be.equal(2);
+        await queueEnd;
+    });
+});
+//# sourceMappingURL=promise-queue.spec.js.map

package/lib/common/utils/promise-queue.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-queue.spec.js","sourceRoot":"","sources":["../../../src/common/utils/promise-queue.spec.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;kFAckF;AAClF,iDAA0C;AAC1C,mDAA+C;AAC/C,+BAA8B;AAE9B,4DAA4D;AAE5D;;GAEG;AACH,MAAM,YAAY;IAAlB;QACY,aAAQ,GAAG,KAAK,CAAC;QACjB,aAAQ,GAAG,KAAK,CAAC;IAiC7B,CAAC;IA7BG,KAAK;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,eAAe,EAAE,CAAC;SAC1B;IACL,CAAC;IAED,IAAI;QACA,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,IAAI,CAAC,cAAc,EAAE,CAAC;SACzB;IACL,CAAC;IAED,OAAO,CAAC,QAAoB;QACxB,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAoB;QACvB,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;IACnC,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ;AAOD,SAAS,cAAc,CAAC,WAAmB;IACvC,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,KAAK,IAAmB,EAAE;QACtC,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,MAAM,IAAA,iBAAK,EAAC,WAAW,CAAC,CAAC;QACzB,KAAK,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,IAAI,KAAK,GAAG,IAAI,4BAAY,EAAE,CAAC;AAE/B,iBAAiB;AACjB,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACZ,KAAK,GAAG,IAAI,4BAAY,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/C,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;YACf,IAAA,aAAM,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,IAAA,aAAM,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;QAC3B,MAAM,MAAM,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;QAEtD,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAE/B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;YAClB,IAAA,aAAM,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YAC3B,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,MAAM,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE;YACjB,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;YAC/B,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;YAClB,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClC,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YAC9B,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;YAClB,IAAA,aAAM,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YAC3B,IAAA,aAAM,EAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC1B,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,QAAQ,CAAC;IACnB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/common/utils/registry.d.ts

@@ -0,0 +1,73 @@
+/**
+ * A registry manages a set of key-value pairs and provides query functionality. In GLSP this is typically used to
+ * provide a convenience API for working with multi-injected instances e.g. action handlers or
+ * operation handlers.
+ *
+ * @typeParam K Key type
+ * @param V Value type
+ */
+export declare class Registry<K, V> {
+    protected elements: Map<K, V>;
+    /**
+     * Registers a new key-value pair.
+     *
+     * @param key     The key object.
+     * @param element The value object.
+     * @returns `true` if the pair was registered successfully, `false` if another pair with the same key is already
+     *         registered.
+     */
+    register(key: K, instance: V): boolean;
+    /**
+     * Removes the value with the given key from the registry.
+     *
+     * @param key The key of the value which should be removed.
+     * @returns `true` if the value was removed successfully, `false` if no value was registered for the given key.
+     */
+    deregister(key: K): boolean;
+    /**
+     * Queries the registry to check whether a value for the given key is registered.
+     *
+     * @param key The key which should be checked.
+     * @returns `true` if a key-value pair is registered for the given key, `false` otherwise.
+     */
+    hasKey(key: K): boolean;
+    /**
+     * Retrieve the value for the given key.
+     *
+     * @param key The key whose value should be retrieved.
+     * @returns The registered value or `undefined`. Is `undefined` if no value was registered for the given key.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Retrieve all registered values from the registry.
+     *
+     * @returns An array of all registered keys.
+     */
+    getAll(): V[];
+    /**
+     * Retrieve all registered keys from the registry.
+     *
+     * @returns An array of all registered keys.
+     */
+    keys(): K[];
+}
+/**
+ * A multi registry is used to manage a set of key-value pairs. The main difference to {@link Registry} is that
+ * a multi registry doesn't enforce a 1-1 relation between key and value(s).
+ * One key can be associated with multiple values.
+ *
+ *
+ * @typeParam K  Type of the key
+ * @param V Type of the values
+ */
+export declare class MultiRegistry<K, V> {
+    protected elements: Map<K, V[]>;
+    register(key: K, instance: V): void;
+    deregister(key: K, element: V): boolean;
+    deregisterAll(key: K): boolean;
+    get(key: K): V[];
+    hasKey(key: K): boolean;
+    getAll(): V[];
+    keys(): K[];
+}
+//# sourceMappingURL=registry.d.ts.map

package/lib/common/utils/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/common/utils/registry.ts"],"names":[],"mappings":"AAkBA;;;;;;;GAOG;AAEH,qBACa,QAAQ,CAAC,CAAC,EAAE,CAAC;IACtB,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO;IAQtC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAI3B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIvB;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAI1B;;;;OAIG;IAEH,MAAM,IAAI,CAAC,EAAE;IAIb;;;;OAIG;IACH,IAAI,IAAI,CAAC,EAAE;CAGd;AAED;;;;;;;;GAQG;AACH,qBACa,aAAa,CAAC,CAAC,EAAE,CAAC;IAC3B,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAa;IAE5C,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI;IASnC,UAAU,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO;IASvC,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAI9B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE;IAShB,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIvB,MAAM,IAAI,CAAC,EAAE;IAMb,IAAI,IAAI,CAAC,EAAE;CAGd"}