@cloudcome/utils-core 0.0.0 → 1.1.0

package/dist/timer.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 定时器状态接口
+ */
+export type TTimerState = {
+    /**
+     * 执行次数
+     */
+    times: number;
+    /**
+     * 开始时间戳
+     */
+    startAt: number;
+    /**
+     * 停止时间戳
+     */
+    stopAt: number;
+    /**
+     * 暂停时间戳
+     */
+    pauseAt: number;
+    /**
+     * 恢复时间戳
+     */
+    resumeAt: number;
+    /**
+     * 当前时间戳
+     */
+    currentAt: number;
+    /**
+     * 总耗时（包括暂停时间）
+     */
+    elapsedTime: number;
+    /**
+     * 实际运行时间（不包括暂停时间）
+     */
+    runningTime: number;
+    /**
+     * 当前间隔时间
+     */
+    intervalTime: number;
+};
+export type TTimerHandler = {
+    /**
+     * 开始
+     */
+    start: () => void;
+    /**
+     * 暂停
+     */
+    pause: () => void;
+    /**
+     * 恢复
+     */
+    resume: (immediate?: boolean) => void;
+    /**
+     * 停止
+     */
+    stop: () => void;
+};
+/**
+ * 创建间隔定时器核心函数
+ *
+ * @param nextTime - 用于安排下一次执行的函数
+ * @param effect - 每次执行的回调函数，接收定时器状态和可选的next函数
+ * @returns 返回包含控制方法的对象
+ */
+export declare function makeInterval(nextTime: (call: () => void) => void, effect: (timer: TTimerState, next?: () => void) => unknown): {
+    canStart: () => boolean;
+    canStop: () => boolean;
+    canPause: () => boolean;
+    canResume: () => boolean;
+    start: () => void;
+    stop: () => void;
+    pause: () => void;
+    resume: () => void;
+    execute: () => void;
+};
+export type TTimerOptions = {
+    /**
+     * 是否在定时器开始时立即执行回调
+     */
+    leading?: boolean;
+    /**
+     * 是否在定时器停止时执行最后一次回调
+     */
+    trailing?: boolean;
+};
+/**
+ * 创建一个基于 `setTimeout` 的间隔定时器
+ *
+ * @param callback - 每次间隔执行的回调函数，接收定时器状态和可选的 `next` 函数
+ * @param interval - 间隔时间，单位为毫秒
+ * @param options - 配置选项
+ * @returns {TTimerHandler}
+ */
+export declare function timeInterval(callback: (state: TTimerState, next?: () => void) => unknown, interval: number, options?: TTimerOptions): TTimerHandler;

package/dist/timer.mjs

@@ -0,0 +1,119 @@
+const STATUS_READY = 0;
+const STATUS_START = 1;
+const STATUS_PAUSE = 2;
+const STATUS_STOP = 3;
+function makeInterval(nextTime, effect) {
+  let startAt = 0;
+  let lastAt = 0;
+  let stopAt = 0;
+  let pauseAt = 0;
+  let resumeAt = 0;
+  let times = 0;
+  let status = STATUS_READY;
+  let runningTime = 0;
+  const execute = () => {
+    if (status >= STATUS_PAUSE) return;
+    const now = Date.now();
+    const intervalTime = lastAt > 0 ? now - lastAt : 0;
+    runningTime += intervalTime;
+    lastAt = now;
+    const state = {
+      times: ++times,
+      startAt,
+      stopAt,
+      pauseAt,
+      resumeAt,
+      currentAt: now,
+      elapsedTime: startAt > 0 ? now - startAt : 0,
+      runningTime,
+      intervalTime
+    };
+    if (effect.length === 2) {
+      effect(state, () => {
+        nextTime(execute);
+      });
+    } else {
+      effect(state);
+      nextTime(execute);
+    }
+  };
+  const canStart = () => status === STATUS_READY;
+  const start = () => {
+    if (!canStart()) return;
+    status = STATUS_START;
+    startAt = Date.now();
+    execute();
+  };
+  const canStop = () => status === STATUS_START;
+  const stop = () => {
+    if (!canStop()) return;
+    status = STATUS_STOP;
+    stopAt = Date.now();
+  };
+  const canPause = () => status === STATUS_START;
+  const pause = () => {
+    if (!canPause()) return;
+    status = STATUS_PAUSE;
+    pauseAt = Date.now();
+  };
+  const canResume = () => status === STATUS_PAUSE;
+  const resume = () => {
+    if (!canResume()) return;
+    status = STATUS_START;
+    resumeAt = Date.now();
+    lastAt = resumeAt;
+    execute();
+  };
+  return {
+    canStart,
+    canStop,
+    canPause,
+    canResume,
+    start,
+    stop,
+    pause,
+    resume,
+    execute
+  };
+}
+function timeInterval(callback, interval, options) {
+  let timeId;
+  const { canStart, canStop, canPause, canResume, start, stop, pause, resume, execute } = makeInterval((call) => {
+    timeId = setTimeout(call, interval);
+  }, callback);
+  return {
+    start() {
+      if (!canStart()) return;
+      if (options == null ? void 0 : options.leading) {
+        start();
+      } else {
+        timeId = setTimeout(start, interval);
+      }
+    },
+    stop() {
+      if (!canStop()) return;
+      if (options == null ? void 0 : options.trailing) execute();
+      clearTimeout(timeId);
+      stop();
+    },
+    pause() {
+      if (!canPause()) return;
+      if (options == null ? void 0 : options.trailing) execute();
+      clearTimeout(timeId);
+      pause();
+    },
+    resume(immediate) {
+      if (!canResume()) return;
+      if (immediate || (options == null ? void 0 : options.leading)) {
+        resume();
+      } else {
+        timeId = setTimeout(resume, interval);
+      }
+    }
+  };
+}
+export {
+  makeInterval,
+  timeInterval
+};
+//# sourceMappingURL=timer.mjs.map

package/dist/timer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"timer.mjs","sources":["../src/timer.ts"],"sourcesContent":["/**\n * 定时器状态接口\n */\nexport type TTimerState = {\n  /**\n   * 执行次数\n   */\n  times: number;\n  /**\n   * 开始时间戳\n   */\n  startAt: number;\n  /**\n   * 停止时间戳\n   */\n  stopAt: number;\n  /**\n   * 暂停时间戳\n   */\n  pauseAt: number;\n  /**\n   * 恢复时间戳\n   */\n  resumeAt: number;\n  /**\n   * 当前时间戳\n   */\n  currentAt: number;\n  /**\n   * 总耗时（包括暂停时间）\n   */\n  elapsedTime: number;\n  /**\n   * 实际运行时间（不包括暂停时间）\n   */\n  runningTime: number;\n  /**\n   * 当前间隔时间\n   */\n  intervalTime: number;\n};\n\nexport type TTimerHandler = {\n  /**\n   * 开始\n   */\n  start: () => void;\n  /**\n   * 暂停\n   */\n  pause: () => void;\n  /**\n   * 恢复\n   */\n  resume: (immediate?: boolean) => void;\n  /**\n   * 停止\n   */\n  stop: () => void;\n};\n\nconst STATUS_READY = 0;\nconst STATUS_START = 1;\nconst STATUS_PAUSE = 2;\nconst STATUS_STOP = 3;\n\n/**\n * 创建间隔定时器核心函数\n *\n * @param nextTime - 用于安排下一次执行的函数\n * @param effect - 每次执行的回调函数，接收定时器状态和可选的next函数\n * @returns 返回包含控制方法的对象\n */\nexport function makeInterval(\n  nextTime: (call: () => void) => void,\n  effect: (timer: TTimerState, next?: () => void) => unknown,\n) {\n  let startAt = 0;\n  let lastAt = 0;\n  let stopAt = 0;\n  let pauseAt = 0;\n  let resumeAt = 0;\n  let times = 0;\n  let status = STATUS_READY;\n  let runningTime = 0;\n\n  const execute = () => {\n    if (status >= STATUS_PAUSE) return;\n\n    const now = Date.now();\n    const intervalTime = lastAt > 0 ? now - lastAt : 0;\n    runningTime += intervalTime;\n    lastAt = now;\n    const state: TTimerState = {\n      times: ++times,\n      startAt,\n      stopAt,\n      pauseAt,\n      resumeAt,\n      currentAt: now,\n      elapsedTime: startAt > 0 ? now - startAt : 0,\n      runningTime,\n      intervalTime,\n    };\n\n    if (effect.length === 2) {\n      effect(state, () => {\n        nextTime(execute);\n      });\n    } else {\n      effect(state);\n      nextTime(execute);\n    }\n  };\n\n  const canStart = () => status === STATUS_READY;\n  const start = () => {\n    if (!canStart()) return;\n    status = STATUS_START;\n    startAt = Date.now();\n    execute();\n  };\n\n  const canStop = () => status === STATUS_START;\n  const stop = () => {\n    if (!canStop()) return;\n    status = STATUS_STOP;\n    stopAt = Date.now();\n  };\n\n  const canPause = () => status === STATUS_START;\n  const pause = () => {\n    if (!canPause()) return;\n    status = STATUS_PAUSE;\n    pauseAt = Date.now();\n  };\n\n  const canResume = () => status === STATUS_PAUSE;\n  const resume = () => {\n    if (!canResume()) return;\n    status = STATUS_START;\n    resumeAt = Date.now();\n    lastAt = resumeAt;\n    execute();\n  };\n\n  return {\n    canStart,\n    canStop,\n    canPause,\n    canResume,\n    start,\n    stop,\n    pause,\n    resume,\n    execute,\n  };\n}\n\nexport type TTimerOptions = {\n  /**\n   * 是否在定时器开始时立即执行回调\n   */\n  leading?: boolean;\n  /**\n   * 是否在定时器停止时执行最后一次回调\n   */\n  trailing?: boolean;\n};\n\n/**\n * 创建一个基于 `setTimeout` 的间隔定时器\n *\n * @param callback - 每次间隔执行的回调函数，接收定时器状态和可选的 `next` 函数\n * @param interval - 间隔时间，单位为毫秒\n * @param options - 配置选项\n * @returns {TTimerHandler}\n */\nexport function timeInterval(\n  callback: (state: TTimerState, next?: () => void) => unknown,\n  interval: number,\n  options?: TTimerOptions,\n): TTimerHandler {\n  let timeId: number | NodeJS.Timeout;\n  const { canStart, canStop, canPause, canResume, start, stop, pause, resume, execute } = makeInterval((call) => {\n    timeId = setTimeout(call, interval);\n  }, callback);\n\n  return {\n    start() {\n      if (!canStart()) return;\n\n      if (options?.leading) {\n        start();\n      } else {\n        timeId = setTimeout(start, interval);\n      }\n    },\n\n    stop() {\n      if (!canStop()) return;\n      if (options?.trailing) execute();\n\n      clearTimeout(timeId);\n      stop();\n    },\n\n    pause() {\n      if (!canPause()) return;\n      if (options?.trailing) execute();\n\n      clearTimeout(timeId);\n      pause();\n    },\n\n    resume(immediate?: boolean) {\n      if (!canResume()) return;\n\n      if (immediate || options?.leading) {\n        resume();\n      } else {\n        timeId = setTimeout(resume, interval);\n      }\n    },\n  };\n}\n"],"names":[],"mappings":"AA6DA,MAAM,eAAe;AACrB,MAAM,eAAe;AACrB,MAAM,eAAe;AACrB,MAAM,cAAc;AASJ,SAAA,aACd,UACA,QACA;AACA,MAAI,UAAU;AACd,MAAI,SAAS;AACb,MAAI,SAAS;AACb,MAAI,UAAU;AACd,MAAI,WAAW;AACf,MAAI,QAAQ;AACZ,MAAI,SAAS;AACb,MAAI,cAAc;AAElB,QAAM,UAAU,MAAM;AACpB,QAAI,UAAU,aAAc;AAEtB,UAAA,MAAM,KAAK,IAAI;AACrB,UAAM,eAAe,SAAS,IAAI,MAAM,SAAS;AAClC,mBAAA;AACN,aAAA;AACT,UAAM,QAAqB;AAAA,MACzB,OAAO,EAAE;AAAA,MACT;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW;AAAA,MACX,aAAa,UAAU,IAAI,MAAM,UAAU;AAAA,MAC3C;AAAA,MACA;AAAA,IACF;AAEI,QAAA,OAAO,WAAW,GAAG;AACvB,aAAO,OAAO,MAAM;AAClB,iBAAS,OAAO;AAAA,MAAA,CACjB;AAAA,IAAA,OACI;AACL,aAAO,KAAK;AACZ,eAAS,OAAO;AAAA,IAAA;AAAA,EAEpB;AAEM,QAAA,WAAW,MAAM,WAAW;AAClC,QAAM,QAAQ,MAAM;AACd,QAAA,CAAC,WAAY;AACR,aAAA;AACT,cAAU,KAAK,IAAI;AACX,YAAA;AAAA,EACV;AAEM,QAAA,UAAU,MAAM,WAAW;AACjC,QAAM,OAAO,MAAM;AACb,QAAA,CAAC,UAAW;AACP,aAAA;AACT,aAAS,KAAK,IAAI;AAAA,EACpB;AAEM,QAAA,WAAW,MAAM,WAAW;AAClC,QAAM,QAAQ,MAAM;AACd,QAAA,CAAC,WAAY;AACR,aAAA;AACT,cAAU,KAAK,IAAI;AAAA,EACrB;AAEM,QAAA,YAAY,MAAM,WAAW;AACnC,QAAM,SAAS,MAAM;AACf,QAAA,CAAC,YAAa;AACT,aAAA;AACT,eAAW,KAAK,IAAI;AACX,aAAA;AACD,YAAA;AAAA,EACV;AAEO,SAAA;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAqBgB,SAAA,aACd,UACA,UACA,SACe;AACX,MAAA;AACJ,QAAM,EAAE,UAAU,SAAS,UAAU,WAAW,OAAO,MAAM,OAAO,QAAQ,QAAY,IAAA,aAAa,CAAC,SAAS;AACpG,aAAA,WAAW,MAAM,QAAQ;AAAA,KACjC,QAAQ;AAEJ,SAAA;AAAA,IACL,QAAQ;AACF,UAAA,CAAC,WAAY;AAEjB,UAAI,mCAAS,SAAS;AACd,cAAA;AAAA,MAAA,OACD;AACI,iBAAA,WAAW,OAAO,QAAQ;AAAA,MAAA;AAAA,IAEvC;AAAA,IAEA,OAAO;AACD,UAAA,CAAC,UAAW;AACZ,UAAA,mCAAS,SAAkB,SAAA;AAE/B,mBAAa,MAAM;AACd,WAAA;AAAA,IACP;AAAA,IAEA,QAAQ;AACF,UAAA,CAAC,WAAY;AACb,UAAA,mCAAS,SAAkB,SAAA;AAE/B,mBAAa,MAAM;AACb,YAAA;AAAA,IACR;AAAA,IAEA,OAAO,WAAqB;AACtB,UAAA,CAAC,YAAa;AAEd,UAAA,cAAa,mCAAS,UAAS;AAC1B,eAAA;AAAA,MAAA,OACF;AACI,iBAAA,WAAW,QAAQ,QAAQ;AAAA,MAAA;AAAA,IACtC;AAAA,EAEJ;AACF;"}

package/dist/tree.cjs

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const array = require("./array.cjs");
+const type = require("./type.cjs");
+function treeEach(treeList, iterator, breadthFist = false) {
+  const treeInfoList = [];
+  let returnFalse = false;
+  const iterate = (info) => {
+    if (iterator(info) === false) {
+      returnFalse = true;
+      return false;
+    }
+  };
+  const next = (info, walk2) => {
+    const { item, level, parent, path } = info;
+    const { children } = item;
+    if (type.isArray(children)) {
+      returnFalse = walk2({
+        ...info,
+        parent: item,
+        list: children,
+        level: level + 1
+      }) === false;
+    }
+  };
+  const walk = (walker) => {
+    const { list, level, parent, path } = walker;
+    const path2 = [...path];
+    while (parent !== null && path2.length > 0 && path2[path2.length - 1] !== parent) {
+      path2.pop();
+    }
+    array.arrayEach(list, (item, index) => {
+      if (returnFalse) return false;
+      const info = {
+        ...walker,
+        item,
+        index,
+        path: [...path2, item]
+      };
+      if (breadthFist) {
+        treeInfoList.push(info);
+      } else {
+        iterate(info);
+        if (returnFalse) return false;
+        next(info, walk);
+      }
+    });
+    if (breadthFist) {
+      while (!returnFalse) {
+        const info = treeInfoList.shift();
+        if (!info) break;
+        iterate(info);
+        if (returnFalse) break;
+        next(info, walk);
+      }
+    }
+    return !returnFalse;
+  };
+  walk({
+    list: treeList,
+    level: 1,
+    parent: null,
+    path: []
+  });
+}
+function treeFind(treeList, predicate, breadthFist = false) {
+  let found;
+  treeEach(
+    treeList,
+    (info) => {
+      if (predicate(info)) {
+        found = info;
+        return false;
+      }
+    },
+    breadthFist
+  );
+  return found;
+}
+function deepFlat(deepList, flatten, breadthFist = false) {
+  const list2 = [];
+  treeEach(
+    deepList,
+    (info) => {
+      list2.push(flatten(info));
+    },
+    breadthFist
+  );
+  return list2;
+}
+function treeFrom(list, options) {
+  const keyMap = /* @__PURE__ */ new Map();
+  const freeSet = /* @__PURE__ */ new Set();
+  const roots = [];
+  const assign = (info, isFirst = false) => {
+    const { selfKey, parentKey, item, index } = info;
+    if (type.isNullish(parentKey)) {
+      roots.push(item);
+    } else {
+      const parent = keyMap.get(parentKey);
+      if (type.isUndefined(parent)) {
+        if (isFirst) freeSet.add(info);
+      } else {
+        options.appendChild(parent, info);
+      }
+    }
+  };
+  array.arrayEach(list, (item, index) => {
+    const selfKey = options.getSelfKey(item, index);
+    const parentKey = options.getParentKey(item, index);
+    if (type.isNullish(selfKey)) return;
+    const info = { selfKey, parentKey, item, index };
+    keyMap.set(selfKey, info);
+    assign(info, true);
+  });
+  for (const info of freeSet.values()) {
+    assign(info);
+  }
+  return roots;
+}
+exports.deepFlat = deepFlat;
+exports.treeEach = treeEach;
+exports.treeFind = treeFind;
+exports.treeFrom = treeFrom;
+//# sourceMappingURL=tree.cjs.map

package/dist/tree.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.cjs","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 TTreeItem = AnyObject & {\n  /**\n   * 子节点列表。\n   */\n  children?: TTreeItem[];\n};\n\n/**\n * 表示深度遍历中的节点列表。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TTreeList<I extends TTreeItem> = I[];\n\n/**\n * 表示深度遍历中的遍历器状态。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TTreeWalker<I extends TTreeItem> = {\n  /**\n   * 当前层级的节点列表。\n   */\n  list: TTreeList<I>;\n\n  /**\n   * 当前节点的父节点，如果为根节点则为 `null`。\n   */\n  parent: I | null;\n\n  /**\n   * 当前节点的层级，从 1 开始计数。\n   */\n  level: number;\n\n  /**\n   * 从根节点到当前节点的路径。\n   */\n  path: TTreeList<I>;\n};\n\n/**\n * 表示深度遍历中的节点信息。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n */\nexport type TTreeInfo<I extends TTreeItem> = TTreeWalker<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 TTreeItem> = (info: TTreeInfo<I>) => false | unknown;\n\n/**\n * 深度遍历的异步迭代器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param info - 当前节点的信息。\n * @returns 如果返回 `false`，则提前终止遍历。\n */\nexport type TreeEachIteratorAsync<I extends TTreeItem> = (info: TTreeInfo<I>) => Promise<boolean | unknown>;\n\n/**\n * 深度遍历的同步遍历器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 遍历结果。\n */\nexport type TreeWalk<I extends TTreeItem> = (walker: TTreeWalker<I>) => unknown;\n\n/**\n * 深度遍历的异步遍历器函数类型。\n *\n * @template I - 节点对象的类型，必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 异步遍历结果。\n */\nexport type TreeWalkAsync<I extends TTreeItem> = (walker: TTreeWalker<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 TTreeItem = TTreeItem>(\n  treeList: TTreeList<I>,\n  iterator: TreeEachIterator<I>,\n  breadthFist = false,\n): void {\n  const treeInfoList: TTreeInfo<I>[] = [];\n  let returnFalse = false;\n\n  const iterate = (info: TTreeInfo<I>) => {\n    if (iterator(info) === false) {\n      returnFalse = true;\n      return false;\n    }\n  };\n\n  const next = (info: TTreeInfo<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 TTreeList<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: TTreeInfo<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 TTreeItem>(\n  treeList: TTreeList<I>,\n  predicate: (info: TTreeInfo<I>) => boolean,\n  breadthFist = false,\n): TTreeInfo<I> | undefined {\n  let found: TTreeInfo<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 {TTreeList<I>} deepList - 要扁平化的深度嵌套树形结构。\n * @param {(info: TTreeInfo<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 TTreeItem, T>(\n  deepList: TTreeList<I>,\n  flatten: (info: TTreeInfo<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 TTreeFromOptions<I extends TTreeItem> = {\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 {TTreeFromOptions<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 TTreeItem>(list: I[], options: TTreeFromOptions<I>): TTreeList<I> | undefined {\n  const keyMap = new Map<unknown, FromItemInfo<I>>();\n  const freeSet = new Set<FromItemInfo<I>>();\n  const roots: TTreeList<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","isArray","arrayEach","isNullish","isUndefined"],"mappings":";;;;AA0HO,SAAS,SACd,UACA,UACA,cAAc,OACR;AACN,QAAM,eAA+B,CAAC;AACtC,MAAI,cAAc;AAEZ,QAAA,UAAU,CAAC,SAAuB;AAClC,QAAA,SAAS,IAAI,MAAM,OAAO;AACd,oBAAA;AACP,aAAA;AAAA,IAAA;AAAA,EAEX;AAEM,QAAA,OAAO,CAAC,MAAoBA,UAAsB;AACtD,UAAM,EAAE,MAAM,OAAO,QAAQ,KAAS,IAAA;AAChC,UAAA,EAAE,aAAa;AAEjB,QAAAC,KAAAA,QAAQ,QAAQ,GAAG;AACrB,oBACED,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;AAGFE,UAAAA,UAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAI,YAAoB,QAAA;AAExB,YAAM,OAAqB;AAAA,QACzB,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,OACY;AACtB,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,SAA8B,MAAW,SAAwD;AACzG,QAAA,6BAAa,IAA8B;AAC3C,QAAA,8BAAc,IAAqB;AACzC,QAAM,QAAsB,CAAC;AAG7B,QAAM,SAAS,CAAC,MAAuB,UAAU,UAAU;AACzD,UAAM,EAAE,SAAS,WAAW,MAAM,MAAU,IAAA;AAGxC,QAAAC,KAAAA,UAAU,SAAS,GAAG;AACxB,YAAM,KAAK,IAAI;AAAA,IAAA,OAGZ;AACG,YAAA,SAAS,OAAO,IAAI,SAAS;AAG/B,UAAAC,KAAAA,YAAY,MAAM,GAAG;AAEnB,YAAA,QAAiB,SAAA,IAAI,IAAI;AAAA,MAAA,OAG1B;AACK,gBAAA,YAAY,QAAQ,IAAI;AAAA,MAAA;AAAA,IAClC;AAAA,EAEJ;AAGUF,QAAAA,UAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAM,UAAU,QAAQ,WAAW,MAAM,KAAK;AAC9C,UAAM,YAAY,QAAQ,aAAa,MAAM,KAAK;AAE9C,QAAAC,KAAAA,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;;;;;"}

package/dist/tree.d.ts

@@ -0,0 +1,210 @@
+import { AnyObject } from './types';
+/**
+ * 表示深度遍历中的节点对象，包含子节点列表。
+ */
+export type TTreeItem = AnyObject & {
+    /**
+     * 子节点列表。
+     */
+    children?: TTreeItem[];
+};
+/**
+ * 表示深度遍历中的节点列表。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ */
+export type TTreeList<I extends TTreeItem> = I[];
+/**
+ * 表示深度遍历中的遍历器状态。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ */
+export type TTreeWalker<I extends TTreeItem> = {
+    /**
+     * 当前层级的节点列表。
+     */
+    list: TTreeList<I>;
+    /**
+     * 当前节点的父节点，如果为根节点则为 `null`。
+     */
+    parent: I | null;
+    /**
+     * 当前节点的层级，从 1 开始计数。
+     */
+    level: number;
+    /**
+     * 从根节点到当前节点的路径。
+     */
+    path: TTreeList<I>;
+};
+/**
+ * 表示深度遍历中的节点信息。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ */
+export type TTreeInfo<I extends TTreeItem> = TTreeWalker<I> & {
+    /**
+     * 当前节点。
+     */
+    item: I;
+    /**
+     * 当前节点在 `list` 中的索引。
+     */
+    index: number;
+};
+/**
+ * 深度遍历的同步迭代器函数类型。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ * @param info - 当前节点的信息。
+ * @returns 如果返回 `false`，则提前终止遍历。
+ */
+export type TreeEachIterator<I extends TTreeItem> = (info: TTreeInfo<I>) => false | unknown;
+/**
+ * 深度遍历的异步迭代器函数类型。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ * @param info - 当前节点的信息。
+ * @returns 如果返回 `false`，则提前终止遍历。
+ */
+export type TreeEachIteratorAsync<I extends TTreeItem> = (info: TTreeInfo<I>) => Promise<boolean | unknown>;
+/**
+ * 深度遍历的同步遍历器函数类型。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ * @param walker - 遍历器状态。
+ * @returns 遍历结果。
+ */
+export type TreeWalk<I extends TTreeItem> = (walker: TTreeWalker<I>) => unknown;
+/**
+ * 深度遍历的异步遍历器函数类型。
+ *
+ * @template I - 节点对象的类型，必须继承自 `TreeItem`。
+ * @param walker - 遍历器状态。
+ * @returns 异步遍历结果。
+ */
+export type TreeWalkAsync<I extends TTreeItem> = (walker: TTreeWalker<I>) => Promise<unknown>;
+/**
+ * 深度遍历数组中的每个元素，并对每个元素执行提供的回调函数。
+ *
+ * @param treeList - 要遍历的深度数组。
+ * @param iterator - 对每个元素执行的回调函数。如果回调函数返回 `false`，则提前终止遍历。
+ * @param breadthFist - 是否使用广度优先遍历，默认为 `false`（深度优先）。
+ * @returns 无返回值。
+ *
+ * @example
+ * ```typescript
+ * const treeList = [
+ *   { value: 1, children: [{ value: 2 }, { value: 3 }] },
+ *   { value: 4 }
+ * ];
+ *
+ * treeEach(treeList, (item) => {
+ *   console.log(item.value);
+ *   if (item.value === 2) return false; // 提前终止遍历
+ * });
+ * ```
+ */
+export declare function treeEach<I extends TTreeItem = TTreeItem>(treeList: TTreeList<I>, iterator: TreeEachIterator<I>, breadthFist?: boolean): void;
+/**
+ * 在深度数组中查找满足条件的第一个节点信息。
+ *
+ * @param treeList - 要查找的深度数组。
+ * @param predicate - 判断节点是否满足条件的回调函数。
+ * @param breadthFist - 是否使用广度优先查找，默认为 `false`（深度优先）。
+ * @returns 如果找到满足条件的节点，则返回该节点的信息；否则返回 `undefined`。
+ *
+ * @example
+ * ```typescript
+ * const treeList = [
+ *   { value: 1, children: [{ value: 2 }, { value: 3 }] },
+ *   { value: 4 }
+ * ];
+ *
+ * const found = treeFind(treeList, (info) => info.item.value === 3);
+ * console.log(found);
+ * // {
+ * //    item: { value: 3 },
+ * //    index: 1,
+ * //    list: [{ value: 2 }, { value: 3 }],
+ * //    parent: { value: 1, children: [{ value: 2 }, { value: 3 }] },
+ * //    level: 2,
+ * //    path: [{ value: 1, children: [{ value: 2 }, { value: 3 }] }, { value: 3 }]
+ * // }
+ * ```
+ */
+export declare function treeFind<I extends TTreeItem>(treeList: TTreeList<I>, predicate: (info: TTreeInfo<I>) => boolean, breadthFist?: boolean): TTreeInfo<I> | undefined;
+/**
+ * 将深度嵌套的树形结构扁平化为一维数组，并对每个节点执行指定的转换函数。
+ *
+ * @template I - 树节点的类型，必须继承自 `TreeItem`。
+ * @template T - 转换后的数据类型。
+ * @param {TTreeList<I>} deepList - 要扁平化的深度嵌套树形结构。
+ * @param {(info: TTreeInfo<I>) => T} flatten - 对每个节点执行的转换函数，返回转换后的数据。
+ * @param {boolean} [breadthFist=false] - 是否使用广度优先遍历，默认为 `false`（深度优先）。
+ * @returns {T[]} - 转换后的一维数组。
+ * @example
+ * ```typescript
+ * const treeList = [
+ *   { value: 1, children: [{ value: 2 }, { value: 3 }] },
+ *   { value: 4 }
+ * ];
+ *
+ * const flattened = deepFlat(treeList, (info) => info.item.value);
+ * console.log(flattened); // [1, 2, 3, 4]
+ * ```
+ */
+export declare function deepFlat<I extends TTreeItem, T>(deepList: TTreeList<I>, flatten: (info: TTreeInfo<I>) => T, breadthFist?: boolean): T[];
+type FromItemInfo<I> = {
+    selfKey: unknown;
+    parentKey: unknown;
+    item: I;
+    index: number;
+};
+export type TTreeFromOptions<I extends TTreeItem> = {
+    getSelfKey: (item: I, index: number) => unknown;
+    getParentKey: (item: I, index: number) => unknown;
+    appendChild: (parentInfo: FromItemInfo<I>, info: FromItemInfo<I>) => unknown;
+};
+/**
+ * 从扁平列表构建树形结构。
+ *
+ * @template I - 节点对象的类型，必须继承自 `AnyObject`。
+ * @param {I[]} list - 扁平化的节点列表。
+ * @param {TTreeFromOptions<I>} options - 构建树形结构的配置选项。
+ * @param {function} options.getSelfKey - 获取节点自身唯一标识的函数。
+ * @param {function} options.getParentKey - 获取节点父节点唯一标识的函数。
+ * @param {function} options.appendChild - 将子节点添加到父节点的函数。
+ * @returns {I | undefined} - 构建的树形结构的根节点，如果未找到根节点则返回 `undefined`。
+ *
+ * @example
+ * ```typescript
+ * const list = [
+ *   { id: 1, parentId: null, name: 'Root' },
+ *   { id: 2, parentId: 1, name: 'Child 1' },
+ *   { id: 3, parentId: 1, name: 'Child 2' }
+ * ];
+ *
+ * const tree = treeFrom(list, {
+ *   getSelfKey: (item) => item.id,
+ *   getParentKey: (item) => item.parentId,
+ *   appendChild: (parent, info) => {
+ *     if (!parent.children) parent.children = [];
+ *     parent.children.push(info.item);
+ *   }
+ * });
+ *
+ * console.log(tree);
+ * // {
+ * //   id: 1,
+ * //   parentId: null,
+ * //   name: 'Root',
+ * //   children: [
+ * //     { id: 2, parentId: 1, name: 'Child 1' },
+ * //     { id: 3, parentId: 1, name: 'Child 2' }
+ * //   ]
+ * // }
+ * ```
+ */
+export declare function treeFrom<I extends TTreeItem>(list: I[], options: TTreeFromOptions<I>): TTreeList<I> | undefined;
+export {};