@splicetree/core 0.1.1 → 0.3.0

package/README.md

@@ -1,7 +1,5 @@
 # @splicetree/core
 
-## 简介
-
 SpliceTree 是一个 Headless 树运行时，面向扁平数据构建可操作的树结构，提供精简 API，并通过插件扩展搜索、拖拽、懒加载、键盘导航等能力。
 
 为扁平数据提供轻量、可扩展的树运行时。支持插件扩展事件与能力。

package/dist/index.d.ts

@@ -5,6 +5,10 @@
  * - 若传入 `D`，表示函数可选择性接收该参数类型
  */
 type Fn<T, D = undefined> = [D] extends [undefined] ? () => T : (data?: D) => T;
+/** 可能是数组的类型 */
+type MaybeArray<T> = T | T[];
+/** 可能是函数的类型 */
+type MaybeFn<T, Args extends any[] = []> = T | ((...args: Args) => T);
 /**
  * 输入数据的通用结构
  * - 表示原始树数据的任意键值对对象
@@ -97,15 +101,10 @@ interface SpliceTreeEvents {
 }
 /**
  * `createSpliceTree` 的选项
- * - `keyField`：主键字段名，默认 `'id'`
- * - `parentField`：父级字段名，默认 `'parent'`
  * - `plugins`：插件列表
- * - `defaultExpanded`：默认展开的节点 id 列表（或设为 true 表示全部展开）
- * - `defaultExpandedLevel`：默认展开的层级（或 `'deepest'` 表示展开到最深层）
  * - 其余键允许被插件进行选项扩展
  */
-interface SpliceTreeConfiguration {}
-interface UseSpliceTreeOptions<T = SpliceTreeData> {
+interface SpliceTreeConfiguration {
   /**
    * 主键字段名
    * @default 'id'
@@ -116,10 +115,6 @@ interface UseSpliceTreeOptions<T = SpliceTreeData> {
    * @default 'parent'
    */
   parentField?: string;
-  /**
-   * 插件列表
-   */
-  plugins?: SpliceTreePlugin<T>[];
   /**
    * 默认展开的节点 ID 列表
    * 设为 true 表示默认展开所有节点
@@ -130,6 +125,12 @@ interface UseSpliceTreeOptions<T = SpliceTreeData> {
    * 设为 'deepest' 表示默认展开所有层级
    */
   defaultExpandedLevel?: number | 'deepest';
+}
+interface UseSpliceTreeOptions<T = SpliceTreeData> {
+  /**
+   * 插件列表
+   */
+  plugins?: SpliceTreePlugin<T>[];
   /**
    * 插件配置聚合入口（按插件名分类）
    */
@@ -214,6 +215,7 @@ interface SpliceTreeInstance<T = SpliceTreeData> {
    * @param beforeId 插入到指定兄弟节点之前（不传表示末尾）
    */
   moveNode: (id: string, newParentId: string | undefined, beforeId?: string) => void;
+  syncData: (next: T[]) => void;
 }
 /**
  * 插件上下文
@@ -281,4 +283,4 @@ type CreateSpliceTree = <T = SpliceTreeData>(data: T[], options?: UseSpliceTreeO
  */
 declare function createSpliceTree<T extends SpliceTreeData = SpliceTreeData>(data: T[], options?: UseSpliceTreeOptions<T>): SpliceTreeInstance<T>;
 //#endregion
-export { CreateSpliceTree, Fn, SpliceTreeConfiguration, SpliceTreeData, SpliceTreeEventName, SpliceTreeEventPayload, SpliceTreeEventPayloadMap, SpliceTreeEvents, SpliceTreeInstance, SpliceTreeNode, SpliceTreePlugin, SpliceTreePluginContext, UseSpliceTreeOptions, createSpliceTree };
+export { CreateSpliceTree, Fn, MaybeArray, MaybeFn, SpliceTreeConfiguration, SpliceTreeData, SpliceTreeEventName, SpliceTreeEventPayload, SpliceTreeEventPayloadMap, SpliceTreeEvents, SpliceTreeInstance, SpliceTreeNode, SpliceTreePlugin, SpliceTreePluginContext, UseSpliceTreeOptions, createSpliceTree };

package/dist/index.js

@@ -327,8 +327,11 @@ function moveNode(ctx, id, newParentId, beforeId) {
 * - 提供插件扩展点（setup/extendNode）
 */
 function createSpliceTree(data, options = {}) {
-	const keyField = options.keyField ?? "id";
-	const parentField = options.parentField ?? "parent";
+	const cfg = options.configuration ?? {};
+	const keyField = cfg.keyField ?? "id";
+	const parentField = cfg.parentField ?? "parent";
+	const defaultExpanded = cfg.defaultExpanded;
+	const defaultExpandedLevel = cfg.defaultExpandedLevel;
 	const events = createEmitter();
 	const expandedKeys = createReactive(/* @__PURE__ */ new Set(), (payload) => {
 		events.emit({
@@ -336,8 +339,8 @@ function createSpliceTree(data, options = {}) {
 			keys: Array.from(payload.target)
 		});
 	});
-	const { roots, map, parentCache, childrenCache } = buildTree(data, keyField, parentField, expandedKeys);
-	initDefaultExpansion(map, expandedKeys, options.defaultExpanded, options.defaultExpandedLevel);
+	let { roots, map, parentCache, childrenCache } = buildTree(data, keyField, parentField, expandedKeys);
+	initDefaultExpansion(map, expandedKeys, defaultExpanded, defaultExpandedLevel);
 	const emitVisibility = () => {
 		events.emit({
 			name: "visibility",
@@ -406,6 +409,22 @@ function createSpliceTree(data, options = {}) {
 				expandedKeys,
 				notify: emitVisibility
 			}, id, newParentId, beforeId);
+		},
+		syncData(next) {
+			tree.data = next;
+			const built = buildTree(next, keyField, parentField, expandedKeys);
+			roots = built.roots;
+			map = built.map;
+			parentCache = built.parentCache;
+			childrenCache = built.childrenCache;
+			const validIds = new Set(map.keys());
+			const toDelete = [];
+			expandedKeys.forEach((id) => {
+				if (!validIds.has(id)) toDelete.push(id);
+			});
+			for (const id of toDelete) expandedKeys.delete(id);
+			applyNodeExtensions();
+			emitVisibility();
 		}
 	};
 	const pluginCtx = {
@@ -417,15 +436,18 @@ function createSpliceTree(data, options = {}) {
 		const api = plugin.setup?.(pluginCtx);
 		Object.assign(tree, api);
 	});
-	if (options?.plugins?.length) for (const n of map.values()) for (const plugin of options.plugins) plugin.extendNode?.(n, pluginCtx);
-	for (const node of map.values()) {
-		node.isExpanded = () => tree.isExpanded(node.id);
-		node.toggleExpand = (expand) => {
-			if (expand === void 0) tree.toggleExpand(node.id);
-			else if (expand) tree.expand(node.id);
-			else tree.collapse(node.id);
-		};
+	function applyNodeExtensions() {
+		if (options?.plugins?.length) for (const n of map.values()) for (const plugin of options.plugins) plugin.extendNode?.(n, pluginCtx);
+		for (const node of map.values()) {
+			node.isExpanded = () => tree.isExpanded(node.id);
+			node.toggleExpand = (expand) => {
+				if (expand === void 0) tree.toggleExpand(node.id);
+				else if (expand) tree.expand(node.id);
+				else tree.collapse(node.id);
+			};
+		}
 	}
+	applyNodeExtensions();
 	return tree;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@splicetree/core",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "author": {
     "email": "michael.cocova@gmail.com",
     "name": "Michael Cocova"