@headless-tree/core 0.0.0-20250921152257 → 0.0.0-20251013200210

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # @headless-tree/core
 
-## 0.0.0-20250921152257
+## 0.0.0-20251013200210
+
+### Patch Changes
+
+- 08f10f1: Fixed an issue where `isFolder` returns incorrect values for leafs if they are not visibly rendered (#166)
+
+## 1.5.0
 
 ### Minor Changes
 
@@ -17,6 +23,10 @@
 - 597faad: Checkbox propagation is now supported for trees with async data loaders!
 - b0ee382: triggering a data refetch will now always set the loadingItemData/loadingItemChildrens state variable to the associated items if they where not apart of the cache before
 
+### Sponsorship appreciation
+
+Thanks for [Docmost](https://docmost.com/), who have supported the development of Headless Tree with a sponsor contribution. Docmost is a wiki-software that can be self-hosted or used in cloud. Thank you!
+
 ## 1.4.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -527,11 +527,11 @@ type HotkeyName = MergedFeatures<RegisteredFeatures<any>>["hotkeys"];
 type HotkeysConfig<T> = Record<HotkeyName, HotkeyConfig<T>>;
 type CustomHotkeysConfig<T> = Partial<Record<HotkeyName | `custom${string}`, Partial<HotkeyConfig<T>>>>;
 type MayReturnNull<T extends (...x: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | null;
-type ItemInstanceOpts<Key extends keyof ItemInstance<any>> = {
-    item: ItemInstance<any>;
-    tree: TreeInstance<any>;
+type ItemInstanceOpts<T, Key extends keyof ItemInstance<any>> = {
+    item: ItemInstance<T>;
+    tree: TreeInstance<T>;
     itemId: string;
-    prev?: MayReturnNull<ItemInstance<any>[Key]>;
+    prev?: MayReturnNull<ItemInstance<T>[Key]>;
 };
 type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
     tree: TreeInstance<any>;
@@ -548,7 +548,7 @@ type FeatureImplementation<T = any> = {
         [key in keyof TreeInstance<T>]?: (opts: TreeInstanceOpts<key>, ...args: Parameters<TreeInstance<T>[key]>) => void;
     };
     itemInstance?: {
-        [key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
+        [key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<T, key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
     };
     onTreeMount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
     onTreeUnmount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;

package/dist/index.d.ts

@@ -527,11 +527,11 @@ type HotkeyName = MergedFeatures<RegisteredFeatures<any>>["hotkeys"];
 type HotkeysConfig<T> = Record<HotkeyName, HotkeyConfig<T>>;
 type CustomHotkeysConfig<T> = Partial<Record<HotkeyName | `custom${string}`, Partial<HotkeyConfig<T>>>>;
 type MayReturnNull<T extends (...x: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | null;
-type ItemInstanceOpts<Key extends keyof ItemInstance<any>> = {
-    item: ItemInstance<any>;
-    tree: TreeInstance<any>;
+type ItemInstanceOpts<T, Key extends keyof ItemInstance<any>> = {
+    item: ItemInstance<T>;
+    tree: TreeInstance<T>;
     itemId: string;
-    prev?: MayReturnNull<ItemInstance<any>[Key]>;
+    prev?: MayReturnNull<ItemInstance<T>[Key]>;
 };
 type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
     tree: TreeInstance<any>;
@@ -548,7 +548,7 @@ type FeatureImplementation<T = any> = {
         [key in keyof TreeInstance<T>]?: (opts: TreeInstanceOpts<key>, ...args: Parameters<TreeInstance<T>[key]>) => void;
     };
     itemInstance?: {
-        [key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
+        [key in keyof ItemInstance<T>]?: (opts: ItemInstanceOpts<T, key>, ...args: Parameters<ItemInstance<T>[key]>) => void;
     };
     onTreeMount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
     onTreeUnmount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;

package/dist/index.js

@@ -303,7 +303,7 @@ var treeFeature = {
       );
     },
     isFocused: ({ tree, item, itemId }) => tree.getState().focusedItem === itemId || tree.getState().focusedItem === null && item.getItemMeta().index === 0,
-    isFolder: ({ tree, item }) => item.getItemMeta().level === -1 || tree.getConfig().isItemFolder(item),
+    isFolder: ({ tree, item, itemId }) => itemId === tree.getConfig().rootItemId || tree.getConfig().isItemFolder(item),
     getItemName: ({ tree, item }) => {
       const config = tree.getConfig();
       return config.getItemName(item);
@@ -1007,7 +1007,8 @@ var specialKeys = {
   minus: /^(NumpadSubtract|Minus)$/,
   control: /^(ControlLeft|ControlRight)$/,
   shift: /^(ShiftLeft|ShiftRight)$/,
-  metaorcontrol: /^(MetaLeft|MetaRight|ControlLeft|ControlRight)$/
+  metaorcontrol: /^(MetaLeft|MetaRight|ControlLeft|ControlRight)$/,
+  enter: /^(Enter|NumpadEnter)$/
 };
 var testHotkeyMatch = (pressedKeys, tree, hotkey) => {
   const supposedKeys = hotkey.hotkey.toLowerCase().split("+");

package/dist/index.mjs

@@ -259,7 +259,7 @@ var treeFeature = {
       );
     },
     isFocused: ({ tree, item, itemId }) => tree.getState().focusedItem === itemId || tree.getState().focusedItem === null && item.getItemMeta().index === 0,
-    isFolder: ({ tree, item }) => item.getItemMeta().level === -1 || tree.getConfig().isItemFolder(item),
+    isFolder: ({ tree, item, itemId }) => itemId === tree.getConfig().rootItemId || tree.getConfig().isItemFolder(item),
     getItemName: ({ tree, item }) => {
       const config = tree.getConfig();
       return config.getItemName(item);
@@ -963,7 +963,8 @@ var specialKeys = {
   minus: /^(NumpadSubtract|Minus)$/,
   control: /^(ControlLeft|ControlRight)$/,
   shift: /^(ShiftLeft|ShiftRight)$/,
-  metaorcontrol: /^(MetaLeft|MetaRight|ControlLeft|ControlRight)$/
+  metaorcontrol: /^(MetaLeft|MetaRight|ControlLeft|ControlRight)$/,
+  enter: /^(Enter|NumpadEnter)$/
 };
 var testHotkeyMatch = (pressedKeys, tree, hotkey) => {
   const supposedKeys = hotkey.hotkey.toLowerCase().split("+");

package/package.json

@@ -13,7 +13,7 @@
     "checkbox",
     "hook"
   ],
-  "version": "0.0.0-20250921152257",
+  "version": "0.0.0-20251013200210",
   "main": "dist/index.d.ts",
   "module": "dist/index.mjs",
   "types": "dist/index.d.mts",

package/src/features/hotkeys-core/feature.ts

@@ -14,6 +14,7 @@ const specialKeys: Record<string, RegExp> = {
   control: /^(ControlLeft|ControlRight)$/,
   shift: /^(ShiftLeft|ShiftRight)$/,
   metaorcontrol: /^(MetaLeft|MetaRight|ControlLeft|ControlRight)$/,
+  enter: /^(Enter|NumpadEnter)$/,
 };
 
 const testHotkeyMatch = (

package/src/features/tree/feature.ts

@@ -203,8 +203,8 @@ export const treeFeature: FeatureImplementation<any> = {
     isFocused: ({ tree, item, itemId }) =>
       tree.getState().focusedItem === itemId ||
       (tree.getState().focusedItem === null && item.getItemMeta().index === 0),
-    isFolder: ({ tree, item }) =>
-      item.getItemMeta().level === -1 ||
+    isFolder: ({ tree, item, itemId }) =>
+      itemId === tree.getConfig().rootItemId ||
       tree.getConfig().isItemFolder(item as ItemInstance<any>),
     getItemName: ({ tree, item }) => {
       const config = tree.getConfig();

package/src/features/tree/tree.spec.ts

@@ -4,8 +4,8 @@ import { propMemoizationFeature } from "../prop-memoization/feature";
 
 const factory = TestTree.default({}).withFeatures(propMemoizationFeature);
 
-describe("core-feature/selections", () => {
-  factory.forSuits((tree) => {
+describe("core-feature/tree", () => {
+  factory.forSuits((tree, title) => {
     describe("expanded items", () => {
       it("can expand via tree instance", () => {
         const setExpandedItems = tree.mockedHandler("setExpandedItems");
@@ -156,6 +156,17 @@ describe("core-feature/selections", () => {
         });
       });
 
+      it("unloaded item", () => {
+        expect(tree.instance.getItemInstance("x444").getItemMeta()).toEqual({
+          index: -1,
+          itemId: "x444",
+          level: -1,
+          parentId: null,
+          posInSet: 0,
+          setSize: 1,
+        });
+      });
+
       it("expanded container", () => {
         expect(tree.instance.getItemInstance("x11").getItemMeta()).toEqual({
           index: 1,
@@ -312,8 +323,30 @@ describe("core-feature/selections", () => {
         expect(tree.instance.getItemInstance("x1").isFolder()).toBe(true);
       });
 
-      it("returns correctly for false cases of isFolder()", () => {
-        expect(tree.instance.getItemInstance("x111").isFolder()).toBe(false);
+      it("returns correctly for true cases of isFolder() ", () => {
+        expect(tree.instance.getItemInstance("x1").isFolder()).toBe(true);
+      });
+
+      it("returns correct isFolder for hidden items", async () => {
+        if (title.toLocaleLowerCase().includes("async")) {
+          // async test tree defaults to "loading" item names
+          return;
+        }
+        const testTree = await tree
+          .with({
+            isItemFolder: (item: any) => item.getItemData().length < 4,
+          })
+          .createTestCaseTree();
+
+        // Reference: https://github.com/lukasbach/headless-tree/issues/166
+        expect(testTree.instance.getItemInstance("x44").isFolder()).toBe(true);
+        expect(testTree.instance.getItemInstance("x444").isFolder()).toBe(
+          false,
+        );
+      });
+
+      it("returns isFolder=true for root item", () => {
+        expect(tree.instance.getItemInstance("x").isFolder()).toBe(true);
       });
 
       it("returns correctly for getParent()", () => {

package/src/test-utils/test-tree.ts

@@ -63,15 +63,15 @@ export class TestTree<T = string> {
     }),
   };
 
-  forSuits(runSuite: (tree: TestTree<T>) => void) {
+  forSuits(runSuite: (tree: TestTree<T>, title: string) => void) {
     describe.for([
       this.suits.sync(),
       this.suits.async(),
       this.suits.proxifiedSync(),
       this.suits.proxifiedAsync(),
-    ])("$title", ({ tree }) => {
+    ])("$title", ({ tree, title }) => {
       tree.resetBeforeEach();
-      runSuite(tree);
+      runSuite(tree, title);
     });
   }
 

package/src/types/core.ts

@@ -93,11 +93,11 @@ type MayReturnNull<T extends (...x: any[]) => any> = (
   ...args: Parameters<T>
 ) => ReturnType<T> | null;
 
-export type ItemInstanceOpts<Key extends keyof ItemInstance<any>> = {
-  item: ItemInstance<any>;
-  tree: TreeInstance<any>;
+export type ItemInstanceOpts<T, Key extends keyof ItemInstance<any>> = {
+  item: ItemInstance<T>;
+  tree: TreeInstance<T>;
   itemId: string;
-  prev?: MayReturnNull<ItemInstance<any>[Key]>;
+  prev?: MayReturnNull<ItemInstance<T>[Key]>;
 };
 
 export type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
@@ -131,7 +131,7 @@ export type FeatureImplementation<T = any> = {
 
   itemInstance?: {
     [key in keyof ItemInstance<T>]?: (
-      opts: ItemInstanceOpts<key>,
+      opts: ItemInstanceOpts<T, key>,
       ...args: Parameters<ItemInstance<T>[key]>
     ) => void;
   };