@difizen/libro-common 0.3.3 → 1.0.0

package/es/app/tree/tree-selection-state.js

@@ -0,0 +1,276 @@
+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); }
+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 _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 _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+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 _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 ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+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); }
+import { equals } from "../../observable/index.js";
+import { DepthFirstTreeIterator } from "./tree-iterator.js";
+import { TreeSelection, SelectableTreeNode } from "./tree-selection.js";
+
+/**
+ * A tree selection that might contain additional information about the tree node that has the focus.
+ */
+export var FocusableTreeSelection;
+(function (_FocusableTreeSelection) {
+  function is(arg) {
+    return TreeSelection.is(arg) && 'focus' in arg;
+  }
+  _FocusableTreeSelection.is = is;
+  function focus(arg) {
+    return is(arg) ? arg.focus : undefined;
+  }
+  _FocusableTreeSelection.focus = focus;
+})(FocusableTreeSelection || (FocusableTreeSelection = {}));
+/**
+ * Class for representing and managing the selection state and the focus of a tree.
+ */
+export var TreeSelectionState = /*#__PURE__*/function () {
+  function TreeSelectionState(tree) {
+    var selectionStack = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+    _classCallCheck(this, TreeSelectionState);
+    this.selectionStack = [];
+    this.tree = tree;
+    this.selectionStack = selectionStack;
+  }
+  _createClass(TreeSelectionState, [{
+    key: "nextState",
+    value: function nextState(selection) {
+      var _type$selection = _objectSpread({
+          type: TreeSelection.SelectionType.DEFAULT
+        }, selection),
+        node = _type$selection.node,
+        type = _type$selection.type;
+      switch (type) {
+        case TreeSelection.SelectionType.DEFAULT:
+          return this.handleDefault(this, node);
+        case TreeSelection.SelectionType.TOGGLE:
+          return this.handleToggle(this, node);
+        case TreeSelection.SelectionType.RANGE:
+          return this.handleRange(this, node);
+        default:
+          throw new Error("Unexpected tree selection type: ".concat(type, "."));
+      }
+    }
+  }, {
+    key: "selection",
+    value: function selection() {
+      var _this = this;
+      var copy = this.checkNoDefaultSelection(this.selectionStack);
+      var nodeIds = new Set();
+      for (var i = 0; i < copy.length; i++) {
+        var _copy$i = copy[i],
+          node = _copy$i.node,
+          type = _copy$i.type;
+        if (TreeSelection.isRange(type)) {
+          var selection = copy[i];
+          var _iterator = _createForOfIteratorHelper(this.selectionRange(selection).map(function (n) {
+              return n.id;
+            })),
+            _step;
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var id = _step.value;
+              nodeIds.add(id);
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+        } else if (TreeSelection.isToggle(type)) {
+          if (nodeIds.has(node.id)) {
+            nodeIds.delete(node.id);
+          } else {
+            nodeIds.add(node.id);
+          }
+        }
+      }
+      return Array.from(nodeIds.keys()).map(function (id) {
+        return _this.tree.getNode(id);
+      }).filter(SelectableTreeNode.is).reverse();
+    }
+  }, {
+    key: "focus",
+    get: function get() {
+      var copy = this.checkNoDefaultSelection(this.selectionStack);
+      var candidate = copy[copy.length - 1].focus;
+      return this.toSelectableTreeNode(candidate);
+    }
+  }, {
+    key: "handleDefault",
+    value: function handleDefault(state, node) {
+      var tree = state.tree;
+      return new TreeSelectionState(tree, [{
+        node: node,
+        type: TreeSelection.SelectionType.TOGGLE,
+        focus: node
+      }]);
+    }
+  }, {
+    key: "handleToggle",
+    value: function handleToggle(state, node) {
+      var _this2 = this;
+      var tree = state.tree,
+        selectionStack = state.selectionStack;
+      var copy = this.checkNoDefaultSelection(selectionStack).slice();
+      var focus = function () {
+        var allRanges = copy.filter(function (selection) {
+          return TreeSelection.isRange(selection);
+        });
+        for (var i = allRanges.length - 1; i >= 0; i--) {
+          var latestRangeIndex = copy.indexOf(allRanges[i]);
+          var latestRangeSelection = copy[latestRangeIndex];
+          var latestRange = latestRangeSelection && latestRangeSelection.focus ? _this2.selectionRange(latestRangeSelection) : [];
+          if (latestRange.indexOf(node) !== -1) {
+            if (equals(_this2.focus, latestRangeSelection.focus)) {
+              return latestRangeSelection.focus || node;
+            }
+            return _this2.focus;
+          }
+        }
+        return node;
+      }();
+      return new TreeSelectionState(tree, [].concat(_toConsumableArray(copy), [{
+        node: node,
+        type: TreeSelection.SelectionType.TOGGLE,
+        focus: focus
+      }]));
+    }
+  }, {
+    key: "handleRange",
+    value: function handleRange(state, node) {
+      var tree = state.tree,
+        selectionStack = state.selectionStack;
+      var copy = this.checkNoDefaultSelection(selectionStack).slice();
+      var focus = FocusableTreeSelection.focus(copy[copy.length - 1]);
+
+      // Drop the previous range when we are trying to modify that.
+      if (TreeSelection.isRange(copy[copy.length - 1])) {
+        var range = this.selectionRange(copy.pop());
+        // And we drop all preceding individual nodes that were contained in the range we are dropping.
+        // That means, anytime we cover individual nodes with a range, they will belong to the range so we need to drop them now.
+        for (var i = copy.length - 1; i >= 0; i--) {
+          if (range.indexOf(copy[i].node) !== -1) {
+            // Make sure to keep a reference to the focus while we are discarding previous elements. Otherwise, we lose this information.
+            focus = copy[i].focus;
+            copy.splice(i, 1);
+          }
+        }
+      }
+      return new TreeSelectionState(tree, [].concat(_toConsumableArray(copy), [{
+        node: node,
+        type: TreeSelection.SelectionType.RANGE,
+        focus: focus
+      }]));
+    }
+
+    /**
+     * Returns with an array of items representing the selection range. The from node is the `focus` the to node
+     * is the selected node itself on the tree selection. Both the `from` node and the `to` node are inclusive.
+     */
+  }, {
+    key: "selectionRange",
+    value: function selectionRange(selection) {
+      var fromNode = selection.focus;
+      var toNode = selection.node;
+      if (fromNode === undefined) {
+        return [];
+      }
+      if (toNode === fromNode) {
+        return [toNode];
+      }
+      var root = this.tree.root;
+      if (root === undefined) {
+        return [];
+      }
+      var to = this.tree.validateNode(toNode);
+      if (to === undefined) {
+        return [];
+      }
+      var from = this.tree.validateNode(fromNode);
+      if (from === undefined) {
+        return [];
+      }
+      var started = false;
+      var finished = false;
+      var range = [];
+      var _iterator2 = _createForOfIteratorHelper(new DepthFirstTreeIterator(root, {
+          pruneCollapsed: true
+        })),
+        _step2;
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var node = _step2.value;
+          if (finished) {
+            break;
+          }
+          // Only collect items which are between (inclusive) the `from` node and the `to` node.
+          if (equals(node, from) || equals(node, to)) {
+            if (started) {
+              finished = true;
+            } else {
+              started = true;
+            }
+          }
+          if (started) {
+            range.push(node);
+          }
+        }
+
+        // We need to reverse the selection range order.
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+      if (range.indexOf(from) > range.indexOf(to)) {
+        range.reverse();
+      }
+      return range.filter(SelectableTreeNode.is);
+    }
+  }, {
+    key: "toSelectableTreeNode",
+    value: function toSelectableTreeNode(node) {
+      if (node) {
+        var candidate = this.tree.getNode(node.id);
+        if (candidate) {
+          if (SelectableTreeNode.is(candidate)) {
+            return candidate;
+          }
+          console.warn("Could not map to a selectable tree node. Node with ID: ".concat(node.id, " is not a selectable node."));
+        } else {
+          console.warn("Could not map to a selectable tree node. Node does not exist with ID: ".concat(node.id, "."));
+        }
+      }
+      return undefined;
+    }
+
+    /**
+     * Checks whether the argument contains any `DEFAULT` tree selection type. If yes, throws an error, otherwise returns with a reference the argument.
+     */
+  }, {
+    key: "checkNoDefaultSelection",
+    value: function checkNoDefaultSelection(selections) {
+      if (selections.some(function (selection) {
+        return selection.type === undefined || selection.type === TreeSelection.SelectionType.DEFAULT;
+      })) {
+        throw new Error("Unexpected DEFAULT selection type. [".concat(selections.map(function (selection) {
+          return "ID: ".concat(selection.node.id, " | ").concat(selection.type);
+        }).join(', '), "]"));
+      }
+      return selections;
+    }
+  }]);
+  return TreeSelectionState;
+}();

package/es/app/tree/tree-selection.d.ts

@@ -0,0 +1,79 @@
+import type { SelectionProvider } from '../../core/index.js';
+import type { Event, Disposable } from '../../common/index.js';
+import { TreeNode } from './tree.js';
+/**
+ * The tree selection service.
+ */
+export declare const TreeSelectionService: unique symbol;
+export type TreeSelectionService = {
+    /**
+     * The tree selection, representing the selected nodes from the tree. If nothing is selected, the
+     * result will be empty.
+     */
+    readonly selectedNodes: readonly Readonly<SelectableTreeNode>[];
+    /**
+     * Emitted when the selection has changed in the tree.
+     */
+    readonly onSelectionChanged: Event<readonly Readonly<SelectableTreeNode>[]>;
+    /**
+     * Registers the given selection into the tree selection service. If the selection state changes after adding the
+     * `selectionOrTreeNode` argument, a selection changed event will be fired. If the argument is a tree node,
+     * a it will be treated as a tree selection with the default selection type.
+     */
+    addSelection: (selectionOrTreeNode: TreeSelection | Readonly<SelectableTreeNode>) => void;
+    /**
+     * Store selection state.
+     */
+    storeState: () => object;
+    /**
+     * Restore selection state.
+     */
+    restoreState: (state: object) => void;
+} & Disposable & SelectionProvider<readonly Readonly<SelectableTreeNode>[]>;
+/**
+ * Representation of a tree selection.
+ */
+export type TreeSelection = {
+    /**
+     * The actual item that has been selected.
+     */
+    readonly node: Readonly<SelectableTreeNode>;
+    /**
+     * The optional tree selection type. Defaults to `SelectionType.DEFAULT`;
+     */
+    readonly type?: TreeSelection.SelectionType;
+};
+export declare namespace TreeSelection {
+    /**
+     * Enumeration of selection types.
+     */
+    enum SelectionType {
+        DEFAULT = 0,
+        TOGGLE = 1,
+        RANGE = 2
+    }
+    function is(arg: Record<any, any> | undefined): arg is TreeSelection;
+    function isRange(arg: TreeSelection | SelectionType | undefined): boolean;
+    function isToggle(arg: TreeSelection | SelectionType | undefined): boolean;
+}
+/**
+ * A selectable tree node.
+ */
+export type SelectableTreeNode = {
+    /**
+     * `true` if the tree node is selected. Otherwise, `false`.
+     */
+    selected: boolean;
+    /**
+     * `true` if the tree node has the focus. Otherwise, `false`. Defaults to `false`.
+     */
+    focus?: boolean;
+} & TreeNode;
+export declare namespace SelectableTreeNode {
+    function is(node: TreeNode | undefined): node is SelectableTreeNode;
+    function isSelected(node: TreeNode | undefined): node is SelectableTreeNode;
+    function hasFocus(node: TreeNode | undefined): boolean;
+    function isVisible(node: TreeNode | undefined): node is SelectableTreeNode;
+    function getVisibleParent(node: TreeNode | undefined): SelectableTreeNode | undefined;
+}
+//# sourceMappingURL=tree-selection.d.ts.map

package/es/app/tree/tree-selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-selection.d.ts","sourceRoot":"","sources":["../../../src/app/tree/tree-selection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,oBAAoB,eAAiC,CAAC;AACnE,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,SAAS,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC,SAAS,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAE5E;;;;OAIG;IACH,YAAY,EAAE,CACZ,mBAAmB,EAAE,aAAa,GAAG,QAAQ,CAAC,kBAAkB,CAAC,KAC9D,IAAI,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC,GAAG,UAAU,GACZ,iBAAiB,CAAC,SAAS,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;CAC7C,CAAC;AAEF,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,KAAY,aAAa;QACvB,OAAO,IAAA;QACP,MAAM,IAAA;QACN,KAAK,IAAA;KACN;IAED,SAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,IAAI,aAAa,CAE1E;IAED,SAAgB,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,CAE/E;IAED,SAAgB,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,CAEhF;CAaF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,QAAQ,CAAC;AAEb,yBAAiB,kBAAkB,CAAC;IAClC,SAAgB,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,IAAI,kBAAkB,CAEzE;IAED,SAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,IAAI,kBAAkB,CAEjF;IAED,SAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAE5D;IAED,SAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,IAAI,kBAAkB,CAEhF;IAGD,SAAgB,gBAAgB,CAC9B,IAAI,EAAE,QAAQ,GAAG,SAAS,GACzB,kBAAkB,GAAG,SAAS,CAQhC;CACF"}

package/es/app/tree/tree-selection.js

@@ -0,0 +1,72 @@
+import { TreeNode } from "./tree.js";
+
+/**
+ * The tree selection service.
+ */
+export var TreeSelectionService = Symbol('TreeSelectionService');
+
+/**
+ * Representation of a tree selection.
+ */
+export var TreeSelection;
+(function (_TreeSelection) {
+  var SelectionType = /*#__PURE__*/function (SelectionType) {
+    SelectionType[SelectionType["DEFAULT"] = 0] = "DEFAULT";
+    SelectionType[SelectionType["TOGGLE"] = 1] = "TOGGLE";
+    SelectionType[SelectionType["RANGE"] = 2] = "RANGE";
+    return SelectionType;
+  }({});
+  _TreeSelection.SelectionType = SelectionType;
+  function is(arg) {
+    return !!arg && 'node' in arg;
+  }
+  _TreeSelection.is = is;
+  function isRange(arg) {
+    return isSelectionTypeOf(arg, SelectionType.RANGE);
+  }
+  _TreeSelection.isRange = isRange;
+  function isToggle(arg) {
+    return isSelectionTypeOf(arg, SelectionType.TOGGLE);
+  }
+  _TreeSelection.isToggle = isToggle;
+  // eslint-disable-next-line no-inner-declarations
+  function isSelectionTypeOf(arg, expected) {
+    if (arg === undefined) {
+      return false;
+    }
+    var type = typeof arg === 'number' ? arg : arg.type;
+    return type === expected;
+  }
+})(TreeSelection || (TreeSelection = {}));
+/**
+ * A selectable tree node.
+ */
+export var SelectableTreeNode;
+(function (_SelectableTreeNode) {
+  function is(node) {
+    return !!node && 'selected' in node;
+  }
+  _SelectableTreeNode.is = is;
+  function isSelected(node) {
+    return is(node) && node.selected;
+  }
+  _SelectableTreeNode.isSelected = isSelected;
+  function hasFocus(node) {
+    return is(node) && node.focus === true;
+  }
+  _SelectableTreeNode.hasFocus = hasFocus;
+  function isVisible(node) {
+    return is(node) && TreeNode.isVisible(node);
+  }
+  _SelectableTreeNode.isVisible = isVisible;
+  function getVisibleParent(node) {
+    if (node) {
+      if (isVisible(node.parent)) {
+        return node.parent;
+      }
+      return getVisibleParent(node.parent);
+    }
+    return undefined;
+  }
+  _SelectableTreeNode.getVisibleParent = getVisibleParent;
+})(SelectableTreeNode || (SelectableTreeNode = {}));