@theia/core 1.67.0-next.56 → 1.67.0-next.86

package/lib/common/menu/menu-model-registry.js

@@ -0,0 +1,303 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2017 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+var MenuModelRegistry_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MenuModelRegistry = exports.MenuNodeFactory = exports.StructuralMenuChange = exports.ChangeKind = exports.MenuContribution = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("inversify");
+const menu_types_1 = require("./menu-types");
+const contribution_provider_1 = require("../contribution-provider");
+const command_1 = require("../command");
+const event_1 = require("../event");
+const disposable_1 = require("../disposable");
+exports.MenuContribution = Symbol('MenuContribution');
+var ChangeKind;
+(function (ChangeKind) {
+    ChangeKind[ChangeKind["ADDED"] = 0] = "ADDED";
+    ChangeKind[ChangeKind["REMOVED"] = 1] = "REMOVED";
+    ChangeKind[ChangeKind["CHANGED"] = 2] = "CHANGED";
+    ChangeKind[ChangeKind["LINKED"] = 3] = "LINKED";
+})(ChangeKind || (exports.ChangeKind = ChangeKind = {}));
+var StructuralMenuChange;
+(function (StructuralMenuChange) {
+    function is(evt) {
+        return evt.kind !== ChangeKind.CHANGED;
+    }
+    StructuralMenuChange.is = is;
+})(StructuralMenuChange || (exports.StructuralMenuChange = StructuralMenuChange = {}));
+exports.MenuNodeFactory = Symbol('MenuNodeFactory');
+/**
+ * The MenuModelRegistry allows to register and unregister menus, submenus and actions
+ * via strings and {@link MenuAction}s without the need to access the underlying UI
+ * representation.
+ */
+let MenuModelRegistry = MenuModelRegistry_1 = class MenuModelRegistry {
+    constructor(contributions, commands, menuNodeFactory) {
+        this.contributions = contributions;
+        this.commands = commands;
+        this.menuNodeFactory = menuNodeFactory;
+        this.onDidChangeEmitter = new event_1.Emitter();
+        this.isReady = false;
+        this.root = this.menuNodeFactory.createGroup('root', 'root');
+        this.root.addNode(this.menuNodeFactory.createGroup(menu_types_1.MAIN_MENU_BAR[0]));
+    }
+    get onDidChange() {
+        return this.onDidChangeEmitter.event;
+    }
+    onStart() {
+        for (const contrib of this.contributions.getContributions()) {
+            contrib.registerMenus(this);
+        }
+        this.isReady = true;
+    }
+    /**
+     * Adds the given menu action to the menu denoted by the given path.
+     *
+     * @returns a disposable which, when called, will remove the menu action again.
+     */
+    registerCommandMenu(menuPath, item) {
+        const parent = this.root.getOrCreate(menuPath, 0, menuPath.length);
+        parent.addNode(item);
+        return disposable_1.Disposable.create(() => {
+            parent.removeNode(item);
+            this.fireChangeEvent({
+                kind: ChangeKind.REMOVED,
+                path: menuPath.slice(0, menuPath.length - 1),
+                affectedChildId: item.id
+            });
+        });
+    }
+    /**
+     * Adds the given menu action to the menu denoted by the given path.
+     *
+     * @returns a disposable which, when called, will remove the menu action again.
+     */
+    registerMenuAction(menuPath, item) {
+        const parent = this.root.getOrCreate(menuPath, 0, menuPath.length);
+        const node = this.menuNodeFactory.createCommandMenu(item);
+        parent.addNode(node);
+        return disposable_1.Disposable.create(() => {
+            parent.removeNode(node);
+            this.fireChangeEvent({
+                kind: ChangeKind.REMOVED,
+                path: menuPath.slice(0, menuPath.length - 1),
+                affectedChildId: node.id
+            });
+        });
+    }
+    /**
+     * Register a new menu at the given path with the given label.
+     * (If the menu already exists without a label, iconClass or order this method can be used to set them.)
+     *
+     * @param menuPath the path for which a new submenu shall be registered.
+     * @param label the label to be used for the new submenu.
+     * @param options optionally allows to set an icon class and specify the order of the new menu.
+     *
+     * @returns if the menu was successfully created a disposable will be returned which,
+     * when called, will remove the menu again. If the menu already existed a no-op disposable
+     * will be returned.
+     *
+     * Note that if the menu already existed and was registered with a different label an error
+     * will be thrown.
+     */
+    registerSubmenu(menuPath, label, options = {}) {
+        const { contextKeyOverlay, sortString, icon, when } = options;
+        const parent = this.root.getOrCreate(menuPath, 0, menuPath.length - 1);
+        const existing = parent.children.find(node => node.id === menuPath[menuPath.length - 1]);
+        if (menu_types_1.Group.is(existing)) {
+            parent.removeNode(existing);
+            const newMenu = this.menuNodeFactory.createSubmenu(menuPath[menuPath.length - 1], label, contextKeyOverlay, sortString, icon, when);
+            newMenu.addNode(...existing.children);
+            parent.addNode(newMenu);
+            this.fireChangeEvent({
+                kind: ChangeKind.CHANGED,
+                path: menuPath
+            });
+            return disposable_1.Disposable.create(() => {
+                parent.removeNode(newMenu);
+                this.fireChangeEvent({
+                    kind: ChangeKind.REMOVED,
+                    path: menuPath.slice(0, menuPath.length - 1),
+                    affectedChildId: newMenu.id
+                });
+            });
+        }
+        else {
+            const newMenu = this.menuNodeFactory.createSubmenu(menuPath[menuPath.length - 1], label, contextKeyOverlay, sortString, icon, when);
+            parent.addNode(newMenu);
+            this.fireChangeEvent({
+                kind: ChangeKind.ADDED,
+                path: menuPath.slice(0, menuPath.length - 1),
+                affectedChildId: newMenu.id
+            });
+            return disposable_1.Disposable.create(() => {
+                parent.removeNode(newMenu);
+                this.fireChangeEvent({
+                    kind: ChangeKind.REMOVED,
+                    path: menuPath.slice(0, menuPath.length - 1),
+                    affectedChildId: newMenu.id
+                });
+            });
+        }
+    }
+    linkCompoundMenuNode(params) {
+        const { newParentPath, submenuPath, order, when } = params;
+        // add a wrapper here
+        let i = 0;
+        while (i < newParentPath.length && i < submenuPath.length && newParentPath[i] === submenuPath[i]) {
+            i++;
+        }
+        if (i === newParentPath.length || i === submenuPath.length) {
+            throw new Error(`trying to recursively link ${JSON.stringify(submenuPath)} into ${JSON.stringify(newParentPath)}`);
+        }
+        const child = this.getMenu(submenuPath);
+        if (!child) {
+            throw new Error(`Not a menu node: ${JSON.stringify(submenuPath)}`);
+        }
+        const newParent = this.root.getOrCreate(newParentPath, 0, newParentPath.length);
+        if (menu_types_1.MutableCompoundMenuNode.is(newParent)) {
+            const link = this.menuNodeFactory.createSubmenuLink(child, order, when);
+            newParent.addNode(link);
+            this.fireChangeEvent({
+                kind: ChangeKind.LINKED,
+                path: newParentPath,
+                affectedChildId: child.id
+            });
+            return disposable_1.Disposable.create(() => {
+                newParent.removeNode(link);
+                this.fireChangeEvent({
+                    kind: ChangeKind.REMOVED,
+                    path: newParentPath,
+                    affectedChildId: child.id
+                });
+            });
+        }
+        else {
+            throw new Error(`Not a compound menu node: ${JSON.stringify(newParentPath)}`);
+        }
+    }
+    unregisterMenuAction(itemOrCommandOrId, menuPath = []) {
+        const id = menu_types_1.MenuAction.is(itemOrCommandOrId) ? itemOrCommandOrId.commandId
+            : command_1.Command.is(itemOrCommandOrId) ? itemOrCommandOrId.id
+                : itemOrCommandOrId;
+        const parent = this.findInNode(this.root, menuPath, 0);
+        if (parent) {
+            this.removeActionInSubtree(parent, id);
+        }
+    }
+    removeActionInSubtree(parent, id) {
+        if (menu_types_1.MutableCompoundMenuNode.is(parent) && menu_types_1.CompoundMenuNode.is(parent)) {
+            const action = parent.children.find(child => child.id === id);
+            if (action) {
+                parent.removeNode(action);
+            }
+            parent.children.forEach(child => this.removeActionInSubtree(child, id));
+        }
+    }
+    findInNode(root, menuPath, pathIndex) {
+        if (pathIndex === menuPath.length) {
+            return root;
+        }
+        if (menu_types_1.CompoundMenuNode.is(root)) {
+            const child = root.children.find(c => c.id === menuPath[pathIndex]);
+            if (child) {
+                return this.findInNode(child, menuPath, pathIndex + 1);
+            }
+        }
+        return undefined;
+    }
+    getMenuNode(menuPath) {
+        return this.findInNode(this.root, menuPath, 0);
+    }
+    getMenu(menuPath) {
+        const node = this.getMenuNode(menuPath);
+        if (!node) {
+            return undefined;
+        }
+        if (!menu_types_1.CompoundMenuNode.is(node)) {
+            throw new Error(`not a compound menu node: ${JSON.stringify(menuPath)}`);
+        }
+        return node;
+    }
+    static removeSingleRootNodes(fullMenuModel) {
+        let current = fullMenuModel;
+        let previous = undefined;
+        while (current !== previous) {
+            previous = current;
+            current = this.removeSingleRootNode(current);
+        }
+        return current;
+    }
+    /**
+     * Checks the given menu model whether it will show a menu with a single submenu.
+     *
+     * @param fullMenuModel the menu model to analyze
+     * @param menuPath the menu's path
+     * @returns if the menu will show a single submenu this returns a menu that will show the child elements of the submenu,
+     * otherwise the given `fullMenuModel` is return
+     */
+    static removeSingleRootNode(fullMenuModel) {
+        let singleChild = undefined;
+        for (const child of fullMenuModel.children) {
+            if (menu_types_1.CompoundMenuNode.is(child)) {
+                if (!MenuModelRegistry_1.isEmpty(child)) {
+                    if (singleChild) {
+                        return fullMenuModel;
+                    }
+                    else {
+                        singleChild = child;
+                    }
+                }
+            }
+            else {
+                return fullMenuModel;
+            }
+        }
+        return singleChild || fullMenuModel;
+    }
+    static isEmpty(node) {
+        if (menu_types_1.CompoundMenuNode.is(node)) {
+            if (node.children.length === 0) {
+                return true;
+            }
+            for (const child of node.children) {
+                if (!MenuModelRegistry_1.isEmpty(child)) {
+                    return false;
+                }
+            }
+        }
+        else {
+            return false;
+        }
+        return true;
+    }
+    fireChangeEvent(evt) {
+        if (this.isReady) {
+            this.onDidChangeEmitter.fire(evt);
+        }
+    }
+};
+exports.MenuModelRegistry = MenuModelRegistry;
+exports.MenuModelRegistry = MenuModelRegistry = MenuModelRegistry_1 = tslib_1.__decorate([
+    (0, inversify_1.injectable)(),
+    tslib_1.__param(0, (0, inversify_1.inject)(contribution_provider_1.ContributionProvider)),
+    tslib_1.__param(0, (0, inversify_1.named)(exports.MenuContribution)),
+    tslib_1.__param(1, (0, inversify_1.inject)(command_1.CommandRegistry)),
+    tslib_1.__param(2, (0, inversify_1.inject)(exports.MenuNodeFactory)),
+    tslib_1.__metadata("design:paramtypes", [Object, command_1.CommandRegistry, Object])
+], MenuModelRegistry);
+//# sourceMappingURL=menu-model-registry.js.map

package/lib/common/menu/menu-model-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-model-registry.js","sourceRoot":"","sources":["../../../src/common/menu/menu-model-registry.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;;;AAEhF,yCAAsD;AACtD,6CAAqJ;AAErJ,oEAAgE;AAChE,wCAAsD;AACtD,oCAAmC;AACnC,8CAA2C;AAE9B,QAAA,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAoC3D,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,6CAAK,CAAA;IACL,iDAAO,CAAA;IACP,iDAAO,CAAA;IACP,+CAAM,CAAA;AACV,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAYD,IAAiB,oBAAoB,CAIpC;AAJD,WAAiB,oBAAoB;IACjC,SAAgB,EAAE,CAAC,GAAqB;QACpC,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC;IAC3C,CAAC;IAFe,uBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,oBAAoB,oCAApB,oBAAoB,QAIpC;AACY,QAAA,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAUzD;;;;GAIG;AAEI,IAAM,iBAAiB,yBAAvB,MAAM,iBAAiB;IAK1B,YAEI,aAAwE,EAExE,QAA4C,EAE5C,eAAmD;QAJhC,kBAAa,GAAb,aAAa,CAAwC;QAErD,aAAQ,GAAR,QAAQ,CAAiB;QAEzB,oBAAe,GAAf,eAAe,CAAiB;QARpC,uBAAkB,GAAG,IAAI,eAAO,EAAoB,CAAC;QAiB9D,YAAO,GAAG,KAAK,CAAC;QARtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,0BAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC;IACzC,CAAC;IAID,OAAO;QACH,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE,CAAC;YAC1D,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,QAAkB,EAAE,IAAiB;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrB,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;YAC1B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;gBACxB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC5C,eAAe,EAAE,IAAI,CAAC,EAAE;aAC3B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAkB,EAAE,IAAgB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrB,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;YAC1B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;gBACxB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC5C,eAAe,EAAE,IAAI,CAAC,EAAE;aAC3B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IAEP,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,QAAkB,EAAE,KAAa,EAC7C,UAA6G,EAAE;QAC/G,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAE9D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACzF,IAAI,kBAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACpI,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;gBACxB,IAAI,EAAE,QAAQ;aACjB,CAAC,CAAC;YACH,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC1B,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC;oBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;oBACxB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;oBAC5C,eAAe,EAAE,OAAO,CAAC,EAAE;iBAC9B,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACpI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,KAAK;gBACtB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC5C,eAAe,EAAE,OAAO,CAAC,EAAE;aAC9B,CAAC,CAAC;YACH,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC1B,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC;oBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;oBACxB,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;oBAC5C,eAAe,EAAE,OAAO,CAAC,EAAE;iBAC9B,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,oBAAoB,CAAC,MAAyF;QAC1G,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3D,qBAAqB;QACrB,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/F,CAAC,EAAE,CAAC;QACR,CAAC;QAED,IAAI,CAAC,KAAK,aAAa,CAAC,MAAM,IAAI,CAAC,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACvH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAY,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QAChF,IAAI,oCAAuB,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACxE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,MAAM;gBACvB,IAAI,EAAE,aAAa;gBACnB,eAAe,EAAE,KAAK,CAAC,EAAE;aAC5B,CAAC,CAAC;YACH,OAAO,uBAAU,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC1B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC;oBACjB,IAAI,EAAE,UAAU,CAAC,OAAO;oBACxB,IAAI,EAAE,aAAa;oBACnB,eAAe,EAAE,KAAK,CAAC,EAAE;iBAC5B,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;IACL,CAAC;IAuBD,oBAAoB,CAAC,iBAAgD,EAAE,WAAqB,EAAE;QAC1F,MAAM,EAAE,GAAG,uBAAU,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS;YACrE,CAAC,CAAC,iBAAO,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,EAAE;gBAClD,CAAC,CAAC,iBAAiB,CAAC;QAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACvD,IAAI,MAAM,EAAE,CAAC;YACT,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAES,qBAAqB,CAAC,MAAgB,EAAE,EAAU;QACxD,IAAI,oCAAuB,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,6BAAgB,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACpE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9D,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC;YACD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5E,CAAC;IACL,CAAC;IAES,UAAU,CAAC,IAAc,EAAE,QAAkB,EAAE,SAAiB;QACtE,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,6BAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;YACpE,IAAI,KAAK,EAAE,CAAC;gBACR,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;YAC3D,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,WAAW,CAAC,QAAkB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,CAAC,QAAkB;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,6BAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,qBAAqB,CAAC,aAA+B;QACxD,IAAI,OAAO,GAAG,aAAa,CAAC;QAC5B,IAAI,QAAQ,GAAG,SAAS,CAAC;QACzB,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC1B,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,oBAAoB,CAAC,aAA+B;QAEvD,IAAI,WAAW,GAAG,SAAS,CAAC;QAE5B,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;YACzC,IAAI,6BAAgB,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,mBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpC,IAAI,WAAW,EAAE,CAAC;wBACd,OAAO,aAAa,CAAC;oBACzB,CAAC;yBAAM,CAAC;wBACJ,WAAW,GAAG,KAAK,CAAC;oBACxB,CAAC;gBACL,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,OAAO,aAAa,CAAC;YACzB,CAAC;QACL,CAAC;QACD,OAAO,WAAW,IAAI,aAAa,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAc;QACzB,IAAI,6BAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,mBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,KAAK,CAAC;gBACjB,CAAC;YACL,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,eAAe,CAA6B,GAAM;QACxD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;CACJ,CAAA;AAnSY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,sBAAU,GAAE;IAOJ,mBAAA,IAAA,kBAAM,EAAC,4CAAoB,CAAC,CAAA;IAAE,mBAAA,IAAA,iBAAK,EAAC,wBAAgB,CAAC,CAAA;IAErD,mBAAA,IAAA,kBAAM,EAAC,yBAAe,CAAC,CAAA;IAEvB,mBAAA,IAAA,kBAAM,EAAC,uBAAe,CAAC,CAAA;qDADK,yBAAe;GATvC,iBAAiB,CAmS7B"}

package/lib/common/menu/menu-types.d.ts

@@ -0,0 +1,113 @@
+import { Event } from '../event';
+export declare const MAIN_MENU_BAR: MenuPath;
+export type MenuPath = string[];
+export declare const MANAGE_MENU: MenuPath;
+export declare const ACCOUNTS_MENU: MenuPath;
+export declare const ACCOUNTS_SUBMENU: string[];
+export interface ContextExpressionMatcher<T> {
+    match(whenExpression: string, context: T | undefined): boolean;
+}
+/**
+ * @internal For most use cases, refer to {@link MenuAction} or {@link MenuNode}
+ */
+export interface MenuNode {
+    /**
+     * technical identifier.
+     */
+    readonly id: string;
+    /**
+     * Menu nodes are sorted in ascending order based on their `sortString`.
+     */
+    readonly sortString: string;
+    readonly effectiveMenuPath?: string[];
+    isVisible<T>(effectiveMenuPath: MenuPath, contextMatcher: ContextExpressionMatcher<T>, context: T | undefined, ...args: unknown[]): boolean;
+    onDidChange?: Event<void>;
+}
+export interface Action {
+    isEnabled(effectiveMenuPath: MenuPath, ...args: unknown[]): boolean;
+    isToggled(effectiveMenuPath: MenuPath, ...args: unknown[]): boolean;
+    run(effectiveMenuPath: MenuPath, ...args: unknown[]): Promise<void>;
+}
+export declare namespace Action {
+    function is(node: object): node is Action;
+}
+export interface MenuAction {
+    /**
+     * The command to execute.
+     */
+    readonly commandId: string;
+    /**
+     * Menu entries are sorted in ascending order based on their `order` strings. If omitted the determined
+     * label will be used instead.
+     */
+    readonly order?: string;
+    readonly label?: string;
+    /**
+     * Icon classes for the menu node. If present, these will produce an icon to the left of the label in browser-style menus.
+     */
+    readonly icon?: string;
+    readonly when?: string;
+}
+export declare namespace MenuAction {
+    function is(obj: unknown): obj is MenuAction;
+}
+/**
+ * Metadata for the visual presentation of a node.
+ * @internal For most uses cases, refer to {@link MenuNode}, {@link CommandMenuNode}, or {@link CompoundMenuNode}
+ */
+export interface RenderedMenuNode extends MenuNode {
+    /**
+     * Optional label. Will be rendered as text of the menu item.
+     */
+    readonly label: string;
+    /**
+     * Icon classes for the menu node. If present, these will produce an icon to the left of the label in browser-style menus.
+     */
+    readonly icon?: string;
+}
+export declare namespace RenderedMenuNode {
+    function is(node: unknown): node is RenderedMenuNode;
+}
+export type CommandMenu = MenuNode & RenderedMenuNode & Action;
+export declare namespace CommandMenu {
+    function is(node: MenuNode | undefined): node is CommandMenu;
+}
+export type Group = CompoundMenuNode;
+export declare namespace Group {
+    function is(obj: unknown): obj is Group;
+}
+export type Submenu = CompoundMenuNode & RenderedMenuNode;
+export interface CompoundMenuNode extends MenuNode {
+    children: MenuNode[];
+    contextKeyOverlays?: Record<string, string>;
+    /**
+     * Whether the group or submenu contains any visible children
+     *
+     * @param effectiveMenuPath The menu path where visibility is checked
+     * @param contextMatcher The context matcher to use
+     * @param context the context to use
+     * @param args the command arguments, if applicable
+     */
+    isEmpty<T>(effectiveMenuPath: MenuPath, contextMatcher: ContextExpressionMatcher<T>, context: T | undefined, ...args: unknown[]): boolean;
+}
+export declare namespace CompoundMenuNode {
+    function is(node?: unknown): node is CompoundMenuNode;
+    function sortChildren(m1: MenuNode, m2: MenuNode): number;
+    /**
+     * Indicates whether the given node is the special `navigation` menu.
+     *
+     * @param node the menu node to check.
+     * @returns `true` when the given node is a {@link CompoundMenuNode} with id `navigation`,
+     * `false` otherwise.
+     */
+    function isNavigationGroup(node: MenuNode): node is CompoundMenuNode;
+}
+export interface MutableCompoundMenuNode {
+    addNode(...node: MenuNode[]): void;
+    removeNode(node: MenuNode): void;
+    getOrCreate(menuPath: MenuPath, pathIndex: number, endIndex: number): CompoundMenuNode & MutableCompoundMenuNode;
+}
+export declare namespace MutableCompoundMenuNode {
+    function is(node: unknown): node is MutableCompoundMenuNode;
+}
+//# sourceMappingURL=menu-types.d.ts.map

package/lib/common/menu/menu-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-types.d.ts","sourceRoot":"","sources":["../../../src/common/menu/menu-types.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAGjC,eAAO,MAAM,aAAa,EAAE,QAAsB,CAAC;AACnD,MAAM,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC;AAChC,eAAO,MAAM,WAAW,EAAE,QAA0B,CAAC;AACrD,eAAO,MAAM,aAAa,EAAE,QAA4B,CAAC;AACzD,eAAO,MAAM,gBAAgB,UAA2C,CAAC;AAEzE,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACvC,KAAK,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IACtC,SAAS,CAAC,CAAC,EAAE,iBAAiB,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5I,WAAW,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,MAAM;IACnB,SAAS,CAAC,iBAAiB,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACpE,SAAS,CAAC,iBAAiB,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACpE,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE;AAED,yBAAiB,MAAM,CAAC;IACpB,SAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,MAAM,CAE/C;CACJ;AAED,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,UAAU,CAAC;IACxB,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAElD;CACJ;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAC9C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,gBAAgB,CAAC;IAC9B,SAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,gBAAgB,CAE1D;CACJ;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,gBAAgB,GAAG,MAAM,CAAC;AAE/D,yBAAiB,WAAW,CAAC;IACzB,SAAgB,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,IAAI,WAAW,CAElE;CACJ;AAED,MAAM,MAAM,KAAK,GAAG,gBAAgB,CAAC;AACrC,yBAAiB,KAAK,CAAC;IACnB,SAAgB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,KAAK,CAE7C;CACJ;AAED,MAAM,MAAM,OAAO,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAE1D,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAC9C,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;CAC7I;AAED,yBAAiB,gBAAgB,CAAC;IAC9B,SAAgB,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,IAAI,gBAAgB,CAA6E;IAEzI,SAAgB,YAAY,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,GAAG,MAAM,CAS/D;IAED;;;;;;OAMG;IACH,SAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,IAAI,gBAAgB,CAE1E;CACJ;AAED,MAAM,WAAW,uBAAuB;IACpC,OAAO,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IACnC,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACjC,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,uBAAuB,CAAC;CACpH;AAED,yBAAiB,uBAAuB,CAAC;IACrC,SAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,uBAAuB,CAKjE;CACJ"}

package/lib/common/menu/menu-types.js

@@ -0,0 +1,98 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2022 Ericsson 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableCompoundMenuNode = exports.CompoundMenuNode = exports.Group = exports.CommandMenu = exports.RenderedMenuNode = exports.MenuAction = exports.Action = exports.ACCOUNTS_SUBMENU = exports.ACCOUNTS_MENU = exports.MANAGE_MENU = exports.MAIN_MENU_BAR = void 0;
+const types_1 = require("../types");
+exports.MAIN_MENU_BAR = ['menubar'];
+exports.MANAGE_MENU = ['manage_menu'];
+exports.ACCOUNTS_MENU = ['accounts_menu'];
+exports.ACCOUNTS_SUBMENU = [...exports.ACCOUNTS_MENU, '1_accounts_submenu'];
+var Action;
+(function (Action) {
+    function is(node) {
+        return (0, types_1.isObject)(node) && typeof node.run === 'function' && typeof node.isEnabled === 'function';
+    }
+    Action.is = is;
+})(Action || (exports.Action = Action = {}));
+var MenuAction;
+(function (MenuAction) {
+    function is(obj) {
+        return (0, types_1.isObject)(obj) && typeof obj.commandId === 'string';
+    }
+    MenuAction.is = is;
+})(MenuAction || (exports.MenuAction = MenuAction = {}));
+var RenderedMenuNode;
+(function (RenderedMenuNode) {
+    function is(node) {
+        return (0, types_1.isObject)(node) && typeof node.label === 'string';
+    }
+    RenderedMenuNode.is = is;
+})(RenderedMenuNode || (exports.RenderedMenuNode = RenderedMenuNode = {}));
+var CommandMenu;
+(function (CommandMenu) {
+    function is(node) {
+        return RenderedMenuNode.is(node) && Action.is(node);
+    }
+    CommandMenu.is = is;
+})(CommandMenu || (exports.CommandMenu = CommandMenu = {}));
+var Group;
+(function (Group) {
+    function is(obj) {
+        return CompoundMenuNode.is(obj) && !RenderedMenuNode.is(obj);
+    }
+    Group.is = is;
+})(Group || (exports.Group = Group = {}));
+;
+var CompoundMenuNode;
+(function (CompoundMenuNode) {
+    function is(node) { return (0, types_1.isObject)(node) && Array.isArray(node.children); }
+    CompoundMenuNode.is = is;
+    function sortChildren(m1, m2) {
+        // The navigation group is special as it will always be sorted to the top/beginning of a menu.
+        if (isNavigationGroup(m1)) {
+            return -1;
+        }
+        if (isNavigationGroup(m2)) {
+            return 1;
+        }
+        return m1.sortString.localeCompare(m2.sortString);
+    }
+    CompoundMenuNode.sortChildren = sortChildren;
+    /**
+     * Indicates whether the given node is the special `navigation` menu.
+     *
+     * @param node the menu node to check.
+     * @returns `true` when the given node is a {@link CompoundMenuNode} with id `navigation`,
+     * `false` otherwise.
+     */
+    function isNavigationGroup(node) {
+        return is(node) && node.id === 'navigation';
+    }
+    CompoundMenuNode.isNavigationGroup = isNavigationGroup;
+})(CompoundMenuNode || (exports.CompoundMenuNode = CompoundMenuNode = {}));
+;
+var MutableCompoundMenuNode;
+(function (MutableCompoundMenuNode) {
+    function is(node) {
+        return (0, types_1.isObject)(node)
+            && typeof node.addNode === 'function'
+            && typeof node.removeNode === 'function'
+            && typeof node.getOrCreate === 'function';
+    }
+    MutableCompoundMenuNode.is = is;
+})(MutableCompoundMenuNode || (exports.MutableCompoundMenuNode = MutableCompoundMenuNode = {}));
+//# sourceMappingURL=menu-types.js.map

package/lib/common/menu/menu-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-types.js","sourceRoot":"","sources":["../../../src/common/menu/menu-types.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAGhF,oCAAoC;AAEvB,QAAA,aAAa,GAAa,CAAC,SAAS,CAAC,CAAC;AAEtC,QAAA,WAAW,GAAa,CAAC,aAAa,CAAC,CAAC;AACxC,QAAA,aAAa,GAAa,CAAC,eAAe,CAAC,CAAC;AAC5C,QAAA,gBAAgB,GAAG,CAAC,GAAG,qBAAa,EAAE,oBAAoB,CAAC,CAAC;AA8BzE,IAAiB,MAAM,CAItB;AAJD,WAAiB,MAAM;IACnB,SAAgB,EAAE,CAAC,IAAY;QAC3B,OAAO,IAAA,gBAAQ,EAAS,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,UAAU,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,UAAU,CAAC;IAC5G,CAAC;IAFe,SAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,MAAM,sBAAN,MAAM,QAItB;AAsBD,IAAiB,UAAU,CAI1B;AAJD,WAAiB,UAAU;IACvB,SAAgB,EAAE,CAAC,GAAY;QAC3B,OAAO,IAAA,gBAAQ,EAAa,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC;IAC1E,CAAC;IAFe,aAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,UAAU,0BAAV,UAAU,QAI1B;AAiBD,IAAiB,gBAAgB,CAIhC;AAJD,WAAiB,gBAAgB;IAC7B,SAAgB,EAAE,CAAC,IAAa;QAC5B,OAAO,IAAA,gBAAQ,EAAmB,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC;IAC9E,CAAC;IAFe,mBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,gBAAgB,gCAAhB,gBAAgB,QAIhC;AAID,IAAiB,WAAW,CAI3B;AAJD,WAAiB,WAAW;IACxB,SAAgB,EAAE,CAAC,IAA0B;QACzC,OAAO,gBAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAFe,cAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,WAAW,2BAAX,WAAW,QAI3B;AAGD,IAAiB,KAAK,CAIrB;AAJD,WAAiB,KAAK;IAClB,SAAgB,EAAE,CAAC,GAAY;QAC3B,OAAO,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAFe,QAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,KAAK,qBAAL,KAAK,QAIrB;AAgBA,CAAC;AAEF,IAAiB,gBAAgB,CAwBhC;AAxBD,WAAiB,gBAAgB;IAC7B,SAAgB,EAAE,CAAC,IAAc,IAA8B,OAAO,IAAA,gBAAQ,EAAmB,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAAzH,mBAAE,KAAuH,CAAA;IAEzI,SAAgB,YAAY,CAAC,EAAY,EAAE,EAAY;QACnD,8FAA8F;QAC9F,IAAI,iBAAiB,CAAC,EAAE,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,CAAC,CAAC;QACd,CAAC;QACD,IAAI,iBAAiB,CAAC,EAAE,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,CAAC;QACb,CAAC;QACD,OAAO,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IATe,6BAAY,eAS3B,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,iBAAiB,CAAC,IAAc;QAC5C,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC;IAChD,CAAC;IAFe,kCAAiB,oBAEhC,CAAA;AACL,CAAC,EAxBgB,gBAAgB,gCAAhB,gBAAgB,QAwBhC;AAMA,CAAC;AAEF,IAAiB,uBAAuB,CAOvC;AAPD,WAAiB,uBAAuB;IACpC,SAAgB,EAAE,CAAC,IAAa;QAC5B,OAAO,IAAA,gBAAQ,EAA0B,IAAI,CAAC;eACvC,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU;eAClC,OAAO,IAAI,CAAC,UAAU,KAAK,UAAU;eACrC,OAAO,IAAI,CAAC,WAAW,KAAK,UAAU,CAAC;IAClD,CAAC;IALe,0BAAE,KAKjB,CAAA;AACL,CAAC,EAPgB,uBAAuB,uCAAvB,uBAAuB,QAOvC"}

package/lib/common/message-rpc/channel.d.ts

@@ -0,0 +1,124 @@
+import { Disposable, DisposableCollection } from '../disposable';
+import { Emitter, Event } from '../event';
+import { ReadBuffer, WriteBuffer } from './message-buffer';
+/**
+ * A channel is a bidirectional communications channel with lifecycle and
+ * error signalling. Note that creation of channels is specific to particular
+ * implementations and thus not part of the protocol.
+ */
+export interface Channel {
+    /**
+     * The remote side has closed the channel
+     */
+    onClose: Event<ChannelCloseEvent>;
+    /**
+     * An error has occurred while writing to or reading from the channel
+     */
+    onError: Event<unknown>;
+    /**
+     * A message has arrived and can be read  by listeners using a {@link MessageProvider}.
+     */
+    onMessage: Event<MessageProvider>;
+    /**
+     * Obtain a {@link WriteBuffer} to write a message to the channel.
+     */
+    getWriteBuffer(): WriteBuffer;
+    /**
+     * Close this channel. No {@link onClose} event should be sent
+     */
+    close(): void;
+}
+/**
+ * The event that is emitted when a channel is closed from the remote side.
+ */
+export interface ChannelCloseEvent {
+    reason: string;
+    code?: number;
+}
+/**
+ * The `MessageProvider` is emitted when a channel receives a new message.
+ * Listeners can invoke the provider to obtain a new {@link ReadBuffer} for the received message.
+ * This ensures that each listener has its own isolated {@link ReadBuffer} instance.
+ *
+ */
+export type MessageProvider = () => ReadBuffer;
+/**
+ *  Reusable abstract {@link Channel} implementation that sets up
+ *  the basic channel event listeners and offers a generic close method.
+ */
+export declare abstract class AbstractChannel implements Channel {
+    onCloseEmitter: Emitter<ChannelCloseEvent>;
+    get onClose(): Event<ChannelCloseEvent>;
+    onErrorEmitter: Emitter<unknown>;
+    get onError(): Event<unknown>;
+    onMessageEmitter: Emitter<MessageProvider>;
+    get onMessage(): Event<MessageProvider>;
+    protected toDispose: DisposableCollection;
+    constructor();
+    close(): void;
+    abstract getWriteBuffer(): WriteBuffer;
+}
+/**
+ * A very basic {@link AbstractChannel} implementation which takes a function
+ * for retrieving the {@link WriteBuffer} as constructor argument.
+ */
+export declare class BasicChannel extends AbstractChannel {
+    protected writeBufferProvider: () => WriteBuffer;
+    constructor(writeBufferProvider: () => WriteBuffer);
+    getWriteBuffer(): WriteBuffer;
+}
+/**
+ * Helper class to implement the single channels on a {@link ChannelMultiplexer}. Simply forwards write requests to
+ * the given write buffer source i.e. the main channel of the {@link ChannelMultiplexer}.
+ */
+export declare class ForwardingChannel extends AbstractChannel {
+    readonly id: string;
+    protected readonly closeHandler: () => void;
+    protected readonly writeBufferSource: () => WriteBuffer;
+    constructor(id: string, closeHandler: () => void, writeBufferSource: () => WriteBuffer);
+    getWriteBuffer(): WriteBuffer;
+    close(): void;
+}
+/**
+ * The different message types used in the messaging protocol of the {@link ChannelMultiplexer}
+ */
+export declare enum MessageTypes {
+    Open = 1,
+    Close = 2,
+    AckOpen = 3,
+    Data = 4
+}
+/**
+ * The write buffers in this implementation immediately write to the underlying
+ * channel, so we rely on writers to the multiplexed channels to always commit their
+ * messages and always in one go.
+ */
+export declare class ChannelMultiplexer implements Disposable {
+    protected readonly underlyingChannel: Channel;
+    protected pendingOpen: Map<string, (channel: ForwardingChannel) => void>;
+    protected openChannels: Map<string, ForwardingChannel>;
+    protected readonly onOpenChannelEmitter: Emitter<{
+        id: string;
+        channel: Channel;
+    }>;
+    get onDidOpenChannel(): Event<{
+        id: string;
+        channel: Channel;
+    }>;
+    protected toDispose: DisposableCollection;
+    constructor(underlyingChannel: Channel);
+    protected handleError(error: unknown): void;
+    onUnderlyingChannelClose(event?: ChannelCloseEvent): void;
+    protected handleMessage(buffer: ReadBuffer): void;
+    protected handleAckOpen(id: string): void;
+    protected handleOpen(id: string): void;
+    protected handleClose(id: string): void;
+    protected handleData(id: string, data: ReadBuffer): void;
+    protected createChannel(id: string): ForwardingChannel;
+    protected prepareWriteBuffer(id: string): WriteBuffer;
+    protected closeChannel(id: string): void;
+    open(id: string): Promise<Channel>;
+    getOpenChannel(id: string): Channel | undefined;
+    dispose(): void;
+}
+//# sourceMappingURL=channel.d.ts.map