@headless-tree/core 0.0.10 → 0.0.11

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 (114) hide show
  1. package/CHANGELOG.md +6 -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 +27 -0
  6. package/lib/cjs/core/create-tree.js +55 -36
  7. package/lib/cjs/features/async-data-loader/feature.js +37 -23
  8. package/lib/cjs/features/async-data-loader/types.d.ts +2 -1
  9. package/lib/cjs/features/drag-and-drop/feature.js +64 -32
  10. package/lib/cjs/features/drag-and-drop/types.d.ts +13 -4
  11. package/lib/cjs/features/drag-and-drop/utils.d.ts +1 -2
  12. package/lib/cjs/features/drag-and-drop/utils.js +140 -37
  13. package/lib/cjs/features/expand-all/feature.js +12 -6
  14. package/lib/cjs/features/main/types.d.ts +8 -2
  15. package/lib/cjs/features/renaming/feature.js +33 -18
  16. package/lib/cjs/features/renaming/types.d.ts +1 -1
  17. package/lib/cjs/features/search/feature.js +38 -24
  18. package/lib/cjs/features/search/types.d.ts +0 -1
  19. package/lib/cjs/features/selection/feature.js +23 -14
  20. package/lib/cjs/features/sync-data-loader/feature.js +7 -2
  21. package/lib/cjs/features/tree/feature.d.ts +2 -1
  22. package/lib/cjs/features/tree/feature.js +85 -63
  23. package/lib/cjs/features/tree/types.d.ts +5 -3
  24. package/lib/cjs/index.d.ts +3 -1
  25. package/lib/cjs/index.js +2 -1
  26. package/lib/cjs/test-utils/test-tree-do.d.ts +23 -0
  27. package/lib/cjs/test-utils/test-tree-do.js +99 -0
  28. package/lib/cjs/test-utils/test-tree-expect.d.ts +15 -0
  29. package/lib/cjs/test-utils/test-tree-expect.js +62 -0
  30. package/lib/cjs/test-utils/test-tree.d.ts +47 -0
  31. package/lib/cjs/test-utils/test-tree.js +195 -0
  32. package/lib/cjs/types/core.d.ts +31 -15
  33. package/lib/cjs/utilities/errors.d.ts +1 -0
  34. package/lib/cjs/utilities/errors.js +5 -0
  35. package/lib/cjs/utilities/insert-items-at-target.js +10 -3
  36. package/lib/cjs/utilities/remove-items-from-parents.js +14 -8
  37. package/lib/cjs/utils.d.ts +3 -3
  38. package/lib/cjs/utils.js +6 -6
  39. package/lib/esm/core/build-proxified-instance.d.ts +2 -0
  40. package/lib/esm/core/build-proxified-instance.js +54 -0
  41. package/lib/esm/core/build-static-instance.d.ts +2 -0
  42. package/lib/esm/core/build-static-instance.js +23 -0
  43. package/lib/esm/core/create-tree.js +55 -36
  44. package/lib/esm/features/async-data-loader/feature.js +37 -23
  45. package/lib/esm/features/async-data-loader/types.d.ts +2 -1
  46. package/lib/esm/features/drag-and-drop/feature.js +64 -32
  47. package/lib/esm/features/drag-and-drop/types.d.ts +13 -4
  48. package/lib/esm/features/drag-and-drop/utils.d.ts +1 -2
  49. package/lib/esm/features/drag-and-drop/utils.js +138 -34
  50. package/lib/esm/features/expand-all/feature.js +12 -6
  51. package/lib/esm/features/main/types.d.ts +8 -2
  52. package/lib/esm/features/renaming/feature.js +33 -18
  53. package/lib/esm/features/renaming/types.d.ts +1 -1
  54. package/lib/esm/features/search/feature.js +38 -24
  55. package/lib/esm/features/search/types.d.ts +0 -1
  56. package/lib/esm/features/selection/feature.js +23 -14
  57. package/lib/esm/features/sync-data-loader/feature.js +7 -2
  58. package/lib/esm/features/tree/feature.d.ts +2 -1
  59. package/lib/esm/features/tree/feature.js +86 -64
  60. package/lib/esm/features/tree/types.d.ts +5 -3
  61. package/lib/esm/index.d.ts +3 -1
  62. package/lib/esm/index.js +2 -1
  63. package/lib/esm/test-utils/test-tree-do.d.ts +23 -0
  64. package/lib/esm/test-utils/test-tree-do.js +95 -0
  65. package/lib/esm/test-utils/test-tree-expect.d.ts +15 -0
  66. package/lib/esm/test-utils/test-tree-expect.js +58 -0
  67. package/lib/esm/test-utils/test-tree.d.ts +47 -0
  68. package/lib/esm/test-utils/test-tree.js +191 -0
  69. package/lib/esm/types/core.d.ts +31 -15
  70. package/lib/esm/utilities/errors.d.ts +1 -0
  71. package/lib/esm/utilities/errors.js +1 -0
  72. package/lib/esm/utilities/insert-items-at-target.js +10 -3
  73. package/lib/esm/utilities/remove-items-from-parents.js +14 -8
  74. package/lib/esm/utils.d.ts +3 -3
  75. package/lib/esm/utils.js +3 -3
  76. package/package.json +7 -3
  77. package/src/core/build-proxified-instance.ts +115 -0
  78. package/src/core/build-static-instance.ts +28 -0
  79. package/src/core/create-tree.ts +60 -62
  80. package/src/features/async-data-loader/async-data-loader.spec.ts +143 -0
  81. package/src/features/async-data-loader/feature.ts +33 -31
  82. package/src/features/async-data-loader/types.ts +3 -1
  83. package/src/features/drag-and-drop/drag-and-drop.spec.ts +716 -0
  84. package/src/features/drag-and-drop/feature.ts +109 -85
  85. package/src/features/drag-and-drop/types.ts +21 -7
  86. package/src/features/drag-and-drop/utils.ts +196 -55
  87. package/src/features/expand-all/expand-all.spec.ts +52 -0
  88. package/src/features/expand-all/feature.ts +8 -12
  89. package/src/features/hotkeys-core/feature.ts +1 -1
  90. package/src/features/main/types.ts +14 -1
  91. package/src/features/renaming/feature.ts +30 -29
  92. package/src/features/renaming/renaming.spec.ts +125 -0
  93. package/src/features/renaming/types.ts +1 -1
  94. package/src/features/search/feature.ts +34 -38
  95. package/src/features/search/search.spec.ts +115 -0
  96. package/src/features/search/types.ts +0 -1
  97. package/src/features/selection/feature.ts +29 -30
  98. package/src/features/selection/selection.spec.ts +220 -0
  99. package/src/features/sync-data-loader/feature.ts +8 -11
  100. package/src/features/tree/feature.ts +82 -87
  101. package/src/features/tree/tree.spec.ts +515 -0
  102. package/src/features/tree/types.ts +5 -3
  103. package/src/index.ts +4 -1
  104. package/src/test-utils/test-tree-do.ts +136 -0
  105. package/src/test-utils/test-tree-expect.ts +86 -0
  106. package/src/test-utils/test-tree.ts +217 -0
  107. package/src/types/core.ts +92 -33
  108. package/src/utilities/errors.ts +2 -0
  109. package/src/utilities/insert-items-at-target.ts +10 -3
  110. package/src/utilities/remove-items-from-parents.ts +15 -10
  111. package/src/utils.spec.ts +89 -0
  112. package/src/utils.ts +6 -6
  113. package/tsconfig.json +1 -0
  114. package/vitest.config.ts +6 -0
@@ -6,34 +6,49 @@ export const renamingFeature = {
6
6
  renamingItem: "setRenamingItem",
7
7
  renamingValue: "setRenamingValue",
8
8
  },
9
- createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { startRenamingItem: (itemId) => {
10
- const item = instance.getItemInstance(itemId);
9
+ treeInstance: {
10
+ startRenamingItem: ({ tree }, itemId) => {
11
+ const item = tree.getItemInstance(itemId);
11
12
  if (!item.canRename()) {
12
13
  return;
13
14
  }
14
- instance.applySubStateUpdate("renamingItem", itemId);
15
- instance.applySubStateUpdate("renamingValue", item.getItemName());
16
- }, getRenamingItem: () => {
17
- const itemId = instance.getState().renamingItem;
18
- return itemId ? instance.getItemInstance(itemId) : null;
19
- }, getRenamingValue: () => instance.getState().renamingValue || "", abortRenaming: () => {
20
- instance.applySubStateUpdate("renamingItem", null);
21
- }, completeRenaming: () => {
15
+ tree.applySubStateUpdate("renamingItem", itemId);
16
+ tree.applySubStateUpdate("renamingValue", item.getItemName());
17
+ },
18
+ getRenamingItem: ({ tree }) => {
19
+ const itemId = tree.getState().renamingItem;
20
+ return itemId ? tree.getItemInstance(itemId) : null;
21
+ },
22
+ getRenamingValue: ({ tree }) => tree.getState().renamingValue || "",
23
+ abortRenaming: ({ tree }) => {
24
+ tree.applySubStateUpdate("renamingItem", null);
25
+ tree.updateDomFocus();
26
+ },
27
+ completeRenaming: ({ tree }) => {
22
28
  var _a;
23
- const config = instance.getConfig();
24
- const item = instance.getRenamingItem();
29
+ const config = tree.getConfig();
30
+ const item = tree.getRenamingItem();
25
31
  if (item) {
26
- (_a = config.onRename) === null || _a === void 0 ? void 0 : _a.call(config, item, instance.getState().renamingValue || "");
32
+ (_a = config.onRename) === null || _a === void 0 ? void 0 : _a.call(config, item, tree.getState().renamingValue || "");
27
33
  }
28
- instance.applySubStateUpdate("renamingItem", null);
29
- }, isRenamingItem: () => !!instance.getState().renamingItem })),
30
- createItemInstance: (prev, instance, tree) => (Object.assign(Object.assign({}, prev), { getRenameInputProps: () => ({
34
+ tree.applySubStateUpdate("renamingItem", null);
35
+ tree.updateDomFocus();
36
+ },
37
+ isRenamingItem: ({ tree }) => !!tree.getState().renamingItem,
38
+ },
39
+ itemInstance: {
40
+ getRenameInputProps: ({ tree }) => ({
31
41
  onBlur: () => tree.abortRenaming(),
32
42
  value: tree.getRenamingValue(),
33
43
  onChange: (e) => {
34
- tree.applySubStateUpdate("renamingValue", e.target.value);
44
+ var _a;
45
+ // TODO custom type with e.target.value
46
+ tree.applySubStateUpdate("renamingValue", (_a = e.target) === null || _a === void 0 ? void 0 : _a.value);
35
47
  },
36
- }), canRename: () => { var _a, _b, _c; return (_c = (_b = (_a = tree.getConfig()).canRename) === null || _b === void 0 ? void 0 : _b.call(_a, instance)) !== null && _c !== void 0 ? _c : true; }, isRenaming: () => instance.getId() === tree.getState().renamingItem })),
48
+ }),
49
+ canRename: ({ tree, item }) => { var _a, _b, _c; return (_c = (_b = (_a = tree.getConfig()).canRename) === null || _b === void 0 ? void 0 : _b.call(_a, item)) !== null && _c !== void 0 ? _c : true; },
50
+ isRenaming: ({ tree, item }) => item.getId() === tree.getState().renamingItem,
51
+ },
37
52
  hotkeys: {
38
53
  renameItem: {
39
54
  hotkey: "F2",
@@ -5,7 +5,7 @@ export type RenamingFeatureDef<T> = {
5
5
  renamingValue?: string;
6
6
  };
7
7
  config: {
8
- setRenamingItem?: SetStateFn<string | null>;
8
+ setRenamingItem?: SetStateFn<string | null | undefined>;
9
9
  setRenamingValue?: SetStateFn<string | undefined>;
10
10
  canRename?: (item: ItemInstance<T>) => boolean;
11
11
  onRename?: (item: ItemInstance<T>, value: string) => void;
@@ -7,39 +7,53 @@ export const searchFeature = {
7
7
  stateHandlerNames: {
8
8
  search: "setSearch",
9
9
  },
10
- createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { setSearch: (search) => {
10
+ treeInstance: {
11
+ setSearch: ({ tree }, search) => {
11
12
  var _a;
12
- instance.applySubStateUpdate("search", search);
13
- (_a = instance
13
+ tree.applySubStateUpdate("search", search);
14
+ (_a = tree
14
15
  .getItems()
15
- .find((item) => {
16
- var _a, _b;
17
- return (_b = (_a = instance
18
- .getConfig()).isSearchMatchingItem) === null || _b === void 0 ? void 0 : _b.call(_a, instance.getSearchValue(), item);
19
- })) === null || _a === void 0 ? void 0 : _a.setFocused();
20
- }, openSearch: (initialValue = "") => {
21
- instance.setSearch(initialValue);
16
+ .find((item) => { var _a, _b; return (_b = (_a = tree.getConfig()).isSearchMatchingItem) === null || _b === void 0 ? void 0 : _b.call(_a, tree.getSearchValue(), item); })) === null || _a === void 0 ? void 0 : _a.setFocused();
17
+ },
18
+ openSearch: ({ tree }, initialValue = "") => {
19
+ var _a, _b;
20
+ tree.setSearch(initialValue);
21
+ (_b = (_a = tree.getConfig()).onOpenSearch) === null || _b === void 0 ? void 0 : _b.call(_a);
22
22
  setTimeout(() => {
23
23
  var _a;
24
- (_a = instance
25
- .getDataRef()
26
- .current.searchInput) === null || _a === void 0 ? void 0 : _a.focus();
24
+ (_a = tree.getDataRef().current.searchInput) === null || _a === void 0 ? void 0 : _a.focus();
27
25
  });
28
- }, closeSearch: () => {
29
- instance.setSearch(null);
30
- instance.updateDomFocus();
31
- }, isSearchOpen: () => instance.getState().search !== null, getSearchValue: () => instance.getState().search || "", registerSearchInputElement: (element) => {
32
- const dataRef = instance.getDataRef();
26
+ },
27
+ closeSearch: ({ tree }) => {
28
+ var _a, _b;
29
+ tree.setSearch(null);
30
+ (_b = (_a = tree.getConfig()).onCloseSearch) === null || _b === void 0 ? void 0 : _b.call(_a);
31
+ tree.updateDomFocus();
32
+ },
33
+ isSearchOpen: ({ tree }) => tree.getState().search !== null,
34
+ getSearchValue: ({ tree }) => tree.getState().search || "",
35
+ registerSearchInputElement: ({ tree }, element) => {
36
+ const dataRef = tree.getDataRef();
33
37
  dataRef.current.searchInput = element;
34
38
  if (element && dataRef.current.keydownHandler) {
35
39
  element.addEventListener("keydown", dataRef.current.keydownHandler);
36
40
  }
37
- }, getSearchInputElement: () => { var _a; return (_a = instance.getDataRef().current.searchInput) !== null && _a !== void 0 ? _a : null; }, getSearchInputElementProps: () => ({
38
- value: instance.getSearchValue(),
39
- onChange: (e) => instance.setSearch(e.target.value),
40
- onBlur: () => instance.closeSearch(),
41
- }), getSearchMatchingItems: memo((search, items) => items.filter((item) => { var _a, _b; return search && ((_b = (_a = instance.getConfig()).isSearchMatchingItem) === null || _b === void 0 ? void 0 : _b.call(_a, search, item)); }), () => [instance.getSearchValue(), instance.getItems()]) })),
42
- createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { isMatchingSearch: () => tree.getSearchMatchingItems().some((i) => i.getId() === item.getId()) })),
41
+ },
42
+ getSearchInputElement: ({ tree }) => { var _a; return (_a = tree.getDataRef().current.searchInput) !== null && _a !== void 0 ? _a : null; },
43
+ getSearchInputElementProps: ({ tree }) => ({
44
+ value: tree.getSearchValue(),
45
+ onChange: (e) => tree.setSearch(e.target.value),
46
+ onBlur: () => tree.closeSearch(),
47
+ }),
48
+ getSearchMatchingItems: memo(({ tree }) => [
49
+ tree.getSearchValue(),
50
+ tree.getItems(),
51
+ tree.getConfig().isSearchMatchingItem,
52
+ ], (search, items, isSearchMatchingItem) => items.filter((item) => search && (isSearchMatchingItem === null || isSearchMatchingItem === void 0 ? void 0 : isSearchMatchingItem(search, item)))),
53
+ },
54
+ itemInstance: {
55
+ isMatchingSearch: ({ tree, item }) => tree.getSearchMatchingItems().some((i) => i.getId() === item.getId()),
56
+ },
43
57
  hotkeys: {
44
58
  openSearch: {
45
59
  hotkey: "LetterOrNumber",
@@ -12,7 +12,6 @@ export type SearchFeatureDef<T> = {
12
12
  setSearch?: SetStateFn<string | null>;
13
13
  onOpenSearch?: () => void;
14
14
  onCloseSearch?: () => void;
15
- onSearchMatchesItems?: (search: string, items: ItemInstance<T>[]) => void;
16
15
  isSearchMatchingItem?: (search: string, item: ItemInstance<T>) => boolean;
17
16
  };
18
17
  treeInstance: {
@@ -6,25 +6,31 @@ export const selectionFeature = {
6
6
  stateHandlerNames: {
7
7
  selectedItems: "setSelectedItems",
8
8
  },
9
- createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { setSelectedItems: (selectedItems) => {
10
- instance.applySubStateUpdate("selectedItems", selectedItems);
11
- },
9
+ treeInstance: {
10
+ setSelectedItems: ({ tree }, selectedItems) => {
11
+ tree.applySubStateUpdate("selectedItems", selectedItems);
12
+ },
12
13
  // TODO memo
13
- getSelectedItems: () => {
14
- return instance.getState().selectedItems.map(instance.getItemInstance);
15
- } })),
16
- createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { select: () => {
14
+ getSelectedItems: ({ tree }) => {
15
+ return tree.getState().selectedItems.map(tree.getItemInstance);
16
+ },
17
+ },
18
+ itemInstance: {
19
+ select: ({ tree, item }) => {
17
20
  const { selectedItems } = tree.getState();
18
21
  tree.setSelectedItems(selectedItems.includes(item.getItemMeta().itemId)
19
22
  ? selectedItems
20
23
  : [...selectedItems, item.getItemMeta().itemId]);
21
- }, deselect: () => {
24
+ },
25
+ deselect: ({ tree, item }) => {
22
26
  const { selectedItems } = tree.getState();
23
27
  tree.setSelectedItems(selectedItems.filter((id) => id !== item.getItemMeta().itemId));
24
- }, isSelected: () => {
28
+ },
29
+ isSelected: ({ tree, item }) => {
25
30
  const { selectedItems } = tree.getState();
26
31
  return selectedItems.includes(item.getItemMeta().itemId);
27
- }, selectUpTo: (ctrl) => {
32
+ },
33
+ selectUpTo: ({ tree, item }, ctrl) => {
28
34
  const indexA = item.getItemMeta().index;
29
35
  // TODO dont use focused item as anchor, but last primary-clicked item
30
36
  const indexB = tree.getFocusedItem().getItemMeta().index;
@@ -42,14 +48,16 @@ export const selectionFeature = {
42
48
  ...new Set([...selectedItems, ...newSelectedItems]),
43
49
  ];
44
50
  tree.setSelectedItems(uniqueSelectedItems);
45
- }, toggleSelect: () => {
51
+ },
52
+ toggleSelect: ({ item }) => {
46
53
  if (item.isSelected()) {
47
54
  item.deselect();
48
55
  }
49
56
  else {
50
57
  item.select();
51
58
  }
52
- }, getProps: () => (Object.assign(Object.assign({}, prev.getProps()), { "aria-selected": item.isSelected() ? "true" : "false", onClick: item.getMemoizedProp("selection/onClick", () => (e) => {
59
+ },
60
+ getProps: ({ tree, item, prev }) => (Object.assign(Object.assign({}, prev === null || prev === void 0 ? void 0 : prev()), { "aria-selected": item.isSelected() ? "true" : "false", onClick: item.getMemoizedProp("selection/onClick", () => (e) => {
53
61
  var _a, _b;
54
62
  if (e.shiftKey) {
55
63
  item.selectUpTo(e.ctrlKey || e.metaKey);
@@ -60,8 +68,9 @@ export const selectionFeature = {
60
68
  else {
61
69
  tree.setSelectedItems([item.getItemMeta().itemId]);
62
70
  }
63
- (_b = (_a = prev.getProps()).onClick) === null || _b === void 0 ? void 0 : _b.call(_a, e);
64
- }) })) })),
71
+ (_b = (_a = prev === null || prev === void 0 ? void 0 : prev()) === null || _a === void 0 ? void 0 : _a.onClick) === null || _b === void 0 ? void 0 : _b.call(_a, e);
72
+ }) })),
73
+ },
65
74
  hotkeys: {
66
75
  // setSelectedItem: {
67
76
  // hotkey: "space",
@@ -6,6 +6,11 @@ export const syncDataLoaderFeature = {
6
6
  stateHandlerNames: {
7
7
  loadingItems: "setLoadingItems",
8
8
  },
9
- createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { retrieveItemData: (itemId) => instance.getConfig().dataLoader.getItem(itemId), retrieveChildrenIds: (itemId) => instance.getConfig().dataLoader.getChildren(itemId) })),
10
- createItemInstance: (prev) => (Object.assign(Object.assign({}, prev), { isLoading: () => false })),
9
+ treeInstance: {
10
+ retrieveItemData: ({ tree }, itemId) => tree.getConfig().dataLoader.getItem(itemId),
11
+ retrieveChildrenIds: ({ tree }, itemId) => tree.getConfig().dataLoader.getChildren(itemId),
12
+ },
13
+ itemInstance: {
14
+ isLoading: () => false,
15
+ },
11
16
  };
@@ -3,4 +3,5 @@ import { TreeFeatureDef } from "./types";
3
3
  import { MainFeatureDef } from "../main/types";
4
4
  import { HotkeysCoreFeatureDef } from "../hotkeys-core/types";
5
5
  import { SyncDataLoaderFeatureDef } from "../sync-data-loader/types";
6
- export declare const treeFeature: FeatureImplementation<any, TreeFeatureDef<any>, MainFeatureDef | TreeFeatureDef<any> | HotkeysCoreFeatureDef<any> | SyncDataLoaderFeatureDef<any>>;
6
+ import { SearchFeatureDef } from "../search/types";
7
+ export declare const treeFeature: FeatureImplementation<any, TreeFeatureDef<any>, MainFeatureDef | TreeFeatureDef<any> | HotkeysCoreFeatureDef<any> | SyncDataLoaderFeatureDef<any> | SearchFeatureDef<any>>;
@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
7
7
  step((generator = generator.apply(thisArg, _arguments || [])).next());
8
8
  });
9
9
  };
10
- import { makeStateUpdater, memo, poll } from "../../utils";
10
+ import { makeStateUpdater, poll } from "../../utils";
11
11
  export const treeFeature = {
12
12
  key: "tree",
13
13
  getInitialState: (initialState) => (Object.assign({ expandedItems: [], focusedItem: null }, initialState)),
@@ -16,14 +16,13 @@ export const treeFeature = {
16
16
  expandedItems: "setExpandedItems",
17
17
  focusedItem: "setFocusedItem",
18
18
  },
19
- createTreeInstance: (prev, instance) => (Object.assign(Object.assign({}, prev), { retrieveItemData: () => {
20
- throw new Error("No data-loader registered");
21
- }, retrieveChildrenIds: () => {
22
- throw new Error("No data-loader registered");
23
- }, isItemExpanded: (itemId) => instance.getState().expandedItems.includes(itemId), getItemsMeta: () => {
24
- const { rootItemId } = instance.getConfig();
25
- const { expandedItems } = instance.getState();
19
+ treeInstance: {
20
+ isItemExpanded: ({ tree }, itemId) => tree.getState().expandedItems.includes(itemId),
21
+ getItemsMeta: ({ tree }) => {
22
+ const { rootItemId } = tree.getConfig();
23
+ const { expandedItems } = tree.getState();
26
24
  const flatItems = [];
25
+ const expandedItemsSet = new Set(expandedItems);
27
26
  const recursiveAdd = (itemId, parentId, level, setSize, posInSet) => {
28
27
  var _a;
29
28
  flatItems.push({
@@ -34,81 +33,89 @@ export const treeFeature = {
34
33
  setSize,
35
34
  posInSet,
36
35
  });
37
- if (expandedItems.includes(itemId)) {
38
- const children = (_a = instance.retrieveChildrenIds(itemId)) !== null && _a !== void 0 ? _a : [];
36
+ if (expandedItemsSet.has(itemId)) {
37
+ // TODO THIS MADE A HUGE DIFFERENCE!
38
+ const children = (_a = tree.retrieveChildrenIds(itemId)) !== null && _a !== void 0 ? _a : [];
39
39
  let i = 0;
40
40
  for (const childId of children) {
41
41
  recursiveAdd(childId, itemId, level + 1, children.length, i++);
42
42
  }
43
43
  }
44
44
  };
45
- const children = instance.retrieveChildrenIds(rootItemId);
45
+ const children = tree.retrieveChildrenIds(rootItemId);
46
46
  let i = 0;
47
47
  for (const itemId of children) {
48
48
  recursiveAdd(itemId, rootItemId, 0, children.length, i++);
49
49
  }
50
50
  return flatItems;
51
- }, expandItem: (itemId) => {
51
+ },
52
+ expandItem: ({ tree }, itemId) => {
52
53
  var _a;
53
- if (!instance.getItemInstance(itemId).isFolder()) {
54
+ if (!tree.getItemInstance(itemId).isFolder()) {
54
55
  return;
55
56
  }
56
- if ((_a = instance.getState().loadingItems) === null || _a === void 0 ? void 0 : _a.includes(itemId)) {
57
+ if ((_a = tree.getState().loadingItems) === null || _a === void 0 ? void 0 : _a.includes(itemId)) {
57
58
  return;
58
59
  }
59
- instance.applySubStateUpdate("expandedItems", (expandedItems) => [
60
+ tree.applySubStateUpdate("expandedItems", (expandedItems) => [
60
61
  ...expandedItems,
61
62
  itemId,
62
63
  ]);
63
- instance.rebuildTree();
64
- }, collapseItem: (itemId) => {
65
- if (!instance.getItemInstance(itemId).isFolder()) {
64
+ tree.rebuildTree();
65
+ },
66
+ collapseItem: ({ tree }, itemId) => {
67
+ if (!tree.getItemInstance(itemId).isFolder()) {
66
68
  return;
67
69
  }
68
- instance.applySubStateUpdate("expandedItems", (expandedItems) => expandedItems.filter((id) => id !== itemId));
69
- instance.rebuildTree();
70
- },
70
+ tree.applySubStateUpdate("expandedItems", (expandedItems) => expandedItems.filter((id) => id !== itemId));
71
+ tree.rebuildTree();
72
+ },
71
73
  // TODO memo
72
- getFocusedItem: () => {
74
+ getFocusedItem: ({ tree }) => {
73
75
  var _a, _b;
74
- return ((_b = instance.getItemInstance((_a = instance.getState().focusedItem) !== null && _a !== void 0 ? _a : "")) !== null && _b !== void 0 ? _b : instance.getItems()[0]);
75
- }, focusItem: (itemId) => {
76
- instance.applySubStateUpdate("focusedItem", itemId);
77
- }, focusNextItem: () => {
78
- const { index } = instance.getFocusedItem().getItemMeta();
79
- const nextIndex = Math.min(index + 1, instance.getItems().length - 1);
80
- instance.focusItem(instance.getItems()[nextIndex].getId());
81
- }, focusPreviousItem: () => {
82
- const { index } = instance.getFocusedItem().getItemMeta();
76
+ return ((_b = tree.getItemInstance((_a = tree.getState().focusedItem) !== null && _a !== void 0 ? _a : "")) !== null && _b !== void 0 ? _b : tree.getItems()[0]);
77
+ },
78
+ focusItem: ({ tree }, itemId) => {
79
+ tree.applySubStateUpdate("focusedItem", itemId);
80
+ },
81
+ focusNextItem: ({ tree }) => {
82
+ const { index } = tree.getFocusedItem().getItemMeta();
83
+ const nextIndex = Math.min(index + 1, tree.getItems().length - 1);
84
+ tree.focusItem(tree.getItems()[nextIndex].getId());
85
+ },
86
+ focusPreviousItem: ({ tree }) => {
87
+ const { index } = tree.getFocusedItem().getItemMeta();
83
88
  const nextIndex = Math.max(index - 1, 0);
84
- instance.focusItem(instance.getItems()[nextIndex].getId());
85
- }, updateDomFocus: () => {
89
+ tree.focusItem(tree.getItems()[nextIndex].getId());
90
+ },
91
+ updateDomFocus: ({ tree }) => {
86
92
  // Required because if the state is managed outside in react, the state only updated during next render
87
93
  setTimeout(() => __awaiter(void 0, void 0, void 0, function* () {
88
94
  var _a, _b;
89
- const focusedItem = instance.getFocusedItem();
90
- (_b = (_a = instance.getConfig()).scrollToItem) === null || _b === void 0 ? void 0 : _b.call(_a, focusedItem);
95
+ const focusedItem = tree.getFocusedItem();
96
+ (_b = (_a = tree.getConfig()).scrollToItem) === null || _b === void 0 ? void 0 : _b.call(_a, focusedItem);
91
97
  yield poll(() => focusedItem.getElement() !== null, 20);
92
98
  const focusedElement = focusedItem.getElement();
93
99
  if (!focusedElement)
94
100
  return;
95
101
  focusedElement.focus();
96
102
  }));
97
- }, getContainerProps: () => {
98
- var _a;
99
- return (Object.assign(Object.assign({}, (_a = prev.getContainerProps) === null || _a === void 0 ? void 0 : _a.call(prev)), { role: "tree", ariaLabel: "", ariaActivedescendant: "" }));
100
- } })),
101
- createItemInstance: (prev, item, tree) => (Object.assign(Object.assign({}, prev), { isLoading: () => {
102
- throw new Error("No data-loader registered");
103
- }, scrollTo: (scrollIntoViewArg) => __awaiter(void 0, void 0, void 0, function* () {
104
- var _a, _b;
105
- (_b = (_a = tree.getConfig()).scrollToItem) === null || _b === void 0 ? void 0 : _b.call(_a, item);
103
+ },
104
+ getContainerProps: ({ prev }) => (Object.assign(Object.assign({}, prev === null || prev === void 0 ? void 0 : prev()), { role: "tree", ariaLabel: "", ariaActivedescendant: "" })),
105
+ // relevant for hotkeys of this feature
106
+ isSearchOpen: () => false,
107
+ },
108
+ itemInstance: {
109
+ scrollTo: (_a, scrollIntoViewArg_1) => __awaiter(void 0, [_a, scrollIntoViewArg_1], void 0, function* ({ tree, item }, scrollIntoViewArg) {
110
+ var _b, _c, _d;
111
+ (_c = (_b = tree.getConfig()).scrollToItem) === null || _c === void 0 ? void 0 : _c.call(_b, item);
106
112
  yield poll(() => item.getElement() !== null, 20);
107
- item.getElement().scrollIntoView(scrollIntoViewArg);
108
- }), getId: () => item.getItemMeta().itemId, getProps: () => {
109
- var _a;
113
+ (_d = item.getElement()) === null || _d === void 0 ? void 0 : _d.scrollIntoView(scrollIntoViewArg);
114
+ }),
115
+ getId: ({ item }) => item.getItemMeta().itemId,
116
+ getProps: ({ item, prev }) => {
110
117
  const itemMeta = item.getItemMeta();
111
- return Object.assign(Object.assign({}, (_a = prev.getProps) === null || _a === void 0 ? void 0 : _a.call(prev)), { role: "treeitem", "aria-setsize": itemMeta.setSize, "aria-posinset": itemMeta.posInSet, "aria-selected": "false", "aria-label": item.getItemName(), "aria-level": itemMeta.level, tabIndex: item.isFocused() ? 0 : -1, onClick: item.getMemoizedProp("tree/onClick", () => (e) => {
118
+ return Object.assign(Object.assign({}, prev === null || prev === void 0 ? void 0 : prev()), { role: "treeitem", "aria-setsize": itemMeta.setSize, "aria-posinset": itemMeta.posInSet, "aria-selected": "false", "aria-label": item.getItemName(), "aria-level": itemMeta.level, tabIndex: item.isFocused() ? 0 : -1, onClick: item.getMemoizedProp("tree/onClick", () => (e) => {
112
119
  item.setFocused();
113
120
  item.primaryAction();
114
121
  if (e.ctrlKey || e.shiftKey || e.metaKey) {
@@ -124,24 +131,38 @@ export const treeFeature = {
124
131
  item.expand();
125
132
  }
126
133
  }) });
127
- }, expand: () => tree.expandItem(item.getItemMeta().itemId), collapse: () => tree.collapseItem(item.getItemMeta().itemId), getItemData: () => tree.retrieveItemData(item.getItemMeta().itemId), isExpanded: () => tree.getState().expandedItems.includes(item.getItemMeta().itemId), isFocused: () => tree.getState().focusedItem === item.getItemMeta().itemId ||
128
- (tree.getState().focusedItem === null && item.getItemMeta().index === 0), isFolder: () => item.getItemMeta().level === -1 ||
129
- tree.getConfig().isItemFolder(item), getItemName: () => {
134
+ },
135
+ expand: ({ tree, item }) => tree.expandItem(item.getItemMeta().itemId),
136
+ collapse: ({ tree, item }) => tree.collapseItem(item.getItemMeta().itemId),
137
+ getItemData: ({ tree, item }) => tree.retrieveItemData(item.getItemMeta().itemId),
138
+ equals: ({ item }, other) => item.getId() === (other === null || other === void 0 ? void 0 : other.getId()),
139
+ isExpanded: ({ tree, item }) => tree.getState().expandedItems.includes(item.getItemMeta().itemId),
140
+ isDescendentOf: ({ item }, parentId) => {
141
+ const parent = item.getParent();
142
+ return Boolean((parent === null || parent === void 0 ? void 0 : parent.getId()) === parentId || (parent === null || parent === void 0 ? void 0 : parent.isDescendentOf(parentId)));
143
+ },
144
+ isFocused: ({ tree, item }) => tree.getState().focusedItem === item.getItemMeta().itemId ||
145
+ (tree.getState().focusedItem === null && item.getItemMeta().index === 0),
146
+ isFolder: ({ tree, item }) => item.getItemMeta().level === -1 ||
147
+ tree.getConfig().isItemFolder(item),
148
+ getItemName: ({ tree, item }) => {
130
149
  const config = tree.getConfig();
131
150
  return config.getItemName(item);
132
- }, setFocused: () => tree.focusItem(item.getItemMeta().itemId), primaryAction: () => { var _a, _b; return (_b = (_a = tree.getConfig()).onPrimaryAction) === null || _b === void 0 ? void 0 : _b.call(_a, item); }, getParent: memo((itemMeta) => {
133
- for (let i = itemMeta.index - 1; i >= 0; i--) {
134
- const potentialParent = tree.getItems()[i];
135
- if (potentialParent.getItemMeta().level < itemMeta.level) {
136
- return potentialParent;
137
- }
138
- }
139
- return tree.getItemInstance(tree.getConfig().rootItemId);
140
- }, () => [item.getItemMeta()]),
151
+ },
152
+ setFocused: ({ tree, item }) => tree.focusItem(item.getItemMeta().itemId),
153
+ primaryAction: ({ tree, item }) => { var _a, _b; return (_b = (_a = tree.getConfig()).onPrimaryAction) === null || _b === void 0 ? void 0 : _b.call(_a, item); },
154
+ getParent: ({ tree, item }) => item.getItemMeta().parentId
155
+ ? tree.getItemInstance(item.getItemMeta().parentId)
156
+ : undefined,
141
157
  // TODO remove
142
- getIndexInParent: () => item.getItemMeta().posInSet, getChildren: () => tree
158
+ getIndexInParent: ({ item }) => item.getItemMeta().posInSet,
159
+ getChildren: ({ tree, item }) => tree
143
160
  .retrieveChildrenIds(item.getItemMeta().itemId)
144
- .map((id) => tree.getItemInstance(id)), getTree: () => tree, getItemAbove: () => tree.getItems()[item.getItemMeta().index - 1], getItemBelow: () => tree.getItems()[item.getItemMeta().index + 1], getMemoizedProp: (name, create, deps) => {
161
+ .map((id) => tree.getItemInstance(id)),
162
+ getTree: ({ tree }) => tree,
163
+ getItemAbove: ({ tree, item }) => tree.getItems()[item.getItemMeta().index - 1],
164
+ getItemBelow: ({ tree, item }) => tree.getItems()[item.getItemMeta().index + 1],
165
+ getMemoizedProp: ({ item }, name, create, deps) => {
145
166
  var _a, _b, _c, _d, _e;
146
167
  var _f, _g;
147
168
  const data = item.getDataRef();
@@ -157,13 +178,14 @@ export const treeFeature = {
157
178
  data.current.memoizedDeps[name] = deps;
158
179
  data.current.memoizedValues[name] = value;
159
180
  return value;
160
- } })),
181
+ },
182
+ },
161
183
  hotkeys: {
162
184
  focusNextItem: {
163
185
  hotkey: "ArrowDown",
164
186
  canRepeat: true,
165
187
  preventDefault: true,
166
- isEnabled: (tree) => { var _a, _b; return !((_b = (_a = tree.isSearchOpen) === null || _a === void 0 ? void 0 : _a.call(tree)) !== null && _b !== void 0 ? _b : false) && !tree.getState().dnd; },
188
+ isEnabled: (tree) => { var _a, _b; return !((_b = (_a = tree.isSearchOpen) === null || _a === void 0 ? void 0 : _a.call(tree)) !== null && _b !== void 0 ? _b : false) && !tree.getState().dnd; }, // TODO what happens when the feature doesnt exist? proxy method still claims to exist
167
189
  handler: (e, tree) => {
168
190
  tree.focusNextItem();
169
191
  tree.updateDomFocus();
@@ -42,19 +42,21 @@ export type TreeFeatureDef<T> = {
42
42
  getProps: () => Record<string, any>;
43
43
  getItemName: () => string;
44
44
  getItemData: () => T;
45
+ equals: (other?: ItemInstance<any> | null) => boolean;
45
46
  expand: () => void;
46
47
  collapse: () => void;
47
48
  isExpanded: () => boolean;
49
+ isDescendentOf: (parentId: string) => boolean;
48
50
  isFocused: () => boolean;
49
51
  isFolder: () => boolean;
50
52
  setFocused: () => void;
51
- getParent: () => ItemInstance<T>;
53
+ getParent: () => ItemInstance<T> | undefined;
52
54
  getChildren: () => ItemInstance<T>[];
53
55
  getIndexInParent: () => number;
54
56
  primaryAction: () => void;
55
57
  getTree: () => TreeInstance<T>;
56
- getItemAbove: () => ItemInstance<T> | null;
57
- getItemBelow: () => ItemInstance<T> | null;
58
+ getItemAbove: () => ItemInstance<T> | undefined;
59
+ getItemBelow: () => ItemInstance<T> | undefined;
58
60
  getMemoizedProp: <X>(name: string, create: () => X, deps?: any[]) => X;
59
61
  scrollTo: (scrollIntoViewArg?: boolean | ScrollIntoViewOptions) => Promise<void>;
60
62
  };
@@ -1,7 +1,7 @@
1
1
  export * from "./types/core";
2
2
  export * from "./core/create-tree";
3
3
  export * from "./features/tree/types";
4
- export * from "./features/main/types";
4
+ export { MainFeatureDef, InstanceBuilder } from "./features/main/types";
5
5
  export * from "./features/drag-and-drop/types";
6
6
  export * from "./features/selection/types";
7
7
  export * from "./features/async-data-loader/types";
@@ -21,3 +21,5 @@ export * from "./features/expand-all/feature";
21
21
  export * from "./utilities/create-on-drop-handler";
22
22
  export * from "./utilities/insert-items-at-target";
23
23
  export * from "./utilities/remove-items-from-parents";
24
+ export * from "./core/build-proxified-instance";
25
+ export * from "./core/build-static-instance";
package/lib/esm/index.js CHANGED
@@ -1,7 +1,6 @@
1
1
  export * from "./types/core";
2
2
  export * from "./core/create-tree";
3
3
  export * from "./features/tree/types";
4
- export * from "./features/main/types";
5
4
  export * from "./features/drag-and-drop/types";
6
5
  export * from "./features/selection/types";
7
6
  export * from "./features/async-data-loader/types";
@@ -21,3 +20,5 @@ export * from "./features/expand-all/feature";
21
20
  export * from "./utilities/create-on-drop-handler";
22
21
  export * from "./utilities/insert-items-at-target";
23
22
  export * from "./utilities/remove-items-from-parents";
23
+ export * from "./core/build-proxified-instance";
24
+ export * from "./core/build-static-instance";
@@ -0,0 +1,23 @@
1
+ import { DragEvent } from "react";
2
+ import { TestTree } from "./test-tree";
3
+ import { HotkeyName } from "../types/core";
4
+ export declare class TestTreeDo<T> {
5
+ protected tree: TestTree<T>;
6
+ protected itemInstance(itemId: string): import("../types/core").ItemInstance<any>;
7
+ protected itemProps(itemId: string): Record<string, any>;
8
+ constructor(tree: TestTree<T>);
9
+ selectItem(id: string): void;
10
+ shiftSelectItem(id: string): void;
11
+ ctrlSelectItem(id: string): void;
12
+ ctrlShiftSelectItem(id: string): void;
13
+ selectMultiple(...ids: string[]): void;
14
+ hotkey(hotkey: HotkeyName, e?: Partial<KeyboardEvent>): void;
15
+ startDrag(itemId: string, event?: DragEvent): DragEvent<Element>;
16
+ dragOver(itemId: string, event?: DragEvent): DragEvent<Element>;
17
+ dragOverNotAllowed(itemId: string, event?: DragEvent): DragEvent<Element>;
18
+ dragLeave(itemId: string): void;
19
+ dragEnd(itemId: string, event?: DragEvent): DragEvent<Element>;
20
+ drop(itemId: string, event?: DragEvent): DragEvent<Element>;
21
+ dragOverAndDrop(itemId: string, event?: DragEvent): DragEvent<Element>;
22
+ private consistentCalls;
23
+ }