@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.
Files changed (148) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/lib/cjs/core/build-proxified-instance.d.ts +2 -0
  3. package/lib/cjs/core/build-proxified-instance.js +58 -0
  4. package/lib/cjs/core/build-static-instance.d.ts +2 -0
  5. package/lib/cjs/core/build-static-instance.js +26 -0
  6. package/lib/cjs/core/create-tree.js +62 -40
  7. package/lib/cjs/features/async-data-loader/feature.d.ts +1 -4
  8. package/lib/cjs/features/async-data-loader/feature.js +35 -23
  9. package/lib/cjs/features/async-data-loader/types.d.ts +4 -6
  10. package/lib/cjs/features/drag-and-drop/feature.d.ts +2 -3
  11. package/lib/cjs/features/drag-and-drop/feature.js +79 -44
  12. package/lib/cjs/features/drag-and-drop/types.d.ts +15 -6
  13. package/lib/cjs/features/drag-and-drop/utils.d.ts +2 -3
  14. package/lib/cjs/features/drag-and-drop/utils.js +140 -37
  15. package/lib/cjs/features/expand-all/feature.d.ts +1 -5
  16. package/lib/cjs/features/expand-all/feature.js +12 -6
  17. package/lib/cjs/features/hotkeys-core/feature.d.ts +1 -3
  18. package/lib/cjs/features/main/types.d.ts +8 -2
  19. package/lib/cjs/features/prop-memoization/feature.d.ts +2 -0
  20. package/lib/cjs/features/prop-memoization/feature.js +48 -0
  21. package/lib/cjs/features/prop-memoization/types.d.ts +10 -0
  22. package/lib/cjs/features/prop-memoization/types.js +2 -0
  23. package/lib/cjs/features/renaming/feature.d.ts +1 -4
  24. package/lib/cjs/features/renaming/feature.js +36 -22
  25. package/lib/cjs/features/renaming/types.d.ts +2 -2
  26. package/lib/cjs/features/search/feature.d.ts +1 -4
  27. package/lib/cjs/features/search/feature.js +38 -24
  28. package/lib/cjs/features/search/types.d.ts +0 -1
  29. package/lib/cjs/features/selection/feature.d.ts +1 -4
  30. package/lib/cjs/features/selection/feature.js +54 -35
  31. package/lib/cjs/features/selection/types.d.ts +1 -1
  32. package/lib/cjs/features/sync-data-loader/feature.d.ts +1 -3
  33. package/lib/cjs/features/sync-data-loader/feature.js +7 -2
  34. package/lib/cjs/features/tree/feature.d.ts +1 -5
  35. package/lib/cjs/features/tree/feature.js +97 -92
  36. package/lib/cjs/features/tree/types.d.ts +5 -8
  37. package/lib/cjs/index.d.ts +5 -1
  38. package/lib/cjs/index.js +4 -1
  39. package/lib/cjs/mddocs-entry.d.ts +10 -0
  40. package/lib/cjs/test-utils/test-tree-do.d.ts +23 -0
  41. package/lib/cjs/test-utils/test-tree-do.js +99 -0
  42. package/lib/cjs/test-utils/test-tree-expect.d.ts +15 -0
  43. package/lib/cjs/test-utils/test-tree-expect.js +62 -0
  44. package/lib/cjs/test-utils/test-tree.d.ts +47 -0
  45. package/lib/cjs/test-utils/test-tree.js +203 -0
  46. package/lib/cjs/types/core.d.ts +39 -24
  47. package/lib/cjs/utilities/errors.d.ts +1 -0
  48. package/lib/cjs/utilities/errors.js +5 -0
  49. package/lib/cjs/utilities/insert-items-at-target.js +10 -3
  50. package/lib/cjs/utilities/remove-items-from-parents.js +14 -8
  51. package/lib/cjs/utils.d.ts +3 -3
  52. package/lib/cjs/utils.js +6 -6
  53. package/lib/esm/core/build-proxified-instance.d.ts +2 -0
  54. package/lib/esm/core/build-proxified-instance.js +54 -0
  55. package/lib/esm/core/build-static-instance.d.ts +2 -0
  56. package/lib/esm/core/build-static-instance.js +22 -0
  57. package/lib/esm/core/create-tree.js +62 -40
  58. package/lib/esm/features/async-data-loader/feature.d.ts +1 -4
  59. package/lib/esm/features/async-data-loader/feature.js +35 -23
  60. package/lib/esm/features/async-data-loader/types.d.ts +4 -6
  61. package/lib/esm/features/drag-and-drop/feature.d.ts +2 -3
  62. package/lib/esm/features/drag-and-drop/feature.js +79 -44
  63. package/lib/esm/features/drag-and-drop/types.d.ts +15 -6
  64. package/lib/esm/features/drag-and-drop/utils.d.ts +2 -3
  65. package/lib/esm/features/drag-and-drop/utils.js +138 -34
  66. package/lib/esm/features/expand-all/feature.d.ts +1 -5
  67. package/lib/esm/features/expand-all/feature.js +12 -6
  68. package/lib/esm/features/hotkeys-core/feature.d.ts +1 -3
  69. package/lib/esm/features/main/types.d.ts +8 -2
  70. package/lib/esm/features/prop-memoization/feature.d.ts +2 -0
  71. package/lib/esm/features/prop-memoization/feature.js +45 -0
  72. package/lib/esm/features/prop-memoization/types.d.ts +10 -0
  73. package/lib/esm/features/prop-memoization/types.js +1 -0
  74. package/lib/esm/features/renaming/feature.d.ts +1 -4
  75. package/lib/esm/features/renaming/feature.js +36 -22
  76. package/lib/esm/features/renaming/types.d.ts +2 -2
  77. package/lib/esm/features/search/feature.d.ts +1 -4
  78. package/lib/esm/features/search/feature.js +38 -24
  79. package/lib/esm/features/search/types.d.ts +0 -1
  80. package/lib/esm/features/selection/feature.d.ts +1 -4
  81. package/lib/esm/features/selection/feature.js +54 -35
  82. package/lib/esm/features/selection/types.d.ts +1 -1
  83. package/lib/esm/features/sync-data-loader/feature.d.ts +1 -3
  84. package/lib/esm/features/sync-data-loader/feature.js +7 -2
  85. package/lib/esm/features/tree/feature.d.ts +1 -5
  86. package/lib/esm/features/tree/feature.js +98 -93
  87. package/lib/esm/features/tree/types.d.ts +5 -8
  88. package/lib/esm/index.d.ts +5 -1
  89. package/lib/esm/index.js +4 -1
  90. package/lib/esm/mddocs-entry.d.ts +10 -0
  91. package/lib/esm/test-utils/test-tree-do.d.ts +23 -0
  92. package/lib/esm/test-utils/test-tree-do.js +95 -0
  93. package/lib/esm/test-utils/test-tree-expect.d.ts +15 -0
  94. package/lib/esm/test-utils/test-tree-expect.js +58 -0
  95. package/lib/esm/test-utils/test-tree.d.ts +47 -0
  96. package/lib/esm/test-utils/test-tree.js +199 -0
  97. package/lib/esm/types/core.d.ts +39 -24
  98. package/lib/esm/utilities/errors.d.ts +1 -0
  99. package/lib/esm/utilities/errors.js +1 -0
  100. package/lib/esm/utilities/insert-items-at-target.js +10 -3
  101. package/lib/esm/utilities/remove-items-from-parents.js +14 -8
  102. package/lib/esm/utils.d.ts +3 -3
  103. package/lib/esm/utils.js +3 -3
  104. package/package.json +7 -3
  105. package/src/core/build-proxified-instance.ts +117 -0
  106. package/src/core/build-static-instance.ts +27 -0
  107. package/src/core/core.spec.ts +210 -0
  108. package/src/core/create-tree.ts +73 -78
  109. package/src/features/async-data-loader/async-data-loader.spec.ts +124 -0
  110. package/src/features/async-data-loader/feature.ts +34 -44
  111. package/src/features/async-data-loader/types.ts +4 -6
  112. package/src/features/drag-and-drop/drag-and-drop.spec.ts +717 -0
  113. package/src/features/drag-and-drop/feature.ts +88 -63
  114. package/src/features/drag-and-drop/types.ts +24 -10
  115. package/src/features/drag-and-drop/utils.ts +197 -56
  116. package/src/features/expand-all/expand-all.spec.ts +56 -0
  117. package/src/features/expand-all/feature.ts +9 -24
  118. package/src/features/hotkeys-core/feature.ts +5 -14
  119. package/src/features/main/types.ts +14 -1
  120. package/src/features/prop-memoization/feature.ts +51 -0
  121. package/src/features/prop-memoization/prop-memoization.spec.ts +68 -0
  122. package/src/features/prop-memoization/types.ts +11 -0
  123. package/src/features/renaming/feature.ts +37 -45
  124. package/src/features/renaming/renaming.spec.ts +127 -0
  125. package/src/features/renaming/types.ts +2 -2
  126. package/src/features/search/feature.ts +36 -46
  127. package/src/features/search/search.spec.ts +117 -0
  128. package/src/features/search/types.ts +0 -1
  129. package/src/features/selection/feature.ts +50 -53
  130. package/src/features/selection/selection.spec.ts +219 -0
  131. package/src/features/selection/types.ts +0 -2
  132. package/src/features/sync-data-loader/feature.ts +9 -18
  133. package/src/features/tree/feature.ts +101 -144
  134. package/src/features/tree/tree.spec.ts +475 -0
  135. package/src/features/tree/types.ts +5 -9
  136. package/src/index.ts +6 -1
  137. package/src/mddocs-entry.ts +13 -0
  138. package/src/test-utils/test-tree-do.ts +136 -0
  139. package/src/test-utils/test-tree-expect.ts +86 -0
  140. package/src/test-utils/test-tree.ts +227 -0
  141. package/src/types/core.ts +76 -108
  142. package/src/utilities/errors.ts +2 -0
  143. package/src/utilities/insert-items-at-target.ts +10 -3
  144. package/src/utilities/remove-items-from-parents.ts +15 -10
  145. package/src/utils.spec.ts +89 -0
  146. package/src/utils.ts +6 -6
  147. package/tsconfig.json +1 -0
  148. package/vitest.config.ts +6 -0
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TestTreeDo = void 0;
4
+ const vitest_1 = require("vitest");
5
+ const test_tree_1 = require("./test-tree");
6
+ class TestTreeDo {
7
+ itemInstance(itemId) {
8
+ return this.tree.instance.getItemInstance(itemId);
9
+ }
10
+ itemProps(itemId) {
11
+ return this.itemInstance(itemId).getProps();
12
+ }
13
+ constructor(tree) {
14
+ this.tree = tree;
15
+ }
16
+ selectItem(id) {
17
+ this.itemProps(id).onClick({});
18
+ }
19
+ shiftSelectItem(id) {
20
+ this.itemProps(id).onClick({ shiftKey: true });
21
+ }
22
+ ctrlSelectItem(id) {
23
+ this.itemProps(id).onClick({ ctrlKey: true });
24
+ }
25
+ ctrlShiftSelectItem(id) {
26
+ this.itemProps(id).onClick({ shiftKey: true, ctrlKey: true });
27
+ }
28
+ selectMultiple(...ids) {
29
+ ids.forEach((id) => this.ctrlSelectItem(id));
30
+ }
31
+ hotkey(hotkey, e = {}) {
32
+ var _a, _b;
33
+ 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]);
34
+ if (hotkeyConfig.isEnabled &&
35
+ !((_b = hotkeyConfig.isEnabled) === null || _b === void 0 ? void 0 : _b.call(hotkeyConfig, this.tree.instance))) {
36
+ throw new Error(`Hotkey "${hotkey}" is disabled`);
37
+ }
38
+ if (!hotkeyConfig.handler) {
39
+ throw new Error(`Hotkey "${hotkey}" has no handler`);
40
+ }
41
+ hotkeyConfig.handler(Object.assign(Object.assign({}, e), { stopPropagation: () => { }, preventDefault: () => { } }), this.tree.instance);
42
+ }
43
+ startDrag(itemId, event) {
44
+ if (!this.itemProps(itemId).draggable) {
45
+ throw new Error(`Can't drag item ${itemId}, has attribute draggable=false`);
46
+ }
47
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
48
+ this.itemProps(itemId).onDragStart(e);
49
+ return e;
50
+ }
51
+ dragOver(itemId, event) {
52
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
53
+ e.preventDefault.mockClear();
54
+ this.itemProps(itemId).onDragOver(e);
55
+ this.itemProps(itemId).onDragOver(e);
56
+ this.itemProps(itemId).onDragOver(e);
57
+ (0, vitest_1.expect)(e.preventDefault).toBeCalledTimes(3);
58
+ this.consistentCalls(e.preventDefault);
59
+ this.consistentCalls(e.stopPropagation);
60
+ return e;
61
+ }
62
+ dragOverNotAllowed(itemId, event) {
63
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
64
+ e.preventDefault.mockClear();
65
+ this.itemProps(itemId).onDragOver(e);
66
+ this.itemProps(itemId).onDragOver(e);
67
+ this.itemProps(itemId).onDragOver(e);
68
+ (0, vitest_1.expect)(e.preventDefault).toBeCalledTimes(0);
69
+ this.consistentCalls(e.preventDefault);
70
+ this.consistentCalls(e.stopPropagation);
71
+ return e;
72
+ }
73
+ dragLeave(itemId) {
74
+ this.itemProps(itemId).onDragLeave({});
75
+ }
76
+ dragEnd(itemId, event) {
77
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
78
+ this.itemProps(itemId).onDragEnd(e);
79
+ return e;
80
+ }
81
+ drop(itemId, event) {
82
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
83
+ this.itemProps(itemId).onDrop(e);
84
+ return e;
85
+ }
86
+ dragOverAndDrop(itemId, event) {
87
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
88
+ this.dragOver(itemId, e);
89
+ return this.drop(itemId, e);
90
+ }
91
+ consistentCalls(fn) {
92
+ if (!vitest_1.vi.isMockFunction(fn)) {
93
+ throw new Error("fn is not a mock");
94
+ }
95
+ (0, vitest_1.expect)(fn.mock.calls.length, "function called inconsistent times").toBeOneOf([0, 3]);
96
+ (0, vitest_1.expect)(new Set(fn.mock.calls.map((call) => call.join("__"))).size, "function called with inconsistent parameters").toBeOneOf([0, 1]);
97
+ }
98
+ }
99
+ exports.TestTreeDo = TestTreeDo;
@@ -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,62 @@
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
+ dropped(draggedItems, target) {
33
+ (0, vitest_1.expect)(this.tree.instance.getConfig().onDrop).toBeCalledWith(draggedItems.map((id) => this.tree.item(id)), target);
34
+ }
35
+ dragOverNotAllowed(itemId, event) {
36
+ const e = event !== null && event !== void 0 ? event : test_tree_1.TestTree.dragEvent();
37
+ e.preventDefault.mockClear();
38
+ this.itemProps(itemId).onDragOver(e);
39
+ this.itemProps(itemId).onDragOver(e);
40
+ this.itemProps(itemId).onDragOver(e);
41
+ (0, vitest_1.expect)(e.preventDefault, "onDragOver shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
42
+ this.itemProps(itemId).onDrop(e);
43
+ (0, vitest_1.expect)(e.preventDefault, "onDrop shouldn't call e.preventDefault if drag is not allowed").not.toBeCalled();
44
+ (0, vitest_1.expect)(this.tree.instance.getConfig().onDrop, "onDrop handler shouldn't be called if drag is not allowed").not.toBeCalled();
45
+ return e;
46
+ }
47
+ defaultDragLineProps(indent = 0) {
48
+ (0, vitest_1.expect)(this.tree.instance.getDragLineData()).toEqual({
49
+ indent,
50
+ left: indent * 20,
51
+ width: 100 - indent * 20,
52
+ top: 0,
53
+ });
54
+ (0, vitest_1.expect)(this.tree.instance.getDragLineStyle(0, 0)).toEqual({
55
+ left: `${indent * 20}px`,
56
+ pointerEvents: "none",
57
+ top: "0px",
58
+ width: `${100 - indent * 20}px`,
59
+ });
60
+ }
61
+ }
62
+ exports.TestTreeExpect = TestTreeExpect;
@@ -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,203 @@
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
+ }
38
+ return this.treeInstance;
39
+ }
40
+ constructor(config) {
41
+ this.config = config;
42
+ this.do = new test_tree_do_1.TestTreeDo(this);
43
+ this.expect = new test_tree_expect_1.TestTreeExpect(this);
44
+ this.treeInstance = null;
45
+ this.suits = {
46
+ sync: () => ({
47
+ tree: this.withFeatures(feature_1.syncDataLoaderFeature),
48
+ title: "Synchronous Data Loader",
49
+ }),
50
+ async: () => ({
51
+ tree: this.withFeatures(feature_2.asyncDataLoaderFeature),
52
+ title: "Asynchronous Data Loader",
53
+ }),
54
+ proxifiedSync: () => ({
55
+ tree: this.withFeatures(feature_1.syncDataLoaderFeature).with({
56
+ instanceBuilder: build_proxified_instance_1.buildProxiedInstance,
57
+ }),
58
+ title: "Proxified Synchronous Data Loader",
59
+ }),
60
+ proxifiedAsync: () => ({
61
+ tree: this.withFeatures(feature_2.asyncDataLoaderFeature).with({
62
+ instanceBuilder: build_proxified_instance_1.buildProxiedInstance,
63
+ }),
64
+ title: "Proxified Asynchronous Data Loader",
65
+ }),
66
+ };
67
+ }
68
+ static resolveAsyncLoaders() {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ var _a;
71
+ while (TestTree.asyncLoaderResolvers.length) {
72
+ (_a = TestTree.asyncLoaderResolvers.shift()) === null || _a === void 0 ? void 0 : _a();
73
+ yield new Promise((r) => {
74
+ setTimeout(r);
75
+ });
76
+ }
77
+ });
78
+ }
79
+ resolveAsyncVisibleItems() {
80
+ return __awaiter(this, void 0, void 0, function* () {
81
+ this.instance.getItems();
82
+ yield TestTree.resolveAsyncLoaders();
83
+ this.instance.getItems().forEach((i) => i.getItemName());
84
+ yield TestTree.resolveAsyncLoaders();
85
+ });
86
+ }
87
+ static default(config) {
88
+ return new TestTree(Object.assign({ rootItemId: "x", createLoadingItemData: () => "loading", dataLoader: {
89
+ getItem: (id) => id,
90
+ getChildren: (id) => [`${id}1`, `${id}2`, `${id}3`, `${id}4`],
91
+ }, asyncDataLoader: {
92
+ getItem: (id) => __awaiter(this, void 0, void 0, function* () {
93
+ yield new Promise((r) => {
94
+ r.debugName = `Loading getItem ${id}`;
95
+ TestTree.asyncLoaderResolvers.push(r);
96
+ });
97
+ return id;
98
+ }),
99
+ getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
100
+ yield new Promise((r) => {
101
+ r.debugName = `Loading getChildren ${id}`;
102
+ TestTree.asyncLoaderResolvers.push(r);
103
+ });
104
+ return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
105
+ }),
106
+ }, getItemName: (item) => item.getItemData(), indent: 20, isItemFolder: (item) => item.getItemMeta().level < 2, initialState: {
107
+ expandedItems: ["x1", "x11"],
108
+ }, features: [] }, config));
109
+ }
110
+ with(config) {
111
+ return new TestTree(Object.assign(Object.assign({}, this.config), config));
112
+ }
113
+ resetBeforeEach() {
114
+ (0, vitest_1.beforeEach)(() => __awaiter(this, void 0, void 0, function* () {
115
+ yield this.createTestCaseTree();
116
+ }));
117
+ }
118
+ createTestCaseTree() {
119
+ return __awaiter(this, void 0, void 0, function* () {
120
+ this.reset();
121
+ vitest_1.vi.clearAllMocks();
122
+ // trigger instance creation
123
+ // eslint-disable-next-line @typescript-eslint/no-unused-expressions
124
+ this.instance;
125
+ yield this.resolveAsyncVisibleItems();
126
+ return this;
127
+ });
128
+ }
129
+ withFeatures(...features) {
130
+ var _a;
131
+ return this.with({
132
+ features: [...((_a = this.config.features) !== null && _a !== void 0 ? _a : []), ...features],
133
+ });
134
+ }
135
+ mockedHandler(handlerName) {
136
+ var _a;
137
+ const mock = vitest_1.vi.fn();
138
+ if (this.treeInstance) {
139
+ (_a = this.treeInstance) === null || _a === void 0 ? void 0 : _a.setConfig((prev) => (Object.assign(Object.assign({}, prev), { [handlerName]: mock })));
140
+ }
141
+ else {
142
+ this.config[handlerName] = mock;
143
+ }
144
+ return mock;
145
+ }
146
+ item(itemId) {
147
+ return this.instance.getItemInstance(itemId);
148
+ }
149
+ reset() {
150
+ this.treeInstance = null;
151
+ TestTree.asyncLoaderResolvers = [];
152
+ }
153
+ debug() {
154
+ console.log(this.instance
155
+ .getItems()
156
+ .map((item) => [
157
+ " ".repeat(item.getItemMeta().level),
158
+ '"',
159
+ item.getItemName(),
160
+ '"',
161
+ ].join(""))
162
+ .join("\n"));
163
+ }
164
+ setElementBoundingBox(itemId, bb = {
165
+ left: 0,
166
+ width: 100,
167
+ top: 0,
168
+ height: 20,
169
+ }) {
170
+ this.instance.registerElement({
171
+ getBoundingClientRect: () => ({
172
+ left: 0,
173
+ width: 100,
174
+ top: 0,
175
+ height: 10000,
176
+ }),
177
+ });
178
+ this.instance.getItemInstance(itemId).registerElement({
179
+ getBoundingClientRect: () => bb,
180
+ });
181
+ }
182
+ static dragEvent(pageX = 1000, pageY = 0) {
183
+ return {
184
+ preventDefault: vitest_1.vi.fn(),
185
+ stopPropagation: vitest_1.vi.fn(),
186
+ dataTransfer: {
187
+ setData: vitest_1.vi.fn(),
188
+ getData: vitest_1.vi.fn(),
189
+ dropEffect: "unchaged-from-test",
190
+ },
191
+ pageX,
192
+ pageY,
193
+ };
194
+ }
195
+ createTopDragEvent(indent = 0) {
196
+ return TestTree.dragEvent(indent * 20, 1);
197
+ }
198
+ createBottomDragEvent(indent = 0) {
199
+ return TestTree.dragEvent(indent * 20, 19);
200
+ }
201
+ }
202
+ exports.TestTree = TestTree;
203
+ TestTree.asyncLoaderResolvers = [];
@@ -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: object;
15
- config: object;
16
- treeInstance: object;
17
- itemInstance: object;
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 TreeStateType<T> = MainFeatureDef["state"] & TreeFeatureDef<T>["state"] & SelectionFeatureDef<T>["state"] & DragAndDropFeatureDef<T>["state"] & HotkeysCoreFeatureDef<T>["state"] & SyncDataLoaderFeatureDef<T>["state"] & AsyncDataLoaderFeatureDef<T>["state"] & SearchFeatureDef<T>["state"] & RenamingFeatureDef<T>["state"] & ExpandAllFeatureDef["state"];
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> = MainFeatureDef["config"] & TreeFeatureDef<T>["config"] & SelectionFeatureDef<T>["config"] & DragAndDropFeatureDef<T>["config"] & HotkeysCoreFeatureDef<T>["config"] & SyncDataLoaderFeatureDef<T>["config"] & AsyncDataLoaderFeatureDef<T>["config"] & SearchFeatureDef<T>["config"] & RenamingFeatureDef<T>["config"] & ExpandAllFeatureDef["config"];
40
+ type TreeConfigType<T> = MergedFeatures<RegisteredFeatures<T>>["config"];
41
41
  export interface TreeConfig<T> extends TreeConfigType<T> {
42
42
  }
43
- type TreeInstanceType<T> = MainFeatureDef["treeInstance"] & TreeFeatureDef<T>["treeInstance"] & SelectionFeatureDef<T>["treeInstance"] & DragAndDropFeatureDef<T>["treeInstance"] & HotkeysCoreFeatureDef<T>["treeInstance"] & SyncDataLoaderFeatureDef<T>["treeInstance"] & AsyncDataLoaderFeatureDef<T>["treeInstance"] & SearchFeatureDef<T>["treeInstance"] & RenamingFeatureDef<T>["treeInstance"] & ExpandAllFeatureDef["treeInstance"];
43
+ type TreeInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["treeInstance"];
44
44
  export interface TreeInstance<T> extends TreeInstanceType<T> {
45
45
  }
46
- type ItemInstanceType<T> = MainFeatureDef["itemInstance"] & TreeFeatureDef<T>["itemInstance"] & SelectionFeatureDef<T>["itemInstance"] & DragAndDropFeatureDef<T>["itemInstance"] & HotkeysCoreFeatureDef<T>["itemInstance"] & SyncDataLoaderFeatureDef<T>["itemInstance"] & AsyncDataLoaderFeatureDef<T>["itemInstance"] & SearchFeatureDef<T>["itemInstance"] & RenamingFeatureDef<T>["itemInstance"] & ExpandAllFeatureDef["itemInstance"];
46
+ type ItemInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["itemInstance"];
47
47
  export interface ItemInstance<T> extends ItemInstanceType<T> {
48
48
  }
49
- export type HotkeyName<F extends FeatureDef = FeatureDefs<any>> = MergedFeatures<F>["hotkeys"];
50
- export type HotkeysConfig<T, F extends FeatureDef = FeatureDefs<T>> = Record<HotkeyName<F>, HotkeyConfig<T>>;
51
- export type CustomHotkeysConfig<T, F extends FeatureDef = FeatureDefs<T>> = Partial<Record<HotkeyName<F> | `custom${string}`, Partial<HotkeyConfig<T>>>>;
52
- export type FeatureImplementation<T = any, D extends FeatureDef = any, F extends FeatureDef = EmptyFeatureDef> = {
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 MergedFeatures<F>["state"], keyof MergedFeatures<F>["config"]>>;
57
- getInitialState?: (initialState: Partial<MergedFeatures<F>["state"]>, tree: MergedFeatures<F>["treeInstance"]) => Partial<D["state"] & MergedFeatures<F>["state"]>;
58
- getDefaultConfig?: (defaultConfig: Partial<MergedFeatures<F>["config"]>, tree: MergedFeatures<F>["treeInstance"]) => Partial<D["config"] & MergedFeatures<F>["config"]>;
59
- createTreeInstance?: (prev: MergedFeatures<F>["treeInstance"], instance: MergedFeatures<F>["treeInstance"]) => D["treeInstance"] & MergedFeatures<F>["treeInstance"];
60
- createItemInstance?: (prev: MergedFeatures<F>["itemInstance"], item: MergedFeatures<F>["itemInstance"], tree: MergedFeatures<F>["treeInstance"], itemId: string) => D["itemInstance"] & MergedFeatures<F>["itemInstance"];
61
- onTreeMount?: (instance: MergedFeatures<F>["treeInstance"], treeElement: HTMLElement) => void;
62
- onTreeUnmount?: (instance: MergedFeatures<F>["treeInstance"], treeElement: HTMLElement) => void;
63
- onItemMount?: (instance: MergedFeatures<F>["itemInstance"], itemElement: HTMLElement, tree: MergedFeatures<F>["treeInstance"]) => void;
64
- onItemUnmount?: (instance: MergedFeatures<F>["itemInstance"], itemElement: HTMLElement, tree: MergedFeatures<F>["treeInstance"]) => void;
65
- hotkeys?: HotkeysConfig<T, D>;
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,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.throwError = void 0;
4
+ const throwError = (message) => Error(`Headless Tree: ${message}`);
5
+ exports.throwError = throwError;
@@ -4,11 +4,15 @@ exports.insertItemsAtTarget = void 0;
4
4
  const insertItemsAtTarget = (itemIds, target, onChangeChildren) => {
5
5
  // add moved items to new common parent, if dropped onto parent
6
6
  if (target.childIndex === null) {
7
- onChangeChildren(target.item, [
7
+ const newChildren = [
8
8
  ...target.item.getChildren().map((item) => item.getId()),
9
9
  ...itemIds,
10
- ]);
11
- // TODO items[0].getTree().rebuildTree();
10
+ ];
11
+ onChangeChildren(target.item, newChildren);
12
+ if (target.item && "updateCachedChildrenIds" in target.item) {
13
+ target.item.updateCachedChildrenIds(newChildren);
14
+ }
15
+ target.item.getTree().rebuildTree();
12
16
  return;
13
17
  }
14
18
  // add moved items to new common parent, if dropped between siblings
@@ -19,6 +23,9 @@ const insertItemsAtTarget = (itemIds, target, onChangeChildren) => {
19
23
  ...oldChildren.slice(target.insertionIndex).map((item) => item.getId()),
20
24
  ];
21
25
  onChangeChildren(target.item, newChildren);
26
+ if (target.item && "updateCachedChildrenIds" in target.item) {
27
+ target.item.updateCachedChildrenIds(newChildren);
28
+ }
22
29
  target.item.getTree().rebuildTree();
23
30
  };
24
31
  exports.insertItemsAtTarget = insertItemsAtTarget;
@@ -2,14 +2,20 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.removeItemsFromParents = void 0;
4
4
  const removeItemsFromParents = (movedItems, onChangeChildren) => {
5
- var _a;
6
- // TODO bulk sibling changes together
7
- for (const item of movedItems) {
8
- const siblings = (_a = item.getParent()) === null || _a === void 0 ? void 0 : _a.getChildren();
9
- if (siblings) {
10
- onChangeChildren(item.getParent(), siblings
11
- .filter((sibling) => sibling.getId() !== item.getId())
12
- .map((i) => i.getId()));
5
+ const movedItemsIds = movedItems.map((item) => item.getId());
6
+ const uniqueParents = [
7
+ ...new Set(movedItems.map((item) => item.getParent())),
8
+ ];
9
+ for (const parent of uniqueParents) {
10
+ const siblings = parent === null || parent === void 0 ? void 0 : parent.getChildren();
11
+ if (siblings && parent) {
12
+ const newChildren = siblings
13
+ .filter((sibling) => !movedItemsIds.includes(sibling.getId()))
14
+ .map((i) => i.getId());
15
+ onChangeChildren(parent, newChildren);
16
+ if (parent && "updateCachedChildrenIds" in parent) {
17
+ parent === null || parent === void 0 ? void 0 : parent.updateCachedChildrenIds(newChildren);
18
+ }
13
19
  }
14
20
  }
15
21
  movedItems[0].getTree().rebuildTree();
@@ -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>(fn: (...args_0: D) => R, deps: () => [...D]) => () => 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): (updater: Updater<TreeState<any>[K]>) => void;
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/cjs/utils.js CHANGED
@@ -1,11 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.poll = exports.makeStateUpdater = exports.functionalUpdate = exports.memo = void 0;
4
- const memo = (fn, deps) => {
3
+ exports.poll = exports.memo = void 0;
4
+ exports.functionalUpdate = functionalUpdate;
5
+ exports.makeStateUpdater = makeStateUpdater;
6
+ const memo = (deps, fn) => {
5
7
  let value;
6
8
  let oldDeps = null;
7
- return () => {
8
- const newDeps = deps();
9
+ return (...a) => {
10
+ const newDeps = deps(...a);
9
11
  if (!value) {
10
12
  value = fn(...newDeps);
11
13
  oldDeps = newDeps;
@@ -28,7 +30,6 @@ function functionalUpdate(updater, input) {
28
30
  ? updater(input)
29
31
  : updater;
30
32
  }
31
- exports.functionalUpdate = functionalUpdate;
32
33
  function makeStateUpdater(key, instance) {
33
34
  return (updater) => {
34
35
  instance.setState((old) => {
@@ -36,7 +37,6 @@ function makeStateUpdater(key, instance) {
36
37
  });
37
38
  };
38
39
  }
39
- exports.makeStateUpdater = makeStateUpdater;
40
40
  const poll = (fn, interval = 100, timeout = 1000) => new Promise((resolve) => {
41
41
  let clear;
42
42
  const i = setInterval(() => {
@@ -0,0 +1,2 @@
1
+ import { InstanceBuilder } from "../features/main/types";
2
+ export declare const buildProxiedInstance: InstanceBuilder;