jqtree 1.7.3 → 1.7.5

package/src/test/node.test.ts

@@ -159,7 +159,7 @@ describe("addChild", () => {
         expect(given.node.children).toEqual(
             expect.arrayContaining([
                 expect.objectContaining({ id: 100, name: "child1" }),
-            ])
+            ]),
         );
     });
 
@@ -330,7 +330,7 @@ describe("constructor", () => {
     const given = getGiven<Vars>();
 
     given("node", () =>
-        given.params === undefined ? new Node() : new Node(given.params)
+        given.params === undefined ? new Node() : new Node(given.params),
     );
 
     context("without parameters", () => {
@@ -351,6 +351,10 @@ describe("constructor", () => {
             });
             expect(given.node).not.toHaveProperty("id");
         });
+
+        it("sets isEmptyFolder to false", () => {
+            expect(given.node.isEmptyFolder).toBe(false);
+        });
     });
 
     context("with an object with a name property", () => {
@@ -408,7 +412,6 @@ describe("constructor", () => {
                 name: "n1",
                 url: "/",
             });
-            // todo: match object?
             expect(given.node).not.toHaveProperty("label");
             expect(given.node.children).toHaveLength(0);
             expect(given.node.parent).toBeNull();
@@ -434,10 +437,24 @@ describe("constructor", () => {
         }));
 
         it("doesn't set the children", () => {
-            // todo: match object?
             expect(given.node.name).toBe("n1");
             expect(given.node.children).toHaveLength(0);
         });
+
+        it("sets isEmptyFolder to false", () => {
+            expect(given.node.isEmptyFolder).toBe(false);
+        });
+    });
+
+    context("when the data contains an empty children attribute", () => {
+        given("params", () => ({
+            name: "n1",
+            children: [],
+        }));
+
+        it("sets isEmptyFolder to true", () => {
+            expect(given.node.isEmptyFolder).toBe(true);
+        });
     });
 });
 
@@ -719,8 +736,8 @@ describe("getNodeByCallback", () => {
         it("returns the node", () => {
             expect(
                 given.tree.getNodeByCallback((node) =>
-                    node.name.startsWith("chi")
-                )
+                    node.name.startsWith("chi"),
+                ),
             ).toMatchObject({
                 name: "child1",
             });
@@ -776,7 +793,7 @@ describe("getNodeByNameMustExist", () => {
     context("when the node doesn't exist", () => {
         it("throws an exception", () => {
             expect(() =>
-                given.tree.getNodeByNameMustExist("non-existing")
+                given.tree.getNodeByNameMustExist("non-existing"),
             ).toThrow("Node with name non-existing not found");
         });
     });
@@ -1074,16 +1091,10 @@ describe("iterate", () => {
 });
 
 describe("loadFromData", () => {
-    interface Vars {
-        tree: Node;
-    }
-
-    const given = getGiven<Vars>();
-
-    given("tree", () => new Node().loadFromData(exampleData));
-
     it("creates a tree", () => {
-        expect(given.tree.children).toEqual([
+        const tree = new Node().loadFromData(exampleData);
+
+        expect(tree.children).toEqual([
             expect.objectContaining({
                 id: 123,
                 intProperty: 1,
@@ -1103,6 +1114,41 @@ describe("loadFromData", () => {
             }),
         ]);
     });
+
+    it("sets isEmptyFolder to true for a node when it is has an empty children attribute", () => {
+        const data = [
+            {
+                name: "test1",
+                children: [],
+            },
+        ];
+
+        const tree = new Node().loadFromData(data);
+        expect((tree.children[0] as Node).isEmptyFolder).toBe(true);
+    });
+
+    it("sets isEmptyFolder to false for a node when it doesn't have a children attribute", () => {
+        const data = [
+            {
+                name: "test1",
+            },
+        ];
+
+        const tree = new Node().loadFromData(data);
+        expect((tree.children[0] as Node).isEmptyFolder).toBe(false);
+    });
+
+    it("sets isEmptyFolder to false for a node when it has a children attribute that is not empty", () => {
+        const data = [
+            {
+                name: "test1",
+                children: ["child1"],
+            },
+        ];
+
+        const tree = new Node().loadFromData(data);
+        expect((tree.children[0] as Node).isEmptyFolder).toBe(false);
+    });
 });
 
 describe("moveNode", () => {
@@ -1125,7 +1171,7 @@ describe("moveNode", () => {
     context("when moving after a node", () => {
         it("moves the node", () => {
             expect(
-                given.tree.moveNode(given.child2, given.node2, Position.After)
+                given.tree.moveNode(given.child2, given.node2, Position.After),
             ).toBe(true);
 
             expect(given.tree).toMatchObject({
@@ -1147,8 +1193,8 @@ describe("moveNode", () => {
                     given.tree.moveNode(
                         given.child2,
                         given.tree,
-                        Position.After
-                    )
+                        Position.After,
+                    ),
                 ).toBe(false);
             });
         });
@@ -1157,7 +1203,7 @@ describe("moveNode", () => {
     context("when moving inside a node", () => {
         it("moves the node", () => {
             expect(
-                given.tree.moveNode(given.child1, given.node2, Position.Inside)
+                given.tree.moveNode(given.child1, given.node2, Position.Inside),
             ).toBe(true);
 
             expect(given.tree).toMatchObject({
@@ -1182,7 +1228,11 @@ describe("moveNode", () => {
     context("when moving before a node", () => {
         it("moves the node", () => {
             expect(
-                given.tree.moveNode(given.child2, given.child1, Position.Before)
+                given.tree.moveNode(
+                    given.child2,
+                    given.child1,
+                    Position.Before,
+                ),
             ).toBe(true);
 
             expect(given.tree).toMatchObject({
@@ -1206,8 +1256,8 @@ describe("moveNode", () => {
                     given.tree.moveNode(
                         given.child2,
                         given.tree,
-                        Position.Before
-                    )
+                        Position.Before,
+                    ),
                 ).toBe(false);
             });
         });
@@ -1216,7 +1266,7 @@ describe("moveNode", () => {
     context("when the moved node is a parent of the target node", () => {
         it("doesn't move the node", () => {
             expect(
-                given.tree.moveNode(given.node1, given.child1, Position.Before)
+                given.tree.moveNode(given.node1, given.child1, Position.Before),
             ).toBe(false);
 
             expect(given.tree).toMatchObject({
@@ -1237,7 +1287,7 @@ describe("moveNode", () => {
     context("with position None", () => {
         it("returns false", () => {
             expect(
-                given.tree.moveNode(given.child2, given.node2, Position.None)
+                given.tree.moveNode(given.child2, given.node2, Position.None),
             ).toBe(false);
         });
     });
@@ -1283,6 +1333,15 @@ describe("prepend", () => {
             });
         });
     });
+
+    it("sets the isEmptyFolder attribute to true when the node data has empty children", () => {
+        given.node.prepend({
+            name: "test1",
+            children: [],
+        });
+
+        expect((given.node.children[0] as Node).isEmptyFolder).toBe(true);
+    });
 });
 
 describe("remove", () => {

package/src/test/nodeUtils.test.ts

@@ -0,0 +1,21 @@
+import { isNodeRecordWithChildren } from "../nodeUtils";
+
+describe("isNodeRecordWithChildren", () => {
+    it("returns true when the data is an object with the children attribute of type array", () => {
+        const data = {
+            children: [],
+        };
+
+        expect(isNodeRecordWithChildren(data)).toBe(true);
+    });
+
+    it("returns when the data is an object without the children attribute", () => {
+        const data = { name: "test" };
+
+        expect(isNodeRecordWithChildren(data)).toBe(false);
+    });
+
+    it("returns when the data is a string", () => {
+        expect(isNodeRecordWithChildren("test")).toBe(false);
+    });
+});

package/src/tree.jquery.ts

@@ -101,7 +101,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     public selectNode(
         node: Node | null,
-        optionsParam?: SelectNodeOptions
+        optionsParam?: SelectNodeOptions,
     ): JQuery {
         this.doSelectNode(node, optionsParam);
         return this.element;
@@ -137,21 +137,21 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     public loadDataFromUrl(
         param1: string | null | Node,
         param2?: Node | null | HandleFinishedLoading,
-        param3?: HandleFinishedLoading
+        param3?: HandleFinishedLoading,
     ): JQuery {
         if (typeof param1 === "string") {
             // first parameter is url
             this.doLoadDataFromUrl(
                 param1,
                 param2 as Node | null,
-                param3 ?? null
+                param3 ?? null,
             );
         } else {
             // first parameter is not url
             this.doLoadDataFromUrl(
                 null,
                 param1,
-                param2 as HandleFinishedLoading | null
+                param2 as HandleFinishedLoading | null,
             );
         }
 
@@ -185,7 +185,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     }
 
     public getNodeByHtmlElement(
-        element: HTMLElement | JQuery<HTMLElement>
+        element: HTMLElement | JQuery<HTMLElement>,
     ): Node | null {
         return this.getNode(jQuery(element));
     }
@@ -197,7 +197,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     public openNode(
         node: Node,
         param1?: boolean | OnFinishOpenNode,
-        param2?: OnFinishOpenNode
+        param2?: OnFinishOpenNode,
     ): JQuery {
         if (!node) {
             throw Error(NODE_PARAM_IS_EMPTY);
@@ -238,7 +238,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
         if (node.isFolder() || node.isEmptyFolder) {
             new FolderElement(node, this).close(
                 slide,
-                this.options.animationSpeed
+                this.options.animationSpeed,
             );
 
             this.saveState();
@@ -258,7 +258,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     public addNodeAfter(
         newNodeInfo: NodeData,
-        existingNode: Node
+        existingNode: Node,
     ): Node | null {
         const newNode = existingNode.addAfter(newNodeInfo);
 
@@ -271,7 +271,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     public addNodeBefore(
         newNodeInfo: NodeData,
-        existingNode: Node
+        existingNode: Node,
     ): Node | null {
         if (!existingNode) {
             throw Error(PARAM_IS_EMPTY + "existingNode");
@@ -288,7 +288,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     public addParentNode(
         newNodeInfo: NodeData,
-        existingNode: Node
+        existingNode: Node,
     ): Node | null {
         if (!existingNode) {
             throw Error(PARAM_IS_EMPTY + "existingNode");
@@ -417,7 +417,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
         this.selectNodeHandler.addToSelection(node);
 
         this._getNodeElementForNode(node).select(
-            mustSetFocus === undefined ? true : mustSetFocus
+            mustSetFocus === undefined ? true : mustSetFocus,
         );
 
         this.saveState();
@@ -455,12 +455,8 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
             throw Error(NODE_PARAM_IS_EMPTY);
         }
 
-        const nodeOffset = jQuery(node.element).offset();
-        const nodeTop = nodeOffset ? nodeOffset.top : 0;
-
-        const treeOffset = this.$el.offset();
-        const treeTop = treeOffset ? treeOffset.top : 0;
-
+        const nodeTop = jQuery(node.element).offset()?.top ?? 0;
+        const treeTop = this.$el.offset()?.top ?? 0;
         const top = nodeTop - treeTop;
 
         this.scrollHandler.scrollToY(top);
@@ -508,7 +504,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     public _triggerEvent(
         eventName: string,
-        values?: Record<string, unknown>
+        values?: Record<string, unknown>,
     ): JQuery.Event {
         const event = jQuery.Event(eventName, values);
         this.element.trigger(event);
@@ -518,18 +514,18 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     public _openNode(
         node: Node,
         slide = true,
-        onFinished: OnFinishOpenNode | null
+        onFinished: OnFinishOpenNode | null,
     ): void {
         const doOpenNode = (
             _node: Node,
             _slide: boolean,
-            _onFinished: OnFinishOpenNode | null
+            _onFinished: OnFinishOpenNode | null,
         ): void => {
             const folderElement = new FolderElement(_node, this);
             folderElement.open(
                 _onFinished,
                 _slide,
-                this.options.animationSpeed
+                this.options.animationSpeed,
             );
         };
 
@@ -660,7 +656,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
         if (this.options.dragAndDrop) {
             const result = this.dndHandler.mouseDrag(positionInfo);
 
-            this.scrollHandler.checkScrolling();
+            this.scrollHandler.checkScrolling(positionInfo);
             return result;
         } else {
             return false;
@@ -669,6 +665,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     protected mouseStop(positionInfo: PositionInfo): boolean {
         if (this.options.dragAndDrop) {
+            this.scrollHandler.stopScrolling();
             return this.dndHandler.mouseStop(positionInfo);
         } else {
             return false;
@@ -755,7 +752,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
         this.tree = new this.options.nodeClass(
             null,
             true,
-            this.options.nodeClass
+            this.options.nodeClass,
         );
 
         this.selectNodeHandler.clear();
@@ -843,7 +840,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
                 } else {
                     this.saveStateHandler.setInitialStateOnDemand(
                         state,
-                        cbFinished
+                        cbFinished,
                     );
 
                     return true;
@@ -904,7 +901,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     }
 
     private handleClick = (
-        e: JQuery.ClickEvent<HTMLElement, any, HTMLElement, HTMLElement>
+        e: JQuery.ClickEvent<HTMLElement, any, HTMLElement, HTMLElement>,
     ): void => {
         const clickTarget = this.getClickTarget(e.target);
 
@@ -929,7 +926,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     };
 
     private handleDblclick = (
-        e: JQuery.DoubleClickEvent<HTMLElement, any, HTMLElement, HTMLElement>
+        e: JQuery.DoubleClickEvent<HTMLElement, any, HTMLElement, HTMLElement>,
     ): void => {
         const clickTarget = this.getClickTarget(e.target);
 
@@ -981,7 +978,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     }
 
     private handleContextmenu = (
-        e: JQuery.ContextMenuEvent<HTMLElement, any, HTMLElement, HTMLElement>
+        e: JQuery.ContextMenuEvent<HTMLElement, any, HTMLElement, HTMLElement>,
     ) => {
         const $div = jQuery(e.target).closest("ul.jqtree-tree .jqtree-element");
         if ($div.length) {
@@ -1054,7 +1051,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
 
     private doSelectNode(
         node: Node | null,
-        optionsParam?: SelectNodeOptions
+        optionsParam?: SelectNodeOptions,
     ): void {
         const saveState = (): void => {
             if (this.options.saveState) {
@@ -1157,7 +1154,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     private doLoadDataFromUrl(
         urlInfoParam: string | JQuery.AjaxSettings | null,
         parentNode: Node | null,
-        onFinished: HandleFinishedLoading | null
+        onFinished: HandleFinishedLoading | null,
     ): void {
         const urlInfo = urlInfoParam || this.getDataUrlInfo(parentNode);
 
@@ -1167,7 +1164,7 @@ export class JqTreeWidget extends MouseWidget<JQTreeOptions> {
     private loadFolderOnDemand(
         node: Node,
         slide = true,
-        onFinished: OnFinishOpenNode | null
+        onFinished: OnFinishOpenNode | null,
     ): void {
         node.is_loading = true;
 

package/src/version.ts

@@ -1,3 +1,3 @@
-const version = "1.7.3";
+const version = "1.7.5";
 
 export default version;