@elliemae/ds-tree-model 3.14.0-next.16 → 3.14.0-next.17

package/dist/types/DSTree.d.ts

@@ -0,0 +1,28 @@
+import type { AddOptions, Item, MoveOptions, MutateOptions, RemoveOptions } from './types';
+import { Node } from './Node';
+export declare class DSTree<T extends Item> {
+    private root;
+    private _hash;
+    private nodes;
+    getUniqueId: (item: T) => string;
+    constructor(item: T, options: {
+        getUniqueId: (item: T) => string;
+    });
+    addNodeToNodesDictionary(node: Node<T>): void;
+    removeNodeFromNodesDictionary(node: Node<T>): void;
+    get hash(): number;
+    getRoot: () => Node<T>;
+    getNode: (id: string) => Node<T>;
+    getNodes: () => Record<string, Node<T>>;
+    walk: (callback: (node: Node<T>) => boolean) => void;
+    walkParents: (callback: (node: Node<T>) => boolean) => void;
+    findNode: (callback: (node: Node<T>) => boolean) => Node<T> | null;
+    findAllNodes: (callback: (node: Node<T>) => boolean) => Node<T>[];
+    flatten: () => Node<T>[];
+    addNode: (item: T, options?: AddOptions<T>) => Node<T>;
+    removeNode: (id: string, options?: RemoveOptions<T>) => Node<T>;
+    moveNode: (id: string, options?: MoveOptions<T>) => Node<T>;
+    replaceNode: (id: string, item: T, options?: MutateOptions<T>) => Node<T>;
+    getPath: (id: string) => Node<T>[];
+    getPathIds: (id: string) => string[];
+}

package/dist/types/Node.d.ts

@@ -0,0 +1,25 @@
+import type { Item, NodeConstructorOptions } from './types';
+export declare class Node<T extends Item> {
+    dsId: string;
+    plainItem: T;
+    childIndex: number;
+    depth: number;
+    parent: Node<T> | null;
+    children: Node<T>[];
+    private tree;
+    private _hash;
+    constructor(item: T, { childIndex, depth, parent, tree }: NodeConstructorOptions<T>);
+    fixChildIndexes: () => void;
+    getCleanItem: (item: T) => T;
+    get hash(): number;
+    walk: (callback: (node: Node<T>) => boolean) => void;
+    walkParents: (callback: (node: Node<T>) => boolean) => void;
+    findNode: (callback: (node: Node<T>) => boolean) => Node<T> | null;
+    findAllNodes: (callback: (node: Node<T>) => boolean) => Node<T>[];
+    flatten: () => Node<T>[];
+    getPath: (id: string) => Node<T>[];
+    getPathIds: (id: string) => string[];
+    getJson: () => T;
+    addNode: (node: Node<T>) => void;
+    removeNode: () => void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export type { Item } from './types';
+export { DSTree } from './DSTree';
+export { useDSTree } from './useDSTree';

package/dist/types/tests/model.read.test.d.ts

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

package/dist/types/tests/model.write.test.d.ts

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

package/dist/types/tests/tree.read.test.d.ts

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

package/dist/types/tests/tree.write.test.d.ts

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

package/dist/types/types.d.ts

@@ -0,0 +1,27 @@
+import type { DSTree } from './DSTree';
+import type { Node } from './Node';
+export interface Item {
+    subitems?: Item[];
+}
+export interface NodeConstructorOptions<T extends Item> {
+    childIndex: number;
+    depth: number;
+    tree: DSTree<T>;
+    parent?: Node<T> | null;
+}
+export interface AddOptions<T extends Item> {
+    position?: number;
+    parent?: Node<T> | null;
+    callback?: (node: Node<T>, tree: DSTree<T>) => void;
+}
+export interface RemoveOptions<T extends Item> {
+    callback?: (node: Node<T>, tree: DSTree<T>) => void;
+}
+export interface MoveOptions<T extends Item> {
+    position?: number;
+    parent?: Node<T>;
+    callback?: (node: Node<T>, tree: DSTree<T>) => void;
+}
+export interface MutateOptions<T extends Item> {
+    callback?: (node: Node<T>, tree: DSTree<T>) => void;
+}

package/dist/types/useDSTree.d.ts

@@ -0,0 +1,19 @@
+import type { AddOptions, Item, MoveOptions, MutateOptions, RemoveOptions } from './types';
+export declare const useDSTree: <T extends Item>(rootItem: T, opts: {
+    getUniqueId: (item: T) => string;
+}) => {
+    hash: number;
+    getRoot: () => import("./Node").Node<T>;
+    getNode: (id: string) => import("./Node").Node<T>;
+    walk: (callback: (node: import("./Node").Node<T>) => boolean) => void;
+    walkParents: (callback: (node: import("./Node").Node<T>) => boolean) => void;
+    findNode: (callback: (node: import("./Node").Node<T>) => boolean) => import("./Node").Node<T> | null;
+    findAllNodes: (callback: (node: import("./Node").Node<T>) => boolean) => import("./Node").Node<T>[];
+    flatten: () => import("./Node").Node<T>[];
+    addNode: (item: T, options?: AddOptions<T> | undefined) => import("./Node").Node<T>;
+    removeNode: (id: string, options?: RemoveOptions<T> | undefined) => import("./Node").Node<T>;
+    moveNode: (id: string, options?: MoveOptions<T> | undefined) => import("./Node").Node<T>;
+    replaceNode: (id: string, item: T, options?: MutateOptions<T> | undefined) => import("./Node").Node<T>;
+    getPath: (id: string) => import("./Node").Node<T>[];
+    getPathIds: (id: string) => string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-tree-model",
-  "version": "3.14.0-next.16",
+  "version": "3.14.0-next.17",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Tree Model",
   "files": [