Extract tree data structure
[arvados-workbench2.git] / src / models / tree.ts
1 import { Children } from "../../node_modules/@types/react";
2
3 // Copyright (C) The Arvados Authors. All rights reserved.
4 //
5 // SPDX-License-Identifier: AGPL-3.0
6
7 export type Tree<T> = Record<string, TreeNode<T>>;
8
9 export const TREE_ROOT_ID = '';
10
11 export interface TreeNode<T> {
12     children: string[];
13     value: T;
14     id: string;
15     parent: string;
16 }
17
18 export const createTree = <T>(): Tree<T> => ({});
19
20 export const getNode = (id: string) => <T>(tree: Tree<T>): TreeNode<T> | undefined => tree[id];
21
22 export const setNode = <T>(node: TreeNode<T>) => (tree: Tree<T>): Tree<T> => {
23     const [newTree] = [tree]
24         .map(tree => getNode(node.id)(tree) === node
25             ? tree
26             : Object.assign({}, tree, { [node.id]: node }))
27         .map(addChild(node.parent, node.id));
28     return newTree;
29 };
30
31 export const addChild = (parentId: string, childId: string) => <T>(tree: Tree<T>): Tree<T> => {
32     const node = getNode(parentId)(tree);
33     if (node) {
34         const children = node.children.some(id => id === childId)
35             ? node.children
36             : [...node.children, childId];
37
38         const newNode = children === node.children
39             ? node
40             : { ...node, children };
41
42         return setNode(newNode)(tree);
43     }
44     return tree;
45 };
46
47
48 export const getNodeAncestors = (id: string) => <T>(tree: Tree<T>): string[] => {
49     const node = getNode(id)(tree);
50     return node && node.parent
51         ? [...getNodeAncestors(node.parent)(tree), node.parent]
52         : [];
53 };
54
55 export const getNodeDescendants = (id: string, limit = Infinity) => <T>(tree: Tree<T>): string[] => {
56     const node = getNode(id)(tree);
57     const children = node ? node.children :
58         id === TREE_ROOT_ID
59             ? getRootNodeChildren(tree)
60             : [];
61
62     return children
63         .concat(limit < 1
64             ? []
65             : children
66                 .map(id => getNodeDescendants(id, limit - 1)(tree))
67                 .reduce((nodes, nodeChildren) => [...nodes, ...nodeChildren], []));
68 };
69
70 export const getNodeChildren = (id: string) => <T>(tree: Tree<T>): string[] =>
71     getNodeDescendants(id, 0)(tree);
72
73 export const mapNodes = (ids: string[]) => <T>(mapFn: (node: TreeNode<T>) => TreeNode<T>) => (tree: Tree<T>): Tree<T> =>
74     ids
75         .map(id => getNode(id)(tree))
76         .map(mapFn)
77         .map(setNode)
78         .reduce((tree, update) => update(tree), tree);
79
80 export const mapTree = <T, R>(mapFn: (node: TreeNode<T>) => TreeNode<R>) => (tree: Tree<T>): Tree<R> =>
81     getNodeDescendants('')(tree)
82         .map(id => getNode(id)(tree))
83         .map(mapFn)
84         .reduce((newTree, node) => setNode(node)(newTree), createTree<R>());
85
86 export const mapNodeValue = <T>(mapFn: (value: T) => T) => (node: TreeNode<T>) =>
87     ({ ...node, value: mapFn(node.value) });
88
89 const getRootNodeChildren = <T>(tree: Tree<T>) =>
90     Object
91         .keys(tree)
92         .filter(id => getNode(id)(tree)!.parent === TREE_ROOT_ID);
93
94
95