@headless-tree/core 1.2.1 → 1.3.0

package/lib/esm/test-utils/test-tree.js

@@ -1,203 +0,0 @@
-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());
-    });
-};
-/* eslint-disable import/no-extraneous-dependencies */
-import { beforeEach, describe, vi } from "vitest";
-import { createTree } from "../core/create-tree";
-import { TestTreeDo } from "./test-tree-do";
-import { TestTreeExpect } from "./test-tree-expect";
-import { syncDataLoaderFeature } from "../features/sync-data-loader/feature";
-import { asyncDataLoaderFeature } from "../features/async-data-loader/feature";
-import { buildProxiedInstance } from "../core/build-proxified-instance";
-vi.useFakeTimers({ shouldAdvanceTime: true });
-export class TestTree {
-    forSuits(runSuite) {
-        describe.for([
-            this.suits.sync(),
-            this.suits.async(),
-            this.suits.proxifiedSync(),
-            this.suits.proxifiedAsync(),
-        ])("$title", ({ tree }) => {
-            tree.resetBeforeEach();
-            runSuite(tree);
-        });
-    }
-    get instance() {
-        if (!this.treeInstance) {
-            this.treeInstance = createTree(this.config);
-            this.treeInstance.rebuildTree();
-        }
-        return this.treeInstance;
-    }
-    constructor(config) {
-        this.config = config;
-        this.do = new TestTreeDo(this);
-        this.expect = new TestTreeExpect(this);
-        this.treeInstance = null;
-        this.asyncDataLoaderImp = {
-            getItem: (id) => __awaiter(this, void 0, void 0, function* () {
-                yield new Promise((r) => {
-                    r.debugName = `Loading getItem ${id}`;
-                    TestTree.asyncLoaderResolvers.push(r);
-                });
-                return id;
-            }),
-            getChildren: (id) => __awaiter(this, void 0, void 0, function* () {
-                yield new Promise((r) => {
-                    r.debugName = `Loading getChildren ${id}`;
-                    TestTree.asyncLoaderResolvers.push(r);
-                });
-                return [`${id}1`, `${id}2`, `${id}3`, `${id}4`];
-            }),
-        };
-        this.suits = {
-            sync: () => ({
-                tree: this.withFeatures(syncDataLoaderFeature),
-                title: "Synchronous Data Loader",
-            }),
-            async: () => ({
-                tree: this.withFeatures(asyncDataLoaderFeature).with({
-                    dataLoader: this.asyncDataLoaderImp,
-                }),
-                title: "Asynchronous Data Loader",
-            }),
-            proxifiedSync: () => ({
-                tree: this.withFeatures(syncDataLoaderFeature).with({
-                    instanceBuilder: buildProxiedInstance,
-                }),
-                title: "Proxified Synchronous Data Loader",
-            }),
-            proxifiedAsync: () => ({
-                tree: this.withFeatures(asyncDataLoaderFeature).with({
-                    instanceBuilder: buildProxiedInstance,
-                }),
-                title: "Proxified Asynchronous Data Loader",
-            }),
-        };
-    }
-    static resolveAsyncLoaders() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            do {
-                (_a = TestTree.asyncLoaderResolvers.shift()) === null || _a === void 0 ? void 0 : _a();
-                yield new Promise((r) => {
-                    setTimeout(r);
-                });
-            } while (TestTree.asyncLoaderResolvers.length);
-        });
-    }
-    resolveAsyncVisibleItems() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.instance.getItems();
-            yield TestTree.resolveAsyncLoaders();
-            this.instance.getItems().forEach((i) => i.getItemName());
-            yield TestTree.resolveAsyncLoaders();
-        });
-    }
-    static default(config) {
-        return new TestTree(Object.assign({ rootItemId: "x", createLoadingItemData: () => "loading", dataLoader: {
-                getItem: (id) => id,
-                getChildren: (id) => [`${id}1`, `${id}2`, `${id}3`, `${id}4`],
-            }, getItemName: (item) => item.getItemData(), indent: 20, isItemFolder: (item) => item.getItemMeta().level < 2, initialState: {
-                expandedItems: ["x1", "x11"],
-            }, features: [] }, config));
-    }
-    with(config) {
-        return new TestTree(Object.assign(Object.assign({}, this.config), config));
-    }
-    resetBeforeEach() {
-        beforeEach(() => __awaiter(this, void 0, void 0, function* () {
-            yield this.createTestCaseTree();
-        }));
-    }
-    createTestCaseTree() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.reset();
-            vi.clearAllMocks();
-            // trigger instance creation
-            // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-            this.instance;
-            yield this.resolveAsyncVisibleItems();
-            return this;
-        });
-    }
-    withFeatures(...features) {
-        var _a;
-        return this.with({
-            features: [...((_a = this.config.features) !== null && _a !== void 0 ? _a : []), ...features],
-        });
-    }
-    mockedHandler(handlerName) {
-        var _a;
-        const mock = vi.fn();
-        if (this.treeInstance) {
-            (_a = this.treeInstance) === null || _a === void 0 ? void 0 : _a.setConfig((prev) => (Object.assign(Object.assign({}, prev), { [handlerName]: mock })));
-        }
-        else {
-            this.config[handlerName] = mock;
-        }
-        return mock;
-    }
-    item(itemId) {
-        return this.instance.getItemInstance(itemId);
-    }
-    reset() {
-        this.treeInstance = null;
-        TestTree.asyncLoaderResolvers = [];
-    }
-    debug() {
-        console.log(this.instance
-            .getItems()
-            .map((item) => [
-            "  ".repeat(item.getItemMeta().level),
-            '"',
-            item.getItemName(),
-            '"',
-        ].join(""))
-            .join("\n"));
-    }
-    setElementBoundingBox(itemId, bb = {
-        left: 0,
-        width: 100,
-        top: 0,
-        height: 20,
-    }) {
-        this.instance.registerElement({
-            getBoundingClientRect: () => ({
-                left: 0,
-                width: 100,
-                top: 0,
-                height: 10000,
-            }),
-        });
-        this.instance.getItemInstance(itemId).registerElement({
-            getBoundingClientRect: () => bb,
-        });
-    }
-    static dragEvent(clientX = 1000, clientY = 0) {
-        return {
-            preventDefault: vi.fn(),
-            stopPropagation: vi.fn(),
-            dataTransfer: {
-                setData: vi.fn(),
-                getData: vi.fn(),
-                dropEffect: "unchaged-from-test",
-            },
-            clientX,
-            clientY,
-        };
-    }
-    createTopDragEvent(indent = 0) {
-        return TestTree.dragEvent(indent * 20, 1);
-    }
-    createBottomDragEvent(indent = 0) {
-        return TestTree.dragEvent(indent * 20, 19);
-    }
-}
-TestTree.asyncLoaderResolvers = [];

package/lib/esm/types/core.d.ts

@@ -1,84 +0,0 @@
-import { DragAndDropFeatureDef } from "../features/drag-and-drop/types";
-import { MainFeatureDef } from "../features/main/types";
-import { SelectionFeatureDef } from "../features/selection/types";
-import { TreeFeatureDef } from "../features/tree/types";
-import { HotkeyConfig, HotkeysCoreFeatureDef } from "../features/hotkeys-core/types";
-import { SyncDataLoaderFeatureDef } from "../features/sync-data-loader/types";
-import { AsyncDataLoaderFeatureDef } from "../features/async-data-loader/types";
-import { SearchFeatureDef } from "../features/search/types";
-import { RenamingFeatureDef } from "../features/renaming/types";
-import { ExpandAllFeatureDef } from "../features/expand-all/types";
-import { PropMemoizationFeatureDef } from "../features/prop-memoization/types";
-import { KeyboardDragAndDropFeatureDef } from "../features/keyboard-drag-and-drop/types";
-import { CheckboxesFeatureDef } from "../features/checkboxes/types";
-export type Updater<T> = T | ((old: T) => T);
-export type SetStateFn<T> = (updaterOrValue: Updater<T>) => void;
-export type FeatureDef = {
-    state: any;
-    config: any;
-    treeInstance: any;
-    itemInstance: any;
-    hotkeys: string;
-};
-export type EmptyFeatureDef = {
-    state: {};
-    config: {};
-    treeInstance: {};
-    itemInstance: {};
-    hotkeys: never;
-};
-type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
-type MergedFeatures<F extends FeatureDef> = {
-    state: UnionToIntersection<F["state"]>;
-    config: UnionToIntersection<F["config"]>;
-    treeInstance: UnionToIntersection<F["treeInstance"]>;
-    itemInstance: UnionToIntersection<F["itemInstance"]>;
-    hotkeys: F["hotkeys"];
-};
-export type RegisteredFeatures<T> = MainFeatureDef<T> | TreeFeatureDef<T> | SelectionFeatureDef<T> | CheckboxesFeatureDef<T> | DragAndDropFeatureDef<T> | KeyboardDragAndDropFeatureDef<T> | HotkeysCoreFeatureDef<T> | SyncDataLoaderFeatureDef<T> | AsyncDataLoaderFeatureDef<T> | SearchFeatureDef<T> | RenamingFeatureDef<T> | ExpandAllFeatureDef | PropMemoizationFeatureDef;
-type TreeStateType<T> = MergedFeatures<RegisteredFeatures<T>>["state"];
-export interface TreeState<T> extends TreeStateType<T> {
-}
-type TreeConfigType<T> = MergedFeatures<RegisteredFeatures<T>>["config"];
-export interface TreeConfig<T> extends TreeConfigType<T> {
-}
-type TreeInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["treeInstance"];
-export interface TreeInstance<T> extends TreeInstanceType<T> {
-}
-type ItemInstanceType<T> = MergedFeatures<RegisteredFeatures<T>>["itemInstance"];
-export interface ItemInstance<T> extends ItemInstanceType<T> {
-}
-export type HotkeyName = MergedFeatures<RegisteredFeatures<any>>["hotkeys"];
-export type HotkeysConfig<T> = Record<HotkeyName, HotkeyConfig<T>>;
-export type CustomHotkeysConfig<T> = Partial<Record<HotkeyName | `custom${string}`, Partial<HotkeyConfig<T>>>>;
-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>;
-    itemId: string;
-    prev?: MayReturnNull<ItemInstance<any>[Key]>;
-};
-export type TreeInstanceOpts<Key extends keyof TreeInstance<any>> = {
-    tree: TreeInstance<any>;
-    prev?: MayReturnNull<TreeInstance<any>[Key]>;
-};
-export type FeatureImplementation<T = any> = {
-    key?: string;
-    deps?: string[];
-    overwrites?: string[];
-    stateHandlerNames?: Partial<Record<keyof TreeState<T>, keyof TreeConfig<T>>>;
-    getInitialState?: (initialState: Partial<TreeState<T>>, tree: TreeInstance<T>) => Partial<TreeState<T>>;
-    getDefaultConfig?: (defaultConfig: Partial<TreeConfig<T>>, tree: TreeInstance<T>) => Partial<TreeConfig<T>>;
-    treeInstance?: {
-        [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;
-    };
-    onTreeMount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
-    onTreeUnmount?: (instance: TreeInstance<T>, treeElement: HTMLElement) => void;
-    onItemMount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
-    onItemUnmount?: (instance: ItemInstance<T>, itemElement: HTMLElement, tree: TreeInstance<T>) => void;
-    hotkeys?: Partial<HotkeysConfig<T>>;
-};
-export {};

package/lib/esm/types/core.js

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

package/lib/esm/types/deep-merge.d.ts

@@ -1,13 +0,0 @@
-type TAllKeys<T> = T extends any ? keyof T : never;
-type TIndexValue<T, K extends PropertyKey, D = never> = T extends any ? K extends keyof T ? T[K] : D : never;
-type TPartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>> extends infer O ? {
-    [P in keyof O]: O[P];
-} : never;
-type TFunction = (...a: any[]) => any;
-type TPrimitives = string | number | boolean | bigint | symbol | Date | TFunction;
-export type TMerged<T> = [T] extends [Array<any>] ? {
-    [K in keyof T]: TMerged<T[K]>;
-} : [T] extends [TPrimitives] ? T : [T] extends [object] ? TPartialKeys<{
-    [K in TAllKeys<T>]: TMerged<TIndexValue<T, K>>;
-}, never> : T;
-export {};

package/lib/esm/types/deep-merge.js

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

package/lib/esm/utilities/create-on-drop-handler.d.ts

@@ -1,3 +0,0 @@
-import { ItemInstance } from "../types/core";
-import { DragTarget } from "../features/drag-and-drop/types";
-export declare const createOnDropHandler: <T>(onChangeChildren: (item: ItemInstance<T>, newChildren: string[]) => void) => (items: ItemInstance<T>[], target: DragTarget<T>) => Promise<void>;

package/lib/esm/utilities/create-on-drop-handler.js

@@ -1,16 +0,0 @@
-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());
-    });
-};
-import { removeItemsFromParents } from "./remove-items-from-parents";
-import { insertItemsAtTarget } from "./insert-items-at-target";
-export const createOnDropHandler = (onChangeChildren) => (items, target) => __awaiter(void 0, void 0, void 0, function* () {
-    const itemIds = items.map((item) => item.getId());
-    yield removeItemsFromParents(items, onChangeChildren);
-    yield insertItemsAtTarget(itemIds, target, onChangeChildren);
-});

package/lib/esm/utilities/errors.d.ts

@@ -1,2 +0,0 @@
-export declare const throwError: (message: string) => Error;
-export declare const logWarning: (message: string) => void;

package/lib/esm/utilities/errors.js

@@ -1,4 +0,0 @@
-const prefix = "Headless Tree: ";
-export const throwError = (message) => Error(prefix + message);
-// eslint-disable-next-line no-console
-export const logWarning = (message) => console.warn(prefix + message);

package/lib/esm/utilities/insert-items-at-target.d.ts

@@ -1,3 +0,0 @@
-import { ItemInstance } from "../types/core";
-import { DragTarget } from "../features/drag-and-drop/types";
-export declare const insertItemsAtTarget: <T>(itemIds: string[], target: DragTarget<T>, onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => Promise<void> | void) => Promise<void>;

package/lib/esm/utilities/insert-items-at-target.js

@@ -1,36 +0,0 @@
-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());
-    });
-};
-export const insertItemsAtTarget = (itemIds, target, onChangeChildren) => __awaiter(void 0, void 0, void 0, function* () {
-    yield target.item.getTree().waitForItemChildrenLoaded(target.item.getId());
-    const oldChildrenIds = target.item
-        .getTree()
-        .retrieveChildrenIds(target.item.getId());
-    // add moved items to new common parent, if dropped onto parent
-    if (!("childIndex" in target)) {
-        const newChildren = [...oldChildrenIds, ...itemIds];
-        yield onChangeChildren(target.item, newChildren);
-        if (target.item && "updateCachedChildrenIds" in target.item) {
-            target.item.updateCachedChildrenIds(newChildren);
-        }
-        target.item.getTree().rebuildTree();
-        return;
-    }
-    // add moved items to new common parent, if dropped between siblings
-    const newChildren = [
-        ...oldChildrenIds.slice(0, target.insertionIndex),
-        ...itemIds,
-        ...oldChildrenIds.slice(target.insertionIndex),
-    ];
-    yield onChangeChildren(target.item, newChildren);
-    if (target.item && "updateCachedChildrenIds" in target.item) {
-        target.item.updateCachedChildrenIds(newChildren);
-    }
-    target.item.getTree().rebuildTree();
-});

package/lib/esm/utilities/remove-items-from-parents.d.ts

@@ -1,2 +0,0 @@
-import { ItemInstance } from "../types/core";
-export declare const removeItemsFromParents: <T>(movedItems: ItemInstance<T>[], onChangeChildren: (item: ItemInstance<T>, newChildrenIds: string[]) => void | Promise<void>) => Promise<void>;

package/lib/esm/utilities/remove-items-from-parents.js

@@ -1,28 +0,0 @@
-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());
-    });
-};
-export const removeItemsFromParents = (movedItems, onChangeChildren) => __awaiter(void 0, void 0, void 0, function* () {
-    const movedItemsIds = movedItems.map((item) => item.getId());
-    const uniqueParents = [
-        ...new Set(movedItems.map((item) => item.getParent())),
-    ];
-    for (const parent of uniqueParents) {
-        const siblings = parent === null || parent === void 0 ? void 0 : parent.getChildren();
-        if (siblings && parent) {
-            const newChildren = siblings
-                .filter((sibling) => !movedItemsIds.includes(sibling.getId()))
-                .map((i) => i.getId());
-            yield onChangeChildren(parent, newChildren);
-            if (parent && "updateCachedChildrenIds" in parent) {
-                parent === null || parent === void 0 ? void 0 : parent.updateCachedChildrenIds(newChildren);
-            }
-        }
-    }
-    movedItems[0].getTree().rebuildTree();
-});

package/lib/esm/utils.d.ts

@@ -1,6 +0,0 @@
-import { SetStateFn, TreeState, Updater } from "./types/core";
-export type NoInfer<T> = [T][T extends any ? 0 : never];
-export declare const memo: <D extends readonly any[], P extends readonly any[], R>(deps: (...args: [...P]) => [...D], fn: (...args: [...D]) => R) => (...a: P) => R;
-export declare function functionalUpdate<T>(updater: Updater<T>, input: T): T;
-export declare function makeStateUpdater<K extends keyof TreeState<any>>(key: K, instance: unknown): SetStateFn<TreeState<any>[K]>;
-export declare const poll: (fn: () => boolean, interval?: number, timeout?: number) => Promise<void>;

package/lib/esm/utils.js

@@ -1,46 +0,0 @@
-export const memo = (deps, fn) => {
-    let value;
-    let oldDeps = null;
-    return (...a) => {
-        const newDeps = deps(...a);
-        if (!value) {
-            value = fn(...newDeps);
-            oldDeps = newDeps;
-            return value;
-        }
-        const match = oldDeps &&
-            oldDeps.length === newDeps.length &&
-            !oldDeps.some((dep, i) => dep !== newDeps[i]);
-        if (match) {
-            return value;
-        }
-        value = fn(...newDeps);
-        oldDeps = newDeps;
-        return value;
-    };
-};
-export function functionalUpdate(updater, input) {
-    return typeof updater === "function"
-        ? updater(input)
-        : updater;
-}
-export function makeStateUpdater(key, instance) {
-    return (updater) => {
-        instance.setState((old) => {
-            return Object.assign(Object.assign({}, old), { [key]: functionalUpdate(updater, old[key]) });
-        });
-    };
-}
-export const poll = (fn, interval = 100, timeout = 1000) => new Promise((resolve) => {
-    let clear;
-    const i = setInterval(() => {
-        if (fn()) {
-            resolve();
-            clearInterval(i);
-            clearTimeout(clear);
-        }
-    }, interval);
-    clear = setTimeout(() => {
-        clearInterval(i);
-    }, timeout);
-});