sculp-js 1.13.4 → 1.14.0

package/dist/esm/tree.js

@@ -1,18 +1,18 @@
 /*!
- * sculp-js v1.13.4
+ * sculp-js v1.14.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
 
 import { objectOmit } from './object.js';
-import { isObject, objectHas, isEmpty, isNodeList } from './type.js';
+import { isObject, objectHas, isNodeList } from './type.js';
 
 const defaultFieldOptions = { keyField: 'key', childField: 'children', pidField: 'pid' };
 const defaultSearchTreeOptions = {
-    childField: 'children',
-    nameField: 'name',
-    removeEmptyChild: false,
-    ignoreCase: true
+  childField: 'children',
+  nameField: 'name',
+  removeEmptyChild: false,
+  ignoreCase: true
 };
 /**
  * 树遍历函数(支持continue和break操作), 可用于遍历Array和NodeList类型的数据
@@ -26,106 +26,177 @@ const defaultSearchTreeOptions = {
   }
  * @returns {*}
  */
-function forEachDeep(tree, iterator, options = {
+function forEachDeep(
+  tree,
+  iterator,
+  options = {
     childField: 'children',
     reverse: false,
     breadthFirst: false,
     isDomNode: false
-}) {
-    const { childField = 'children', reverse = false, breadthFirst = false, isDomNode = false } = isObject(options) ? options : {};
-    let isBreak = false;
-    const queue = [];
-    const reverseWalk = (arr, parent, level = 0) => {
-        for (let index = arr.length - 1; index >= 0; index--) {
-            if (isBreak) {
-                break;
-            }
-            const item = arr[index];
-            // 广度优先
-            if (breadthFirst) {
-                queue.push({ item, index, array: arr, tree, parent, level });
-            }
-            else {
-                const re = iterator(item, index, arr, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
-                    reverseWalk(item[childField], item, level + 1);
-                }
-            }
+  }
+) {
+  const {
+    childField = 'children',
+    reverse = false,
+    breadthFirst = false,
+    isDomNode = false
+  } = isObject(options) ? options : {};
+  let isBreak = false;
+  const queue = [];
+  const reverseWalk = (arr, parent, level = 0) => {
+    for (let index = arr.length - 1; index >= 0; index--) {
+      if (isBreak) {
+        break;
+      }
+      const item = arr[index];
+      // 广度优先
+      if (breadthFirst) {
+        queue.push({ item, index, array: arr, tree, parent, level });
+      } else {
+        const re = iterator(item, index, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
         }
-        if (breadthFirst) {
-            // Process queue
-            while (queue.length > 0 && !isBreak) {
-                const current = queue.shift();
-                const { item, index, array, tree, parent, level } = current;
-                const re = iterator(item, index, array, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
-                    reverseWalk(item[childField], item, level + 1);
-                }
-            }
+        if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
+          reverseWalk(item[childField], item, level + 1);
         }
-    };
-    const walk = (arr, parent, level = 0) => {
-        for (let index = 0, len = arr.length; index < len; index++) {
-            if (isBreak) {
-                break;
-            }
-            const item = arr[index];
-            if (breadthFirst) {
-                // 广度优先
-                queue.push({ item, index: index, array: arr, tree, parent, level });
-            }
-            else {
-                // 深度优先
-                const re = iterator(item, index, arr, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
-                    walk(item[childField], item, level + 1);
-                }
-            }
+      }
+    }
+    if (breadthFirst) {
+      // Process queue
+      while (queue.length > 0 && !isBreak) {
+        const current = queue.shift();
+        const { item, index, array, tree, parent, level } = current;
+        const re = iterator(item, index, array, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
         }
-        if (breadthFirst) {
-            while (queue.length > 0 && !isBreak) {
-                const current = queue.shift();
-                if (!current)
-                    break;
-                const { item, index, array, tree, parent, level } = current;
-                const re = iterator(item, index, array, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
-                    walk(item[childField], item, level + 1);
-                }
-            }
+        if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
+          reverseWalk(item[childField], item, level + 1);
         }
-    };
-    reverse ? reverseWalk(tree, null, 0) : walk(tree, null, 0);
-    // @ts-ignore
-    tree = null;
+      }
+    }
+  };
+  const walk = (arr, parent, level = 0) => {
+    for (let index = 0, len = arr.length; index < len; index++) {
+      if (isBreak) {
+        break;
+      }
+      const item = arr[index];
+      if (breadthFirst) {
+        // 广度优先
+        queue.push({ item, index: index, array: arr, tree, parent, level });
+      } else {
+        // 深度优先
+        const re = iterator(item, index, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
+        }
+        if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
+          walk(item[childField], item, level + 1);
+        }
+      }
+    }
+    if (breadthFirst) {
+      while (queue.length > 0 && !isBreak) {
+        const current = queue.shift();
+        if (!current) break;
+        const { item, index, array, tree, parent, level } = current;
+        const re = iterator(item, index, array, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
+        }
+        if (item && (isDomNode ? isNodeList(item[childField]) : Array.isArray(item[childField]))) {
+          walk(item[childField], item, level + 1);
+        }
+      }
+    }
+  };
+  reverse ? reverseWalk(tree, null, 0) : walk(tree, null, 0);
+  // @ts-ignore
+  tree = null;
+}
+/**
+ * 树查找函数, 可用于查找Array和NodeList类型的数据
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} predicate  断言函数
+ * @param {options} options 支持定制子元素名称、反向遍历、广度优先遍历，默认{
+    childField: 'children',
+    reverse: false,
+    breadthFirst: false,
+    isDomNode: false,
+  }
+ * @returns {V|null}
+ */
+function findDeep(
+  tree,
+  predicate,
+  options = {
+    childField: 'children',
+    reverse: false,
+    breadthFirst: false,
+    isDomNode: false
+  }
+) {
+  let result = null;
+  forEachDeep(
+    tree,
+    (...args) => {
+      if (predicate(...args)) {
+        result = args[0];
+        return false;
+      }
+    },
+    options
+  );
+  return result;
+}
+/**
+ * 树过滤函数, 可用于过滤Array和NodeList类型的数据
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} predicate  断言函数
+ * @param {options} options 支持定制子元素名称、反向遍历、广度优先遍历，默认{
+    childField: 'children',
+    reverse: false,
+    breadthFirst: false,
+    isDomNode: false,
+  }
+ * @returns {V|null}
+ */
+function filterDeep(
+  tree,
+  predicate,
+  options = {
+    childField: 'children',
+    reverse: false,
+    breadthFirst: false,
+    isDomNode: false
+  }
+) {
+  const result = [];
+  forEachDeep(
+    tree,
+    (...args) => {
+      if (predicate(...args)) {
+        result.push(args[0]);
+      }
+    },
+    options
+  );
+  return result;
 }
 /**
  * 创建一个新数组, 深度优先遍历的Map函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
@@ -139,69 +210,68 @@ function forEachDeep(tree, iterator, options = {
   }
  * @returns {any[]} 新的一棵树
  */
-function mapDeep(tree, iterator, options = {
+function mapDeep(
+  tree,
+  iterator,
+  options = {
     childField: 'children',
     reverse: false
-}) {
-    const { childField = 'children', reverse = false } = isObject(options) ? options : {};
-    let isBreak = false;
-    const newTree = [];
-    const walk = (arr, parent, newTree, level = 0) => {
-        if (reverse) {
-            for (let i = arr.length - 1; i >= 0; i--) {
-                if (isBreak) {
-                    break;
-                }
-                const item = arr[i];
-                const re = iterator(item, i, arr, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                newTree.push(objectOmit(re, [childField]));
-                if (item && Array.isArray(item[childField])) {
-                    newTree[newTree.length - 1][childField] = [];
-                    walk(item[childField], item, newTree[newTree.length - 1][childField], level + 1);
-                }
-                else {
-                    // children非有效数组时，移除该属性字段
-                    delete re[childField];
-                }
-            }
+  }
+) {
+  const { childField = 'children', reverse = false } = isObject(options) ? options : {};
+  let isBreak = false;
+  const newTree = [];
+  const walk = (arr, parent, newTree, level = 0) => {
+    if (reverse) {
+      for (let i = arr.length - 1; i >= 0; i--) {
+        if (isBreak) {
+          break;
         }
-        else {
-            for (let i = 0; i < arr.length; i++) {
-                if (isBreak) {
-                    break;
-                }
-                const item = arr[i];
-                const re = iterator(item, i, arr, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                newTree.push(objectOmit(re, [childField]));
-                if (item && Array.isArray(item[childField])) {
-                    newTree[newTree.length - 1][childField] = [];
-                    walk(item[childField], item, newTree[newTree.length - 1][childField], level + 1);
-                }
-                else {
-                    // children非有效数组时，移除该属性字段
-                    delete re[childField];
-                }
-            }
+        const item = arr[i];
+        const re = iterator(item, i, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
         }
-    };
-    walk(tree, null, newTree);
-    // @ts-ignore
-    tree = null;
-    return newTree;
+        newTree.push(objectOmit(re, [childField]));
+        if (item && Array.isArray(item[childField])) {
+          newTree[newTree.length - 1][childField] = [];
+          walk(item[childField], item, newTree[newTree.length - 1][childField], level + 1);
+        } else {
+          // children非有效数组时，移除该属性字段
+          delete re[childField];
+        }
+      }
+    } else {
+      for (let i = 0; i < arr.length; i++) {
+        if (isBreak) {
+          break;
+        }
+        const item = arr[i];
+        const re = iterator(item, i, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
+        }
+        newTree.push(objectOmit(re, [childField]));
+        if (item && Array.isArray(item[childField])) {
+          newTree[newTree.length - 1][childField] = [];
+          walk(item[childField], item, newTree[newTree.length - 1][childField], level + 1);
+        } else {
+          // children非有效数组时，移除该属性字段
+          delete re[childField];
+        }
+      }
+    }
+  };
+  walk(tree, null, newTree);
+  // @ts-ignore
+  tree = null;
+  return newTree;
 }
 /**
  * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
@@ -212,29 +282,30 @@ function mapDeep(tree, iterator, options = {
  * @returns {[(number | string)[], V[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
  */
 function searchTreeById(tree, nodeId, options = { childField: 'children', keyField: 'id' }) {
-    const { childField = 'children', keyField = 'id' } = isObject(options) ? options : {};
-    const toFlatArray = (tree, parentId, parent) => {
-        return tree.reduce((t, _) => {
-            const child = _[childField];
-            return [
-                ...t,
-                parentId ? { ..._, parentId, parent } : _,
-                ...(child && child.length ? toFlatArray(child, _[keyField], _) : [])
-            ];
-        }, []);
-    };
-    const getIds = (flatArray) => {
-        let child = flatArray.find(_ => _[keyField] === nodeId);
-        const { parent, parentId, ...other } = child;
-        let ids = [nodeId], nodes = [other];
-        while (child && child.parentId) {
-            ids = [child.parentId, ...ids];
-            nodes = [child.parent, ...nodes];
-            child = flatArray.find(_ => _[keyField] === child.parentId); // eslint-disable-line
-        }
-        return [ids, nodes];
-    };
-    return getIds(toFlatArray(tree));
+  const { childField = 'children', keyField = 'id' } = isObject(options) ? options : {};
+  const toFlatArray = (tree, parentId, parent) => {
+    return tree.reduce((t, _) => {
+      const child = _[childField];
+      return [
+        ...t,
+        parentId ? { ..._, parentId, parent } : _,
+        ...(child && child.length ? toFlatArray(child, _[keyField], _) : [])
+      ];
+    }, []);
+  };
+  const getIds = flatArray => {
+    let child = flatArray.find(_ => _[keyField] === nodeId);
+    const { parent, parentId, ...other } = child;
+    let ids = [nodeId],
+      nodes = [other];
+    while (child && child.parentId) {
+      ids = [child.parentId, ...ids];
+      nodes = [child.parent, ...nodes];
+      child = flatArray.find(_ => _[keyField] === child.parentId); // eslint-disable-line
+    }
+    return [ids, nodes];
+  };
+  return getIds(toFlatArray(tree));
 }
 /**
  * 扁平化数组转换成树
@@ -244,26 +315,25 @@ function searchTreeById(tree, nodeId, options = { childField: 'children', keyFie
  * @returns {any[]}
  */
 function formatTree(list, options = defaultFieldOptions) {
-    const { keyField = 'key', childField = 'children', pidField = 'pid' } = isObject(options) ? options : {};
-    const treeArr = [];
-    const sourceMap = {};
-    for (let i = 0, len = list.length; i < len; i++) {
-        const item = list[i];
-        sourceMap[item[keyField]] = item;
-    }
-    for (let i = 0, len = list.length; i < len; i++) {
-        const item = list[i];
-        const parent = sourceMap[item[pidField]];
-        if (parent) {
-            (parent[childField] || (parent[childField] = [])).push(item);
-        }
-        else {
-            treeArr.push(item);
-        }
+  const { keyField = 'key', childField = 'children', pidField = 'pid' } = isObject(options) ? options : {};
+  const treeArr = [];
+  const sourceMap = {};
+  for (let i = 0, len = list.length; i < len; i++) {
+    const item = list[i];
+    sourceMap[item[keyField]] = item;
+  }
+  for (let i = 0, len = list.length; i < len; i++) {
+    const item = list[i];
+    const parent = sourceMap[item[pidField]];
+    if (parent) {
+      (parent[childField] || (parent[childField] = [])).push(item);
+    } else {
+      treeArr.push(item);
     }
-    // @ts-ignore
-    list = null;
-    return treeArr;
+  }
+  // @ts-ignore
+  list = null;
+  return treeArr;
 }
 /**
  * 树形结构转扁平化
@@ -273,25 +343,25 @@ function formatTree(list, options = defaultFieldOptions) {
  * @returns {any[]}
  */
 function flatTree(treeList, options = defaultFieldOptions) {
-    const { keyField = 'key', childField = 'children', pidField = 'pid' } = isObject(options) ? options : {};
-    let res = [];
-    for (let i = 0, len = treeList.length; i < len; i++) {
-        const node = treeList[i];
-        const item = {
-            ...node,
-            [childField]: [] // 清空子级
-        };
-        objectHas(item, childField) && delete item[childField];
-        res.push(item);
-        if (node[childField]) {
-            const children = node[childField].map(item => ({
-                ...item,
-                [pidField]: node[keyField] || item.pid // 给子级设置pid
-            }));
-            res = res.concat(flatTree(children, options));
-        }
+  const { keyField = 'key', childField = 'children', pidField = 'pid' } = isObject(options) ? options : {};
+  let res = [];
+  for (let i = 0, len = treeList.length; i < len; i++) {
+    const node = treeList[i];
+    const item = {
+      ...node,
+      [childField]: [] // 清空子级
+    };
+    objectHas(item, childField) && delete item[childField];
+    res.push(item);
+    if (node[childField]) {
+      const children = node[childField].map(item => ({
+        ...item,
+        [pidField]: node[keyField] || item.pid // 给子级设置pid
+      }));
+      res = res.concat(flatTree(children, options));
     }
-    return res;
+  }
+  return res;
 }
 /**
  * 模糊搜索函数，返回包含搜索字符的节点及其祖先节点, 适用于树型组件的字符过滤功能
@@ -313,50 +383,49 @@ function flatTree(treeList, options = defaultFieldOptions) {
  * @returns {V[]}
  */
 function fuzzySearchTree(nodes, filterCondition, options = defaultSearchTreeOptions) {
-    if (!objectHas(filterCondition, 'filter') &&
-        (!objectHas(filterCondition, 'keyword') || isEmpty(filterCondition.keyword))) {
-        return nodes;
-    }
-    const result = [];
-    for (let i = 0, len = nodes.length; i < len; i++) {
-        const node = nodes[i];
-        // 递归检查子节点是否匹配
-        const matchedChildren = node[options.childField] && node[options.childField].length > 0
-            ? fuzzySearchTree(node[options.childField] || [], filterCondition, options)
-            : [];
-        // 检查当前节点是否匹配或者有匹配的子节点
-        if ((objectHas(filterCondition, 'filter')
-            ? filterCondition.filter(node)
-            : !options.ignoreCase
-                ? node[options.nameField].includes(filterCondition.keyword)
-                : node[options.nameField].toLowerCase().includes(filterCondition.keyword.toLowerCase())) ||
-            matchedChildren.length > 0) {
-            // 将当前节点加入结果中
-            if (node[options.childField]) {
-                if (matchedChildren.length > 0) {
-                    result.push({
-                        ...node,
-                        [options.childField]: matchedChildren // 包含匹配的子节点
-                    });
-                }
-                else if (options.removeEmptyChild) {
-                    const { [options.childField]: _, ...other } = node;
-                    result.push(other);
-                }
-                else {
-                    result.push({
-                        ...node,
-                        [options.childField]: []
-                    });
-                }
-            }
-            else {
-                const { [options.childField]: _, ...other } = node;
-                result.push(other);
-            }
+  if (!objectHas(filterCondition, 'filter') && !filterCondition.keyword) {
+    return nodes;
+  }
+  const result = [];
+  for (let i = 0, len = nodes.length; i < len; i++) {
+    const node = nodes[i];
+    // 递归检查子节点是否匹配
+    const matchedChildren =
+      node[options.childField] && node[options.childField].length > 0
+        ? fuzzySearchTree(node[options.childField] || [], filterCondition, options)
+        : [];
+    // 检查当前节点是否匹配或者有匹配的子节点
+    if (
+      (objectHas(filterCondition, 'filter')
+        ? filterCondition.filter(node)
+        : !options.ignoreCase
+        ? node[options.nameField].includes(filterCondition.keyword)
+        : node[options.nameField].toLowerCase().includes(filterCondition.keyword.toLowerCase())) ||
+      matchedChildren.length > 0
+    ) {
+      // 将当前节点加入结果中
+      if (node[options.childField]) {
+        if (matchedChildren.length > 0) {
+          result.push({
+            ...node,
+            [options.childField]: matchedChildren // 包含匹配的子节点
+          });
+        } else if (options.removeEmptyChild) {
+          const { [options.childField]: _, ...other } = node;
+          result.push(other);
+        } else {
+          result.push({
+            ...node,
+            [options.childField]: []
+          });
         }
+      } else {
+        const { [options.childField]: _, ...other } = node;
+        result.push(other);
+      }
     }
-    return result;
+  }
+  return result;
 }
 
-export { flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById };
+export { filterDeep, findDeep, flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById };