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 getNodeValue = (id: string) => <T>(tree: Tree<T>) => {
  32     const node = getNode(id)(tree);
  33     return node ? node.value : undefined;
  34 };
  35
  36 export const setNodeValue = (id: string) => <T>(value: T) => (tree: Tree<T>) => {
  37     const node = getNode(id)(tree);
  38     return node
  39         ? setNode(mapNodeValue(() => value)(node))(tree)
  40         : tree;
  41 };
  42
  43 export const setNodeValueWith = <T>(mapFn: (value: T) => T) => (id: string) => (tree: Tree<T>) => {
  44     const node = getNode(id)(tree);
  45     return node
  46         ? setNode(mapNodeValue(mapFn)(node))(tree)
  47         : tree;
  48 };
  49
  50 export const mapTreeValues = <T, R>(mapFn: (value: T) => R) => (tree: Tree<T>): Tree<R> =>
  51     getNodeDescendants('')(tree)
  52         .map(id => getNode(id)(tree))
  53         .map(mapNodeValue(mapFn))
  54         .reduce((newTree, node) => setNode(node)(newTree), createTree<R>());
  55
  56 export const mapTree = <T, R>(mapFn: (node: TreeNode<T>) => TreeNode<R>) => (tree: Tree<T>): Tree<R> =>
  57     getNodeDescendants('')(tree)
  58         .map(id => getNode(id)(tree))
  59         .map(mapFn)
  60         .reduce((newTree, node) => setNode(node)(newTree), createTree<R>());
  61
  62 export const getNodeAncestors = (id: string) => <T>(tree: Tree<T>): string[] => {
  63     const node = getNode(id)(tree);
  64     return node && node.parent
  65         ? [...getNodeAncestors(node.parent)(tree), node.parent]
  66         : [];
  67 };
  68
  69 export const getNodeDescendants = (id: string, limit = Infinity) => <T>(tree: Tree<T>): string[] => {
  70     const node = getNode(id)(tree);
  71     const children = node ? node.children :
  72         id === TREE_ROOT_ID
  73             ? getRootNodeChildren(tree)
  74             : [];
  75
  76     return children
  77         .concat(limit < 1
  78             ? []
  79             : children
  80                 .map(id => getNodeDescendants(id, limit - 1)(tree))
  81                 .reduce((nodes, nodeChildren) => [...nodes, ...nodeChildren], []));
  82 };
  83
  84 export const getNodeChildren = (id: string) => <T>(tree: Tree<T>): string[] =>
  85     getNodeDescendants(id, 0)(tree);
  86
  87 const mapNodeValue = <T, R>(mapFn: (value: T) => R) => (node: TreeNode<T>): TreeNode<R> =>
  88     ({ ...node, value: mapFn(node.value) });
  89
  90 const getRootNodeChildren = <T>(tree: Tree<T>) =>
  91     Object
  92         .keys(tree)
  93         .filter(id => getNode(id)(tree)!.parent === TREE_ROOT_ID);
  94
  95 const addChild = (parentId: string, childId: string) => <T>(tree: Tree<T>): Tree<T> => {
  96     const node = getNode(parentId)(tree);
  97     if (node) {
  98         const children = node.children.some(id => id === childId)
  99             ? node.children
 100             : [...node.children, childId];
 101
 102         const newNode = children === node.children
 103             ? node
 104             : { ...node, children };
 105
 106         return setNode(newNode)(tree);
 107     }
 108     return tree;
 109 };