@cloudcome/utils-core/dist/tree.mjs.map

cloudcome core utils

{"version":3,"file":"tree.mjs","sources":["../src/tree.ts"],"sourcesContent":["import { arrayEach } from './array';\nimport { isArray, isNullish, isUndefined } from './type';\nimport type { AnyObject } from './types';\n\n/**\n * 表示深度遍历中的节点对象，包含子节点列表。\n */\nexport type TreeItem = AnyObject & {\n  /**\n   * 子节点列表。\n   */\n  children?: TreeItem[];\n};\n\n/**\n * 表示深度遍历中的节点列表。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TreeList<I extends TreeItem> = I[];\n\n/**\n * 表示深度遍历中的遍历器状态。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TreeWalker<I extends TreeItem> = {\n  /**\n   * 当前层级的节点列表。\n   */\n  list: TreeList<I>;\n\n  /**\n   * 当前节点的父节点，如果为根节点则为 `null`。\n   */\n  parent: I | null;\n\n  /**\n   * 当前节点的层级，从 1 开始计数。\n   */\n  level: number;\n\n  /**\n   * 从根节点到当前节点的路径。\n   */\n  path: TreeList<I>;\n};\n\n/**\n * 表示深度遍历中的节点信息。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TreeInfo<I extends TreeItem> = TreeWalker<I> & {\n  /**\n   * 当前节点。\n   */\n  item: I;\n\n  /**\n   * 当前节点在 `list` 中的索引。\n   */\n  index: number;\n};\n\n/**\n * 深度遍历的同步迭代器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param info - 当前节点的信息。\n * @returns 如果返回 `false`，则提前终止遍历。\n */\nexport type TreeEachIterator<I extends TreeItem> = (info: TreeInfo<I>) => false | unknown;\n\n/**\n * 深度遍历的异步迭代器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param info - 当前节点的信息。\n * @returns 如果返回 `false`，则提前终止遍历。\n */\nexport type TreeEachIteratorAsync<I extends TreeItem> = (info: TreeInfo<I>) => Promise<boolean | unknown>;\n\n/**\n * 深度遍历的同步遍历器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 遍历结果。\n */\nexport type TreeWalk<I extends TreeItem> = (walker: TreeWalker<I>) => unknown;\n\n/**\n * 深度遍历的异步遍历器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 异步遍历结果。\n */\nexport type TreeWalkAsync<I extends TreeItem> = (walker: TreeWalker<I>) => Promise<unknown>;\n\n/**\n * 深度遍历数组中的每个元素，并对每个元素执行提供的回调函数。\n *\n * @param treeList - 要遍历的深度数组。\n * @param iterator - 对每个元素执行的回调函数。如果回调函数返回 `false`，则提前终止遍历。\n * @param breadthFist - 是否使用广度优先遍历，默认为 `false`（深度优先）。\n * @returns 无返回值。\n *\n * @example\n * ```typescript\n * const treeList = [\n *   { value: 1, children: [{ value: 2 }, { value: 3 }] },\n *   { value: 4 }\n * ];\n *\n * treeEach(treeList, (item) => {\n *   console.log(item.value);\n *   if (item.value === 2) return false; // 提前终止遍历\n * });\n * ```\n */\nexport function treeEach<I extends TreeItem = TreeItem>(\n  treeList: TreeList<I>,\n  iterator: TreeEachIterator<I>,\n  breadthFist = false,\n): void {\n  const treeInfoList: TreeInfo<I>[] = [];\n  let returnFalse = false;\n\n  const iterate = (info: TreeInfo<I>) => {\n    if (iterator(info) === false) {\n      returnFalse = true;\n      return false;\n    }\n  };\n\n  const next = (info: TreeInfo<I>, walk: TreeWalk<I>) => {\n    const { item, level, parent, path } = info;\n    const { children } = item;\n\n    if (isArray(children)) {\n      returnFalse =\n        walk({\n          ...info,\n          parent: item,\n          list: children as TreeList<I>,\n          level: level + 1,\n        }) === false;\n    }\n  };\n\n  const walk: TreeWalk<I> = (walker) => {\n    const { list, level, parent, path } = walker;\n\n    const path2 = [...path];\n    while (parent !== null && path2.length > 0 && path2[path2.length - 1] !== parent) {\n      path2.pop();\n    }\n\n    arrayEach(list, (item, index) => {\n      if (returnFalse) return false;\n\n      const info: TreeInfo<I> = {\n        ...walker,\n        item,\n        index,\n        path: [...path2, item],\n      };\n\n      // 广度优先\n      if (breadthFist) {\n        treeInfoList.push(info);\n      }\n      // 深度优先\n      else {\n        iterate(info);\n        if (returnFalse) return false;\n        next(info, walk);\n      }\n    });\n\n    if (breadthFist) {\n      while (!returnFalse) {\n        const info = treeInfoList.shift();\n        if (!info) break;\n\n        iterate(info);\n        if (returnFalse) break;\n\n        // 内部也会进入 walk\n        next(info, walk);\n      }\n    }\n\n    return !returnFalse;\n  };\n\n  walk({\n    list: treeList,\n    level: 1,\n    parent: null,\n    path: [],\n  });\n}\n\n/**\n * 在深度数组中查找满足条件的第一个节点信息。\n *\n * @param treeList - 要查找的深度数组。\n * @param predicate - 判断节点是否满足条件的回调函数。\n * @param breadthFist - 是否使用广度优先查找，默认为 `false`（深度优先）。\n * @returns 如果找到满足条件的节点，则返回该节点的信息；否则返回 `undefined`。\n *\n * @example\n * ```typescript\n * const treeList = [\n *   { value: 1, children: [{ value: 2 }, { value: 3 }] },\n *   { value: 4 }\n * ];\n *\n * const found = treeFind(treeList, (info) => info.item.value === 3);\n * console.log(found);\n * // {\n * //    item: { value: 3 },\n * //    index: 1,\n * //    list: [{ value: 2 }, { value: 3 }],\n * //    parent: { value: 1, children: [{ value: 2 }, { value: 3 }] },\n * //    level: 2,\n * //    path: [{ value: 1, children: [{ value: 2 }, { value: 3 }] }, { value: 3 }]\n * // }\n * ```\n */\nexport function treeFind<I extends TreeItem>(\n  treeList: TreeList<I>,\n  predicate: (info: TreeInfo<I>) => boolean,\n  breadthFist = false,\n): TreeInfo<I> | undefined {\n  let found: TreeInfo<I> | undefined;\n\n  treeEach(\n    treeList,\n    (info) => {\n      if (predicate(info)) {\n        found = info;\n        return false;\n      }\n    },\n    breadthFist,\n  );\n\n  return found;\n}\n\n/**\n * 将深度嵌套的树形结构扁平化为一维数组，并对每个节点执行指定的转换函数。\n *\n * @template I - 树节点的类型，必须继承自 `TreeItem`。\n * @template T - 转换后的数据类型。\n * @param {TreeList<I>} deepList - 要扁平化的深度嵌套树形结构。\n * @param {(info: TreeInfo<I>) => T} flatten - 对每个节点执行的转换函数，返回转换后的数据。\n * @param {boolean} [breadthFist=false] - 是否使用广度优先遍历，默认为 `false`（深度优先）。\n * @returns {T[]} - 转换后的一维数组。\n * @example\n * ```typescript\n * const treeList = [\n *   { value: 1, children: [{ value: 2 }, { value: 3 }] },\n *   { value: 4 }\n * ];\n *\n * const flattened = deepFlat(treeList, (info) => info.item.value);\n * console.log(flattened); // [1, 2, 3, 4]\n * ```\n */\nexport function deepFlat<I extends TreeItem, T>(\n  deepList: TreeList<I>,\n  flatten: (info: TreeInfo<I>) => T,\n  breadthFist = false,\n): T[] {\n  const list2: T[] = [];\n\n  treeEach(\n    deepList,\n    (info) => {\n      list2.push(flatten(info));\n    },\n    breadthFist,\n  );\n\n  return list2;\n}\n\ntype FromItemInfo<I> = {\n  selfKey: unknown;\n  parentKey: unknown;\n  item: I;\n  index: number;\n};\n\nexport type TreeFromOptions<I extends TreeItem> = {\n  getSelfKey: (item: I, index: number) => unknown;\n  getParentKey: (item: I, index: number) => unknown;\n  appendChild: (parentInfo: FromItemInfo<I>, info: FromItemInfo<I>) => unknown;\n};\n\n/**\n * 从扁平列表构建树形结构。\n *\n * @template I - 节点对象的类型，必须继承自 `AnyObject`。\n * @param {I[]} list - 扁平化的节点列表。\n * @param {TreeFromOptions<I>} options - 构建树形结构的配置选项。\n * @param {function} options.getSelfKey - 获取节点自身唯一标识的函数。\n * @param {function} options.getParentKey - 获取节点父节点唯一标识的函数。\n * @param {function} options.appendChild - 将子节点添加到父节点的函数。\n * @returns {I | undefined} - 构建的树形结构的根节点，如果未找到根节点则返回 `undefined`。\n *\n * @example\n * ```typescript\n * const list = [\n *   { id: 1, parentId: null, name: 'Root' },\n *   { id: 2, parentId: 1, name: 'Child 1' },\n *   { id: 3, parentId: 1, name: 'Child 2' }\n * ];\n *\n * const tree = treeFrom(list, {\n *   getSelfKey: (item) => item.id,\n *   getParentKey: (item) => item.parentId,\n *   appendChild: (parent, info) => {\n *     if (!parent.children) parent.children = [];\n *     parent.children.push(info.item);\n *   }\n * });\n *\n * console.log(tree);\n * // {\n * //   id: 1,\n * //   parentId: null,\n * //   name: 'Root',\n * //   children: [\n * //     { id: 2, parentId: 1, name: 'Child 1' },\n * //     { id: 3, parentId: 1, name: 'Child 2' }\n * //   ]\n * // }\n * ```\n */\nexport function treeFrom<I extends TreeItem>(list: I[], options: TreeFromOptions<I>): TreeList<I> | undefined {\n  const keyMap = new Map<unknown, FromItemInfo<I>>();\n  const freeSet = new Set<FromItemInfo<I>>();\n  const roots: TreeList<I> = [];\n\n  // 分配节点\n  const assign = (info: FromItemInfo<I>, isFirst = false) => {\n    const { selfKey, parentKey, item, index } = info;\n\n    // 父级指向为空\n    if (isNullish(parentKey)) {\n      roots.push(item);\n    }\n    // 父级指向不为空\n    else {\n      const parent = keyMap.get(parentKey);\n\n      // 未找到父级节点\n      if (isUndefined(parent)) {\n        // 游离节点\n        if (isFirst) freeSet.add(info);\n      }\n      // 已找到父级节点\n      else {\n        options.appendChild(parent, info);\n      }\n    }\n  };\n\n  // 构建 map\n  arrayEach(list, (item, index) => {\n    const selfKey = options.getSelfKey(item, index);\n    const parentKey = options.getParentKey(item, index);\n\n    if (isNullish(selfKey)) return;\n\n    const info = { selfKey, parentKey, item, index };\n    keyMap.set(selfKey, info);\n\n    assign(info, true);\n  });\n\n  // 处理游离节点\n  for (const info of freeSet.values()) {\n    assign(info);\n  }\n\n  return roots;\n}\n"],"names":["walk"],"mappings":";;AA0HO,SAAS,SACd,UACA,UACA,cAAc,OACR;AACN,QAAM,eAA8B,CAAC;AACrC,MAAI,cAAc;AAEZ,QAAA,UAAU,CAAC,SAAsB;AACjC,QAAA,SAAS,IAAI,MAAM,OAAO;AACd,oBAAA;AACP,aAAA;AAAA,IAAA;AAAA,EAEX;AAEM,QAAA,OAAO,CAAC,MAAmBA,UAAsB;AACrD,UAAM,EAAE,MAAM,OAAO,QAAQ,KAAS,IAAA;AAChC,UAAA,EAAE,aAAa;AAEjB,QAAA,QAAQ,QAAQ,GAAG;AACrB,oBACEA,MAAK;AAAA,QACH,GAAG;AAAA,QACH,QAAQ;AAAA,QACR,MAAM;AAAA,QACN,OAAO,QAAQ;AAAA,MAChB,CAAA,MAAM;AAAA,IAAA;AAAA,EAEb;AAEM,QAAA,OAAoB,CAAC,WAAW;AACpC,UAAM,EAAE,MAAM,OAAO,QAAQ,KAAS,IAAA;AAEhC,UAAA,QAAQ,CAAC,GAAG,IAAI;AACf,WAAA,WAAW,QAAQ,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,MAAM,QAAQ;AAChF,YAAM,IAAI;AAAA,IAAA;AAGF,cAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAI,YAAoB,QAAA;AAExB,YAAM,OAAoB;AAAA,QACxB,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QACA,MAAM,CAAC,GAAG,OAAO,IAAI;AAAA,MACvB;AAGA,UAAI,aAAa;AACf,qBAAa,KAAK,IAAI;AAAA,MAAA,OAGnB;AACH,gBAAQ,IAAI;AACZ,YAAI,YAAoB,QAAA;AACxB,aAAK,MAAM,IAAI;AAAA,MAAA;AAAA,IACjB,CACD;AAED,QAAI,aAAa;AACf,aAAO,CAAC,aAAa;AACb,cAAA,OAAO,aAAa,MAAM;AAChC,YAAI,CAAC,KAAM;AAEX,gBAAQ,IAAI;AACZ,YAAI,YAAa;AAGjB,aAAK,MAAM,IAAI;AAAA,MAAA;AAAA,IACjB;AAGF,WAAO,CAAC;AAAA,EACV;AAEK,OAAA;AAAA,IACH,MAAM;AAAA,IACN,OAAO;AAAA,IACP,QAAQ;AAAA,IACR,MAAM,CAAA;AAAA,EAAC,CACR;AACH;AA6BO,SAAS,SACd,UACA,WACA,cAAc,OACW;AACrB,MAAA;AAEJ;AAAA,IACE;AAAA,IACA,CAAC,SAAS;AACJ,UAAA,UAAU,IAAI,GAAG;AACX,gBAAA;AACD,eAAA;AAAA,MAAA;AAAA,IAEX;AAAA,IACA;AAAA,EACF;AAEO,SAAA;AACT;AAsBO,SAAS,SACd,UACA,SACA,cAAc,OACT;AACL,QAAM,QAAa,CAAC;AAEpB;AAAA,IACE;AAAA,IACA,CAAC,SAAS;AACF,YAAA,KAAK,QAAQ,IAAI,CAAC;AAAA,IAC1B;AAAA,IACA;AAAA,EACF;AAEO,SAAA;AACT;AAuDgB,SAAA,SAA6B,MAAW,SAAsD;AACtG,QAAA,6BAAa,IAA8B;AAC3C,QAAA,8BAAc,IAAqB;AACzC,QAAM,QAAqB,CAAC;AAG5B,QAAM,SAAS,CAAC,MAAuB,UAAU,UAAU;AACzD,UAAM,EAAE,SAAS,WAAW,MAAM,MAAU,IAAA;AAGxC,QAAA,UAAU,SAAS,GAAG;AACxB,YAAM,KAAK,IAAI;AAAA,IAAA,OAGZ;AACG,YAAA,SAAS,OAAO,IAAI,SAAS;AAG/B,UAAA,YAAY,MAAM,GAAG;AAEnB,YAAA,QAAiB,SAAA,IAAI,IAAI;AAAA,MAAA,OAG1B;AACK,gBAAA,YAAY,QAAQ,IAAI;AAAA,MAAA;AAAA,IAClC;AAAA,EAEJ;AAGU,YAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAM,UAAU,QAAQ,WAAW,MAAM,KAAK;AAC9C,UAAM,YAAY,QAAQ,aAAa,MAAM,KAAK;AAE9C,QAAA,UAAU,OAAO,EAAG;AAExB,UAAM,OAAO,EAAE,SAAS,WAAW,MAAM,MAAM;AACxC,WAAA,IAAI,SAAS,IAAI;AAExB,WAAO,MAAM,IAAI;AAAA,EAAA,CAClB;AAGU,aAAA,QAAQ,QAAQ,UAAU;AACnC,WAAO,IAAI;AAAA,EAAA;AAGN,SAAA;AACT;"}