@headless-tree/core 1.0.1 → 1.2.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 (58) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/lib/cjs/core/create-tree.js +13 -2
  3. package/lib/cjs/features/async-data-loader/feature.js +78 -68
  4. package/lib/cjs/features/async-data-loader/types.d.ts +12 -7
  5. package/lib/cjs/features/drag-and-drop/feature.js +1 -0
  6. package/lib/cjs/features/expand-all/feature.js +2 -2
  7. package/lib/cjs/features/hotkeys-core/feature.js +50 -18
  8. package/lib/cjs/features/hotkeys-core/types.d.ts +3 -0
  9. package/lib/cjs/features/keyboard-drag-and-drop/feature.js +1 -1
  10. package/lib/cjs/features/renaming/feature.js +8 -0
  11. package/lib/cjs/features/selection/feature.js +1 -1
  12. package/lib/cjs/features/sync-data-loader/feature.js +13 -9
  13. package/lib/cjs/features/sync-data-loader/types.d.ts +11 -2
  14. package/lib/cjs/features/tree/feature.js +1 -0
  15. package/lib/cjs/features/tree/types.d.ts +1 -0
  16. package/lib/cjs/index.d.ts +2 -0
  17. package/lib/cjs/index.js +5 -0
  18. package/lib/cjs/test-utils/test-tree-expect.js +1 -0
  19. package/lib/cjs/test-utils/test-tree.js +1 -0
  20. package/lib/esm/core/create-tree.js +13 -2
  21. package/lib/esm/features/async-data-loader/feature.js +78 -68
  22. package/lib/esm/features/async-data-loader/types.d.ts +12 -7
  23. package/lib/esm/features/drag-and-drop/feature.js +1 -0
  24. package/lib/esm/features/expand-all/feature.js +2 -2
  25. package/lib/esm/features/hotkeys-core/feature.js +50 -18
  26. package/lib/esm/features/hotkeys-core/types.d.ts +3 -0
  27. package/lib/esm/features/keyboard-drag-and-drop/feature.js +1 -1
  28. package/lib/esm/features/renaming/feature.js +8 -0
  29. package/lib/esm/features/selection/feature.js +1 -1
  30. package/lib/esm/features/sync-data-loader/feature.js +13 -9
  31. package/lib/esm/features/sync-data-loader/types.d.ts +11 -2
  32. package/lib/esm/features/tree/feature.js +1 -0
  33. package/lib/esm/features/tree/types.d.ts +1 -0
  34. package/lib/esm/index.d.ts +2 -0
  35. package/lib/esm/index.js +2 -0
  36. package/lib/esm/test-utils/test-tree-expect.js +1 -0
  37. package/lib/esm/test-utils/test-tree.js +1 -0
  38. package/package.json +7 -2
  39. package/readme.md +2 -2
  40. package/src/core/create-tree.ts +20 -2
  41. package/src/features/async-data-loader/async-data-loader.spec.ts +82 -0
  42. package/src/features/async-data-loader/feature.ts +92 -67
  43. package/src/features/async-data-loader/types.ts +14 -7
  44. package/src/features/drag-and-drop/feature.ts +1 -0
  45. package/src/features/expand-all/feature.ts +2 -2
  46. package/src/features/hotkeys-core/feature.ts +56 -17
  47. package/src/features/hotkeys-core/types.ts +4 -0
  48. package/src/features/keyboard-drag-and-drop/feature.ts +1 -1
  49. package/src/features/renaming/feature.ts +13 -0
  50. package/src/features/renaming/renaming.spec.ts +31 -0
  51. package/src/features/selection/feature.ts +1 -1
  52. package/src/features/sync-data-loader/feature.ts +16 -9
  53. package/src/features/sync-data-loader/types.ts +11 -4
  54. package/src/features/tree/feature.ts +1 -0
  55. package/src/features/tree/types.ts +1 -0
  56. package/src/index.ts +3 -0
  57. package/src/test-utils/test-tree-expect.ts +1 -0
  58. package/src/test-utils/test-tree.ts +1 -0
@@ -3,6 +3,12 @@ import { makeStateUpdater } from "../../utils";
3
3
  import { throwError } from "../../utilities/errors";
4
4
 
5
5
  const promiseErrorMessage = "sync dataLoader returned promise";
6
+ const unpromise = <T>(data: T | Promise<T>): T => {
7
+ if (!data || (typeof data === "object" && "then" in data)) {
8
+ throw throwError(promiseErrorMessage);
9
+ }
10
+ return data;
11
+ };
6
12
 
7
13
  export const syncDataLoaderFeature: FeatureImplementation = {
8
14
  key: "sync-data-loader",
@@ -29,20 +35,21 @@ export const syncDataLoaderFeature: FeatureImplementation = {
29
35
  waitForItemChildrenLoaded: async () => {},
30
36
 
31
37
  retrieveItemData: ({ tree }, itemId) => {
32
- const data = tree.getConfig().dataLoader.getItem(itemId);
33
- if (typeof data === "object" && "then" in data) {
34
- throw throwError(promiseErrorMessage);
35
- }
36
- return data;
38
+ return unpromise(tree.getConfig().dataLoader.getItem(itemId));
37
39
  },
38
40
 
39
41
  retrieveChildrenIds: ({ tree }, itemId) => {
40
- const data = tree.getConfig().dataLoader.getChildren(itemId);
41
- if (typeof data === "object" && "then" in data) {
42
- throw throwError(promiseErrorMessage);
42
+ const { dataLoader } = tree.getConfig();
43
+ if ("getChildren" in dataLoader) {
44
+ return unpromise(dataLoader.getChildren(itemId));
43
45
  }
44
- return data;
46
+ return unpromise(dataLoader.getChildrenWithData(itemId)).map(
47
+ (c) => c.data,
48
+ );
45
49
  },
50
+
51
+ loadItemData: ({ tree }, itemId) => tree.retrieveItemData(itemId),
52
+ loadChildrenIds: ({ tree }, itemId) => tree.retrieveChildrenIds(itemId),
46
53
  },
47
54
 
48
55
  itemInstance: {
@@ -1,7 +1,14 @@
1
- export interface TreeDataLoader<T> {
2
- getItem: (itemId: string) => T | Promise<T>;
3
- getChildren: (itemId: string) => string[] | Promise<string[]>;
4
- }
1
+ export type TreeDataLoader<T> =
2
+ | {
3
+ getItem: (itemId: string) => T | Promise<T>;
4
+ getChildren: (itemId: string) => string[] | Promise<string[]>;
5
+ }
6
+ | {
7
+ getItem: (itemId: string) => T | Promise<T>;
8
+ getChildrenWithData: (
9
+ itemId: string,
10
+ ) => { id: string; data: T }[] | Promise<{ id: string; data: T }[]>;
11
+ };
5
12
 
6
13
  export type SyncDataLoaderFeatureDef<T> = {
7
14
  state: {};
@@ -126,6 +126,7 @@ export const treeFeature: FeatureImplementation<any> = {
126
126
  item.getElement()?.scrollIntoView(scrollIntoViewArg);
127
127
  },
128
128
  getId: ({ itemId }) => itemId,
129
+ getKey: ({ itemId }) => itemId, // TODO apply to all stories to use
129
130
  getProps: ({ item, prev }) => {
130
131
  const itemMeta = item.getItemMeta();
131
132
  return {
@@ -44,6 +44,7 @@ export type TreeFeatureDef<T> = {
44
44
  };
45
45
  itemInstance: {
46
46
  getId: () => string;
47
+ getKey: () => string;
47
48
  getProps: () => Record<string, any>;
48
49
  getItemName: () => string;
49
50
  getItemData: () => T;
package/src/index.ts CHANGED
@@ -31,3 +31,6 @@ export * from "./utilities/remove-items-from-parents";
31
31
 
32
32
  export * from "./core/build-proxified-instance";
33
33
  export * from "./core/build-static-instance";
34
+
35
+ export { makeStateUpdater } from "./utils";
36
+ export { isOrderedDragTarget } from "./features/drag-and-drop/utils";
@@ -82,6 +82,7 @@ export class TestTreeExpect<T> {
82
82
  top: 0,
83
83
  });
84
84
  expect(this.tree.instance.getDragLineStyle(0, 0)).toEqual({
85
+ position: "absolute",
85
86
  left: `${indent * 20}px`,
86
87
  pointerEvents: "none",
87
88
  top: "0px",
@@ -78,6 +78,7 @@ export class TestTree<T = string> {
78
78
  get instance() {
79
79
  if (!this.treeInstance) {
80
80
  this.treeInstance = createTree(this.config);
81
+ this.treeInstance.rebuildTree();
81
82
  }
82
83
  return this.treeInstance;
83
84
  }