@headless-tree/core 0.0.10 → 0.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/lib/cjs/core/build-proxified-instance.d.ts +2 -0
- package/lib/cjs/core/build-proxified-instance.js +58 -0
- package/lib/cjs/core/build-static-instance.d.ts +2 -0
- package/lib/cjs/core/build-static-instance.js +26 -0
- package/lib/cjs/core/create-tree.js +62 -40
- package/lib/cjs/features/async-data-loader/feature.d.ts +1 -4
- package/lib/cjs/features/async-data-loader/feature.js +35 -23
- package/lib/cjs/features/async-data-loader/types.d.ts +4 -6
- package/lib/cjs/features/drag-and-drop/feature.d.ts +2 -3
- package/lib/cjs/features/drag-and-drop/feature.js +79 -44
- package/lib/cjs/features/drag-and-drop/types.d.ts +15 -6
- package/lib/cjs/features/drag-and-drop/utils.d.ts +2 -3
- package/lib/cjs/features/drag-and-drop/utils.js +140 -37
- package/lib/cjs/features/expand-all/feature.d.ts +1 -5
- package/lib/cjs/features/expand-all/feature.js +12 -6
- package/lib/cjs/features/hotkeys-core/feature.d.ts +1 -3
- package/lib/cjs/features/main/types.d.ts +8 -2
- package/lib/cjs/features/prop-memoization/feature.d.ts +2 -0
- package/lib/cjs/features/prop-memoization/feature.js +48 -0
- package/lib/cjs/features/prop-memoization/types.d.ts +10 -0
- package/lib/cjs/features/prop-memoization/types.js +2 -0
- package/lib/cjs/features/renaming/feature.d.ts +1 -4
- package/lib/cjs/features/renaming/feature.js +36 -22
- package/lib/cjs/features/renaming/types.d.ts +2 -2
- package/lib/cjs/features/search/feature.d.ts +1 -4
- package/lib/cjs/features/search/feature.js +38 -24
- package/lib/cjs/features/search/types.d.ts +0 -1
- package/lib/cjs/features/selection/feature.d.ts +1 -4
- package/lib/cjs/features/selection/feature.js +54 -35
- package/lib/cjs/features/selection/types.d.ts +1 -1
- package/lib/cjs/features/sync-data-loader/feature.d.ts +1 -3
- package/lib/cjs/features/sync-data-loader/feature.js +7 -2
- package/lib/cjs/features/tree/feature.d.ts +1 -5
- package/lib/cjs/features/tree/feature.js +97 -92
- package/lib/cjs/features/tree/types.d.ts +5 -8
- package/lib/cjs/index.d.ts +5 -1
- package/lib/cjs/index.js +4 -1
- package/lib/cjs/mddocs-entry.d.ts +10 -0
- package/lib/cjs/test-utils/test-tree-do.d.ts +23 -0
- package/lib/cjs/test-utils/test-tree-do.js +99 -0
- package/lib/cjs/test-utils/test-tree-expect.d.ts +15 -0
- package/lib/cjs/test-utils/test-tree-expect.js +62 -0
- package/lib/cjs/test-utils/test-tree.d.ts +47 -0
- package/lib/cjs/test-utils/test-tree.js +203 -0
- package/lib/cjs/types/core.d.ts +39 -24
- package/lib/cjs/utilities/errors.d.ts +1 -0
- package/lib/cjs/utilities/errors.js +5 -0
- package/lib/cjs/utilities/insert-items-at-target.js +10 -3
- package/lib/cjs/utilities/remove-items-from-parents.js +14 -8
- package/lib/cjs/utils.d.ts +3 -3
- package/lib/cjs/utils.js +6 -6
- package/lib/esm/core/build-proxified-instance.d.ts +2 -0
- package/lib/esm/core/build-proxified-instance.js +54 -0
- package/lib/esm/core/build-static-instance.d.ts +2 -0
- package/lib/esm/core/build-static-instance.js +22 -0
- package/lib/esm/core/create-tree.js +62 -40
- package/lib/esm/features/async-data-loader/feature.d.ts +1 -4
- package/lib/esm/features/async-data-loader/feature.js +35 -23
- package/lib/esm/features/async-data-loader/types.d.ts +4 -6
- package/lib/esm/features/drag-and-drop/feature.d.ts +2 -3
- package/lib/esm/features/drag-and-drop/feature.js +79 -44
- package/lib/esm/features/drag-and-drop/types.d.ts +15 -6
- package/lib/esm/features/drag-and-drop/utils.d.ts +2 -3
- package/lib/esm/features/drag-and-drop/utils.js +138 -34
- package/lib/esm/features/expand-all/feature.d.ts +1 -5
- package/lib/esm/features/expand-all/feature.js +12 -6
- package/lib/esm/features/hotkeys-core/feature.d.ts +1 -3
- package/lib/esm/features/main/types.d.ts +8 -2
- package/lib/esm/features/prop-memoization/feature.d.ts +2 -0
- package/lib/esm/features/prop-memoization/feature.js +45 -0
- package/lib/esm/features/prop-memoization/types.d.ts +10 -0
- package/lib/esm/features/prop-memoization/types.js +1 -0
- package/lib/esm/features/renaming/feature.d.ts +1 -4
- package/lib/esm/features/renaming/feature.js +36 -22
- package/lib/esm/features/renaming/types.d.ts +2 -2
- package/lib/esm/features/search/feature.d.ts +1 -4
- package/lib/esm/features/search/feature.js +38 -24
- package/lib/esm/features/search/types.d.ts +0 -1
- package/lib/esm/features/selection/feature.d.ts +1 -4
- package/lib/esm/features/selection/feature.js +54 -35
- package/lib/esm/features/selection/types.d.ts +1 -1
- package/lib/esm/features/sync-data-loader/feature.d.ts +1 -3
- package/lib/esm/features/sync-data-loader/feature.js +7 -2
- package/lib/esm/features/tree/feature.d.ts +1 -5
- package/lib/esm/features/tree/feature.js +98 -93
- package/lib/esm/features/tree/types.d.ts +5 -8
- package/lib/esm/index.d.ts +5 -1
- package/lib/esm/index.js +4 -1
- package/lib/esm/mddocs-entry.d.ts +10 -0
- package/lib/esm/test-utils/test-tree-do.d.ts +23 -0
- package/lib/esm/test-utils/test-tree-do.js +95 -0
- package/lib/esm/test-utils/test-tree-expect.d.ts +15 -0
- package/lib/esm/test-utils/test-tree-expect.js +58 -0
- package/lib/esm/test-utils/test-tree.d.ts +47 -0
- package/lib/esm/test-utils/test-tree.js +199 -0
- package/lib/esm/types/core.d.ts +39 -24
- package/lib/esm/utilities/errors.d.ts +1 -0
- package/lib/esm/utilities/errors.js +1 -0
- package/lib/esm/utilities/insert-items-at-target.js +10 -3
- package/lib/esm/utilities/remove-items-from-parents.js +14 -8
- package/lib/esm/utils.d.ts +3 -3
- package/lib/esm/utils.js +3 -3
- package/package.json +7 -3
- package/src/core/build-proxified-instance.ts +117 -0
- package/src/core/build-static-instance.ts +27 -0
- package/src/core/core.spec.ts +210 -0
- package/src/core/create-tree.ts +73 -78
- package/src/features/async-data-loader/async-data-loader.spec.ts +124 -0
- package/src/features/async-data-loader/feature.ts +34 -44
- package/src/features/async-data-loader/types.ts +4 -6
- package/src/features/drag-and-drop/drag-and-drop.spec.ts +717 -0
- package/src/features/drag-and-drop/feature.ts +88 -63
- package/src/features/drag-and-drop/types.ts +24 -10
- package/src/features/drag-and-drop/utils.ts +197 -56
- package/src/features/expand-all/expand-all.spec.ts +56 -0
- package/src/features/expand-all/feature.ts +9 -24
- package/src/features/hotkeys-core/feature.ts +5 -14
- package/src/features/main/types.ts +14 -1
- package/src/features/prop-memoization/feature.ts +51 -0
- package/src/features/prop-memoization/prop-memoization.spec.ts +68 -0
- package/src/features/prop-memoization/types.ts +11 -0
- package/src/features/renaming/feature.ts +37 -45
- package/src/features/renaming/renaming.spec.ts +127 -0
- package/src/features/renaming/types.ts +2 -2
- package/src/features/search/feature.ts +36 -46
- package/src/features/search/search.spec.ts +117 -0
- package/src/features/search/types.ts +0 -1
- package/src/features/selection/feature.ts +50 -53
- package/src/features/selection/selection.spec.ts +219 -0
- package/src/features/selection/types.ts +0 -2
- package/src/features/sync-data-loader/feature.ts +9 -18
- package/src/features/tree/feature.ts +101 -144
- package/src/features/tree/tree.spec.ts +475 -0
- package/src/features/tree/types.ts +5 -9
- package/src/index.ts +6 -1
- package/src/mddocs-entry.ts +13 -0
- package/src/test-utils/test-tree-do.ts +136 -0
- package/src/test-utils/test-tree-expect.ts +86 -0
- package/src/test-utils/test-tree.ts +227 -0
- package/src/types/core.ts +76 -108
- package/src/utilities/errors.ts +2 -0
- package/src/utilities/insert-items-at-target.ts +10 -3
- package/src/utilities/remove-items-from-parents.ts +15 -10
- package/src/utils.spec.ts +89 -0
- package/src/utils.ts +6 -6
- package/tsconfig.json +1 -0
- package/vitest.config.ts +6 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { expect, vi } from "vitest";
|
|
2
|
+
import { TestTree } from "./test-tree";
|
|
3
|
+
export class TestTreeDo {
|
|
4
|
+
itemInstance(itemId) {
|
|
5
|
+
return this.tree.instance.getItemInstance(itemId);
|
|
6
|
+
}
|
|
7
|
+
itemProps(itemId) {
|
|
8
|
+
return this.itemInstance(itemId).getProps();
|
|
9
|
+
}
|
|
10
|
+
constructor(tree) {
|
|
11
|
+
this.tree = tree;
|
|
12
|
+
}
|
|
13
|
+
selectItem(id) {
|
|
14
|
+
this.itemProps(id).onClick({});
|
|
15
|
+
}
|
|
16
|
+
shiftSelectItem(id) {
|
|
17
|
+
this.itemProps(id).onClick({ shiftKey: true });
|
|
18
|
+
}
|
|
19
|
+
ctrlSelectItem(id) {
|
|
20
|
+
this.itemProps(id).onClick({ ctrlKey: true });
|
|
21
|
+
}
|
|
22
|
+
ctrlShiftSelectItem(id) {
|
|
23
|
+
this.itemProps(id).onClick({ shiftKey: true, ctrlKey: true });
|
|
24
|
+
}
|
|
25
|
+
selectMultiple(...ids) {
|
|
26
|
+
ids.forEach((id) => this.ctrlSelectItem(id));
|
|
27
|
+
}
|
|
28
|
+
hotkey(hotkey, e = {}) {
|
|
29
|
+
var _a, _b;
|
|
30
|
+
const hotkeyConfig = Object.assign(Object.assign({}, this.tree.instance.getHotkeyPresets()[hotkey]), (_a = this.tree.instance.getConfig().hotkeys) === null || _a === void 0 ? void 0 : _a[hotkey]);
|
|
31
|
+
if (hotkeyConfig.isEnabled &&
|
|
32
|
+
!((_b = hotkeyConfig.isEnabled) === null || _b === void 0 ? void 0 : _b.call(hotkeyConfig, this.tree.instance))) {
|
|
33
|
+
throw new Error(`Hotkey "${hotkey}" is disabled`);
|
|
34
|
+
}
|
|
35
|
+
if (!hotkeyConfig.handler) {
|
|
36
|
+
throw new Error(`Hotkey "${hotkey}" has no handler`);
|
|
37
|
+
}
|
|
38
|
+
hotkeyConfig.handler(Object.assign(Object.assign({}, e), { stopPropagation: () => { }, preventDefault: () => { } }), this.tree.instance);
|
|
39
|
+
}
|
|
40
|
+
startDrag(itemId, event) {
|
|
41
|
+
if (!this.itemProps(itemId).draggable) {
|
|
42
|
+
throw new Error(`Can't drag item ${itemId}, has attribute draggable=false`);
|
|
43
|
+
}
|
|
44
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
45
|
+
this.itemProps(itemId).onDragStart(e);
|
|
46
|
+
return e;
|
|
47
|
+
}
|
|
48
|
+
dragOver(itemId, event) {
|
|
49
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
50
|
+
e.preventDefault.mockClear();
|
|
51
|
+
this.itemProps(itemId).onDragOver(e);
|
|
52
|
+
this.itemProps(itemId).onDragOver(e);
|
|
53
|
+
this.itemProps(itemId).onDragOver(e);
|
|
54
|
+
expect(e.preventDefault).toBeCalledTimes(3);
|
|
55
|
+
this.consistentCalls(e.preventDefault);
|
|
56
|
+
this.consistentCalls(e.stopPropagation);
|
|
57
|
+
return e;
|
|
58
|
+
}
|
|
59
|
+
dragOverNotAllowed(itemId, event) {
|
|
60
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
61
|
+
e.preventDefault.mockClear();
|
|
62
|
+
this.itemProps(itemId).onDragOver(e);
|
|
63
|
+
this.itemProps(itemId).onDragOver(e);
|
|
64
|
+
this.itemProps(itemId).onDragOver(e);
|
|
65
|
+
expect(e.preventDefault).toBeCalledTimes(0);
|
|
66
|
+
this.consistentCalls(e.preventDefault);
|
|
67
|
+
this.consistentCalls(e.stopPropagation);
|
|
68
|
+
return e;
|
|
69
|
+
}
|
|
70
|
+
dragLeave(itemId) {
|
|
71
|
+
this.itemProps(itemId).onDragLeave({});
|
|
72
|
+
}
|
|
73
|
+
dragEnd(itemId, event) {
|
|
74
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
75
|
+
this.itemProps(itemId).onDragEnd(e);
|
|
76
|
+
return e;
|
|
77
|
+
}
|
|
78
|
+
drop(itemId, event) {
|
|
79
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
80
|
+
this.itemProps(itemId).onDrop(e);
|
|
81
|
+
return e;
|
|
82
|
+
}
|
|
83
|
+
dragOverAndDrop(itemId, event) {
|
|
84
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
85
|
+
this.dragOver(itemId, e);
|
|
86
|
+
return this.drop(itemId, e);
|
|
87
|
+
}
|
|
88
|
+
consistentCalls(fn) {
|
|
89
|
+
if (!vi.isMockFunction(fn)) {
|
|
90
|
+
throw new Error("fn is not a mock");
|
|
91
|
+
}
|
|
92
|
+
expect(fn.mock.calls.length, "function called inconsistent times").toBeOneOf([0, 3]);
|
|
93
|
+
expect(new Set(fn.mock.calls.map((call) => call.join("__"))).size, "function called with inconsistent parameters").toBeOneOf([0, 1]);
|
|
94
|
+
}
|
|
95
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { DragEvent } from "react";
|
|
2
|
+
import { TestTree } from "./test-tree";
|
|
3
|
+
import { DropTarget } from "../features/drag-and-drop/types";
|
|
4
|
+
export declare class TestTreeExpect<T> {
|
|
5
|
+
private tree;
|
|
6
|
+
protected itemInstance(itemId: string): import("..").ItemInstance<T>;
|
|
7
|
+
protected itemProps(itemId: string): Record<string, any>;
|
|
8
|
+
constructor(tree: TestTree<T>);
|
|
9
|
+
foldersExpanded(...itemIds: string[]): void;
|
|
10
|
+
foldersCollapsed(...itemIds: string[]): void;
|
|
11
|
+
hasChildren(itemId: string, children: string[]): void;
|
|
12
|
+
dropped(draggedItems: string[], target: DropTarget<any>): void;
|
|
13
|
+
dragOverNotAllowed(itemId: string, event?: DragEvent): DragEvent<Element>;
|
|
14
|
+
defaultDragLineProps(indent?: number): void;
|
|
15
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/* eslint-disable import/no-extraneous-dependencies */
|
|
2
|
+
import { expect } from "vitest";
|
|
3
|
+
import { TestTree } from "./test-tree";
|
|
4
|
+
export class TestTreeExpect {
|
|
5
|
+
itemInstance(itemId) {
|
|
6
|
+
return this.tree.instance.getItemInstance(itemId);
|
|
7
|
+
}
|
|
8
|
+
itemProps(itemId) {
|
|
9
|
+
return this.itemInstance(itemId).getProps();
|
|
10
|
+
}
|
|
11
|
+
constructor(tree) {
|
|
12
|
+
this.tree = tree;
|
|
13
|
+
}
|
|
14
|
+
foldersExpanded(...itemIds) {
|
|
15
|
+
for (const itemId of itemIds) {
|
|
16
|
+
expect(this.tree.instance.getItemInstance(itemId).isExpanded(), `Expected ${itemId} to be expanded`).toBe(true);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
foldersCollapsed(...itemIds) {
|
|
20
|
+
for (const itemId of itemIds) {
|
|
21
|
+
expect(this.tree.instance.getItemInstance(itemId).isExpanded(), `Expected ${itemId} to be collapsed`).toBe(false);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
hasChildren(itemId, children) {
|
|
25
|
+
const item = this.tree.instance.getItemInstance(itemId);
|
|
26
|
+
const itemChildren = item.getChildren().map((child) => child.getId());
|
|
27
|
+
expect(itemChildren).toEqual(children);
|
|
28
|
+
}
|
|
29
|
+
dropped(draggedItems, target) {
|
|
30
|
+
expect(this.tree.instance.getConfig().onDrop).toBeCalledWith(draggedItems.map((id) => this.tree.item(id)), target);
|
|
31
|
+
}
|
|
32
|
+
dragOverNotAllowed(itemId, event) {
|
|
33
|
+
const e = event !== null && event !== void 0 ? event : TestTree.dragEvent();
|
|
34
|
+
e.preventDefault.mockClear();
|
|
35
|
+
this.itemProps(itemId).onDragOver(e);
|
|
36
|
+
this.itemProps(itemId).onDragOver(e);
|
|
37
|
+
this.itemProps(itemId).onDragOver(e);
|
|
38
|
+
expect(e.preventDefault, "onDragOver shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
|
|
39
|
+
this.itemProps(itemId).onDrop(e);
|
|
40
|
+
expect(e.preventDefault, "onDrop shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
|
|
41
|
+
expect(this.tree.instance.getConfig().onDrop, "onDrop handler shouldn't be called if drag is not allowed").not.toBeCalled();
|
|
42
|
+
return e;
|
|
43
|
+
}
|
|
44
|
+
defaultDragLineProps(indent = 0) {
|
|
45
|
+
expect(this.tree.instance.getDragLineData()).toEqual({
|
|
46
|
+
indent,
|
|
47
|
+
left: indent * 20,
|
|
48
|
+
width: 100 - indent * 20,
|
|
49
|
+
top: 0,
|
|
50
|
+
});
|
|
51
|
+
expect(this.tree.instance.getDragLineStyle(0, 0)).toEqual({
|
|
52
|
+
left: `${indent * 20}px`,
|
|
53
|
+
pointerEvents: "none",
|
|
54
|
+
top: "0px",
|
|
55
|
+
width: `${100 - indent * 20}px`,
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { DragEvent } from "react";
|
|
2
|
+
import { TreeConfig, TreeInstance } from "../types/core";
|
|
3
|
+
import { TestTreeDo } from "./test-tree-do";
|
|
4
|
+
import { TestTreeExpect } from "./test-tree-expect";
|
|
5
|
+
export declare class TestTree<T = string> {
|
|
6
|
+
private config;
|
|
7
|
+
readonly do: TestTreeDo<T>;
|
|
8
|
+
readonly expect: TestTreeExpect<T>;
|
|
9
|
+
private treeInstance;
|
|
10
|
+
private static asyncLoaderResolvers;
|
|
11
|
+
suits: {
|
|
12
|
+
sync: () => {
|
|
13
|
+
tree: TestTree<T>;
|
|
14
|
+
title: string;
|
|
15
|
+
};
|
|
16
|
+
async: () => {
|
|
17
|
+
tree: TestTree<T>;
|
|
18
|
+
title: string;
|
|
19
|
+
};
|
|
20
|
+
proxifiedSync: () => {
|
|
21
|
+
tree: TestTree<T>;
|
|
22
|
+
title: string;
|
|
23
|
+
};
|
|
24
|
+
proxifiedAsync: () => {
|
|
25
|
+
tree: TestTree<T>;
|
|
26
|
+
title: string;
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
forSuits(runSuite: (tree: TestTree<T>) => void): void;
|
|
30
|
+
get instance(): TreeInstance<T>;
|
|
31
|
+
private constructor();
|
|
32
|
+
static resolveAsyncLoaders(): Promise<void>;
|
|
33
|
+
resolveAsyncVisibleItems(): Promise<void>;
|
|
34
|
+
static default(config: Partial<TreeConfig<string>>): TestTree<string>;
|
|
35
|
+
with(config: Partial<TreeConfig<T>>): TestTree<T>;
|
|
36
|
+
resetBeforeEach(): void;
|
|
37
|
+
createTestCaseTree(): Promise<this>;
|
|
38
|
+
withFeatures(...features: any): TestTree<T>;
|
|
39
|
+
mockedHandler(handlerName: keyof TreeConfig<T>): import("vitest").Mock<(...args: any[]) => any>;
|
|
40
|
+
item(itemId: string): import("../types/core").ItemInstance<T>;
|
|
41
|
+
reset(): void;
|
|
42
|
+
debug(): void;
|
|
43
|
+
setElementBoundingBox(itemId: string, bb?: Partial<DOMRect>): void;
|
|
44
|
+
static dragEvent(pageX?: number, pageY?: number): DragEvent;
|
|
45
|
+
createTopDragEvent(indent?: number): DragEvent<Element>;
|
|
46
|
+
createBottomDragEvent(indent?: number): DragEvent<Element>;
|
|
47
|
+
}
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
/* eslint-disable import/no-extraneous-dependencies */
|
|
11
|
+
import { beforeEach, describe, vi } from "vitest";
|
|
12
|
+
import { createTree } from "../core/create-tree";
|
|
13
|
+
import { TestTreeDo } from "./test-tree-do";
|
|
14
|
+
import { TestTreeExpect } from "./test-tree-expect";
|
|
15
|
+
import { syncDataLoaderFeature } from "../features/sync-data-loader/feature";
|
|
16
|
+
import { asyncDataLoaderFeature } from "../features/async-data-loader/feature";
|
|
17
|
+
import { buildProxiedInstance } from "../core/build-proxified-instance";
|
|
18
|
+
vi.useFakeTimers({ shouldAdvanceTime: true });
|
|
19
|
+
export class TestTree {
|
|
20
|
+
forSuits(runSuite) {
|
|
21
|
+
describe.for([
|
|
22
|
+
this.suits.sync(),
|
|
23
|
+
this.suits.async(),
|
|
24
|
+
this.suits.proxifiedSync(),
|
|
25
|
+
this.suits.proxifiedAsync(),
|
|
26
|
+
])("$title", ({ tree }) => {
|
|
27
|
+
tree.resetBeforeEach();
|
|
28
|
+
runSuite(tree);
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
get instance() {
|
|
32
|
+
if (!this.treeInstance) {
|
|
33
|
+
this.treeInstance = createTree(this.config);
|
|
34
|
+
}
|
|
35
|
+
return this.treeInstance;
|
|
36
|
+
}
|
|
37
|
+
constructor(config) {
|
|
38
|
+
this.config = config;
|
|
39
|
+
this.do = new TestTreeDo(this);
|
|
40
|
+
this.expect = new TestTreeExpect(this);
|
|
41
|
+
this.treeInstance = null;
|
|
42
|
+
this.suits = {
|
|
43
|
+
sync: () => ({
|
|
44
|
+
tree: this.withFeatures(syncDataLoaderFeature),
|
|
45
|
+
title: "Synchronous Data Loader",
|
|
46
|
+
}),
|
|
47
|
+
async: () => ({
|
|
48
|
+
tree: this.withFeatures(asyncDataLoaderFeature),
|
|
49
|
+
title: "Asynchronous Data Loader",
|
|
50
|
+
}),
|
|
51
|
+
proxifiedSync: () => ({
|
|
52
|
+
tree: this.withFeatures(syncDataLoaderFeature).with({
|
|
53
|
+
instanceBuilder: buildProxiedInstance,
|
|
54
|
+
}),
|
|
55
|
+
title: "Proxified Synchronous Data Loader",
|
|
56
|
+
}),
|
|
57
|
+
proxifiedAsync: () => ({
|
|
58
|
+
tree: this.withFeatures(asyncDataLoaderFeature).with({
|
|
59
|
+
instanceBuilder: buildProxiedInstance,
|
|
60
|
+
}),
|
|
61
|
+
title: "Proxified Asynchronous Data Loader",
|
|
62
|
+
}),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
static resolveAsyncLoaders() {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
var _a;
|
|
68
|
+
while (TestTree.asyncLoaderResolvers.length) {
|
|
69
|
+
(_a = TestTree.asyncLoaderResolvers.shift()) === null || _a === void 0 ? void 0 : _a();
|
|
70
|
+
yield new Promise((r) => {
|
|
71
|
+
setTimeout(r);
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
resolveAsyncVisibleItems() {
|
|
77
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
78
|
+
this.instance.getItems();
|
|
79
|
+
yield TestTree.resolveAsyncLoaders();
|
|
80
|
+
this.instance.getItems().forEach((i) => i.getItemName());
|
|
81
|
+
yield TestTree.resolveAsyncLoaders();
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
static default(config) {
|
|
85
|
+
return new TestTree(Object.assign({ rootItemId: "x", createLoadingItemData: () => "loading", dataLoader: {
|
|
86
|
+
getItem: (id) => id,
|
|
87
|
+
getChildren: (id) => [`${id}1`, `${id}2`, `${id}3`, `${id}4`],
|
|
88
|
+
}, asyncDataLoader: {
|
|
89
|
+
getItem: (id) => __awaiter(this, void 0, void 0, function* () {
|
|
90
|
+
yield new Promise((r) => {
|
|
91
|
+
r.debugName = `Loading getItem ${id}`;
|
|
92
|
+
TestTree.asyncLoaderResolvers.push(r);
|
|
93
|
+
});
|
|
94
|
+
return id;
|
|
95
|
+
}),
|
|
96
|
+
getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
|
|
97
|
+
yield new Promise((r) => {
|
|
98
|
+
r.debugName = `Loading getChildren ${id}`;
|
|
99
|
+
TestTree.asyncLoaderResolvers.push(r);
|
|
100
|
+
});
|
|
101
|
+
return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
|
|
102
|
+
}),
|
|
103
|
+
}, getItemName: (item) => item.getItemData(), indent: 20, isItemFolder: (item) => item.getItemMeta().level < 2, initialState: {
|
|
104
|
+
expandedItems: ["x1", "x11"],
|
|
105
|
+
}, features: [] }, config));
|
|
106
|
+
}
|
|
107
|
+
with(config) {
|
|
108
|
+
return new TestTree(Object.assign(Object.assign({}, this.config), config));
|
|
109
|
+
}
|
|
110
|
+
resetBeforeEach() {
|
|
111
|
+
beforeEach(() => __awaiter(this, void 0, void 0, function* () {
|
|
112
|
+
yield this.createTestCaseTree();
|
|
113
|
+
}));
|
|
114
|
+
}
|
|
115
|
+
createTestCaseTree() {
|
|
116
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
117
|
+
this.reset();
|
|
118
|
+
vi.clearAllMocks();
|
|
119
|
+
// trigger instance creation
|
|
120
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
|
|
121
|
+
this.instance;
|
|
122
|
+
yield this.resolveAsyncVisibleItems();
|
|
123
|
+
return this;
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
withFeatures(...features) {
|
|
127
|
+
var _a;
|
|
128
|
+
return this.with({
|
|
129
|
+
features: [...((_a = this.config.features) !== null && _a !== void 0 ? _a : []), ...features],
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
mockedHandler(handlerName) {
|
|
133
|
+
var _a;
|
|
134
|
+
const mock = vi.fn();
|
|
135
|
+
if (this.treeInstance) {
|
|
136
|
+
(_a = this.treeInstance) === null || _a === void 0 ? void 0 : _a.setConfig((prev) => (Object.assign(Object.assign({}, prev), { [handlerName]: mock })));
|
|
137
|
+
}
|
|
138
|
+
else {
|
|
139
|
+
this.config[handlerName] = mock;
|
|
140
|
+
}
|
|
141
|
+
return mock;
|
|
142
|
+
}
|
|
143
|
+
item(itemId) {
|
|
144
|
+
return this.instance.getItemInstance(itemId);
|
|
145
|
+
}
|
|
146
|
+
reset() {
|
|
147
|
+
this.treeInstance = null;
|
|
148
|
+
TestTree.asyncLoaderResolvers = [];
|
|
149
|
+
}
|
|
150
|
+
debug() {
|
|
151
|
+
console.log(this.instance
|
|
152
|
+
.getItems()
|
|
153
|
+
.map((item) => [
|
|
154
|
+
" ".repeat(item.getItemMeta().level),
|
|
155
|
+
'"',
|
|
156
|
+
item.getItemName(),
|
|
157
|
+
'"',
|
|
158
|
+
].join(""))
|
|
159
|
+
.join("\n"));
|
|
160
|
+
}
|
|
161
|
+
setElementBoundingBox(itemId, bb = {
|
|
162
|
+
left: 0,
|
|
163
|
+
width: 100,
|
|
164
|
+
top: 0,
|
|
165
|
+
height: 20,
|
|
166
|
+
}) {
|
|
167
|
+
this.instance.registerElement({
|
|
168
|
+
getBoundingClientRect: () => ({
|
|
169
|
+
left: 0,
|
|
170
|
+
width: 100,
|
|
171
|
+
top: 0,
|
|
172
|
+
height: 10000,
|
|
173
|
+
}),
|
|
174
|
+
});
|
|
175
|
+
this.instance.getItemInstance(itemId).registerElement({
|
|
176
|
+
getBoundingClientRect: () => bb,
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
static dragEvent(pageX = 1000, pageY = 0) {
|
|
180
|
+
return {
|
|
181
|
+
preventDefault: vi.fn(),
|
|
182
|
+
stopPropagation: vi.fn(),
|
|
183
|
+
dataTransfer: {
|
|
184
|
+
setData: vi.fn(),
|
|
185
|
+
getData: vi.fn(),
|
|
186
|
+
dropEffect: "unchaged-from-test",
|
|
187
|
+
},
|
|
188
|
+
pageX,
|
|
189
|
+
pageY,
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
createTopDragEvent(indent = 0) {
|
|
193
|
+
return TestTree.dragEvent(indent * 20, 1);
|
|
194
|
+
}
|
|
195
|
+
createBottomDragEvent(indent = 0) {
|
|
196
|
+
return TestTree.dragEvent(indent * 20, 19);
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
TestTree.asyncLoaderResolvers = [];
|
package/lib/esm/types/core.d.ts
CHANGED
|
@@ -8,13 +8,14 @@ import { AsyncDataLoaderFeatureDef } from "../features/async-data-loader/types";
|
|
|
8
8
|
import { SearchFeatureDef } from "../features/search/types";
|
|
9
9
|
import { RenamingFeatureDef } from "../features/renaming/types";
|
|
10
10
|
import { ExpandAllFeatureDef } from "../features/expand-all/types";
|
|
11
|
+
import { PropMemoizationFeatureDef } from "../features/prop-memoization/types";
|
|
11
12
|
export type Updater<T> = T | ((old: T) => T);
|
|
12
13
|
export type SetStateFn<T> = (updaterOrValue: Updater<T>) => void;
|
|
13
14
|
export type FeatureDef = {
|
|
14
|
-
state:
|
|
15
|
-
config:
|
|
16
|
-
treeInstance:
|
|
17
|
-
itemInstance:
|
|
15
|
+
state: any;
|
|
16
|
+
config: any;
|
|
17
|
+
treeInstance: any;
|
|
18
|
+
itemInstance: any;
|
|
18
19
|
hotkeys: string;
|
|
19
20
|
};
|
|
20
21
|
export type EmptyFeatureDef = {
|
|
@@ -25,8 +26,6 @@ export type EmptyFeatureDef = {
|
|
|
25
26
|
hotkeys: never;
|
|
26
27
|
};
|
|
27
28
|
type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
|
|
28
|
-
export type DefaultFeatures<T> = MainFeatureDef | TreeFeatureDef<T>;
|
|
29
|
-
export type FeatureDefs<T> = MainFeatureDef | TreeFeatureDef<T> | SelectionFeatureDef<T> | DragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef;
|
|
30
29
|
type MergedFeatures<F extends FeatureDef> = {
|
|
31
30
|
state: UnionToIntersection<F["state"]>;
|
|
32
31
|
config: UnionToIntersection<F["config"]>;
|
|
@@ -34,34 +33,50 @@ type MergedFeatures<F extends FeatureDef> = {
|
|
|
34
33
|
itemInstance: UnionToIntersection<F["itemInstance"]>;
|
|
35
34
|
hotkeys: F["hotkeys"];
|
|
36
35
|
};
|
|
37
|
-
type
|
|
36
|
+
export type RegisteredFeatures<T> = MainFeatureDef<T> | TreeFeatureDef<T> | SelectionFeatureDef<T> | DragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef | PropMemoizationFeatureDef;
|
|
37
|
+
type TreeStateType<T> = MergedFeatures<RegisteredFeatures<T>>["state"];
|
|
38
38
|
export interface TreeState<T> extends TreeStateType<T> {
|
|
39
39
|
}
|
|
40
|
-
type TreeConfigType<T> =
|
|
40
|
+
type TreeConfigType<T> = MergedFeatures<RegisteredFeatures<T>>["config"];
|
|
41
41
|
export interface TreeConfig<T> extends TreeConfigType<T> {
|
|
42
42
|
}
|
|
43
|
-
type TreeInstanceType<T> =
|
|
43
|
+
type TreeInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["treeInstance"];
|
|
44
44
|
export interface TreeInstance<T> extends TreeInstanceType<T> {
|
|
45
45
|
}
|
|
46
|
-
type ItemInstanceType<T> =
|
|
46
|
+
type ItemInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["itemInstance"];
|
|
47
47
|
export interface ItemInstance<T> extends ItemInstanceType<T> {
|
|
48
48
|
}
|
|
49
|
-
export type HotkeyName
|
|
50
|
-
export type HotkeysConfig<T
|
|
51
|
-
export type CustomHotkeysConfig<T
|
|
52
|
-
|
|
49
|
+
export type HotkeyName = MergedFeatures<RegisteredFeatures<any>>["hotkeys"];
|
|
50
|
+
export type HotkeysConfig<T> = Record<HotkeyName, HotkeyConfig<T>>;
|
|
51
|
+
export type CustomHotkeysConfig<T> = Partial<Record<HotkeyName | `custom${string}`, Partial<HotkeyConfig<T>>>>;
|
|
52
|
+
type MayReturnNull<T extends (...x: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | null;
|
|
53
|
+
export type ItemInstanceOpts<Key extends keyof ItemInstance<any>> = {
|
|
54
|
+
item: ItemInstance<any>;
|
|
55
|
+
tree: TreeInstance<any>;
|
|
56
|
+
itemId: string;
|
|
57
|
+
prev?: MayReturnNull<ItemInstance<any>[Key]>;
|
|
58
|
+
};
|
|
59
|
+
export type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
|
|
60
|
+
tree: TreeInstance<any>;
|
|
61
|
+
prev?: MayReturnNull<TreeInstance<any>[Key]>;
|
|
62
|
+
};
|
|
63
|
+
export type FeatureImplementation<T = any> = {
|
|
53
64
|
key?: string;
|
|
54
65
|
deps?: string[];
|
|
55
66
|
overwrites?: string[];
|
|
56
|
-
stateHandlerNames?: Partial<Record<keyof
|
|
57
|
-
getInitialState?: (initialState: Partial<
|
|
58
|
-
getDefaultConfig?: (defaultConfig: Partial<
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
67
|
+
stateHandlerNames?: Partial<Record<keyof TreeState<T>, keyof TreeConfig<T>>>;
|
|
68
|
+
getInitialState?: (initialState: Partial<TreeState<T>>, tree: TreeInstance<T>) => Partial<TreeState<T>>;
|
|
69
|
+
getDefaultConfig?: (defaultConfig: Partial<TreeConfig<T>>, tree: TreeInstance<T>) => Partial<TreeConfig<T>>;
|
|
70
|
+
treeInstance?: {
|
|
71
|
+
[key in keyof TreeInstance<T>]?: (opts: TreeInstanceOpts<key>, ...args: Parameters<TreeInstance<T>[key]>) => void;
|
|
72
|
+
};
|
|
73
|
+
itemInstance?: {
|
|
74
|
+
[key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
|
|
75
|
+
};
|
|
76
|
+
onTreeMount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
|
|
77
|
+
onTreeUnmount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
|
|
78
|
+
onItemMount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
|
|
79
|
+
onItemUnmount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
|
|
80
|
+
hotkeys?: Partial<HotkeysConfig<T>>;
|
|
66
81
|
};
|
|
67
82
|
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const throwError: (message: string) => Error;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export const throwError = (message) => Error(`Headless Tree: ${message}`);
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
export const insertItemsAtTarget = (itemIds, target, onChangeChildren) => {
|
|
2
2
|
// add moved items to new common parent, if dropped onto parent
|
|
3
3
|
if (target.childIndex === null) {
|
|
4
|
-
|
|
4
|
+
const newChildren = [
|
|
5
5
|
...target.item.getChildren().map((item) => item.getId()),
|
|
6
6
|
...itemIds,
|
|
7
|
-
]
|
|
8
|
-
|
|
7
|
+
];
|
|
8
|
+
onChangeChildren(target.item, newChildren);
|
|
9
|
+
if (target.item && "updateCachedChildrenIds" in target.item) {
|
|
10
|
+
target.item.updateCachedChildrenIds(newChildren);
|
|
11
|
+
}
|
|
12
|
+
target.item.getTree().rebuildTree();
|
|
9
13
|
return;
|
|
10
14
|
}
|
|
11
15
|
// add moved items to new common parent, if dropped between siblings
|
|
@@ -16,5 +20,8 @@ export const insertItemsAtTarget = (itemIds, target, onChangeChildren) => {
|
|
|
16
20
|
...oldChildren.slice(target.insertionIndex).map((item) => item.getId()),
|
|
17
21
|
];
|
|
18
22
|
onChangeChildren(target.item, newChildren);
|
|
23
|
+
if (target.item && "updateCachedChildrenIds" in target.item) {
|
|
24
|
+
target.item.updateCachedChildrenIds(newChildren);
|
|
25
|
+
}
|
|
19
26
|
target.item.getTree().rebuildTree();
|
|
20
27
|
};
|
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
export const removeItemsFromParents = (movedItems, onChangeChildren) => {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
2
|
+
const movedItemsIds = movedItems.map((item) => item.getId());
|
|
3
|
+
const uniqueParents = [
|
|
4
|
+
...new Set(movedItems.map((item) => item.getParent())),
|
|
5
|
+
];
|
|
6
|
+
for (const parent of uniqueParents) {
|
|
7
|
+
const siblings = parent === null || parent === void 0 ? void 0 : parent.getChildren();
|
|
8
|
+
if (siblings && parent) {
|
|
9
|
+
const newChildren = siblings
|
|
10
|
+
.filter((sibling) => !movedItemsIds.includes(sibling.getId()))
|
|
11
|
+
.map((i) => i.getId());
|
|
12
|
+
onChangeChildren(parent, newChildren);
|
|
13
|
+
if (parent && "updateCachedChildrenIds" in parent) {
|
|
14
|
+
parent === null || parent === void 0 ? void 0 : parent.updateCachedChildrenIds(newChildren);
|
|
15
|
+
}
|
|
10
16
|
}
|
|
11
17
|
}
|
|
12
18
|
movedItems[0].getTree().rebuildTree();
|
package/lib/esm/utils.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { TreeState, Updater } from "./types/core";
|
|
1
|
+
import { SetStateFn, TreeState, Updater } from "./types/core";
|
|
2
2
|
export type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
3
|
-
export declare const memo: <D extends readonly any[], R>(
|
|
3
|
+
export declare const memo: <D extends readonly any[], P extends readonly any[], R>(deps: (...args: [...P]) => [...D], fn: (...args: [...D]) => R) => (...a: P) => R;
|
|
4
4
|
export declare function functionalUpdate<T>(updater: Updater<T>, input: T): T;
|
|
5
|
-
export declare function makeStateUpdater<K extends keyof TreeState<any>>(key: K, instance: unknown):
|
|
5
|
+
export declare function makeStateUpdater<K extends keyof TreeState<any>>(key: K, instance: unknown): SetStateFn<TreeState<any>[K]>;
|
|
6
6
|
export declare const poll: (fn: () => boolean, interval?: number, timeout?: number) => Promise<void>;
|
package/lib/esm/utils.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export const memo = (
|
|
1
|
+
export const memo = (deps, fn) => {
|
|
2
2
|
let value;
|
|
3
3
|
let oldDeps = null;
|
|
4
|
-
return () => {
|
|
5
|
-
const newDeps = deps();
|
|
4
|
+
return (...a) => {
|
|
5
|
+
const newDeps = deps(...a);
|
|
6
6
|
if (!value) {
|
|
7
7
|
value = fn(...newDeps);
|
|
8
8
|
oldDeps = newDeps;
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@headless-tree/core",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.12",
|
|
4
|
+
"type": "module",
|
|
4
5
|
"main": "lib/cjs/index.js",
|
|
5
6
|
"module": "lib/esm/index.js",
|
|
6
7
|
"types": "lib/esm/index.d.ts",
|
|
@@ -8,7 +9,8 @@
|
|
|
8
9
|
"scripts": {
|
|
9
10
|
"build:cjs": "tsc -m commonjs --outDir lib/cjs",
|
|
10
11
|
"build:esm": "tsc",
|
|
11
|
-
"start": "tsc -w"
|
|
12
|
+
"start": "tsc -w",
|
|
13
|
+
"test": "vitest run"
|
|
12
14
|
},
|
|
13
15
|
"repository": {
|
|
14
16
|
"type": "git",
|
|
@@ -18,6 +20,8 @@
|
|
|
18
20
|
"author": "Lukas Bach <npm@lukasbach.com>",
|
|
19
21
|
"license": "MIT",
|
|
20
22
|
"devDependencies": {
|
|
21
|
-
"
|
|
23
|
+
"jsdom": "^26.0.0",
|
|
24
|
+
"typescript": "^5.7.3",
|
|
25
|
+
"vitest": "^3.0.3"
|
|
22
26
|
}
|
|
23
27
|
}
|