@headless-tree/core 1.2.0 → 1.3.0

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.
Files changed (183) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist/index.d.mts +577 -0
  3. package/dist/index.d.ts +577 -0
  4. package/dist/index.js +2321 -0
  5. package/dist/index.mjs +2276 -0
  6. package/package.json +18 -10
  7. package/src/core/create-tree.ts +26 -2
  8. package/src/features/async-data-loader/feature.ts +9 -4
  9. package/src/features/async-data-loader/types.ts +2 -0
  10. package/src/features/checkboxes/checkboxes.spec.ts +149 -0
  11. package/src/features/checkboxes/feature.ts +134 -0
  12. package/src/features/checkboxes/types.ts +29 -0
  13. package/src/features/drag-and-drop/drag-and-drop.spec.ts +11 -2
  14. package/src/features/drag-and-drop/feature.ts +88 -17
  15. package/src/features/drag-and-drop/types.ts +22 -0
  16. package/src/features/keyboard-drag-and-drop/feature.ts +8 -1
  17. package/src/features/keyboard-drag-and-drop/keyboard-drag-and-drop.spec.ts +34 -3
  18. package/src/features/sync-data-loader/feature.ts +5 -1
  19. package/src/features/tree/feature.ts +9 -3
  20. package/src/features/tree/tree.spec.ts +14 -4
  21. package/src/features/tree/types.ts +3 -2
  22. package/src/index.ts +2 -0
  23. package/src/test-utils/test-tree-do.ts +2 -0
  24. package/src/test-utils/test-tree.ts +1 -0
  25. package/src/types/core.ts +2 -0
  26. package/tsconfig.json +1 -4
  27. package/vitest.config.ts +3 -1
  28. package/lib/cjs/core/build-proxified-instance.d.ts +0 -2
  29. package/lib/cjs/core/build-proxified-instance.js +0 -58
  30. package/lib/cjs/core/build-static-instance.d.ts +0 -2
  31. package/lib/cjs/core/build-static-instance.js +0 -26
  32. package/lib/cjs/core/create-tree.d.ts +0 -2
  33. package/lib/cjs/core/create-tree.js +0 -182
  34. package/lib/cjs/features/async-data-loader/feature.d.ts +0 -2
  35. package/lib/cjs/features/async-data-loader/feature.js +0 -135
  36. package/lib/cjs/features/async-data-loader/types.d.ts +0 -47
  37. package/lib/cjs/features/async-data-loader/types.js +0 -2
  38. package/lib/cjs/features/drag-and-drop/feature.d.ts +0 -2
  39. package/lib/cjs/features/drag-and-drop/feature.js +0 -179
  40. package/lib/cjs/features/drag-and-drop/types.d.ts +0 -66
  41. package/lib/cjs/features/drag-and-drop/types.js +0 -9
  42. package/lib/cjs/features/drag-and-drop/utils.d.ts +0 -27
  43. package/lib/cjs/features/drag-and-drop/utils.js +0 -182
  44. package/lib/cjs/features/expand-all/feature.d.ts +0 -2
  45. package/lib/cjs/features/expand-all/feature.js +0 -70
  46. package/lib/cjs/features/expand-all/types.d.ts +0 -19
  47. package/lib/cjs/features/expand-all/types.js +0 -2
  48. package/lib/cjs/features/hotkeys-core/feature.d.ts +0 -2
  49. package/lib/cjs/features/hotkeys-core/feature.js +0 -107
  50. package/lib/cjs/features/hotkeys-core/types.d.ts +0 -27
  51. package/lib/cjs/features/hotkeys-core/types.js +0 -2
  52. package/lib/cjs/features/keyboard-drag-and-drop/feature.d.ts +0 -2
  53. package/lib/cjs/features/keyboard-drag-and-drop/feature.js +0 -206
  54. package/lib/cjs/features/keyboard-drag-and-drop/types.d.ts +0 -27
  55. package/lib/cjs/features/keyboard-drag-and-drop/types.js +0 -11
  56. package/lib/cjs/features/main/types.d.ts +0 -45
  57. package/lib/cjs/features/main/types.js +0 -2
  58. package/lib/cjs/features/prop-memoization/feature.d.ts +0 -2
  59. package/lib/cjs/features/prop-memoization/feature.js +0 -70
  60. package/lib/cjs/features/prop-memoization/types.d.ts +0 -15
  61. package/lib/cjs/features/prop-memoization/types.js +0 -2
  62. package/lib/cjs/features/renaming/feature.d.ts +0 -2
  63. package/lib/cjs/features/renaming/feature.js +0 -86
  64. package/lib/cjs/features/renaming/types.d.ts +0 -27
  65. package/lib/cjs/features/renaming/types.js +0 -2
  66. package/lib/cjs/features/search/feature.d.ts +0 -2
  67. package/lib/cjs/features/search/feature.js +0 -119
  68. package/lib/cjs/features/search/types.d.ts +0 -32
  69. package/lib/cjs/features/search/types.js +0 -2
  70. package/lib/cjs/features/selection/feature.d.ts +0 -2
  71. package/lib/cjs/features/selection/feature.js +0 -132
  72. package/lib/cjs/features/selection/types.d.ts +0 -21
  73. package/lib/cjs/features/selection/types.js +0 -2
  74. package/lib/cjs/features/sync-data-loader/feature.d.ts +0 -2
  75. package/lib/cjs/features/sync-data-loader/feature.js +0 -49
  76. package/lib/cjs/features/sync-data-loader/types.d.ts +0 -28
  77. package/lib/cjs/features/sync-data-loader/types.js +0 -2
  78. package/lib/cjs/features/tree/feature.d.ts +0 -2
  79. package/lib/cjs/features/tree/feature.js +0 -240
  80. package/lib/cjs/features/tree/types.d.ts +0 -62
  81. package/lib/cjs/features/tree/types.js +0 -2
  82. package/lib/cjs/index.d.ts +0 -31
  83. package/lib/cjs/index.js +0 -49
  84. package/lib/cjs/mddocs-entry.d.ts +0 -121
  85. package/lib/cjs/mddocs-entry.js +0 -17
  86. package/lib/cjs/test-utils/test-tree-do.d.ts +0 -23
  87. package/lib/cjs/test-utils/test-tree-do.js +0 -112
  88. package/lib/cjs/test-utils/test-tree-expect.d.ts +0 -17
  89. package/lib/cjs/test-utils/test-tree-expect.js +0 -66
  90. package/lib/cjs/test-utils/test-tree.d.ts +0 -48
  91. package/lib/cjs/test-utils/test-tree.js +0 -207
  92. package/lib/cjs/types/core.d.ts +0 -83
  93. package/lib/cjs/types/core.js +0 -2
  94. package/lib/cjs/types/deep-merge.d.ts +0 -13
  95. package/lib/cjs/types/deep-merge.js +0 -2
  96. package/lib/cjs/utilities/create-on-drop-handler.d.ts +0 -3
  97. package/lib/cjs/utilities/create-on-drop-handler.js +0 -20
  98. package/lib/cjs/utilities/errors.d.ts +0 -2
  99. package/lib/cjs/utilities/errors.js +0 -9
  100. package/lib/cjs/utilities/insert-items-at-target.d.ts +0 -3
  101. package/lib/cjs/utilities/insert-items-at-target.js +0 -40
  102. package/lib/cjs/utilities/remove-items-from-parents.d.ts +0 -2
  103. package/lib/cjs/utilities/remove-items-from-parents.js +0 -32
  104. package/lib/cjs/utils.d.ts +0 -6
  105. package/lib/cjs/utils.js +0 -53
  106. package/lib/esm/core/build-proxified-instance.d.ts +0 -2
  107. package/lib/esm/core/build-proxified-instance.js +0 -54
  108. package/lib/esm/core/build-static-instance.d.ts +0 -2
  109. package/lib/esm/core/build-static-instance.js +0 -22
  110. package/lib/esm/core/create-tree.d.ts +0 -2
  111. package/lib/esm/core/create-tree.js +0 -178
  112. package/lib/esm/features/async-data-loader/feature.d.ts +0 -2
  113. package/lib/esm/features/async-data-loader/feature.js +0 -132
  114. package/lib/esm/features/async-data-loader/types.d.ts +0 -47
  115. package/lib/esm/features/async-data-loader/types.js +0 -1
  116. package/lib/esm/features/drag-and-drop/feature.d.ts +0 -2
  117. package/lib/esm/features/drag-and-drop/feature.js +0 -176
  118. package/lib/esm/features/drag-and-drop/types.d.ts +0 -66
  119. package/lib/esm/features/drag-and-drop/types.js +0 -6
  120. package/lib/esm/features/drag-and-drop/utils.d.ts +0 -27
  121. package/lib/esm/features/drag-and-drop/utils.js +0 -172
  122. package/lib/esm/features/expand-all/feature.d.ts +0 -2
  123. package/lib/esm/features/expand-all/feature.js +0 -67
  124. package/lib/esm/features/expand-all/types.d.ts +0 -19
  125. package/lib/esm/features/expand-all/types.js +0 -1
  126. package/lib/esm/features/hotkeys-core/feature.d.ts +0 -2
  127. package/lib/esm/features/hotkeys-core/feature.js +0 -104
  128. package/lib/esm/features/hotkeys-core/types.d.ts +0 -27
  129. package/lib/esm/features/hotkeys-core/types.js +0 -1
  130. package/lib/esm/features/keyboard-drag-and-drop/feature.d.ts +0 -2
  131. package/lib/esm/features/keyboard-drag-and-drop/feature.js +0 -203
  132. package/lib/esm/features/keyboard-drag-and-drop/types.d.ts +0 -27
  133. package/lib/esm/features/keyboard-drag-and-drop/types.js +0 -8
  134. package/lib/esm/features/main/types.d.ts +0 -45
  135. package/lib/esm/features/main/types.js +0 -1
  136. package/lib/esm/features/prop-memoization/feature.d.ts +0 -2
  137. package/lib/esm/features/prop-memoization/feature.js +0 -67
  138. package/lib/esm/features/prop-memoization/types.d.ts +0 -15
  139. package/lib/esm/features/prop-memoization/types.js +0 -1
  140. package/lib/esm/features/renaming/feature.d.ts +0 -2
  141. package/lib/esm/features/renaming/feature.js +0 -83
  142. package/lib/esm/features/renaming/types.d.ts +0 -27
  143. package/lib/esm/features/renaming/types.js +0 -1
  144. package/lib/esm/features/search/feature.d.ts +0 -2
  145. package/lib/esm/features/search/feature.js +0 -116
  146. package/lib/esm/features/search/types.d.ts +0 -32
  147. package/lib/esm/features/search/types.js +0 -1
  148. package/lib/esm/features/selection/feature.d.ts +0 -2
  149. package/lib/esm/features/selection/feature.js +0 -129
  150. package/lib/esm/features/selection/types.d.ts +0 -21
  151. package/lib/esm/features/selection/types.js +0 -1
  152. package/lib/esm/features/sync-data-loader/feature.d.ts +0 -2
  153. package/lib/esm/features/sync-data-loader/feature.js +0 -46
  154. package/lib/esm/features/sync-data-loader/types.d.ts +0 -28
  155. package/lib/esm/features/sync-data-loader/types.js +0 -1
  156. package/lib/esm/features/tree/feature.d.ts +0 -2
  157. package/lib/esm/features/tree/feature.js +0 -237
  158. package/lib/esm/features/tree/types.d.ts +0 -62
  159. package/lib/esm/features/tree/types.js +0 -1
  160. package/lib/esm/index.d.ts +0 -31
  161. package/lib/esm/index.js +0 -30
  162. package/lib/esm/mddocs-entry.d.ts +0 -121
  163. package/lib/esm/mddocs-entry.js +0 -1
  164. package/lib/esm/test-utils/test-tree-do.d.ts +0 -23
  165. package/lib/esm/test-utils/test-tree-do.js +0 -108
  166. package/lib/esm/test-utils/test-tree-expect.d.ts +0 -17
  167. package/lib/esm/test-utils/test-tree-expect.js +0 -62
  168. package/lib/esm/test-utils/test-tree.d.ts +0 -48
  169. package/lib/esm/test-utils/test-tree.js +0 -203
  170. package/lib/esm/types/core.d.ts +0 -83
  171. package/lib/esm/types/core.js +0 -1
  172. package/lib/esm/types/deep-merge.d.ts +0 -13
  173. package/lib/esm/types/deep-merge.js +0 -1
  174. package/lib/esm/utilities/create-on-drop-handler.d.ts +0 -3
  175. package/lib/esm/utilities/create-on-drop-handler.js +0 -16
  176. package/lib/esm/utilities/errors.d.ts +0 -2
  177. package/lib/esm/utilities/errors.js +0 -4
  178. package/lib/esm/utilities/insert-items-at-target.d.ts +0 -3
  179. package/lib/esm/utilities/insert-items-at-target.js +0 -36
  180. package/lib/esm/utilities/remove-items-from-parents.d.ts +0 -2
  181. package/lib/esm/utilities/remove-items-from-parents.js +0 -28
  182. package/lib/esm/utils.d.ts +0 -6
  183. package/lib/esm/utils.js +0 -46
@@ -1,112 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.TestTreeDo = void 0;
13
- const vitest_1 = require("vitest");
14
- const test_tree_1 = require("./test-tree");
15
- class TestTreeDo {
16
- itemInstance(itemId) {
17
- return this.tree.instance.getItemInstance(itemId);
18
- }
19
- itemProps(itemId) {
20
- return this.itemInstance(itemId).getProps();
21
- }
22
- constructor(tree) {
23
- this.tree = tree;
24
- }
25
- selectItem(id) {
26
- this.itemProps(id).onClick({});
27
- }
28
- shiftSelectItem(id) {
29
- this.itemProps(id).onClick({ shiftKey: true });
30
- }
31
- ctrlSelectItem(id) {
32
- this.itemProps(id).onClick({ ctrlKey: true });
33
- }
34
- ctrlShiftSelectItem(id) {
35
- this.itemProps(id).onClick({ shiftKey: true, ctrlKey: true });
36
- }
37
- selectMultiple(...ids) {
38
- ids.forEach((id) => this.ctrlSelectItem(id));
39
- }
40
- hotkey(hotkey, e = {}) {
41
- var _a, _b;
42
- 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]);
43
- if (hotkeyConfig.isEnabled &&
44
- !((_b = hotkeyConfig.isEnabled) === null || _b === void 0 ? void 0 : _b.call(hotkeyConfig, this.tree.instance))) {
45
- throw new Error(`Hotkey "${hotkey}" is disabled`);
46
- }
47
- if (!hotkeyConfig.handler) {
48
- throw new Error(`Hotkey "${hotkey}" has no handler`);
49
- }
50
- hotkeyConfig.handler(Object.assign(Object.assign({}, e), { stopPropagation: () => { }, preventDefault: () => { } }), this.tree.instance);
51
- }
52
- startDrag(itemId, event) {
53
- if (!this.itemProps(itemId).draggable) {
54
- throw new Error(`Can't drag item ${itemId}, has attribute draggable=false`);
55
- }
56
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
57
- this.itemProps(itemId).onDragStart(e);
58
- return e;
59
- }
60
- dragOver(itemId, event) {
61
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
62
- e.preventDefault.mockClear();
63
- this.itemProps(itemId).onDragOver(e);
64
- this.itemProps(itemId).onDragOver(e);
65
- this.itemProps(itemId).onDragOver(e);
66
- (0, vitest_1.expect)(e.preventDefault).toBeCalledTimes(3);
67
- this.consistentCalls(e.preventDefault);
68
- this.consistentCalls(e.stopPropagation);
69
- return e;
70
- }
71
- dragOverNotAllowed(itemId, event) {
72
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
73
- e.preventDefault.mockClear();
74
- this.itemProps(itemId).onDragOver(e);
75
- this.itemProps(itemId).onDragOver(e);
76
- this.itemProps(itemId).onDragOver(e);
77
- (0, vitest_1.expect)(e.preventDefault).toBeCalledTimes(0);
78
- this.consistentCalls(e.preventDefault);
79
- this.consistentCalls(e.stopPropagation);
80
- return e;
81
- }
82
- dragLeave(itemId) {
83
- this.itemProps(itemId).onDragLeave({});
84
- }
85
- dragEnd(itemId, event) {
86
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
87
- this.itemProps(itemId).onDragEnd(e);
88
- return e;
89
- }
90
- drop(itemId, event) {
91
- return __awaiter(this, void 0, void 0, function* () {
92
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
93
- yield this.itemProps(itemId).onDrop(e);
94
- return e;
95
- });
96
- }
97
- dragOverAndDrop(itemId, event) {
98
- return __awaiter(this, void 0, void 0, function* () {
99
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
100
- this.dragOver(itemId, e);
101
- return this.drop(itemId, e);
102
- });
103
- }
104
- consistentCalls(fn) {
105
- if (!vitest_1.vi.isMockFunction(fn)) {
106
- throw new Error("fn is not a mock");
107
- }
108
- (0, vitest_1.expect)(fn.mock.calls.length, "function called inconsistent times").toBeOneOf([0, 3]);
109
- (0, vitest_1.expect)(new Set(fn.mock.calls.map((call) => call.join("__"))).size, "function called with inconsistent parameters").toBeOneOf([0, 1]);
110
- }
111
- }
112
- exports.TestTreeDo = TestTreeDo;
@@ -1,17 +0,0 @@
1
- import { DragEvent } from "react";
2
- import { TestTree } from "./test-tree";
3
- import { DragTarget } from "../features/drag-and-drop/types";
4
- import { TreeState } from "../types/core";
5
- export declare class TestTreeExpect<T> {
6
- private tree;
7
- protected itemInstance(itemId: string): import("../types/core").ItemInstance<T>;
8
- protected itemProps(itemId: string): Record<string, any>;
9
- constructor(tree: TestTree<T>);
10
- foldersExpanded(...itemIds: string[]): void;
11
- foldersCollapsed(...itemIds: string[]): void;
12
- hasChildren(itemId: string, children: string[]): void;
13
- substate<K extends keyof TreeState<T>>(key: K, value: TreeState<T>[K]): void;
14
- dropped(draggedItems: string[], target: DragTarget<any>): void;
15
- dragOverNotAllowed(itemId: string, event?: DragEvent): DragEvent<Element>;
16
- defaultDragLineProps(indent?: number): void;
17
- }
@@ -1,66 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TestTreeExpect = void 0;
4
- /* eslint-disable import/no-extraneous-dependencies */
5
- const vitest_1 = require("vitest");
6
- const test_tree_1 = require("./test-tree");
7
- class TestTreeExpect {
8
- itemInstance(itemId) {
9
- return this.tree.instance.getItemInstance(itemId);
10
- }
11
- itemProps(itemId) {
12
- return this.itemInstance(itemId).getProps();
13
- }
14
- constructor(tree) {
15
- this.tree = tree;
16
- }
17
- foldersExpanded(...itemIds) {
18
- for (const itemId of itemIds) {
19
- (0, vitest_1.expect)(this.tree.instance.getItemInstance(itemId).isExpanded(), `Expected ${itemId} to be expanded`).toBe(true);
20
- }
21
- }
22
- foldersCollapsed(...itemIds) {
23
- for (const itemId of itemIds) {
24
- (0, vitest_1.expect)(this.tree.instance.getItemInstance(itemId).isExpanded(), `Expected ${itemId} to be collapsed`).toBe(false);
25
- }
26
- }
27
- hasChildren(itemId, children) {
28
- const item = this.tree.instance.getItemInstance(itemId);
29
- const itemChildren = item.getChildren().map((child) => child.getId());
30
- (0, vitest_1.expect)(itemChildren).toEqual(children);
31
- }
32
- substate(key, value) {
33
- (0, vitest_1.expect)(this.tree.instance.getState()[key]).toEqual(value);
34
- }
35
- dropped(draggedItems, target) {
36
- (0, vitest_1.expect)(this.tree.instance.getConfig().onDrop).toBeCalledWith(draggedItems.map((id) => this.tree.item(id)), target);
37
- }
38
- dragOverNotAllowed(itemId, event) {
39
- const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
40
- e.preventDefault.mockClear();
41
- this.itemProps(itemId).onDragOver(e);
42
- this.itemProps(itemId).onDragOver(e);
43
- this.itemProps(itemId).onDragOver(e);
44
- (0, vitest_1.expect)(e.preventDefault, "onDragOver shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
45
- this.itemProps(itemId).onDrop(e);
46
- (0, vitest_1.expect)(e.preventDefault, "onDrop shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
47
- (0, vitest_1.expect)(this.tree.instance.getConfig().onDrop, "onDrop handler shouldn't be called if drag is not allowed").not.toBeCalled();
48
- return e;
49
- }
50
- defaultDragLineProps(indent = 0) {
51
- (0, vitest_1.expect)(this.tree.instance.getDragLineData()).toEqual({
52
- indent,
53
- left: indent * 20,
54
- width: 100 - indent * 20,
55
- top: 0,
56
- });
57
- (0, vitest_1.expect)(this.tree.instance.getDragLineStyle(0, 0)).toEqual({
58
- position: "absolute",
59
- left: `${indent * 20}px`,
60
- pointerEvents: "none",
61
- top: "0px",
62
- width: `${100 - indent * 20}px`,
63
- });
64
- }
65
- }
66
- exports.TestTreeExpect = TestTreeExpect;
@@ -1,48 +0,0 @@
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
- private asyncDataLoaderImp;
12
- suits: {
13
- sync: () => {
14
- tree: TestTree<T>;
15
- title: string;
16
- };
17
- async: () => {
18
- tree: TestTree<T>;
19
- title: string;
20
- };
21
- proxifiedSync: () => {
22
- tree: TestTree<T>;
23
- title: string;
24
- };
25
- proxifiedAsync: () => {
26
- tree: TestTree<T>;
27
- title: string;
28
- };
29
- };
30
- forSuits(runSuite: (tree: TestTree<T>) => void): void;
31
- get instance(): TreeInstance<T>;
32
- private constructor();
33
- static resolveAsyncLoaders(): Promise<void>;
34
- resolveAsyncVisibleItems(): Promise<void>;
35
- static default(config: Partial<TreeConfig<string>>): TestTree<string>;
36
- with(config: Partial<TreeConfig<T>>): TestTree<T>;
37
- resetBeforeEach(): void;
38
- createTestCaseTree(): Promise<this>;
39
- withFeatures(...features: any): TestTree<T>;
40
- mockedHandler(handlerName: keyof TreeConfig<T>): import("vitest").Mock<(...args: any[]) => any>;
41
- item(itemId: string): import("../types/core").ItemInstance<T>;
42
- reset(): void;
43
- debug(): void;
44
- setElementBoundingBox(itemId: string, bb?: Partial<DOMRect>): void;
45
- static dragEvent(clientX?: number, clientY?: number): DragEvent;
46
- createTopDragEvent(indent?: number): DragEvent<Element>;
47
- createBottomDragEvent(indent?: number): DragEvent<Element>;
48
- }
@@ -1,207 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.TestTree = void 0;
13
- /* eslint-disable import/no-extraneous-dependencies */
14
- const vitest_1 = require("vitest");
15
- const create_tree_1 = require("../core/create-tree");
16
- const test_tree_do_1 = require("./test-tree-do");
17
- const test_tree_expect_1 = require("./test-tree-expect");
18
- const feature_1 = require("../features/sync-data-loader/feature");
19
- const feature_2 = require("../features/async-data-loader/feature");
20
- const build_proxified_instance_1 = require("../core/build-proxified-instance");
21
- vitest_1.vi.useFakeTimers({ shouldAdvanceTime: true });
22
- class TestTree {
23
- forSuits(runSuite) {
24
- vitest_1.describe.for([
25
- this.suits.sync(),
26
- this.suits.async(),
27
- this.suits.proxifiedSync(),
28
- this.suits.proxifiedAsync(),
29
- ])("$title", ({ tree }) => {
30
- tree.resetBeforeEach();
31
- runSuite(tree);
32
- });
33
- }
34
- get instance() {
35
- if (!this.treeInstance) {
36
- this.treeInstance = (0, create_tree_1.createTree)(this.config);
37
- this.treeInstance.rebuildTree();
38
- }
39
- return this.treeInstance;
40
- }
41
- constructor(config) {
42
- this.config = config;
43
- this.do = new test_tree_do_1.TestTreeDo(this);
44
- this.expect = new test_tree_expect_1.TestTreeExpect(this);
45
- this.treeInstance = null;
46
- this.asyncDataLoaderImp = {
47
- getItem: (id) => __awaiter(this, void 0, void 0, function* () {
48
- yield new Promise((r) => {
49
- r.debugName = `Loading getItem ${id}`;
50
- TestTree.asyncLoaderResolvers.push(r);
51
- });
52
- return id;
53
- }),
54
- getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
55
- yield new Promise((r) => {
56
- r.debugName = `Loading getChildren ${id}`;
57
- TestTree.asyncLoaderResolvers.push(r);
58
- });
59
- return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
60
- }),
61
- };
62
- this.suits = {
63
- sync: () => ({
64
- tree: this.withFeatures(feature_1.syncDataLoaderFeature),
65
- title: "Synchronous Data Loader",
66
- }),
67
- async: () => ({
68
- tree: this.withFeatures(feature_2.asyncDataLoaderFeature).with({
69
- dataLoader: this.asyncDataLoaderImp,
70
- }),
71
- title: "Asynchronous Data Loader",
72
- }),
73
- proxifiedSync: () => ({
74
- tree: this.withFeatures(feature_1.syncDataLoaderFeature).with({
75
- instanceBuilder: build_proxified_instance_1.buildProxiedInstance,
76
- }),
77
- title: "Proxified Synchronous Data Loader",
78
- }),
79
- proxifiedAsync: () => ({
80
- tree: this.withFeatures(feature_2.asyncDataLoaderFeature).with({
81
- instanceBuilder: build_proxified_instance_1.buildProxiedInstance,
82
- }),
83
- title: "Proxified Asynchronous Data Loader",
84
- }),
85
- };
86
- }
87
- static resolveAsyncLoaders() {
88
- return __awaiter(this, void 0, void 0, function* () {
89
- var _a;
90
- do {
91
- (_a = TestTree.asyncLoaderResolvers.shift()) === null || _a === void 0 ? void 0 : _a();
92
- yield new Promise((r) => {
93
- setTimeout(r);
94
- });
95
- } while (TestTree.asyncLoaderResolvers.length);
96
- });
97
- }
98
- resolveAsyncVisibleItems() {
99
- return __awaiter(this, void 0, void 0, function* () {
100
- this.instance.getItems();
101
- yield TestTree.resolveAsyncLoaders();
102
- this.instance.getItems().forEach((i) => i.getItemName());
103
- yield TestTree.resolveAsyncLoaders();
104
- });
105
- }
106
- static default(config) {
107
- return new TestTree(Object.assign({ rootItemId: "x", createLoadingItemData: () => "loading", dataLoader: {
108
- getItem: (id) => id,
109
- getChildren: (id) => [`${id}1`, `${id}2`, `${id}3`, `${id}4`],
110
- }, getItemName: (item) => item.getItemData(), indent: 20, isItemFolder: (item) => item.getItemMeta().level < 2, initialState: {
111
- expandedItems: ["x1", "x11"],
112
- }, features: [] }, config));
113
- }
114
- with(config) {
115
- return new TestTree(Object.assign(Object.assign({}, this.config), config));
116
- }
117
- resetBeforeEach() {
118
- (0, vitest_1.beforeEach)(() => __awaiter(this, void 0, void 0, function* () {
119
- yield this.createTestCaseTree();
120
- }));
121
- }
122
- createTestCaseTree() {
123
- return __awaiter(this, void 0, void 0, function* () {
124
- this.reset();
125
- vitest_1.vi.clearAllMocks();
126
- // trigger instance creation
127
- // eslint-disable-next-line @typescript-eslint/no-unused-expressions
128
- this.instance;
129
- yield this.resolveAsyncVisibleItems();
130
- return this;
131
- });
132
- }
133
- withFeatures(...features) {
134
- var _a;
135
- return this.with({
136
- features: [...((_a = this.config.features) !== null && _a !== void 0 ? _a : []), ...features],
137
- });
138
- }
139
- mockedHandler(handlerName) {
140
- var _a;
141
- const mock = vitest_1.vi.fn();
142
- if (this.treeInstance) {
143
- (_a = this.treeInstance) === null || _a === void 0 ? void 0 : _a.setConfig((prev) => (Object.assign(Object.assign({}, prev), { [handlerName]: mock })));
144
- }
145
- else {
146
- this.config[handlerName] = mock;
147
- }
148
- return mock;
149
- }
150
- item(itemId) {
151
- return this.instance.getItemInstance(itemId);
152
- }
153
- reset() {
154
- this.treeInstance = null;
155
- TestTree.asyncLoaderResolvers = [];
156
- }
157
- debug() {
158
- console.log(this.instance
159
- .getItems()
160
- .map((item) => [
161
- " ".repeat(item.getItemMeta().level),
162
- '"',
163
- item.getItemName(),
164
- '"',
165
- ].join(""))
166
- .join("\n"));
167
- }
168
- setElementBoundingBox(itemId, bb = {
169
- left: 0,
170
- width: 100,
171
- top: 0,
172
- height: 20,
173
- }) {
174
- this.instance.registerElement({
175
- getBoundingClientRect: () => ({
176
- left: 0,
177
- width: 100,
178
- top: 0,
179
- height: 10000,
180
- }),
181
- });
182
- this.instance.getItemInstance(itemId).registerElement({
183
- getBoundingClientRect: () => bb,
184
- });
185
- }
186
- static dragEvent(clientX = 1000, clientY = 0) {
187
- return {
188
- preventDefault: vitest_1.vi.fn(),
189
- stopPropagation: vitest_1.vi.fn(),
190
- dataTransfer: {
191
- setData: vitest_1.vi.fn(),
192
- getData: vitest_1.vi.fn(),
193
- dropEffect: "unchaged-from-test",
194
- },
195
- clientX,
196
- clientY,
197
- };
198
- }
199
- createTopDragEvent(indent = 0) {
200
- return TestTree.dragEvent(indent * 20, 1);
201
- }
202
- createBottomDragEvent(indent = 0) {
203
- return TestTree.dragEvent(indent * 20, 19);
204
- }
205
- }
206
- exports.TestTree = TestTree;
207
- TestTree.asyncLoaderResolvers = [];
@@ -1,83 +0,0 @@
1
- import { DragAndDropFeatureDef } from "../features/drag-and-drop/types";
2
- import { MainFeatureDef } from "../features/main/types";
3
- import { SelectionFeatureDef } from "../features/selection/types";
4
- import { TreeFeatureDef } from "../features/tree/types";
5
- import { HotkeyConfig, HotkeysCoreFeatureDef } from "../features/hotkeys-core/types";
6
- import { SyncDataLoaderFeatureDef } from "../features/sync-data-loader/types";
7
- import { AsyncDataLoaderFeatureDef } from "../features/async-data-loader/types";
8
- import { SearchFeatureDef } from "../features/search/types";
9
- import { RenamingFeatureDef } from "../features/renaming/types";
10
- import { ExpandAllFeatureDef } from "../features/expand-all/types";
11
- import { PropMemoizationFeatureDef } from "../features/prop-memoization/types";
12
- import { KeyboardDragAndDropFeatureDef } from "../features/keyboard-drag-and-drop/types";
13
- export type Updater<T> = T | ((old: T) => T);
14
- export type SetStateFn<T> = (updaterOrValue: Updater<T>) => void;
15
- export type FeatureDef = {
16
- state: any;
17
- config: any;
18
- treeInstance: any;
19
- itemInstance: any;
20
- hotkeys: string;
21
- };
22
- export type EmptyFeatureDef = {
23
- state: {};
24
- config: {};
25
- treeInstance: {};
26
- itemInstance: {};
27
- hotkeys: never;
28
- };
29
- type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
30
- type MergedFeatures<F extends FeatureDef> = {
31
- state: UnionToIntersection<F["state"]>;
32
- config: UnionToIntersection<F["config"]>;
33
- treeInstance: UnionToIntersection<F["treeInstance"]>;
34
- itemInstance: UnionToIntersection<F["itemInstance"]>;
35
- hotkeys: F["hotkeys"];
36
- };
37
- export type RegisteredFeatures<T> = MainFeatureDef<T> | TreeFeatureDef<T> | SelectionFeatureDef<T> | DragAndDropFeatureDef<T> | KeyboardDragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef | PropMemoizationFeatureDef;
38
- type TreeStateType<T> = MergedFeatures<RegisteredFeatures<T>>["state"];
39
- export interface TreeState<T> extends TreeStateType<T> {
40
- }
41
- type TreeConfigType<T> = MergedFeatures<RegisteredFeatures<T>>["config"];
42
- export interface TreeConfig<T> extends TreeConfigType<T> {
43
- }
44
- type TreeInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["treeInstance"];
45
- export interface TreeInstance<T> extends TreeInstanceType<T> {
46
- }
47
- type ItemInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["itemInstance"];
48
- export interface ItemInstance<T> extends ItemInstanceType<T> {
49
- }
50
- export type HotkeyName = MergedFeatures<RegisteredFeatures<any>>["hotkeys"];
51
- export type HotkeysConfig<T> = Record<HotkeyName, HotkeyConfig<T>>;
52
- export type CustomHotkeysConfig<T> = Partial<Record<HotkeyName | `custom${string}`, Partial<HotkeyConfig<T>>>>;
53
- type MayReturnNull<T extends (...x: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | null;
54
- export type ItemInstanceOpts<Key extends keyof ItemInstance<any>> = {
55
- item: ItemInstance<any>;
56
- tree: TreeInstance<any>;
57
- itemId: string;
58
- prev?: MayReturnNull<ItemInstance<any>[Key]>;
59
- };
60
- export type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
61
- tree: TreeInstance<any>;
62
- prev?: MayReturnNull<TreeInstance<any>[Key]>;
63
- };
64
- export type FeatureImplementation<T = any> = {
65
- key?: string;
66
- deps?: string[];
67
- overwrites?: string[];
68
- stateHandlerNames?: Partial<Record<keyof TreeState<T>, keyof TreeConfig<T>>>;
69
- getInitialState?: (initialState: Partial<TreeState<T>>, tree: TreeInstance<T>) => Partial<TreeState<T>>;
70
- getDefaultConfig?: (defaultConfig: Partial<TreeConfig<T>>, tree: TreeInstance<T>) => Partial<TreeConfig<T>>;
71
- treeInstance?: {
72
- [key in keyof TreeInstance<T>]?: (opts: TreeInstanceOpts<key>, ...args: Parameters<TreeInstance<T>[key]>) => void;
73
- };
74
- itemInstance?: {
75
- [key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
76
- };
77
- onTreeMount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
78
- onTreeUnmount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
79
- onItemMount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
80
- onItemUnmount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
81
- hotkeys?: Partial<HotkeysConfig<T>>;
82
- };
83
- export {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- type TAllKeys<T> = T extends any ? keyof T : never;
2
- type TIndexValue<T, K extends PropertyKey, D = never> = T extends any ? K extends keyof T ? T[K] : D : never;
3
- type TPartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>> extends infer O ? {
4
- [P in keyof O]: O[P];
5
- } : never;
6
- type TFunction = (...a: any[]) => any;
7
- type TPrimitives = string | number | boolean | bigint | symbol | Date | TFunction;
8
- export type TMerged<T> = [T] extends [Array<any>] ? {
9
- [K in keyof T]: TMerged<T[K]>;
10
- } : [T] extends [TPrimitives] ? T : [T] extends [object] ? TPartialKeys<{
11
- [K in TAllKeys<T>]: TMerged<TIndexValue<T, K>>;
12
- }, never> : T;
13
- export {};
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,3 +0,0 @@
1
- import { ItemInstance } from "../types/core";
2
- import { DragTarget } from "../features/drag-and-drop/types";
3
- export declare const createOnDropHandler: <T>(onChangeChildren: (item: ItemInstance<T>, newChildren: string[]) => void) => (items: ItemInstance<T>[], target: DragTarget<T>) => Promise<void>;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.createOnDropHandler = void 0;
13
- const remove_items_from_parents_1 = require("./remove-items-from-parents");
14
- const insert_items_at_target_1 = require("./insert-items-at-target");
15
- const createOnDropHandler = (onChangeChildren) => (items, target) => __awaiter(void 0, void 0, void 0, function* () {
16
- const itemIds = items.map((item) => item.getId());
17
- yield (0, remove_items_from_parents_1.removeItemsFromParents)(items, onChangeChildren);
18
- yield (0, insert_items_at_target_1.insertItemsAtTarget)(itemIds, target, onChangeChildren);
19
- });
20
- exports.createOnDropHandler = createOnDropHandler;
@@ -1,2 +0,0 @@
1
- export declare const throwError: (message: string) => Error;
2
- export declare const logWarning: (message: string) => void;
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.logWarning = exports.throwError = void 0;
4
- const prefix = "Headless Tree: ";
5
- const throwError = (message) => Error(prefix + message);
6
- exports.throwError = throwError;
7
- // eslint-disable-next-line no-console
8
- const logWarning = (message) => console.warn(prefix + message);
9
- exports.logWarning = logWarning;
@@ -1,3 +0,0 @@
1
- import { ItemInstance } from "../types/core";
2
- import { DragTarget } from "../features/drag-and-drop/types";
3
- export declare const insertItemsAtTarget: <T>(itemIds: string[], target: DragTarget<T>, onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => Promise<void> | void) => Promise<void>;
@@ -1,40 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.insertItemsAtTarget = void 0;
13
- const insertItemsAtTarget = (itemIds, target, onChangeChildren) => __awaiter(void 0, void 0, void 0, function* () {
14
- yield target.item.getTree().waitForItemChildrenLoaded(target.item.getId());
15
- const oldChildrenIds = target.item
16
- .getTree()
17
- .retrieveChildrenIds(target.item.getId());
18
- // add moved items to new common parent, if dropped onto parent
19
- if (!("childIndex" in target)) {
20
- const newChildren = [...oldChildrenIds, ...itemIds];
21
- yield onChangeChildren(target.item, newChildren);
22
- if (target.item && "updateCachedChildrenIds" in target.item) {
23
- target.item.updateCachedChildrenIds(newChildren);
24
- }
25
- target.item.getTree().rebuildTree();
26
- return;
27
- }
28
- // add moved items to new common parent, if dropped between siblings
29
- const newChildren = [
30
- ...oldChildrenIds.slice(0, target.insertionIndex),
31
- ...itemIds,
32
- ...oldChildrenIds.slice(target.insertionIndex),
33
- ];
34
- yield onChangeChildren(target.item, newChildren);
35
- if (target.item && "updateCachedChildrenIds" in target.item) {
36
- target.item.updateCachedChildrenIds(newChildren);
37
- }
38
- target.item.getTree().rebuildTree();
39
- });
40
- exports.insertItemsAtTarget = insertItemsAtTarget;
@@ -1,2 +0,0 @@
1
- import { ItemInstance } from "../types/core";
2
- export declare const removeItemsFromParents: <T>(movedItems: ItemInstance<T>[], onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => void | Promise<void>) => Promise<void>;