react-native-tree-multi-select/src/helpers/flattenTree.helper.ts

A super-fast, customizable tree view component for React Native with multi-selection, checkboxes, and search filtering capabilities.

import { TreeNode, __FlattenedTreeNode__ } from "../types/treeView.types";

/**
 * Flatten the tree and attach a "level" key to object to indicate it's depth. This
 * returns the flattened tree data of expanded ids only. We do not prune the tree off the
 * children after the flattening as it would be unnecessary computation.
 *
 * @param nodes - Input recursive tree
 * @param expandedIds - ids of currently expanded nodes
 * @param __level__ - (optional) for internal recursive use only
 * @returns Flattened tree data with expanded ids only
 */
export function getFlattenedTreeData<ID>(
    nodes: TreeNode<ID>[],
    expandedIds: Set<ID>,
): __FlattenedTreeNode__<ID>[] {
    const flattened: __FlattenedTreeNode__<ID>[] = [];
    const stack: { node: TreeNode<ID>; level: number; }[] = [];

    // Initialize stack with the root nodes and level 0
    for (let i = nodes.length - 1; i >= 0; i--) {
        const node = nodes[i];
        /* istanbul ignore next */
        if (node) { // Ensure node is not undefined - redundant safety
            stack.push({ node, level: 0 });
        }
    }

    while (stack.length > 0) {
        const item = stack.pop();
        /* istanbul ignore next */
        if (!item) continue; // Redundant safety check

        const { node, level } = item;

        // Push current node into the flattened array
        flattened.push({ ...node, level });

        // Add children nodes to the stack if the node is expanded
        if (node.children && expandedIds.has(node.id)) {
            for (let i = node.children.length - 1; i >= 0; i--) {
                const childNode = node.children[i];
                /* istanbul ignore next */
                if (childNode) { // Ensure childNode is not undefined - redundant safety
                    stack.push({ node: childNode, level: level + 1 });
                }
            }
        }
    }

    return flattened;
}