import { GenomeConfig, GenomeDefinition } from "./genome.js";
import { BuiltInThemeName, GenomeSpyConfig } from "./config.js";
import { ViewSpec } from "./view.js";

export type NamedGenomeConfig = GenomeDefinition | Record<string, never>;

export interface RootConfig {
    $schema?: string;

    /**
     * Named genome assembly definitions.
     *
     * Each object key is the assembly name.
     */
    genomes?: Record<string, NamedGenomeConfig>;

    /**
     * Default assembly for locus scales that do not define `scale.assembly`.
     *
     * Can reference either a key in `genomes` or a built-in assembly name.
     */
    assembly?: string;

    /**
     * @deprecated Legacy root-level genome config. Use `genomes` and `assembly` instead.
     */
    genome?: GenomeConfig;

    baseUrl?: string;

    /**
     * Background color of the canvas.
     */
    background?: string;

    /**
     * https://vega.github.io/vega-lite/docs/data.html#datasets
     */
    datasets?: Record<string, any[]>;

    /**
     * Global configuration defaults and theme tokens.
     *
     * The configuration is inherited by descendant views and can be overridden
     * by view-local `config` objects.
     */
    config?: GenomeSpyConfig;

    /**
     * Selects built-in theme preset(s) for the whole visualization.
     */
    theme?: BuiltInThemeName | BuiltInThemeName[];
}

export type RootSpec = ViewSpec & RootConfig;