react-arborist 3.10.3 → 3.10.5

package/dist/main/interfaces/tree-api.test.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const redux_1 = require("redux");
 const root_reducer_1 = require("../state/root-reducer");
@@ -38,6 +47,45 @@ describe("tree.drop() fires onMove (#313)", () => {
         expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ parentId: "folder", index: 0 }));
     });
 });
+describe("custom idAccessor is honored when methods receive raw data (#347)", () => {
+    const uuidData = [{ uuid: "a" }, { uuid: "b" }, { uuid: "c" }];
+    test("select(data) resolves the id through idAccessor", () => {
+        const onSelect = jest.fn();
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onSelect });
+        api.select(uuidData[1]);
+        expect(api.selectedIds.has("b")).toBe(true);
+        expect(api.selectedNodes.map((n) => n.id)).toEqual(["b"]);
+    });
+    test("focus(data) resolves the id through idAccessor", () => {
+        var _a;
+        const api = setupApi({ data: uuidData, idAccessor: "uuid" });
+        api.focus(uuidData[2]);
+        expect((_a = api.focusedNode) === null || _a === void 0 ? void 0 : _a.id).toBe("c");
+    });
+    test("delete(data) passes the accessor-derived id to onDelete", () => {
+        const onDelete = jest.fn();
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onDelete });
+        api.delete(uuidData[0]);
+        expect(onDelete).toHaveBeenCalledWith(expect.objectContaining({ ids: ["a"] }));
+    });
+    test("create() focuses the new node by its accessor-derived id", () => __awaiter(void 0, void 0, void 0, function* () {
+        // create() passes the raw row data returned by onCreate straight to
+        // focus/edit/select; before the fix these read `.id` and lost the node.
+        const onCreate = () => ({ uuid: "new" });
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onCreate });
+        yield api.create();
+        expect(api.state.nodes.focus.id).toBe("new");
+    }));
+    test("a function idAccessor is honored too", () => {
+        const fnData = [{ meta: { key: "x" } }, { meta: { key: "y" } }];
+        const api = setupApi({
+            data: fnData,
+            idAccessor: (d) => d.meta.key,
+        });
+        api.select(fnData[1]);
+        expect(api.selectedIds.has("y")).toBe(true);
+    });
+});
 test("rowHeight defaults to 24", () => {
     const api = setupApi({});
     expect(api.rowHeight).toBe(24);

package/dist/main/types/handlers.d.ts

@@ -5,7 +5,7 @@ export type CreateHandler<T> = (args: {
     parentNode: NodeApi<T> | null;
     index: number;
     type: "internal" | "leaf";
-}) => (IdObj | null) | Promise<IdObj | null>;
+}) => (T | IdObj | null) | Promise<T | IdObj | null>;
 export type MoveHandler<T> = (args: {
     dragIds: string[];
     dragNodes: NodeApi<T>[];

package/dist/module/data/simple-tree.d.ts

@@ -1,11 +1,16 @@
-type SimpleData = {
-    id: string;
-    name: string;
-    children?: SimpleData[];
+export type SimpleTreeOptions<T> = {
+    idAccessor?: string | ((d: T) => string);
+    childrenAccessor?: string | ((d: T) => readonly T[] | null | undefined);
+};
+type Accessors<T> = {
+    getId: (data: T) => string;
+    getChildren: (data: T) => readonly T[] | null | undefined;
+    childrenKey: string;
 };
-export declare class SimpleTree<T extends SimpleData> {
+export declare class SimpleTree<T> {
     root: SimpleNode<T>;
-    constructor(data: T[]);
+    private accessors;
+    constructor(data: T[], options?: SimpleTreeOptions<T>);
     get data(): T[];
     create(args: {
         parentId: string | null;
@@ -26,12 +31,13 @@ export declare class SimpleTree<T extends SimpleData> {
     }): void;
     find(id: string, node?: SimpleNode<T>): SimpleNode<T> | null;
 }
-declare class SimpleNode<T extends SimpleData> {
+declare class SimpleNode<T> {
     data: T;
     parent: SimpleNode<T> | null;
+    private accessors;
     id: string;
     children?: SimpleNode<T>[];
-    constructor(data: T, parent: SimpleNode<T> | null);
+    constructor(data: T, parent: SimpleNode<T> | null, accessors: Accessors<T>, id?: string);
     hasParent(): this is this & {
         parent: SimpleNode<T>;
     };

package/dist/module/data/simple-tree.js

@@ -1,6 +1,17 @@
+function resolveAccessors(options = {}) {
+    var _a, _b;
+    const id = (_a = options.idAccessor) !== null && _a !== void 0 ? _a : "id";
+    const children = (_b = options.childrenAccessor) !== null && _b !== void 0 ? _b : "children";
+    return {
+        getId: typeof id === "function" ? id : (data) => data[id],
+        getChildren: typeof children === "function" ? children : (data) => data[children],
+        childrenKey: typeof children === "string" ? children : "children",
+    };
+}
 export class SimpleTree {
-    constructor(data) {
-        this.root = createRoot(data);
+    constructor(data, options = {}) {
+        this.accessors = resolveAccessors(options);
+        this.root = createRoot(data, this.accessors);
     }
     get data() {
         var _a, _b;
@@ -46,22 +57,27 @@ export class SimpleTree {
         return null;
     }
 }
-function createRoot(data) {
-    const root = new SimpleNode({ id: "ROOT" }, null);
-    root.children = data.map((d) => createNode(d, root));
+function createRoot(data, accessors) {
+    // The synthetic root has no real data, so it gets an explicit id rather than
+    // running the user's accessor on `{}` — a function accessor that reaches into
+    // the data (e.g. `d => d.meta.id`) would otherwise throw during construction.
+    const root = new SimpleNode({}, null, accessors, "ROOT");
+    root.children = data.map((d) => createNode(d, root, accessors));
     return root;
 }
-function createNode(data, parent) {
-    const node = new SimpleNode(data, parent);
-    if (data.children)
-        node.children = data.children.map((d) => createNode(d, node));
+function createNode(data, parent, accessors) {
+    const node = new SimpleNode(data, parent, accessors);
+    const children = accessors.getChildren(data);
+    if (children)
+        node.children = children.map((d) => createNode(d, node, accessors));
     return node;
 }
 class SimpleNode {
-    constructor(data, parent) {
+    constructor(data, parent, accessors, id) {
         this.data = data;
         this.parent = parent;
-        this.id = data.id;
+        this.accessors = accessors;
+        this.id = id !== null && id !== void 0 ? id : accessors.getId(data);
     }
     hasParent() {
         return !!this.parent;
@@ -71,16 +87,19 @@ class SimpleNode {
     }
     addChild(data, index) {
         var _a, _b;
-        const node = createNode(data, this);
+        const node = createNode(data, this, this.accessors);
         this.children = (_a = this.children) !== null && _a !== void 0 ? _a : [];
         this.children.splice(index, 0, node);
-        this.data.children = (_b = this.data.children) !== null && _b !== void 0 ? _b : [];
-        this.data.children.splice(index, 0, data);
+        const key = this.accessors.childrenKey;
+        const raw = this.data;
+        raw[key] = (_b = raw[key]) !== null && _b !== void 0 ? _b : [];
+        raw[key].splice(index, 0, data);
     }
     removeChild(index) {
         var _a, _b;
         (_a = this.children) === null || _a === void 0 ? void 0 : _a.splice(index, 1);
-        (_b = this.data.children) === null || _b === void 0 ? void 0 : _b.splice(index, 1);
+        const raw = this.data;
+        (_b = raw[this.accessors.childrenKey]) === null || _b === void 0 ? void 0 : _b.splice(index, 1);
     }
     update(changes) {
         if (this.hasParent()) {

package/dist/module/data/simple-tree.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/module/data/simple-tree.test.js

@@ -0,0 +1,61 @@
+import { SimpleTree } from "./simple-tree";
+describe("SimpleTree with default accessors", () => {
+    const data = () => [
+        { id: "1", name: "a", children: [{ id: "1a", name: "a-child" }] },
+        { id: "2", name: "b" },
+    ];
+    test("finds nodes by id, including nested ones", () => {
+        var _a, _b;
+        const tree = new SimpleTree(data());
+        expect((_a = tree.find("2")) === null || _a === void 0 ? void 0 : _a.data.name).toBe("b");
+        expect((_b = tree.find("1a")) === null || _b === void 0 ? void 0 : _b.data.name).toBe("a-child");
+    });
+    test("moves a node into a folder", () => {
+        const tree = new SimpleTree(data());
+        tree.move({ id: "2", parentId: "1", index: 1 });
+        expect(tree.data[0].children.map((c) => c.id)).toEqual(["1a", "2"]);
+        expect(tree.data).toHaveLength(1);
+    });
+});
+describe("SimpleTree honors custom accessors (issue #73, #170)", () => {
+    // Custom keys: `uuid` for the id, `elements` for the children.
+    const data = () => [
+        { uuid: "1", name: "a", elements: [{ uuid: "1a", name: "a-child" }] },
+        { uuid: "2", name: "b" },
+    ];
+    function tree() {
+        return new SimpleTree(data(), { idAccessor: "uuid", childrenAccessor: "elements" });
+    }
+    test("finds nodes by the custom id key, including nested ones", () => {
+        var _a, _b;
+        const t = tree();
+        expect((_a = t.find("2")) === null || _a === void 0 ? void 0 : _a.data.name).toBe("b");
+        expect((_b = t.find("1a")) === null || _b === void 0 ? void 0 : _b.data.name).toBe("a-child"); // read through `elements`
+    });
+    test("reorders a node, writing children back under the custom key (#170)", () => {
+        const t = tree();
+        t.move({ id: "2", parentId: "1", index: 1 });
+        expect(t.data).toHaveLength(1);
+        expect(t.data[0].elements.map((c) => c.uuid)).toEqual(["1a", "2"]);
+    });
+    test("moving a node with children into a childless node keeps its children (#73)", () => {
+        const t = tree();
+        // Put node "1" (which has children) inside node "2" (which has none).
+        t.move({ id: "1", parentId: "2", index: 0 });
+        expect(t.data.map((n) => n.uuid)).toEqual(["2"]);
+        const moved = t.find("1");
+        expect(moved === null || moved === void 0 ? void 0 : moved.data.elements.map((c) => c.uuid)).toEqual(["1a"]);
+    });
+    test("supports a function idAccessor", () => {
+        var _a;
+        const t = new SimpleTree(data(), { idAccessor: (d) => d.uuid, childrenAccessor: "elements" });
+        expect((_a = t.find("1a")) === null || _a === void 0 ? void 0 : _a.data.name).toBe("a-child");
+        t.move({ id: "2", parentId: "1", index: 1 });
+        expect(t.data[0].elements.map((c) => c.uuid)).toEqual(["1a", "2"]);
+    });
+    test("a function idAccessor that reaches into the data doesn't throw on construction", () => {
+        const nested = [{ meta: { id: "x" }, name: "x" }];
+        // The synthetic root must not run this accessor on its empty data.
+        expect(() => new SimpleTree(nested, { idAccessor: (d) => d.meta.id })).not.toThrow();
+    });
+});

package/dist/module/hooks/use-simple-tree.d.ts

@@ -1,10 +1,11 @@
+import { SimpleTreeOptions } from "../data/simple-tree";
 import { CreateHandler, DeleteHandler, MoveHandler, RenameHandler } from "../types/handlers";
 export type SimpleTreeData = {
     id: string;
     name: string;
     children?: SimpleTreeData[];
 };
-export declare function useSimpleTree<T>(initialData: readonly T[]): readonly [readonly T[], {
+export declare function useSimpleTree<T>(initialData: readonly T[], options?: SimpleTreeOptions<T>): readonly [readonly T[], {
     onMove: MoveHandler<T>;
     onRename: RenameHandler<T>;
     onCreate: CreateHandler<T>;

package/dist/module/hooks/use-simple-tree.js

@@ -1,9 +1,11 @@
 import { useMemo, useState } from "react";
 import { SimpleTree } from "../data/simple-tree";
 let nextId = 0;
-export function useSimpleTree(initialData) {
+export function useSimpleTree(initialData, options = {}) {
     const [data, setData] = useState(initialData);
-    const tree = useMemo(() => new SimpleTree(data), [data]);
+    const idAccessor = options.idAccessor;
+    const childrenAccessor = options.childrenAccessor;
+    const tree = useMemo(() => new SimpleTree(data, { idAccessor, childrenAccessor }), [data, idAccessor, childrenAccessor]);
     const onMove = (args) => {
         for (const id of args.dragIds) {
             tree.move({ id, parentId: args.parentId, index: args.index });
@@ -14,10 +16,23 @@ export function useSimpleTree(initialData) {
         tree.update({ id, changes: { name } });
         setData(tree.data);
     };
+    // New nodes must carry their id/children under the same keys the accessors
+    // read, or the controller (and the tree's own accessId) can't find them
+    // afterward (issue #73). A function accessor can't be inverted to a writable
+    // key, so node creation with one isn't supportable — fail fast instead of
+    // returning a node that throws deeper in the tree.
+    const idKey = typeof idAccessor === "string" ? idAccessor : "id";
+    const childrenKey = typeof childrenAccessor === "string" ? childrenAccessor : "children";
     const onCreate = ({ parentId, index, type }) => {
-        const data = { id: `simple-tree-id-${nextId++}`, name: "" };
+        if (typeof idAccessor === "function") {
+            throw new Error(`React Arborist => initialData can't create nodes when idAccessor is a function: the generated id can't be written under a key the accessor reads. Use a string idAccessor, or the controlled \`data\` prop with your own onCreate.`);
+        }
+        if (type === "internal" && typeof childrenAccessor === "function") {
+            throw new Error(`React Arborist => initialData can't create folder nodes when childrenAccessor is a function: the new children array can't be written under a key the accessor reads. Use a string childrenAccessor, or the controlled \`data\` prop with your own onCreate.`);
+        }
+        const data = { [idKey]: `simple-tree-id-${nextId++}`, name: "" };
         if (type === "internal")
-            data.children = [];
+            data[childrenKey] = [];
         tree.create({ parentId, index, data });
         setData(tree.data);
         return data;

package/dist/module/hooks/use-simple-tree.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/module/hooks/use-simple-tree.test.js

@@ -0,0 +1,30 @@
+import { act, renderHook } from "@testing-library/react";
+import { useSimpleTree } from "./use-simple-tree";
+/* onCreate has to write a new node's id (and a folder's children) under a key
+   the accessors will read back. A function accessor can't be inverted to a key,
+   so creation with one must fail fast rather than return an unusable node
+   (issue #73 review follow-up). */
+describe("useSimpleTree onCreate guards function accessors", () => {
+    function controllerFor(data, options) {
+        const { result } = renderHook(() => useSimpleTree(data, options));
+        return result.current[1];
+    }
+    const create = { parentId: null, parentNode: null, index: 0 };
+    test("throws when idAccessor is a function", () => {
+        const controller = controllerFor([{ uuid: "1", name: "a" }], { idAccessor: (d) => d.uuid });
+        expect(() => controller.onCreate(Object.assign(Object.assign({}, create), { type: "leaf" }))).toThrow(/idAccessor is a function/);
+    });
+    test("throws when creating a folder with a function childrenAccessor", () => {
+        const controller = controllerFor([{ id: "1", name: "a" }], {
+            childrenAccessor: (d) => d.kids,
+        });
+        expect(() => controller.onCreate(Object.assign(Object.assign({}, create), { type: "internal" }))).toThrow(/childrenAccessor is a function/);
+    });
+    test("a leaf can still be created when only childrenAccessor is a function", () => {
+        const controller = controllerFor([{ id: "1", name: "a" }], {
+            childrenAccessor: (d) => d.kids,
+        });
+        // onCreate calls setData, so run it inside act to keep the suite warning-clean.
+        expect(() => act(() => void controller.onCreate(Object.assign(Object.assign({}, create), { type: "leaf" })))).not.toThrow();
+    });
+});

package/dist/module/hooks/use-validated-props.js

@@ -15,7 +15,10 @@ Use the data prop if you want to provide your own handlers.`);
          *
          * We will provide the real data and the handlers to update it.
          *   */
-        const [data, controller] = useSimpleTree(props.initialData);
+        const [data, controller] = useSimpleTree(props.initialData, {
+            idAccessor: props.idAccessor,
+            childrenAccessor: props.childrenAccessor,
+        });
         return Object.assign(Object.assign(Object.assign({}, props), controller), { data });
     }
     else {

package/dist/module/interfaces/tree-api.d.ts

@@ -149,6 +149,19 @@ export declare class TreeApi<T> {
     get matchFn(): (node: NodeApi<T>) => boolean;
     accessChildren(data: T): readonly T[] | null;
     accessId(data: T): string;
+    /**
+     * Resolve an identifier to a node id. Public methods accept an id string, a
+     * NodeApi, or the raw row data; this is the one place that turns any of those
+     * into the string id used internally. Raw data is run through the configured
+     * `idAccessor` so a custom accessor (e.g. `uuid`) is honored everywhere, not
+     * just where nodes were built. A NodeApi already carries its accessor-derived
+     * `id`, so it is used directly rather than re-accessed (the accessor reads the
+     * underlying data, which a NodeApi does not expose under that key). Unlike
+     * `accessId`, an unresolved id comes back as `undefined` rather than throwing,
+     * preserving the previous behavior of the `id`-only lookup.
+     */
+    identify(identity: string | IdObj | T): string;
+    identifyNull(identity: Identity | T): string | null;
     get firstNode(): NodeApi<T>;
     get lastNode(): NodeApi<T>;
     get focusedNode(): NodeApi<T> | null;
@@ -158,7 +171,7 @@ export declare class TreeApi<T> {
     get(id: string | null): NodeApi<T> | null;
     at(index: number): NodeApi<T> | null;
     nodesBetween(startId: string | null, endId: string | null): NodeApi<T>[];
-    indexOf(id: Identity): number | null;
+    indexOf(id: Identity | T): number | null;
     get editingId(): string | null;
     createInternal(): Promise<void>;
     createLeaf(): Promise<void>;
@@ -167,36 +180,36 @@ export declare class TreeApi<T> {
         parentId?: null | string;
         index?: null | number;
     }): Promise<void>;
-    delete(node: Identity | string[] | IdObj[]): Promise<void>;
-    edit(node: string | IdObj): Promise<EditResult>;
-    submit(identity: Identity, value: string): Promise<void>;
+    delete(node: Identity | T | (string | IdObj | T)[]): Promise<void>;
+    edit(node: string | IdObj | T): Promise<EditResult>;
+    submit(identity: Identity | T, value: string): Promise<void>;
     reset(): void;
-    activate(id: Identity): void;
+    activate(id: Identity | T): void;
     private resolveEdit;
     get selectedIds(): Set<string>;
     get selectedNodes(): NodeApi<T>[];
-    focus(node: Identity, opts?: {
+    focus(node: Identity | T, opts?: {
         scroll?: boolean;
     }): void;
     pageUp(): void;
     pageDown(): void;
-    select(node: Identity, opts?: {
+    select(node: Identity | T, opts?: {
         align?: Align;
         focus?: boolean;
     }): void;
-    deselect(node: Identity): void;
-    selectMulti(identity: Identity, opts?: {
+    deselect(node: Identity | T): void;
+    selectMulti(identity: Identity | T, opts?: {
         align?: Align;
         focus?: boolean;
     }): void;
-    selectContiguous(identity: Identity): void;
+    selectContiguous(identity: Identity | T): void;
     deselectAll(): void;
     selectAll(): void;
     private filterSelectableNodes;
     setSelection(args: {
-        ids: (IdObj | string)[] | null;
-        anchor: Identity;
-        mostRecent: Identity;
+        ids: (IdObj | string | T)[] | null;
+        anchor: Identity | T;
+        mostRecent: Identity | T;
     }): void;
     get cursorParentId(): string | null;
     get cursorOverFolder(): boolean;
@@ -208,14 +221,14 @@ export declare class TreeApi<T> {
     drop(): void;
     hideCursor(): void;
     showCursor(cursor: Cursor): void;
-    open(identity: Identity, redraw?: boolean): void;
-    close(identity: Identity, redraw?: boolean): void;
-    toggle(identity: Identity): void;
-    openParents(identity: Identity): void;
+    open(identity: Identity | T, redraw?: boolean): void;
+    close(identity: Identity | T, redraw?: boolean): void;
+    toggle(identity: Identity | T): void;
+    openParents(identity: Identity | T): void;
     openSiblings(node: NodeApi<T>): void;
     openAll(): void;
     closeAll(): void;
-    scrollTo(identity: Identity, align?: Align): Promise<void> | undefined;
+    scrollTo(identity: Identity | T, align?: Align): Promise<void> | undefined;
     get isEditing(): boolean;
     get isFiltered(): boolean;
     get hasFocus(): boolean;
@@ -228,10 +241,10 @@ export declare class TreeApi<T> {
     isDraggable(data: T): boolean;
     isSelectable(data: T): boolean;
     private isActionPossible;
-    isDragging(node: Identity): boolean;
+    isDragging(node: Identity | T): boolean;
     isFocused(id: string): boolean;
     isMatch(node: NodeApi<T>): boolean;
-    willReceiveDrop(node: Identity): boolean;
+    willReceiveDrop(node: Identity | T): boolean;
     onFocus(): void;
     onBlur(): void;
     onItemsRendered(args: ListOnItemsRenderedProps): void;