@difizen/libro-common 0.3.4 → 1.0.0

package/es/core/menu/default-menu-node.js

@@ -0,0 +1,205 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+var _dec, _dec2, _class, _class2, _descriptor, _dec3, _dec4, _dec5, _dec6, _dec7, _class3, _class4, _descriptor2, _descriptor3, _descriptor4, _descriptor5;
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _initializerDefineProperty(target, property, descriptor, context) { if (!descriptor) return; Object.defineProperty(target, property, { enumerable: descriptor.enumerable, configurable: descriptor.configurable, writable: descriptor.writable, value: descriptor.initializer ? descriptor.initializer.call(context) : void 0 }); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _applyDecoratedDescriptor(target, property, decorators, descriptor, context) { var desc = {}; Object.keys(descriptor).forEach(function (key) { desc[key] = descriptor[key]; }); desc.enumerable = !!desc.enumerable; desc.configurable = !!desc.configurable; if ('value' in desc || desc.initializer) { desc.writable = true; } desc = decorators.slice().reverse().reduce(function (desc, decorator) { return decorator(target, property, desc) || desc; }, desc); if (context && desc.initializer !== void 0) { desc.value = desc.initializer ? desc.initializer.call(context) : void 0; desc.initializer = undefined; } if (desc.initializer === void 0) { Object.defineProperty(target, property, desc); desc = null; } return desc; }
+function _initializerWarningHelper(descriptor, context) { throw new Error('Decorating class property failed. Please ensure that ' + 'transform-class-properties is enabled and runs after the decorators transform.'); }
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import { Emitter } from "../../common/index.js";
+import { getOrigin, prop } from "../../observable/index.js";
+import { inject, transient } from "../../ioc/index.js";
+import { CommandRegistry } from "../command/command-registry";
+import { renderNode } from "../view/utils";
+import { CommandMenuNode, ExecutableMenuNode, MenuSymbol } from "./menu-protocol";
+/**
+ * Node representing a (sub)menu in the menu tree structure.
+ */
+export var DefaultActionMenuItem = (_dec = transient(), _dec2 = prop(), _dec(_class = (_class2 = /*#__PURE__*/function () {
+  function DefaultActionMenuItem(commands, node, parentPath) {
+    var _this = this;
+    _classCallCheck(this, DefaultActionMenuItem);
+    _initializerDefineProperty(this, "order", _descriptor, this);
+    this.disposedEventEmitter = new Emitter();
+    this.onDisposed = this.disposedEventEmitter.event;
+    this.doCommandExecute = function () {
+      if (_this.command) {
+        var _this$commands;
+        for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+          args[_key] = arguments[_key];
+        }
+        return (_this$commands = _this.commands).executeCommand.apply(_this$commands, [_this.command].concat(args));
+      }
+    };
+    this.renderTitle = function () {
+      var label = _this.label;
+      if (!label && _this.command) {
+        var _this$commands$getCom;
+        label = (_this$commands$getCom = _this.commands.getCommand(_this.command)) === null || _this$commands$getCom === void 0 ? void 0 : _this$commands$getCom.label;
+      }
+      return renderNode(label);
+    };
+    this.renderIcon = function () {
+      var icon = _this.icon;
+      if (!icon && _this.command) {
+        var _this$commands$getCom2;
+        icon = (_this$commands$getCom2 = _this.commands.getCommand(_this.command)) === null || _this$commands$getCom2 === void 0 ? void 0 : _this$commands$getCom2.icon;
+      }
+      return renderNode(icon);
+    };
+    this.commands = commands;
+    this.node = node;
+    this.parentPath = parentPath;
+    this.order = node.order;
+    this.label = node.label;
+    this.icon = node.icon;
+    this.id = node.id;
+    this.key = parentPath.join('/') + '/' + this.id;
+    if (CommandMenuNode.is(node)) {
+      this.command = node.command;
+      this.execute = this.doCommandExecute;
+    }
+    if (ExecutableMenuNode.is(node)) {
+      this.execute = node.execute;
+      this.isEnabled = node.isEnabled;
+      this.isVisible = node.isVisible;
+      this.isActive = node.isActive;
+    }
+  }
+  DefaultActionMenuItem = inject(MenuSymbol.ParentPathSymbol)(DefaultActionMenuItem, undefined, 2) || DefaultActionMenuItem;
+  DefaultActionMenuItem = inject(MenuSymbol.ActionMenuNodeSymbol)(DefaultActionMenuItem, undefined, 1) || DefaultActionMenuItem;
+  DefaultActionMenuItem = inject(CommandRegistry)(DefaultActionMenuItem, undefined, 0) || DefaultActionMenuItem;
+  _createClass(DefaultActionMenuItem, [{
+    key: "dispose",
+    value: function dispose() {
+      this.disposedEventEmitter.fire();
+      this.disposed = true;
+    }
+  }]);
+  return DefaultActionMenuItem;
+}(), (_descriptor = _applyDecoratedDescriptor(_class2.prototype, "order", [_dec2], {
+  configurable: true,
+  enumerable: true,
+  writable: true,
+  initializer: null
+})), _class2)) || _class);
+
+/**
+ * Node representing a (sub)menu in the menu tree structure.
+ */
+export var DefaultGeneralMenuItem = (_dec3 = transient(), _dec4 = prop(), _dec5 = prop(), _dec6 = prop(), _dec7 = prop(), _dec3(_class3 = (_class4 = /*#__PURE__*/function () {
+  function DefaultGeneralMenuItem(commands, node, parentPath) {
+    var _this2 = this;
+    _classCallCheck(this, DefaultGeneralMenuItem);
+    _initializerDefineProperty(this, "children", _descriptor2, this);
+    _initializerDefineProperty(this, "order", _descriptor3, this);
+    /**
+     * Optional label for the item.
+     */
+    _initializerDefineProperty(this, "label", _descriptor4, this);
+    /**
+     * Optional icon for the item.
+     */
+    _initializerDefineProperty(this, "icon", _descriptor5, this);
+    this.disposedEventEmitter = new Emitter();
+    this.onDisposed = this.disposedEventEmitter.event;
+    /**
+     * Inserts the given node at the position indicated by `sortString`.
+     *
+     * @returns a disposable which, when called, will remove the given node again.
+     */
+    this.addNode = function (item) {
+      _this2.children.push(item);
+      var remove = function remove() {
+        var idx = _this2.children.indexOf(getOrigin(item));
+        if (idx >= 0) {
+          _this2.children.splice(idx, 1);
+        }
+      };
+      item.onDisposed(remove);
+      return item;
+    };
+    this.renderTitle = function () {
+      return renderNode(_this2.label);
+    };
+    this.renderIcon = function () {
+      return renderNode(_this2.icon);
+    };
+    this.commands = commands;
+    this.node = node;
+    this.parentPath = parentPath;
+    this.order = node.order;
+    this.label = node.label;
+    this.icon = node.icon;
+    this.id = node.id;
+    this.key = parentPath.join('/') + '/' + this.id;
+    this.path = [].concat(_toConsumableArray(parentPath), [this.id]);
+  }
+  DefaultGeneralMenuItem = inject(MenuSymbol.ParentPathSymbol)(DefaultGeneralMenuItem, undefined, 2) || DefaultGeneralMenuItem;
+  DefaultGeneralMenuItem = inject(MenuSymbol.MenuNodeSymbol)(DefaultGeneralMenuItem, undefined, 1) || DefaultGeneralMenuItem;
+  DefaultGeneralMenuItem = inject(CommandRegistry)(DefaultGeneralMenuItem, undefined, 0) || DefaultGeneralMenuItem;
+  _createClass(DefaultGeneralMenuItem, [{
+    key: "isSubmenu",
+    get: function get() {
+      return !!this.label;
+    }
+  }, {
+    key: "removeNode",
+    value:
+    /**
+     * Removes the first node with the given id.
+     *
+     * @param id node id.
+     */
+    function removeNode(id) {
+      var node = this.children.find(function (n) {
+        return n.id === id;
+      });
+      if (node) {
+        var idx = this.children.indexOf(node);
+        if (idx >= 0) {
+          this.children.splice(idx, 1);
+        }
+      }
+    }
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      this.disposedEventEmitter.fire();
+      this.disposed = true;
+    }
+  }]);
+  return DefaultGeneralMenuItem;
+}(), (_descriptor2 = _applyDecoratedDescriptor(_class4.prototype, "children", [_dec4], {
+  configurable: true,
+  enumerable: true,
+  writable: true,
+  initializer: function initializer() {
+    return [];
+  }
+}), _descriptor3 = _applyDecoratedDescriptor(_class4.prototype, "order", [_dec5], {
+  configurable: true,
+  enumerable: true,
+  writable: true,
+  initializer: null
+}), _descriptor4 = _applyDecoratedDescriptor(_class4.prototype, "label", [_dec6], {
+  configurable: true,
+  enumerable: true,
+  writable: true,
+  initializer: null
+}), _descriptor5 = _applyDecoratedDescriptor(_class4.prototype, "icon", [_dec7], {
+  configurable: true,
+  enumerable: true,
+  writable: true,
+  initializer: null
+})), _class4)) || _class3);

package/es/core/menu/index.d.ts

@@ -0,0 +1,5 @@
+import { ManaModule } from '../module';
+export * from './menu-registry';
+export * from './menu-protocol';
+export declare const CoreMenuModule: ManaModule;
+//# sourceMappingURL=index.d.ts.map

package/es/core/menu/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/menu/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAWvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAEhC,eAAO,MAAM,cAAc,YAwBvB,CAAC"}

package/es/core/menu/index.js

@@ -0,0 +1,39 @@
+import { ManaModule } from "../module";
+import { DefaultActionMenuItem, DefaultGeneralMenuItem } from "./default-menu-node";
+import { MenuSymbol, ActionMenuItemFactory, GeneralMenuItemFactory } from "./menu-protocol";
+import { MenuRegistry, MenuContribution } from "./menu-registry";
+export * from "./menu-registry";
+export * from "./menu-protocol";
+export var CoreMenuModule = ManaModule.create().contribution(MenuContribution).register(MenuRegistry, DefaultGeneralMenuItem, DefaultActionMenuItem).register({
+  token: GeneralMenuItemFactory,
+  useDynamic: function useDynamic(ctx) {
+    return function (item, parent) {
+      var child = ctx.container.createChild();
+      child.register({
+        token: MenuSymbol.MenuNodeSymbol,
+        useValue: item
+      });
+      child.register({
+        token: MenuSymbol.ParentPathSymbol,
+        useValue: parent
+      });
+      return child.get(DefaultGeneralMenuItem);
+    };
+  }
+}).register({
+  token: ActionMenuItemFactory,
+  useDynamic: function useDynamic(ctx) {
+    return function (item, parent) {
+      var child = ctx.container.createChild();
+      child.register({
+        token: MenuSymbol.ActionMenuNodeSymbol,
+        useValue: item
+      });
+      child.register({
+        token: MenuSymbol.ParentPathSymbol,
+        useValue: parent
+      });
+      return child.get(DefaultActionMenuItem);
+    };
+  }
+});

package/es/core/menu/menu-protocol.d.ts

@@ -0,0 +1,101 @@
+/// <reference types="react" />
+import type { CommandHandler } from '../command/command-protocol';
+import type { DefaultActionMenuItem, DefaultGeneralMenuItem } from './default-menu-node';
+export type ActionMenuItem = DefaultActionMenuItem;
+export type GeneralMenuItem = DefaultGeneralMenuItem;
+export type MenuPath = string[];
+export declare namespace MenuSymbol {
+    const MenuNodeSymbol: unique symbol;
+    const ActionMenuNodeSymbol: unique symbol;
+    const ParentPathSymbol: unique symbol;
+}
+/**
+ * Factory for instantiating menu item.
+ */
+export declare const GeneralMenuItemFactory: unique symbol;
+export interface GeneralMenuItemFactory {
+    (item: MenuNode, menuPath: MenuPath): GeneralMenuItem;
+}
+/**
+ * Factory for instantiating menu item.
+ */
+export declare const ActionMenuItemFactory: unique symbol;
+export interface ActionMenuItemFactory {
+    (item: ActionMenuNode, menuPath: MenuPath): ActionMenuItem;
+}
+/**
+ * Base interface of the nodes used in the menu tree structure.
+ */
+export interface MenuNode {
+    /**
+     * The unique ID of the menu node.
+     */
+    label?: React.ReactNode | React.FC;
+    /**
+     * technical identifier.
+     */
+    readonly id: string;
+    /**
+     * The order to display menu node.
+     */
+    order?: string;
+    /**
+     * Optional icon for the menu item
+     */
+    icon?: React.ReactNode | React.FC;
+}
+export declare namespace MenuNode {
+    function is(arg: any): arg is MenuNode;
+}
+export interface CommandMenuNode extends MenuNode {
+    /**
+     * The command to execute.
+     */
+    command: 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;
+}
+export declare namespace CommandMenuNode {
+    function is(arg: any): arg is CommandMenuNode;
+}
+export interface ExecutableMenuNode extends MenuNode, CommandHandler {
+    command?: 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;
+}
+export declare namespace ExecutableMenuNode {
+    function is(arg: any): arg is ExecutableMenuNode;
+}
+export type ActionMenuNode = CommandMenuNode | ExecutableMenuNode;
+export declare namespace ActionMenuNode {
+    function is(arg: any): arg is ActionMenuNode;
+}
+export type MenuOptions = Omit<MenuNode, 'id'>;
+export declare namespace MenuItem {
+    function isGeneralMenuItem(arg: any): arg is GeneralMenuItem;
+    function isActionMenuItem(arg: any): arg is ActionMenuItem;
+}
+export declare namespace ActionMenuItem {
+    /**
+     * @deprecated use MenuItem.isActionMenuItem instead
+     * @param arg
+     * @returns arg is ActionMenuItem
+     */
+    function is(arg: any): arg is ActionMenuItem;
+}
+export declare namespace GeneralMenuItem {
+    /**
+     * @deprecated use MenuItem.isGeneralMenuItem instead
+     * @param arg
+     * @returns arg is GeneralMenuItem
+     */
+    function is(arg: any): arg is GeneralMenuItem;
+}
+export type MenuItem = ActionMenuItem | GeneralMenuItem;
+//# sourceMappingURL=menu-protocol.d.ts.map

package/es/core/menu/menu-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-protocol.d.ts","sourceRoot":"","sources":["../../../src/core/menu/menu-protocol.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,KAAK,EACV,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC;AACnD,MAAM,MAAM,eAAe,GAAG,sBAAsB,CAAC;AAErD,MAAM,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC;AAEhC,yBAAiB,UAAU,CAAC;IACnB,MAAM,cAAc,eAA2B,CAAC;IAChD,MAAM,oBAAoB,eAAiC,CAAC;IAC5D,MAAM,gBAAgB,eAA6B,CAAC;CAC5D;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,eAAmC,CAAC;AACvE,MAAM,WAAW,sBAAsB;IACrC,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,GAAG,eAAe,CAAC;CACvD;AACD;;GAEG;AACH,eAAO,MAAM,qBAAqB,eAAkC,CAAC;AACrE,MAAM,WAAW,qBAAqB;IACpC,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ,GAAG,cAAc,CAAC;CAC5D;AACD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;CACnC;AACD,yBAAiB,QAAQ,CAAC;IACxB,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,QAAQ,CAE5C;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,eAAe,CAAC;IAG/B,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,eAAe,CAEnD;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,QAAQ,EAAE,cAAc;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,yBAAiB,kBAAkB,CAAC;IAGlC,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,kBAAkB,CAEtD;CACF;AAED,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,kBAAkB,CAAC;AAClE,yBAAiB,cAAc,CAAC;IAG9B,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,cAAc,CAElD;CACF;AAED,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAE/C,yBAAiB,QAAQ,CAAC;IAExB,SAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,eAAe,CAIlE;IAED,SAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,cAAc,CAEhE;CACF;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;;OAIG;IACH,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,cAAc,CAElD;CACF;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;;OAIG;IACH,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,eAAe,CAEnD;CACF;AAED,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,eAAe,CAAC"}

package/es/core/menu/menu-protocol.js

@@ -0,0 +1,72 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+export var MenuSymbol;
+(function (_MenuSymbol) {
+  var MenuNodeSymbol = _MenuSymbol.MenuNodeSymbol = Symbol('MenuNodeSymbol');
+  var ActionMenuNodeSymbol = _MenuSymbol.ActionMenuNodeSymbol = Symbol('ActionMenuNodeSymbol');
+  var ParentPathSymbol = _MenuSymbol.ParentPathSymbol = Symbol('ParentPathSymbol');
+})(MenuSymbol || (MenuSymbol = {}));
+/**
+ * Factory for instantiating menu item.
+ */
+export var GeneralMenuItemFactory = Symbol('GeneralMenuItemFactory');
+/**
+ * Factory for instantiating menu item.
+ */
+export var ActionMenuItemFactory = Symbol('ActionMenuItemFactory');
+
+/**
+ * Base interface of the nodes used in the menu tree structure.
+ */
+export var MenuNode;
+(function (_MenuNode) {
+  function is(arg) {
+    return !!arg && _typeof(arg) === 'object' && 'id' in arg;
+  }
+  _MenuNode.is = is;
+})(MenuNode || (MenuNode = {}));
+export var CommandMenuNode;
+(function (_CommandMenuNode) {
+  function is(arg) {
+    return MenuNode.is(arg) && 'command' in arg;
+  }
+  _CommandMenuNode.is = is;
+})(CommandMenuNode || (CommandMenuNode = {}));
+export var ExecutableMenuNode;
+(function (_ExecutableMenuNode) {
+  function is(arg) {
+    return MenuNode.is(arg) && 'execute' in arg;
+  }
+  _ExecutableMenuNode.is = is;
+})(ExecutableMenuNode || (ExecutableMenuNode = {}));
+export var ActionMenuNode;
+(function (_ActionMenuNode) {
+  function is(arg) {
+    return CommandMenuNode.is(arg) || ExecutableMenuNode.is(arg);
+  }
+  _ActionMenuNode.is = is;
+})(ActionMenuNode || (ActionMenuNode = {}));
+export var MenuItem;
+(function (_MenuItem) {
+  function isGeneralMenuItem(arg) {
+    return MenuNode.is(arg) && 'children' in arg && ('addNode' in arg || 'removeNode' in arg);
+  }
+  _MenuItem.isGeneralMenuItem = isGeneralMenuItem;
+  function isActionMenuItem(arg) {
+    return ActionMenuNode.is(arg) && 'command' in arg && 'onDisposed' in arg;
+  }
+  _MenuItem.isActionMenuItem = isActionMenuItem;
+})(MenuItem || (MenuItem = {}));
+export var ActionMenuItem;
+(function (_ActionMenuItem) {
+  function is(arg) {
+    return MenuItem.isActionMenuItem(arg);
+  }
+  _ActionMenuItem.is = is;
+})(ActionMenuItem || (ActionMenuItem = {}));
+export var GeneralMenuItem;
+(function (_GeneralMenuItem) {
+  function is(arg) {
+    return MenuItem.isGeneralMenuItem(arg);
+  }
+  _GeneralMenuItem.is = is;
+})(GeneralMenuItem || (GeneralMenuItem = {}));

package/es/core/menu/menu-registry.d.ts

@@ -0,0 +1,92 @@
+import type { MaybePromise } from '../../common/index.js';
+import { Disposable } from '../../common/index.js';
+import type { Contribution } from '../../ioc/index.js';
+import { Syringe } from '../../ioc/index.js';
+import { ApplicationContribution } from '../application/application';
+import { CommandRegistry } from '../command/command-registry';
+import type { MenuOptions, MenuPath, ActionMenuNode, GeneralMenuItem } from './menu-protocol';
+import { GeneralMenuItemFactory, MenuNode, MenuItem, ActionMenuItemFactory } from './menu-protocol';
+export declare const MenuContribution: Syringe.DefinedToken;
+export type MenuContribution = {
+    /**
+     * Register menus.
+     * @param menus the menu registry.
+     */
+    registerMenus: (menus: MenuRegistry) => void;
+};
+/**
+ * Register and unregister menus, submenus and actions
+ */
+export declare class MenuRegistry implements ApplicationContribution {
+    protected readonly root: GeneralMenuItem;
+    protected readonly contributions: Contribution.Provider<MenuContribution>;
+    protected readonly generalItemFactory: GeneralMenuItemFactory;
+    protected readonly actionItemFactory: ActionMenuItemFactory;
+    protected readonly commands: CommandRegistry;
+    constructor(contributions: Contribution.Provider<MenuContribution>, generalItemFactory: GeneralMenuItemFactory, actionItemFactory: ActionMenuItemFactory, commands: CommandRegistry);
+    onStart(): void;
+    /**
+     * 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: MenuPath, item: ActionMenuNode): Disposable;
+    /**
+     * Adds the given menu node to the menu denoted by the given path.
+     *
+     * @returns a disposable which, when called, will remove the menu node again.
+     */
+    registerMenuNode(menuPath: MenuPath, item: MenuNode): Disposable;
+    registerGroupMenu(menuPath: MenuPath, options?: MenuOptions): Disposable;
+    /**
+     * 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: MenuPath, options?: MenuOptions): Disposable;
+    /**
+     * Unregister all menu nodes with the same id as the given menu action.
+     *
+     * @param item the item whose id will be used.
+     * @param menuPath if specified only nodes within the path will be unregistered.
+     */
+    unregisterMenuAction(item: ActionMenuNode, menuPath?: MenuPath): void;
+    /**
+     * Unregister all menu nodes with the given id.
+     *
+     * @param id the id which shall be removed.
+     * @param menuPath if specified only nodes within the path will be unregistered.
+     */
+    unregisterMenuAction(id: string, menuPath?: MenuPath): void;
+    /**
+     * Recurse all menus, removing any menus matching the `id`.
+     *
+     * @param id technical identifier of the `MenuNode`.
+     */
+    unregisterMenuNode(id: string): void;
+    protected getOrCreateGroup(menuPath: MenuPath, options?: MenuOptions): GeneralMenuItem;
+    protected getOrCreateSub(current: GeneralMenuItem, menuId: string, options?: MenuOptions): GeneralMenuItem;
+    /**
+     * Returns the menu at the given path.
+     *
+     * @param menuPath the path specifying the menu to return. If not given the empty path will be used.
+     *
+     * @returns the root menu when `menuPath` is empty. If `menuPath` is not empty the specified menu is
+     * returned if it exists, otherwise an error is thrown.
+     */
+    getMenu(menuPath?: MenuPath): GeneralMenuItem;
+    isVisible(item: MenuItem, ...args: any[]): boolean;
+    isEnabled(item: MenuItem, ...args: any[]): boolean;
+    execute(item: MenuItem, ...args: any[]): MaybePromise<void>;
+}
+//# sourceMappingURL=menu-registry.d.ts.map

package/es/core/menu/menu-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-registry.d.ts","sourceRoot":"","sources":["../../../src/core/menu/menu-registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAA8B,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAEzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,cAAc,EACd,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,sBAAsB,EACtB,QAAQ,EACR,QAAQ,EACR,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,gBAAgB,sBAA0C,CAAC;AAExE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,qBACa,YAAa,YAAW,uBAAuB;IAC1D,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1E,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,sBAAsB,CAAC;IAC9D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,qBAAqB,CAAC;IAC5D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;gBAGhB,aAAa,EAAE,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EACjD,kBAAkB,EAAE,sBAAsB,EAC3C,iBAAiB,EAAE,qBAAqB,EAC9C,QAAQ,EAAE,eAAe;IASpD,OAAO,IAAI,IAAI;IAMf;;;;OAIG;IACH,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,GAAG,UAAU;IAMxE;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,UAAU;IAMhE,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU;IAyB5E;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU;IAyB1E;;;;;OAKG;IACH,oBAAoB,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IACrE;;;;;OAKG;IAEH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAkB3D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAYpC,SAAS,CAAC,gBAAgB,CACxB,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,eAAe;IAQlB,SAAS,CAAC,cAAc,CACtB,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,WAAgB,GACxB,eAAe;IAalB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,GAAE,QAAa,GAAG,eAAe;IAIjD,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAYlD,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAYlD,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC;CAQ5D"}