wunderbaum 0.0.8 → 0.0.9

package/dist/wunderbaum.esm.js

@@ -1,7 +1,7 @@
 /*!
  * Wunderbaum - util
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 /** @module util */
 /** Readable names for `MouseEvent.button` */
@@ -707,7 +707,7 @@ var util = /*#__PURE__*/Object.freeze({
 /*!
  * Wunderbaum - types
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 /** Possible values for `setModified()`. */
 var ChangeType;
@@ -759,7 +759,7 @@ var NavigationOptions;
 /*!
  * Wunderbaum - wb_extension_base
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 class WunderbaumExtension {
     constructor(tree, id, defaults) {
@@ -1050,7 +1050,7 @@ function debounce(func, wait = 0, options = {}) {
 /*!
  * Wunderbaum - ext-filter
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 const START_MARKER = "\uFFF7";
 const END_MARKER = "\uFFF8";
@@ -1355,7 +1355,7 @@ function _markFuzzyMatchedChars(text, matches, escapeTitles = true) {
 /*!
  * Wunderbaum - ext-keynav
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 const QUICKSEARCH_DELAY = 500;
 class KeynavExtension extends WunderbaumExtension {
@@ -1453,7 +1453,8 @@ class KeynavExtension extends WunderbaumExtension {
                     if (!node.expanded && (node.children || node.lazy)) {
                         eventName = "Add"; // expand
                     }
-                    else if (navModeOption === NavigationOptions.startRow) {
+                    else if (navModeOption === NavigationOptions.startCell ||
+                        navModeOption === NavigationOptions.startRow) {
                         tree.setCellNav();
                         return;
                     }
@@ -1606,17 +1607,31 @@ class KeynavExtension extends WunderbaumExtension {
                     }
                     handled = true;
                     break;
+                case "Home": // Generated by FN + ArrowLeft on Mac
+                case "Meta+ArrowLeft":
+                    tree.setFocus(); // Blur prev. input if any
+                    if (!isColspan && tree.activeColIdx > 0) {
+                        tree.setColumn(0);
+                    }
+                    handled = true;
+                    break;
+                case "End": // Generated by FN + ArrowRight on Mac
+                case "Meta+ArrowRight":
+                    tree.setFocus(); // Blur prev. input if any
+                    if (!isColspan && tree.activeColIdx < tree.columns.length - 1) {
+                        tree.setColumn(tree.columns.length - 1);
+                    }
+                    handled = true;
+                    break;
                 case "ArrowDown":
                 case "ArrowUp":
                 case "Backspace":
-                case "End":
-                case "Home":
-                case "Control+End":
-                case "Control+Home":
+                case "Control+End": // Generated by FN + Control + ArrowRight on Mac
+                case "Control+Home": // Generated by FN + Control + Arrowleft on Mac
                 case "Meta+ArrowDown":
                 case "Meta+ArrowUp":
-                case "PageDown":
-                case "PageUp":
+                case "PageDown": // Generated by FN + ArrowDown on Mac
+                case "PageUp": // Generated by FN + ArrowUp on Mac
                     node.navigate(eventName, { activate: activate, event: event });
                     // if (isCellEditMode) {
                     //   this._getEmbeddedInputElem(null, true); // set focus to input
@@ -1637,7 +1652,7 @@ class KeynavExtension extends WunderbaumExtension {
 /*!
  * Wunderbaum - ext-logger
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 class LoggerExtension extends WunderbaumExtension {
     constructor(tree) {
@@ -1677,7 +1692,7 @@ class LoggerExtension extends WunderbaumExtension {
 /*!
  * Wunderbaum - common
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 const DEFAULT_DEBUGLEVEL = 4; // Replaced by rollup script
 /**
@@ -1917,7 +1932,7 @@ function inflateSourceData(source) {
 /*!
  * Wunderbaum - ext-dnd
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 const nodeMimeType = "application/x-wunderbaum-node";
 class DndExtension extends WunderbaumExtension {
@@ -2061,6 +2076,11 @@ class DndExtension extends WunderbaumExtension {
         if (e.type === "dragstart") {
             // Set a default definition of allowed effects
             e.dataTransfer.effectAllowed = dndOpts.effectAllowed; //"copyMove"; // "all";
+            if (srcNode.isEditing()) {
+                srcNode.logDebug("Prevented dragging node in edit mode.");
+                e.preventDefault();
+                return false;
+            }
             // Let user cancel the drag operation, override effectAllowed, etc.:
             const res = srcNode._callEvent("dnd.dragStart", { event: e });
             if (!res) {
@@ -2185,7 +2205,7 @@ class DndExtension extends WunderbaumExtension {
 /*!
  * Wunderbaum - drag_observer
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 /**
  * Convert mouse- and touch events to 'dragstart', 'drag', and 'dragstop'.
@@ -2204,8 +2224,10 @@ class DragObserver {
         this.dragging = false;
         // TODO: touch events
         this.events = ["mousedown", "mouseup", "mousemove", "keydown"];
-        assert(opts.root);
-        this.opts = extend({ thresh: 5 }, opts);
+        if (!opts.root) {
+            throw new Error("Missing `root` option.");
+        }
+        this.opts = Object.assign({ thresh: 5 }, opts);
         this.root = opts.root;
         this._handler = this.handleEvent.bind(this);
         this.events.forEach((type) => {
@@ -2319,7 +2341,7 @@ class DragObserver {
 /*!
  * Wunderbaum - ext-grid
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 class GridExtension extends WunderbaumExtension {
     constructor(tree) {
@@ -2356,7 +2378,7 @@ class GridExtension extends WunderbaumExtension {
 /*!
  * Wunderbaum - deferred
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 /**
  * Implement a ES6 Promise, that exposes a resolve() and reject() method.
@@ -2409,7 +2431,7 @@ class Deferred {
 /*!
  * Wunderbaum - wunderbaum_node
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 /** Top-level properties that can be passed with `data`. */
 const NODE_PROPS = new Set([
@@ -2520,6 +2542,35 @@ class WunderbaumNode {
     toString() {
         return `WunderbaumNode@${this.key}<'${this.title}'>`;
     }
+    /**
+     * Iterate all descendant nodes depth-first, pre-order using `for ... of ...` syntax.
+     * More concise, but slightly slower than {@link WunderbaumNode.visit}.
+     *
+     * Example:
+     * ```js
+     * for(const n of node) {
+     *   ...
+     * }
+     * ```
+     */
+    *[Symbol.iterator]() {
+        // let node: WunderbaumNode | null = this;
+        const cl = this.children;
+        if (cl) {
+            for (let i = 0, l = cl.length; i < l; i++) {
+                const n = cl[i];
+                yield n;
+                if (n.children) {
+                    yield* n;
+                }
+            }
+            // Slower:
+            // for (let node of this.children) {
+            //   yield node;
+            //   yield* node : 0;
+            // }
+        }
+    }
     // /** Return an option value. */
     // protected _getOpt(
     //   name: string,
@@ -2824,6 +2875,57 @@ class WunderbaumNode {
     findRelatedNode(where, includeHidden = false) {
         return this.tree.findRelatedNode(this, where, includeHidden);
     }
+    /**
+     * Iterator version of {@link WunderbaumNode.format}.
+     */
+    *format_iter(name_cb, connectors) {
+        connectors !== null && connectors !== void 0 ? connectors : (connectors = ["    ", " |  ", " ╰─ ", " ├─ "]);
+        name_cb !== null && name_cb !== void 0 ? name_cb : (name_cb = (node) => "" + node);
+        function _is_last(node) {
+            const ca = node.parent.children;
+            return node === ca[ca.length - 1];
+        }
+        const _format_line = (node) => {
+            // https://www.measurethat.net/Benchmarks/Show/12196/0/arr-unshift-vs-push-reverse-small-array
+            const parts = [name_cb(node)];
+            parts.unshift(connectors[_is_last(node) ? 2 : 3]);
+            let p = node.parent;
+            while (p && p !== this) {
+                // `this` is the top node
+                parts.unshift(connectors[_is_last(p) ? 0 : 1]);
+                p = p.parent;
+            }
+            return parts.join("");
+        };
+        yield name_cb(this);
+        for (let node of this) {
+            yield _format_line(node);
+        }
+    }
+    /**
+     * Return multiline string representation of a node/subnode hierarchy.
+     * Mostly useful for debugging.
+     *
+     * Example:
+     * ```js
+     * console.info(tree.getActiveNode().format((n)=>n.title));
+     * ```
+     * logs
+     * ```
+     * Books
+     *  ├─ Art of War
+     *  ╰─ Don Quixote
+     * ...
+     * ```
+     * @see {@link WunderbaumNode.format_iter}
+     */
+    format(name_cb, connectors) {
+        const a = [];
+        for (let line of this.format_iter(name_cb, connectors)) {
+            a.push(line);
+        }
+        return a.join("\n");
+    }
     /** Return the `<span class='wb-col'>` element with a given index or id.
      * @returns {WunderbaumNode | null}
      */
@@ -3078,7 +3180,10 @@ class WunderbaumNode {
         const tree = this.tree;
         level !== null && level !== void 0 ? level : (level = this.getLevel());
         // Let caller modify the parsed JSON response:
-        this._callEvent("receive", { response: source });
+        const res = this._callEvent("receive", { response: source });
+        if (res != null) {
+            source = res;
+        }
         if (isArray(source)) {
             source = { children: source };
         }
@@ -3475,13 +3580,15 @@ class WunderbaumNode {
             renderColInfosById: renderColInfosById,
         };
     }
-    _createIcon(parentElem, replaceChild) {
+    _createIcon(parentElem, replaceChild, showLoading) {
         let iconSpan;
         let icon = this.getOption("icon");
         if (this._errorInfo) {
             icon = iconMap.error;
         }
-        else if (this._isLoading) {
+        else if (this._isLoading && showLoading) {
+            // Status nodes, or nodes without expander (< minExpandLevel) should
+            // display the 'loading' status with the i.wb-icon span
             icon = iconMap.loading;
         }
         if (icon === false) {
@@ -3576,7 +3683,9 @@ class WunderbaumNode {
             nodeElem.appendChild(expanderSpan);
             ofsTitlePx += ICON_WIDTH;
         }
-        iconSpan = this._createIcon(nodeElem);
+        // Render the icon (show a 'loading' icon if we do not have an expander that
+        // we would prefer).
+        iconSpan = this._createIcon(nodeElem, null, !expanderSpan);
         if (iconSpan) {
             ofsTitlePx += ICON_WIDTH;
         }
@@ -3734,7 +3843,10 @@ class WunderbaumNode {
             rowDiv.classList.add(...typeInfo.classes);
         }
         if (expanderSpan) {
-            if (this.isExpandable(false)) {
+            if (this._isLoading) {
+                expanderSpan.className = "wb-expander " + iconMap.loading;
+            }
+            else if (this.isExpandable(false)) {
                 if (this.expanded) {
                     expanderSpan.className = "wb-expander " + iconMap.expanderExpanded;
                 }
@@ -3742,9 +3854,6 @@ class WunderbaumNode {
                     expanderSpan.className = "wb-expander " + iconMap.expanderCollapsed;
                 }
             }
-            else if (this._isLoading) {
-                expanderSpan.className = "wb-expander " + iconMap.loading;
-            }
             else if (this.lazy && this.children == null) {
                 expanderSpan.className = "wb-expander " + iconMap.expanderLazy;
             }
@@ -3769,7 +3878,7 @@ class WunderbaumNode {
             // Update icon (if not opts.isNew, which would rebuild markup anyway)
             const iconSpan = nodeElem.querySelector("i.wb-icon");
             if (iconSpan) {
-                this._createIcon(nodeElem, iconSpan);
+                this._createIcon(nodeElem, iconSpan, !expanderSpan);
             }
         }
     }
@@ -3778,11 +3887,14 @@ class WunderbaumNode {
      *
      * `options.change` defaults to ChangeType.data, which updates the title,
      * icon, and status. It also triggers the `render` event, that lets the user
-     * create or update the content of embeded cell elements.<br>
+     * create or update the content of embeded cell elements.
      *
      * If only the status or other class-only modifications have changed,
      * `options.change` should be set to ChangeType.status instead for best
      * efficiency.
+     *
+     * Calling `setModified` instead may be a better alternative.
+     * @see {@link WunderbaumNode.setModified}
      */
     render(options) {
         // this.log("render", options);
@@ -4082,8 +4194,13 @@ class WunderbaumNode {
                 this._errorInfo = null;
                 break;
             case "loading":
-                // If this is the invisible root, add a visible top-level node
-                if (!this.parent) {
+                this._isLoading = true;
+                this._errorInfo = null;
+                if (this.parent) {
+                    this.setModified(ChangeType.status);
+                }
+                else {
+                    // If this is the invisible root, add a visible top-level node
                     _setStatusNode({
                         statusNodeType: status,
                         title: tree.options.strings.loading +
@@ -4093,8 +4210,6 @@ class WunderbaumNode {
                         tooltip: details,
                     });
                 }
-                this._isLoading = true;
-                this._errorInfo = null;
                 // this.render();
                 break;
             case "error":
@@ -4157,7 +4272,7 @@ class WunderbaumNode {
         this.parent.triggerModifyChild(operation, this, extra);
     }
     /**
-     * Call fn(node) for all child nodes in hierarchical order (depth-first).
+     * Call `callback(node)` for all child nodes in hierarchical order (depth-first, pre-order).
      *
      * Stop iteration, if fn() returns false. Skip current branch, if fn()
      * returns "skip".<br>
@@ -4166,6 +4281,7 @@ class WunderbaumNode {
      * @param {function} callback the callback function.
      *     Return false to stop iteration, return "skip" to skip this node and
      *     its children only.
+     * @see {@link WunderbaumNode.*[Symbol.iterator]}, {@link Wunderbaum.visit}.
      */
     visit(callback, includeSelf = false) {
         let i, l, res = true, children = this.children;
@@ -4236,7 +4352,7 @@ WunderbaumNode.sequence = 0;
 /*!
  * Wunderbaum - ext-edit
  * Copyright (c) 2021-2022, Martin Wendt. Released under the MIT license.
- * v0.0.8, Fri, 23 Sep 2022 20:47:29 GMT (https://github.com/mar10/wunderbaum)
+ * v0.0.9, Mon, 31 Oct 2022 17:06:10 GMT (https://github.com/mar10/wunderbaum)
  */
 // const START_MARKER = "\uFFF7";
 class EditExtension extends WunderbaumExtension {
@@ -4529,8 +4645,8 @@ class EditExtension extends WunderbaumExtension {
  * https://github.com/mar10/wunderbaum
  *
  * Released under the MIT license.
- * @version v0.0.8
- * @date Fri, 23 Sep 2022 20:47:29 GMT
+ * @version v0.0.9
+ * @date Mon, 31 Oct 2022 17:06:10 GMT
  */
 class WbSystemRoot extends WunderbaumNode {
     constructor(tree) {
@@ -4917,6 +5033,20 @@ class Wunderbaum {
         }
         return null;
     }
+    /**
+     * Iterate all descendant nodes depth-first, pre-order using `for ... of ...` syntax.
+     * More concise, but slightly slower than {@link Wunderbaum.visit}.
+     *
+     * Example:
+     * ```js
+     * for(const node of tree) {
+     *   ...
+     * }
+     * ```
+     */
+    *[Symbol.iterator]() {
+        yield* this.root;
+    }
     /** @internal */
     _registerExtension(extension) {
         this.extensionList.push(extension);
@@ -4931,8 +5061,8 @@ class Wunderbaum {
     }
     /** Add node to tree's bookkeeping data structures. */
     _registerNode(node) {
-        let key = node.key;
-        assert(key != null && !this.keyMap.has(key));
+        const key = node.key;
+        assert(key != null && !this.keyMap.has(key), `Missing or duplicate key: '${key}'.`);
         this.keyMap.set(key, node);
         let rk = node.refKey;
         if (rk) {
@@ -5510,6 +5640,35 @@ class Wunderbaum {
         }
         return res;
     }
+    /**
+     * Iterator version of {@link Wunderbaum.format}.
+     */
+    *format_iter(name_cb, connectors) {
+        return this.root.format_iter(name_cb, connectors);
+    }
+    /**
+     * Return multiline string representation of the node hierarchy.
+     * Mostly useful for debugging.
+     *
+     * Example:
+     * ```js
+     * console.info(tree.format((n)=>n.title));
+     * ```
+     * logs
+     * ```
+     * Playground
+     * ├─ Books
+     * |   ├─ Art of War
+     * |   ╰─ Don Quixote
+     * ├─ Music
+     * ...
+     * ```
+     *
+     * @see {@link Wunderbaum.format_iter} and {@link WunderbaumNode.format}.
+     */
+    format(name_cb, connectors) {
+        return this.root.format(name_cb, connectors);
+    }
     /**
      * Return the active cell (`span.wb-col`) of the currently active node or null.
      */
@@ -6236,7 +6395,8 @@ class Wunderbaum {
         return modified;
     }
     /**
-     * Call callback(node) for all nodes in hierarchical order (depth-first).
+     * Call `callback(node)` for all nodes in hierarchical order (depth-first, pre-order).
+     * @see {@link Wunderbaum.*[Symbol.iterator]}, {@link WunderbaumNode.visit}.
      *
      * @param {function} callback the callback function.
      *     Return false to stop iteration, return "skip" to skip this node and
@@ -6459,7 +6619,7 @@ class Wunderbaum {
 }
 Wunderbaum.sequence = 0;
 /** Wunderbaum release version number "MAJOR.MINOR.PATCH". */
-Wunderbaum.version = "v0.0.8"; // Set to semver by 'grunt release'
+Wunderbaum.version = "v0.0.9"; // Set to semver by 'grunt release'
 /** Expose some useful methods of the util.ts module as `Wunderbaum.util`. */
 Wunderbaum.util = util;