react-arborist 3.2.0 → 3.3.1-0

package/dist/module/utils.js

@@ -0,0 +1,162 @@
+export function bound(n, min, max) {
+    return Math.max(Math.min(n, max), min);
+}
+export function isItem(node) {
+    return node && node.isLeaf;
+}
+export function isClosed(node) {
+    return node && node.isInternal && !node.isOpen;
+}
+/**
+ * Is first param a descendant of the second param
+ */
+export const isDescendant = (a, b) => {
+    let n = a;
+    while (n) {
+        if (n.id === b.id)
+            return true;
+        n = n.parent;
+    }
+    return false;
+};
+export const indexOf = (node) => {
+    if (!node.parent)
+        throw Error("Node does not have a parent");
+    return node.parent.children.findIndex((c) => c.id === node.id);
+};
+export function noop() { }
+export function dfs(node, id) {
+    if (!node)
+        return null;
+    if (node.id === id)
+        return node;
+    if (node.children) {
+        for (let child of node.children) {
+            const result = dfs(child, id);
+            if (result)
+                return result;
+        }
+    }
+    return null;
+}
+export function walk(node, fn) {
+    fn(node);
+    if (node.children) {
+        for (let child of node.children) {
+            walk(child, fn);
+        }
+    }
+}
+export function focusNextElement(target) {
+    const elements = getFocusable(target);
+    let next;
+    for (let i = 0; i < elements.length; ++i) {
+        const item = elements[i];
+        if (item === target) {
+            next = nextItem(elements, i);
+            break;
+        }
+    }
+    // @ts-ignore ??
+    next === null || next === void 0 ? void 0 : next.focus();
+}
+export function focusPrevElement(target) {
+    const elements = getFocusable(target);
+    let next;
+    for (let i = 0; i < elements.length; ++i) {
+        const item = elements[i];
+        if (item === target) {
+            next = prevItem(elements, i);
+            break;
+        }
+    }
+    // @ts-ignore
+    next === null || next === void 0 ? void 0 : next.focus();
+}
+function nextItem(list, index) {
+    if (index + 1 < list.length) {
+        return list[index + 1];
+    }
+    else {
+        return list[0];
+    }
+}
+function prevItem(list, index) {
+    if (index - 1 >= 0) {
+        return list[index - 1];
+    }
+    else {
+        return list[list.length - 1];
+    }
+}
+function getFocusable(target) {
+    return Array.from(document.querySelectorAll('button:not([disabled]), [href], input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex="-1"]):not([disabled]), details:not([disabled]), summary:not(:disabled)')).filter((e) => e === target || !target.contains(e));
+}
+export function access(obj, accessor) {
+    if (typeof accessor === "boolean")
+        return accessor;
+    if (typeof accessor === "string")
+        return obj[accessor];
+    return accessor(obj);
+}
+export function identifyNull(obj) {
+    if (obj === null)
+        return null;
+    else
+        return identify(obj);
+}
+export function identify(obj) {
+    return typeof obj === "string" ? obj : obj.id;
+}
+export function mergeRefs(...refs) {
+    return (instance) => {
+        refs.forEach((ref) => {
+            if (typeof ref === "function") {
+                ref(instance);
+            }
+            else if (ref != null) {
+                ref.current = instance;
+            }
+        });
+    };
+}
+export function safeRun(fn, ...args) {
+    if (fn)
+        return fn(...args);
+}
+export function waitFor(fn) {
+    return new Promise((resolve, reject) => {
+        let tries = 0;
+        function check() {
+            tries += 1;
+            if (tries === 100)
+                reject();
+            if (fn())
+                resolve();
+            else
+                setTimeout(check, 10);
+        }
+        check();
+    });
+}
+export function getInsertIndex(tree) {
+    var _a, _b;
+    const focus = tree.focusedNode;
+    if (!focus)
+        return (_b = (_a = tree.root.children) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+    if (focus.isOpen)
+        return 0;
+    if (focus.parent)
+        return focus.childIndex + 1;
+    return 0;
+}
+export function getInsertParentId(tree) {
+    const focus = tree.focusedNode;
+    if (!focus)
+        return null;
+    if (focus.isOpen)
+        return focus.id;
+    if (focus.parent && !focus.parent.isRoot)
+        return focus.parent.id;
+    return null;
+}

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "react-arborist",
-  "version": "3.2.0",
+  "version": "3.3.1-0",
   "license": "MIT",
   "source": "src/index.ts",
-  "main": "dist/index.js",
-  "module": "dist/module.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/main/index.js",
+  "module": "dist/module/index.js",
+  "types": "dist/module/index.d.ts",
   "sideEffects": false,
   "scripts": {
-    "start": "run-p 'start:**'",
+    "build:cjs": "tsc --outDir dist/main",
+    "build:es": "tsc --outDir dist/module --module es2022 --moduleResolution node",
     "build": "npm-run-all clean -p 'build:**'",
-    "test": "jest",
-    "build:js": "parcel build --target main --target module",
-    "build:types": "tsc --outDir dist",
     "clean": "rimraf dist",
-    "start:js": "parcel watch --target main --target module --no-hmr --no-cache",
-    "start:types": "tsc --outDir dist --watch",
-    "prepack": "yarn build"
+    "prepack": "yarn build",
+    "test": "jest",
+    "watch": "yarn build:es --watch"
   },
+  "files": [
+    "src",
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/brimdata/react-arborist.git"
@@ -37,9 +39,9 @@
   ],
   "dependencies": {
     "react-dnd": "^14.0.3",
-    "react-dnd-html5-backend": "^14.0.1",
-    "react-window": "^1.8.6",
-    "redux": "^4.1.1",
+    "react-dnd-html5-backend": "^14.0.3",
+    "react-window": "^1.8.10",
+    "redux": "^5.0.0",
     "use-sync-external-store": "^1.2.0"
   },
   "peerDependencies": {
@@ -47,16 +49,15 @@
     "react-dom": ">= 16.14"
   },
   "devDependencies": {
-    "@parcel/core": "^2.3.2",
-    "@types/jest": "^27.4.1",
-    "@types/react": "^18.0.0",
-    "@types/react-window": "^1.8.5",
-    "@types/use-sync-external-store": "^0.0.3",
-    "jest": "^29.4.1",
+    "@types/jest": "^29.5.11",
+    "@types/react": "^18.2.43",
+    "@types/react-window": "^1.8.8",
+    "@types/use-sync-external-store": "^0.0.6",
+    "jest": "^29.7.0",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.3.2",
-    "rimraf": "^4.1.2",
-    "ts-jest": "^29.0.5",
-    "typescript": "^4.6.2"
-  }
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "stableVersion": "3.3.0"
 }

package/src/components/default-container.tsx

@@ -18,6 +18,7 @@ export function DefaultContainer() {
   const tree = useTreeApi();
   return (
     <div
+      role="tree"
       style={{
         height: tree.height,
         width: tree.width,
@@ -215,6 +216,7 @@ export function DefaultContainer() {
         if (node) tree.focus(node.id);
       }}
     >
+      {/* @ts-ignore */}
       <FixedSizeList
         className={tree.props.className}
         outerRef={tree.listEl}

package/src/components/provider.tsx

@@ -15,7 +15,7 @@ import {
 } from "../context";
 import { TreeApi } from "../interfaces/tree-api";
 import { initialState } from "../state/initial";
-import { rootReducer, RootState } from "../state/root-reducer";
+import { Actions, rootReducer, RootState } from "../state/root-reducer";
 import { HTML5Backend } from "react-dnd-html5-backend";
 import { DndProvider } from "react-dnd";
 import { TreeProps } from "../types/tree-props";
@@ -37,7 +37,8 @@ export function TreeProvider<T>({
 }: Props<T>) {
   const list = useRef<FixedSizeList | null>(null);
   const listEl = useRef<HTMLDivElement | null>(null);
-  const store = useRef<Store>(
+  const store = useRef<Store<RootState, Actions>>(
+    // @ts-ignore
     createStore(rootReducer, initialState(treeProps))
   );
   const state = useSyncExternalStore<RootState>(

package/src/components/row-container.tsx

@@ -58,7 +58,7 @@ export const RowContainer = React.memo(function RowContainer<T>({
   );
   const rowAttrs: React.HTMLAttributes<any> = {
     role: "treeitem",
-    "aria-level": node.level,
+    "aria-level": node.level + 1,
     "aria-selected": node.isSelected,
     style: rowStyle,
     tabIndex: -1,

package/src/dnd/compute-drop.ts

@@ -26,7 +26,7 @@ function getNodesAroundCursor(
   hover: HoverData
 ): [NodeApi | null, NodeApi | null] {
   if (!node) {
-    // We're hoving over the empty part of the list, not over an item,
+    // We're hovering over the empty part of the list, not over an item,
     // Put the cursor below the last item which is "prev"
     return [prev, null];
   }
@@ -83,7 +83,10 @@ export type ComputedDrop = {
   cursor: Cursor | null;
 };
 
-function dropAt(parentId: string | undefined, index: number): DropResult {
+function dropAt(
+  parentId: string | undefined,
+  index: number | null
+): DropResult {
   return { parentId: parentId || null, index };
 }
 
@@ -135,7 +138,7 @@ export function computeDrop(args: Args): ComputedDrop {
   /* Hovering over the middle of a folder */
   if (node && node.isInternal && hover.inMiddle) {
     return {
-      drop: dropAt(node.id, 0),
+      drop: dropAt(node.id, null),
       cursor: highlightCursor(node.id),
     };
   }

package/src/dnd/drag-hook.ts

@@ -31,7 +31,7 @@ export function useDragHook<T>(node: NodeApi<T>): ConnectDragSource {
           safeRun(tree.props.onMove, {
             dragIds,
             parentId: parentId === ROOT_ID ? null : parentId,
-            index,
+            index: index === null ? 0 : index, // When it's null it was dropped over a folder
             dragNodes: tree.dragNodes,
             parentNode: tree.get(parentId),
           });

package/src/dnd/drop-hook.ts

@@ -8,7 +8,7 @@ import { actions as dnd } from "../state/dnd-slice";
 
 export type DropResult = {
   parentId: string | null;
-  index: number;
+  index: number | null;
 };
 
 export function useDropHook(

package/src/interfaces/node-api.ts

@@ -130,6 +130,16 @@ export class NodeApi<T = any> {
     return this.parent?.children![i + 1] ?? null;
   }
 
+  isAncestorOf(node: NodeApi<T> | null) {
+    if (!node) return false;
+    let ancestor: NodeApi<T> | null = node;
+    while (ancestor) {
+      if (ancestor.id === this.id) return true;
+      ancestor = ancestor.parent;
+    }
+    return false;
+  }
+
   select() {
     this.tree.select(this);
   }

package/src/interfaces/tree-api.ts

@@ -419,6 +419,18 @@ export class TreeApi<T> {
       .filter((n) => !!n) as NodeApi<T>[];
   }
 
+  get dragNode() {
+    return this.get(this.state.nodes.drag.id);
+  }
+
+  get dragDestinationParent() {
+    return this.get(this.state.nodes.drag.destinationParentId);
+  }
+
+  get dragDestinationIndex() {
+    return this.state.nodes.drag.destinationIndex;
+  }
+
   canDrop() {
     if (this.isFiltered) return false;
     const parentNode = this.get(this.state.dnd.parentId) ?? this.root;
@@ -428,7 +440,7 @@ export class TreeApi<T> {
     for (const drag of dragNodes) {
       if (!drag) return false;
       if (!parentNode) return false;
-      if (drag.isInternal && utils.isDecendent(parentNode, drag)) return false;
+      if (drag.isInternal && utils.isDescendant(parentNode, drag)) return false;
     }
 
     // Allow the user to insert their own logic
@@ -436,7 +448,7 @@ export class TreeApi<T> {
       return !isDisabled({
         parentNode,
         dragNodes: this.dragNodes,
-        index: this.state.dnd.index,
+        index: this.state.dnd.index || 0,
       });
     } else if (typeof isDisabled == "string") {
       // @ts-ignore
@@ -606,7 +618,8 @@ export class TreeApi<T> {
   willReceiveDrop(node: string | IdObj | null) {
     const id = identifyNull(node);
     if (!id) return false;
-    return id === this.state.nodes.drag.idWillReceiveDrop;
+    const { destinationParentId, destinationIndex } = this.state.nodes.drag;
+    return id === destinationParentId && destinationIndex === null;
   }
 
   /* Tree Event Handlers */

package/src/state/dnd-slice.ts

@@ -8,7 +8,7 @@ export type DndState = {
   cursor: Cursor;
   dragIds: string[];
   parentId: null | string;
-  index: number;
+  index: number | null;
 };
 
 /* Actions */
@@ -22,7 +22,7 @@ export const actions = {
   dragEnd() {
     return { type: "DND_DRAG_END" as const };
   },
-  hovering(parentId: string | null, index: number) {
+  hovering(parentId: string | null, index: number | null) {
     return { type: "DND_HOVERING" as const, parentId, index };
   },
 };

package/src/state/drag-slice.ts

@@ -1,27 +1,43 @@
 import { ActionTypes } from "../types/utils";
 import { actions as dnd } from "./dnd-slice";
+import { initialState } from "./initial";
 
 /* Types */
 
-export type DragSlice = { id: string | null; idWillReceiveDrop: string | null };
+export type DragSlice = {
+  id: string | null;
+  selectedIds: string[];
+  destinationParentId: string | null;
+  destinationIndex: number | null;
+};
 
 /* Reducer */
 
 export function reducer(
-  state: DragSlice = { id: null, idWillReceiveDrop: null },
+  state: DragSlice = initialState().nodes.drag,
   action: ActionTypes<typeof dnd>
-) {
+): DragSlice {
   switch (action.type) {
     case "DND_DRAG_START":
-      return { ...state, id: action.id };
+      return { ...state, id: action.id, selectedIds: action.dragIds };
     case "DND_DRAG_END":
-      return { ...state, id: null };
-    case "DND_CURSOR":
-      const c = action.cursor;
-      if (c.type === "highlight" && c.id !== state.idWillReceiveDrop) {
-        return { ...state, idWillReceiveDrop: c.id };
-      } else if (c.type !== "highlight" && state.idWillReceiveDrop !== null) {
-        return { ...state, idWillReceiveDrop: null };
+      return {
+        ...state,
+        id: null,
+        destinationParentId: null,
+        destinationIndex: null,
+        selectedIds: [],
+      };
+    case "DND_HOVERING":
+      if (
+        action.parentId !== state.destinationParentId ||
+        action.index != state.destinationIndex
+      ) {
+        return {
+          ...state,
+          destinationParentId: action.parentId,
+          destinationIndex: action.index,
+        };
       } else {
         return state;
       }

package/src/state/initial.ts

@@ -7,7 +7,12 @@ export const initialState = (props?: TreeProps<any>): RootState => ({
     open: { filtered: {}, unfiltered: props?.initialOpenState ?? {} },
     focus: { id: null, treeFocused: false },
     edit: { id: null },
-    drag: { id: null, idWillReceiveDrop: null },
+    drag: {
+      id: null,
+      selectedIds: [],
+      destinationParentId: null,
+      destinationIndex: null,
+    },
     selection: { ids: new Set(), anchor: null, mostRecent: null },
   },
   dnd: {

package/src/utils.ts

@@ -15,9 +15,9 @@ export function isClosed(node: NodeApi<any> | null) {
 }
 
 /**
- * Is first param a decendent of the second param
+ * Is first param a descendant of the second param
  */
-export const isDecendent = (a: NodeApi<any>, b: NodeApi<any>) => {
+export const isDescendant = (a: NodeApi<any>, b: NodeApi<any>) => {
   let n: NodeApi<any> | null = a;
   while (n) {
     if (n.id === b.id) return true;

package/dist/components/cursor.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare function Cursor(): JSX.Element | null;

package/dist/components/drag-preview-container.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare function DragPreviewContainer(): JSX.Element;

package/dist/components/list-outer-element.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare const ListOuterElement: import("react").ForwardRefExoticComponent<Pick<import("react").HTMLProps<HTMLDivElement>, "id" | "children" | "data" | "open" | "cite" | "form" | "label" | "slot" | "span" | "style" | "summary" | "title" | "pattern" | "start" | "hidden" | "color" | "content" | "size" | "default" | "wrap" | "multiple" | "disabled" | "onFocus" | "onClick" | "list" | "name" | "defaultValue" | "onBlur" | "onKeyDown" | "accessKey" | "dir" | "draggable" | "lang" | "translate" | "className" | "classID" | "value" | "defaultChecked" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "download" | "alt" | "coords" | "autoPlay" | "controls" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "dateTime" | "acceptCharset" | "action" | "autoComplete" | "encType" | "manifest" | "allowFullScreen" | "allowTransparency" | "frameBorder" | "accept" | "capture" | "checked" | "challenge" | "keyType" | "keyParams" | "htmlFor" | "as" | "charSet" | "httpEquiv" | "high" | "low" | "reversed" | "selected" | "async" | "cellPadding" | "cellSpacing" | "colSpan" | "headers" | "rowSpan" | "scope" | "cols" | "maxLength" | "minLength" | "kind" | "src" | "srcLang" | "preload" | "crossOrigin" | "defer" | "height" | "href" | "hrefLang" | "integrity" | "loop" | "marginHeight" | "marginWidth" | "max" | "media" | "mediaGroup" | "method" | "min" | "muted" | "nonce" | "noValidate" | "optimum" | "placeholder" | "playsInline" | "poster" | "readOnly" | "rel" | "required" | "rows" | "sandbox" | "scoped" | "scrolling" | "seamless" | "shape" | "sizes" | "srcDoc" | "srcSet" | "step" | "target" | "type" | "useMap" | "width" | "wmode" | "contentEditable" | "contextMenu" | "spellCheck" | "tabIndex" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocusCapture" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "key"> & import("react").RefAttributes<unknown>>;

package/dist/components/tree-container.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare function TreeContainer(): JSX.Element;