/**
 * This file gathers configuration related implementations.
 * In particular, it defines the {@link Configuration} interface and provide a default configuration for ts-typedoc
 * project.
 */

import { Project } from './models'
import { setup } from '../../auto-generated'
import type { DisplayFactory, NotebookOptions, Scope } from '../notebook'

/**
 * Specification of the configuration interface.
 */
export interface Configuration {
    /**
     * Defines the stylesheet to install.
     *
     * @param project
     * @returns Stylesheet full URL.
     */
    css: (project: Project) => string
    /**
     * External types to link in the documentation, where keys are symbol path and values associated URL.
     */
    externalTypes: { [k: string]: string }
    /**
     * Define the code url from repo for a file in the project (located at `path`) and a starting line (`startLine`).
     */
    codeUrl: ({
        project,
        path,
        startLine,
    }: {
        project: Project
        path: string
        startLine: number
    }) => string

    /**
     * If `true` or an object, use the {@link Notebook} module to parse the code documentation included in the API
     * files, eventually forwarding the parameters provided to the {@link Notebook.NotebookPage} constructor.
     */
    notebook?:
        | boolean
        | {
              initialScope?: Partial<Scope>
              displayFactory?: DisplayFactory
              options?: NotebookOptions
          }
}
export const configurationDefault: Configuration = {
    codeUrl: ({
        project,
        path,
        startLine,
    }: {
        project: Project
        path: string
        startLine: number
    }) => {
        return `https://github.com/${project.name}/tree/main/src/${path}#L${startLine}`
    },
    externalTypes: {},
    css: () => `${setup.name}#${setup.version}~assets/ts-typedoc.css`,
    notebook: undefined,
}

/**
 * Configuration for the `TsTypedoc` backend.
 */
export const configurationTsTypedoc: Configuration = configurationDefault

/**
 * Configuration for the `Python` backend.
 */
export const configurationPython: Configuration = configurationDefault