/********************************************************************************
 * Copyright (C) 2024-2025 EclipseSource and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License as outlined in the LICENSE File
 ********************************************************************************/

import type { CDTTreeItem, CDTTreeItemResource } from './tree-model-types';

/**
 * A TreeConverterContext is used to pass additional information to the TreeResourceConverter.
 * It contains the expanded keys, pinned keys and a resource map.
 * It will be propagated to all TreeResourceConverters.
 */
export interface CDTTreeConverterContext<TResource extends CDTTreeItemResource = CDTTreeItemResource> {
    parent?: CDTTreeItem<CDTTreeItemResource>;
    /**
     * The expanded keys of the tree. This is used to determine if a node should be expanded or not.
     */
    expandedKeys: string[];
    /**
     * The pinned keys of the tree. This is used to determine if a node should be pinned or not.
     */
    pinnedKeys: string[];
    /**
     * A map of all resources that are currently in the tree.
     * This can be useful to access parent resources.
     * It is filled while converting the tree.
     */
    assignedResources: Record<string, TResource | undefined>;
    /**
     * A map of all items that are currently in the tree.
     */
    assignedItems: Record<string, CDTTreeItem<TResource> | undefined>;
}

/**
 * A TreeResourceConverter is responsible for converting a resource into a CDTTreeItem.
 */
export interface CDTTreeResourceConverter<TResource extends CDTTreeItemResource, TContextResource extends CDTTreeItemResource = TResource> {
    canHandle(resource: TResource): boolean;

    convert(resource: TResource, context: CDTTreeConverterContext<TContextResource>): CDTTreeItem<TResource>;
}