@theia/core 1.48.0 → 1.48.1

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

@@ -1,149 +1,149 @@
-import { Disposable } from '../disposable';
-export declare type MenuPath = string[];
-export declare const MAIN_MENU_BAR: MenuPath;
-export declare const MANAGE_MENU: MenuPath;
-export declare const ACCOUNTS_MENU: MenuPath;
-export declare const ACCOUNTS_SUBMENU: string[];
-/**
- * @internal For most use cases, refer to {@link MenuAction} or {@link MenuNode}
- */
-export interface MenuNodeMetadata {
-    /**
-     * technical identifier.
-     */
-    readonly id: string;
-    /**
-     * Menu nodes are sorted in ascending order based on their `sortString`.
-     */
-    readonly sortString: string;
-    /**
-     * Condition under which the menu node should be rendered.
-     * See https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts
-     */
-    readonly when?: string;
-    /**
-     * A reference to the parent node - useful for determining the menu path by which the node can be accessed.
-     */
-    readonly parent?: MenuNode;
-}
-/**
- * Metadata for the visual presentation of a node.
- * @internal For most uses cases, refer to {@link MenuNode}, {@link CommandMenuNode}, or {@link CompoundMenuNode}
- */
-export interface MenuNodeRenderingData {
-    /**
-     * 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;
-}
-/** @internal For most use cases refer to {@link MenuNode}, {@link CommandMenuNode}, or {@link CompoundMenuNode} */
-export interface MenuNodeBase extends MenuNodeMetadata, MenuNodeRenderingData {
-}
-/**
- * A menu entry representing an action, e.g. "New File".
- */
-export interface MenuAction extends MenuNodeRenderingData, Pick<MenuNodeMetadata, 'when'> {
-    /**
-     * The command to execute.
-     */
-    commandId: string;
-    /**
-     * In addition to the mandatory command property, an alternative command can be defined.
-     * It will be shown and invoked when pressing Alt while opening a menu.
-     */
-    alt?: string;
-    /**
-     * Menu entries are sorted in ascending order based on their `order` strings. If omitted the determined
-     * label will be used instead.
-     */
-    order?: string;
-}
-export declare namespace MenuAction {
-    function is(arg: unknown): arg is MenuAction;
-}
-/**
- * Additional options when creating a new submenu.
- */
-export interface SubMenuOptions extends Pick<MenuAction, 'order'>, Pick<MenuNodeMetadata, 'when'>, Partial<Pick<CompoundMenuNode, 'role' | 'label' | 'icon'>> {
-    /**
-     * The class to use for the submenu icon.
-     * @deprecated use `icon` instead;
-     */
-    iconClass?: string;
-}
-export declare const enum CompoundMenuNodeRole {
-    /** Indicates that the node should be rendered as submenu that opens a new menu on hover */
-    Submenu = 0,
-    /** Indicates that the node's children should be rendered as group separated from other items by a separator */
-    Group = 1,
-    /** Indicates that the node's children should be treated as though they were direct children of the node's parent */
-    Flat = 2
-}
-export interface CompoundMenuNode extends MenuNodeBase {
-    /**
-     * Items that are grouped under this menu.
-     */
-    readonly children: ReadonlyArray<MenuNode>;
-    /**
-     * @deprecated @since 1.28 use `role` instead.
-     * Whether the item should be rendered as a submenu.
-     */
-    readonly isSubmenu: boolean;
-    /**
-     * How the node and its children should be rendered. See {@link CompoundMenuNodeRole}.
-     */
-    readonly role: CompoundMenuNodeRole;
-}
-export interface MutableCompoundMenuNode extends CompoundMenuNode {
-    /**
-     * Inserts the given node at the position indicated by `sortString`.
-     *
-     * @returns a disposable which, when called, will remove the given node again.
-     */
-    addNode(node: MenuNode): Disposable;
-    /**
-     * Removes the first node with the given id.
-     *
-     * @param id node id.
-     */
-    removeNode(id: string): void;
-    /**
-     * Fills any `undefined` fields with the values from the {@link options}.
-     */
-    updateOptions(options: SubMenuOptions): void;
-}
-export declare namespace CompoundMenuNode {
-    function is(node?: MenuNode): node is CompoundMenuNode;
-    function getRole(node: MenuNode): CompoundMenuNodeRole | undefined;
-    function sortChildren(m1: MenuNode, m2: MenuNode): number;
-    /** Collapses the children of any subemenus with role {@link CompoundMenuNodeRole Flat} and sorts */
-    function getFlatChildren(children: ReadonlyArray<MenuNode>): MenuNode[];
-    /**
-     * 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;
-    function isMutable(node?: MenuNode): node is MutableCompoundMenuNode;
-}
-export interface CommandMenuNode extends MenuNodeBase {
-    command: string;
-}
-export declare namespace CommandMenuNode {
-    function is(candidate?: MenuNode): candidate is CommandMenuNode;
-    function hasAltHandler(candidate?: MenuNode): candidate is AlternativeHandlerMenuNode;
-}
-export interface AlternativeHandlerMenuNode extends CommandMenuNode {
-    altNode: CommandMenuNode;
-}
-/**
- * Base interface of the nodes used in the menu tree structure.
- */
-export declare type MenuNode = MenuNodeMetadata & MenuNodeRenderingData & Partial<CompoundMenuNode> & Partial<CommandMenuNode> & Partial<AlternativeHandlerMenuNode>;
+import { Disposable } from '../disposable';
+export declare type MenuPath = string[];
+export declare const MAIN_MENU_BAR: MenuPath;
+export declare const MANAGE_MENU: MenuPath;
+export declare const ACCOUNTS_MENU: MenuPath;
+export declare const ACCOUNTS_SUBMENU: string[];
+/**
+ * @internal For most use cases, refer to {@link MenuAction} or {@link MenuNode}
+ */
+export interface MenuNodeMetadata {
+    /**
+     * technical identifier.
+     */
+    readonly id: string;
+    /**
+     * Menu nodes are sorted in ascending order based on their `sortString`.
+     */
+    readonly sortString: string;
+    /**
+     * Condition under which the menu node should be rendered.
+     * See https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts
+     */
+    readonly when?: string;
+    /**
+     * A reference to the parent node - useful for determining the menu path by which the node can be accessed.
+     */
+    readonly parent?: MenuNode;
+}
+/**
+ * Metadata for the visual presentation of a node.
+ * @internal For most uses cases, refer to {@link MenuNode}, {@link CommandMenuNode}, or {@link CompoundMenuNode}
+ */
+export interface MenuNodeRenderingData {
+    /**
+     * 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;
+}
+/** @internal For most use cases refer to {@link MenuNode}, {@link CommandMenuNode}, or {@link CompoundMenuNode} */
+export interface MenuNodeBase extends MenuNodeMetadata, MenuNodeRenderingData {
+}
+/**
+ * A menu entry representing an action, e.g. "New File".
+ */
+export interface MenuAction extends MenuNodeRenderingData, Pick<MenuNodeMetadata, 'when'> {
+    /**
+     * The command to execute.
+     */
+    commandId: string;
+    /**
+     * In addition to the mandatory command property, an alternative command can be defined.
+     * It will be shown and invoked when pressing Alt while opening a menu.
+     */
+    alt?: string;
+    /**
+     * Menu entries are sorted in ascending order based on their `order` strings. If omitted the determined
+     * label will be used instead.
+     */
+    order?: string;
+}
+export declare namespace MenuAction {
+    function is(arg: unknown): arg is MenuAction;
+}
+/**
+ * Additional options when creating a new submenu.
+ */
+export interface SubMenuOptions extends Pick<MenuAction, 'order'>, Pick<MenuNodeMetadata, 'when'>, Partial<Pick<CompoundMenuNode, 'role' | 'label' | 'icon'>> {
+    /**
+     * The class to use for the submenu icon.
+     * @deprecated use `icon` instead;
+     */
+    iconClass?: string;
+}
+export declare const enum CompoundMenuNodeRole {
+    /** Indicates that the node should be rendered as submenu that opens a new menu on hover */
+    Submenu = 0,
+    /** Indicates that the node's children should be rendered as group separated from other items by a separator */
+    Group = 1,
+    /** Indicates that the node's children should be treated as though they were direct children of the node's parent */
+    Flat = 2
+}
+export interface CompoundMenuNode extends MenuNodeBase {
+    /**
+     * Items that are grouped under this menu.
+     */
+    readonly children: ReadonlyArray<MenuNode>;
+    /**
+     * @deprecated @since 1.28 use `role` instead.
+     * Whether the item should be rendered as a submenu.
+     */
+    readonly isSubmenu: boolean;
+    /**
+     * How the node and its children should be rendered. See {@link CompoundMenuNodeRole}.
+     */
+    readonly role: CompoundMenuNodeRole;
+}
+export interface MutableCompoundMenuNode extends CompoundMenuNode {
+    /**
+     * Inserts the given node at the position indicated by `sortString`.
+     *
+     * @returns a disposable which, when called, will remove the given node again.
+     */
+    addNode(node: MenuNode): Disposable;
+    /**
+     * Removes the first node with the given id.
+     *
+     * @param id node id.
+     */
+    removeNode(id: string): void;
+    /**
+     * Fills any `undefined` fields with the values from the {@link options}.
+     */
+    updateOptions(options: SubMenuOptions): void;
+}
+export declare namespace CompoundMenuNode {
+    function is(node?: MenuNode): node is CompoundMenuNode;
+    function getRole(node: MenuNode): CompoundMenuNodeRole | undefined;
+    function sortChildren(m1: MenuNode, m2: MenuNode): number;
+    /** Collapses the children of any subemenus with role {@link CompoundMenuNodeRole Flat} and sorts */
+    function getFlatChildren(children: ReadonlyArray<MenuNode>): MenuNode[];
+    /**
+     * 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;
+    function isMutable(node?: MenuNode): node is MutableCompoundMenuNode;
+}
+export interface CommandMenuNode extends MenuNodeBase {
+    command: string;
+}
+export declare namespace CommandMenuNode {
+    function is(candidate?: MenuNode): candidate is CommandMenuNode;
+    function hasAltHandler(candidate?: MenuNode): candidate is AlternativeHandlerMenuNode;
+}
+export interface AlternativeHandlerMenuNode extends CommandMenuNode {
+    altNode: CommandMenuNode;
+}
+/**
+ * Base interface of the nodes used in the menu tree structure.
+ */
+export declare type MenuNode = MenuNodeMetadata & MenuNodeRenderingData & Partial<CompoundMenuNode> & Partial<CommandMenuNode> & Partial<AlternativeHandlerMenuNode>;
 //# sourceMappingURL=menu-types.d.ts.map

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

@@ -1,94 +1,94 @@
-"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.CommandMenuNode = exports.CompoundMenuNode = exports.MenuAction = 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 MenuAction;
-(function (MenuAction) {
-    /* Determine whether object is a MenuAction */
-    function is(arg) {
-        return (0, types_1.isObject)(arg) && 'commandId' in arg;
-    }
-    MenuAction.is = is;
-})(MenuAction = exports.MenuAction || (exports.MenuAction = {}));
-var CompoundMenuNode;
-(function (CompoundMenuNode) {
-    function is(node) { return !!node && Array.isArray(node.children); }
-    CompoundMenuNode.is = is;
-    function getRole(node) {
-        var _a;
-        if (!is(node)) {
-            return undefined;
-        }
-        return (_a = node.role) !== null && _a !== void 0 ? _a : (node.label ? 0 /* Submenu */ : 1 /* Group */);
-    }
-    CompoundMenuNode.getRole = getRole;
-    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;
-    /** Collapses the children of any subemenus with role {@link CompoundMenuNodeRole Flat} and sorts */
-    function getFlatChildren(children) {
-        const childrenToMerge = [];
-        return children.filter(child => {
-            if (getRole(child) === 2 /* Flat */) {
-                childrenToMerge.push(child.children);
-                return false;
-            }
-            return true;
-        }).concat(...childrenToMerge).sort(sortChildren);
-    }
-    CompoundMenuNode.getFlatChildren = getFlatChildren;
-    /**
-     * 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;
-    function isMutable(node) {
-        const candidate = node;
-        return is(candidate) && typeof candidate.addNode === 'function' && typeof candidate.removeNode === 'function';
-    }
-    CompoundMenuNode.isMutable = isMutable;
-})(CompoundMenuNode = exports.CompoundMenuNode || (exports.CompoundMenuNode = {}));
-var CommandMenuNode;
-(function (CommandMenuNode) {
-    function is(candidate) { return Boolean(candidate === null || candidate === void 0 ? void 0 : candidate.command); }
-    CommandMenuNode.is = is;
-    function hasAltHandler(candidate) {
-        const asAltNode = candidate;
-        return is(asAltNode) && is(asAltNode === null || asAltNode === void 0 ? void 0 : asAltNode.altNode);
-    }
-    CommandMenuNode.hasAltHandler = hasAltHandler;
-})(CommandMenuNode = exports.CommandMenuNode || (exports.CommandMenuNode = {}));
+"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.CommandMenuNode = exports.CompoundMenuNode = exports.MenuAction = 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 MenuAction;
+(function (MenuAction) {
+    /* Determine whether object is a MenuAction */
+    function is(arg) {
+        return (0, types_1.isObject)(arg) && 'commandId' in arg;
+    }
+    MenuAction.is = is;
+})(MenuAction = exports.MenuAction || (exports.MenuAction = {}));
+var CompoundMenuNode;
+(function (CompoundMenuNode) {
+    function is(node) { return !!node && Array.isArray(node.children); }
+    CompoundMenuNode.is = is;
+    function getRole(node) {
+        var _a;
+        if (!is(node)) {
+            return undefined;
+        }
+        return (_a = node.role) !== null && _a !== void 0 ? _a : (node.label ? 0 /* Submenu */ : 1 /* Group */);
+    }
+    CompoundMenuNode.getRole = getRole;
+    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;
+    /** Collapses the children of any subemenus with role {@link CompoundMenuNodeRole Flat} and sorts */
+    function getFlatChildren(children) {
+        const childrenToMerge = [];
+        return children.filter(child => {
+            if (getRole(child) === 2 /* Flat */) {
+                childrenToMerge.push(child.children);
+                return false;
+            }
+            return true;
+        }).concat(...childrenToMerge).sort(sortChildren);
+    }
+    CompoundMenuNode.getFlatChildren = getFlatChildren;
+    /**
+     * 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;
+    function isMutable(node) {
+        const candidate = node;
+        return is(candidate) && typeof candidate.addNode === 'function' && typeof candidate.removeNode === 'function';
+    }
+    CompoundMenuNode.isMutable = isMutable;
+})(CompoundMenuNode = exports.CompoundMenuNode || (exports.CompoundMenuNode = {}));
+var CommandMenuNode;
+(function (CommandMenuNode) {
+    function is(candidate) { return Boolean(candidate === null || candidate === void 0 ? void 0 : candidate.command); }
+    CommandMenuNode.is = is;
+    function hasAltHandler(candidate) {
+        const asAltNode = candidate;
+        return is(asAltNode) && is(asAltNode === null || asAltNode === void 0 ? void 0 : asAltNode.altNode);
+    }
+    CommandMenuNode.hasAltHandler = hasAltHandler;
+})(CommandMenuNode = exports.CommandMenuNode || (exports.CommandMenuNode = {}));
 //# sourceMappingURL=menu-types.js.map

package/lib/common/menu/menu.spec.d.ts

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