jqtree 1.9.1 → 2.0.0

package/src/tree.jquery.d.ts

@@ -1,35 +1,47 @@
-interface ClickNodeEvent {
-    click_event: JQuery.ClickEvent;
-    deselected_node?: INode | null;
-    node: INode;
-    previous_node?: INode;
+interface JQTreeNode {
+    [key: string]: unknown;
+    children: JQTreeNode[];
+    element?: HTMLElement;
+    id?: JQTreeNodeId;
+    is_open: boolean;
+    iterate(callback: (node: JQTreeNode, level: number) => boolean): void;
+
+    name: string;
+
+    parent: JQTreeNode | null;
 }
 
-type DataUrl = DataUrlFunction | JQuery.AjaxSettings | string;
+type JQTreeNodeData = JQTreeNodeRecord | string;
+
+type JQTreeNodeId = number | string;
 
-type DataUrlFunction = (node?: Node) => JQuery.AjaxSettings;
+interface JQTreeNodeRecord {
+    [key: string]: unknown;
+    children?: JQTreeNodeData[];
+    id?: JQTreeNodeId;
+}
 
-interface IJQTreeOptions {
+interface JQTreeOptions {
     animationSpeed?: number | string;
     autoEscape?: boolean;
     autoOpen?: boolean | number | string;
     buttonLeft?: boolean;
     closedIcon?: HTMLElement | JQuery | string;
     data?: NodeData[];
-    dataFilter?: (data: NodeData[]) => NodeData[];
-    dataUrl?: DataUrl;
+    dataFilter?: (data: JQTreeNodeData[]) => JQTreeNodeData[];
+    dataUrl?: ((node?: Node) => string) | string;
     dragAndDrop?: boolean;
     keyboardSupport?: boolean;
     nodeClass?: any;
-    onCanMove?: (node: INode) => boolean;
-    onCanSelectNode?: (node: INode) => boolean;
-    onCreateLi?: (node: INode, el: JQuery, isSelected: boolean) => void;
-    onDragMove?: (node: INode, event: Event | Touch) => void;
-    onDragStop?: (node: INode, event: Event | Touch) => void;
+    onCanMove?: (node: JQTreeNode) => boolean;
+    onCanSelectNode?: (node: JQTreeNode) => boolean;
+    onCreateLi?: (node: JQTreeNode, el: JQuery, isSelected: boolean) => void;
+    onDragMove?: (node: JQTreeNode, event: Event | Touch) => void;
+    onDragStop?: (node: JQTreeNode, event: Event | Touch) => void;
     onGetStateFromStorage?: () => string;
     onIsMoveHandle?: (el: JQuery) => boolean;
-    onLoadFailed?: (response: JQuery.jqXHR) => void;
-    onLoading?: (isLoading: boolean, node: INode, $el: JQuery) => void;
+    onLoadFailed?: (response: Response) => void;
+    onLoading?: (isLoading: boolean, node: JQTreeNode, $el: JQuery) => void;
     onSetStateFromStorage?: (data: string) => void;
     openedIcon?: HTMLElement | JQuery | string;
     openFolderDelay?: false | number;
@@ -43,124 +55,100 @@ interface IJQTreeOptions {
     useContextMenu?: boolean;
 }
 
-interface IJQTreePlugin {
-    (options?: IJQTreeOptions): JQuery;
+interface JQTreePlugin {
+    (options?: JQTreeOptions): JQuery;
     (
         behavior: "addNodeAfter",
         newNodeInfo: NodeData,
-        existingNode: INode,
-    ): INode | null;
+        existingNode: JQTreeNode,
+    ): JQTreeNode | null;
     (
         behavior: "addNodeBefore",
         newNodeInfo: NodeData,
-        existingNode: INode,
-    ): INode | null;
+        existingNode: JQTreeNode,
+    ): JQTreeNode | null;
     (
         behavior: "addParentNode",
         newNodeInfo: NodeData,
-        existingNode: INode,
-    ): INode | null;
-    (behavior: "addToSelection", node: INode, mustSetFocus?: boolean): JQuery;
-    (behavior: "appendNode", newNodeInfo: NodeData, parentNode?: INode): INode;
-    (behavior: "closeNode", node: INode, slide?: boolean): JQuery;
+        existingNode: JQTreeNode,
+    ): JQTreeNode | null;
+    (behavior: "addToSelection", node: JQTreeNode, mustSetFocus?: boolean): JQuery;
+    (behavior: "appendNode", newNodeInfo: NodeData, parentNode?: JQTreeNode): JQTreeNode;
+    (behavior: "closeNode", node: JQTreeNode, slide?: boolean): JQuery;
     (behavior: "destroy"): void;
     (
         behavior: "getNodeByCallback",
-        callback: (node: INode) => boolean,
-    ): INode | null;
-    (behavior: "getNodeByHtmlElement", element: Element | JQuery): INode | null;
-    (behavior: "getNodeById", id: NodeId): INode | null;
-    (behavior: "getNodeByName", name: string): INode | null;
-    (behavior: "getNodeByNameMustExist", name: string): INode;
-    (behavior: "getNodesByProperty", key: string, value: unknown): INode[];
-    (behavior: "getSelectedNode"): false | INode;
-    (behavior: "getSelectedNodes"): INode[];
-    (behavior: "getState"): null | SavedState;
-    (behavior: "getStateFromStorage"): INode | null;
-    (behavior: "getTree"): INode;
+        callback: (node: JQTreeNode) => boolean,
+    ): JQTreeNode | null;
+    (behavior: "getNodeByHtmlElement", element: Element | JQuery): JQTreeNode | null;
+    (behavior: "getNodeById", id: NodeId): JQTreeNode | null;
+    (behavior: "getNodeByName", name: string): JQTreeNode | null;
+    (behavior: "getNodeByNameMustExist", name: string): JQTreeNode;
+    (behavior: "getNodesByProperty", key: string, value: unknown): JQTreeNode[];
+    (behavior: "getSelectedNode"): false | JQTreeNode;
+    (behavior: "getSelectedNodes"): JQTreeNode[];
+    (behavior: "getState"): JQTreeSavedState | null;
+    (behavior: "getStateFromStorage"): JQTreeNode | null;
+    (behavior: "getTree"): JQTreeNode;
     (behavior: "getVersion"): string;
     (behavior: "isDragging"): boolean;
-    (behavior: "isNodeSelected", node: INode): boolean;
-    (behavior: "loadData", data: NodeData[], parentNode?: INode): JQuery;
+    (behavior: "isNodeSelected", node: JQTreeNode): boolean;
+    (behavior: "loadData", data: NodeData[], parentNode?: JQTreeNode): JQuery;
     (
         behavior: "loadDataFromUrl",
-        param1?: INode | null | string,
-        param2?: (() => void) | INode | null,
+        param1?: JQTreeNode | null | string,
+        param2?: (() => void) | JQTreeNode,
         param3?: () => void,
     ): JQuery;
     (behavior: "moveDown"): JQuery;
     (
         behavior: "moveNode",
-        node: INode,
-        targetNode: INode,
+        node: JQTreeNode,
+        targetNode: JQTreeNode,
         position: "after" | "before" | "inside",
     ): JQuery;
     (behavior: "moveUp"): JQuery;
-    (behavior: "openNode", node: INode): JQuery;
-    (behavior: "openNode", node: INode, slide: boolean): JQuery;
+    (behavior: "openNode", node: JQTreeNode): JQuery;
+    (behavior: "openNode", node: JQTreeNode, slide: boolean): JQuery;
     (
         behavior: "openNode",
-        node: INode,
-        onFinished: (node: INode) => void,
+        node: JQTreeNode,
+        onFinished: (node: JQTreeNode) => void,
     ): JQuery;
     (
         behavior: "openNode",
-        node: INode,
+        node: JQTreeNode,
         slide: boolean,
-        onFinished?: (node: INode) => void,
+        onFinished?: (node: JQTreeNode) => void,
     ): JQuery;
-    (behavior: "prependNode", newNodeInfo: NodeData, parentNode?: INode): INode;
+    (behavior: "prependNode", newNodeInfo: NodeData, parentNode?: JQTreeNode): JQTreeNode;
     (behavior: "refresh"): JQuery;
     (behavior: "reload", onFinished?: () => void): JQuery;
-    (behavior: "removeFromSelection", node: INode): JQuery;
-    (behavior: "removeNode", node: INode): JQuery;
-    (behavior: "scrollToNode", node: INode): JQuery;
+    (behavior: "removeFromSelection", node: JQTreeNode): JQuery;
+    (behavior: "removeNode", node: JQTreeNode): JQuery;
+    (behavior: "scrollToNode", node: JQTreeNode): JQuery;
     (
         behavior: "selectNode",
-        node: INode | null,
-        optionsParam?: SelectNodeOptions,
+        node: JQTreeNode | null,
+        optionsParam?: JQTreeSelectNodeOptions,
     ): JQuery;
     (behavior: "setOption", option: string, value: unknown): JQuery;
     (behavior: "setState", options: Record<string, unknown>): JQuery;
-    (behavior: "toggle", node: INode, slideParam?: boolean): JQuery;
+    (behavior: "toggle", node: JQTreeNode, slideParam?: boolean): JQuery;
     (behavior: "toJson"): string;
-    (behavior: "updateNode", node: INode, data: NodeData): JQuery;
+    (behavior: "updateNode", node: JQTreeNode, data: NodeData): JQuery;
 }
 
-interface INode {
-    [key: string]: unknown;
-    children: INode[];
-    element?: HTMLElement;
-    id?: NodeId;
-    is_open: boolean;
-    iterate(callback: IterateCallback): void;
-
-    name: string;
-
-    parent: INode | null;
-}
-type IterateCallback = (node: INode, level: number) => boolean;
-
-interface JQuery {
-    tree: IJQTreePlugin;
+interface JQTreeSavedState {
+    open_nodes: JQTreeNodeId[];
+    selected_node: JQTreeNodeId[];
 }
 
-type NodeData = NodeRecord | string;
-
-type NodeId = number | string;
-
-interface NodeRecord {
-    [key: string]: unknown;
-    children?: NodeData[];
-    id?: NodeId;
-}
-
-interface SavedState {
-    open_nodes: NodeId[];
-    selected_node: NodeId[];
-}
-
-interface SelectNodeOptions {
+interface JQTreeSelectNodeOptions {
     mustSetFocus?: boolean;
     mustToggle?: boolean;
 }
+
+interface JQuery {
+    tree: JQTreePlugin;
+}