@wordpress/components/src/query-controls/terms.ts

UI components for WordPress.

/**
 * Internal dependencies
 */
import type {
	Author,
	Category,
	TermWithParentAndChildren,
	TermsByParent,
} from './types';

const ensureParentsAreDefined = (
	terms: TermWithParentAndChildren[]
): terms is ( TermWithParentAndChildren & { parent: number } )[] => {
	return terms.every( ( term ) => term.parent !== null );
};
/**
 * Returns terms in a tree form.
 *
 * @param flatTerms Array of terms in flat format.
 *
 * @return Terms in tree format.
 */
export function buildTermsTree( flatTerms: readonly ( Author | Category )[] ) {
	const flatTermsWithParentAndChildren: TermWithParentAndChildren[] =
		flatTerms.map( ( term ) => ( {
			children: [],
			parent: null,
			...term,
			id: String( term.id ),
		} ) );

	// We use a custom type guard here to ensure that the parent property is
	// defined on all terms. The type of the `parent` property is `number | null`
	// and we need to ensure that it is `number`. This is because we use the
	// `parent` property as a key in the `termsByParent` object.
	if ( ! ensureParentsAreDefined( flatTermsWithParentAndChildren ) ) {
		return flatTermsWithParentAndChildren;
	}

	const termsByParent = flatTermsWithParentAndChildren.reduce(
		( acc: TermsByParent, term ) => {
			const { parent } = term;
			if ( ! acc[ parent ] ) {
				acc[ parent ] = [];
			}
			acc[ parent ].push( term );
			return acc;
		},
		{}
	);

	const fillWithChildren = (
		terms: TermWithParentAndChildren[]
	): TermWithParentAndChildren[] => {
		return terms.map( ( term ) => {
			const children = termsByParent[ term.id ];
			return {
				...term,
				children:
					children && children.length
						? fillWithChildren( children )
						: [],
			};
		} );
	};

	return fillWithChildren( termsByParent[ '0' ] || [] );
}