import { PluginFunction, App } from 'vuepress/core';

interface SassPalettePluginOptions {
    /**
     * Identifier for palette, used to avoid duplicate registration.
     *
     * 调色板的唯一 ID，用于避免重复注册。
     */
    id: string;
    /**
     * User config file path, relative to source dir
     *
     * @description This is the file where user set style variables.
     *
     * 用户配置文件路径，相对于源文件夹。
     *
     * @description 这是用户设置样式变量的文件。
     *
     * @default `.vuepress/styles/${id}-config.scss`
     */
    config?: string;
    /**
     * Default config file path, should be absolute path.
     *
     * @description This is the file you should use to provide default style values with `!default`。
     *
     * 默认的配置文件路径，应为绝对路径。
     *
     * @description 这是你应该通过 `!default` 来提供默认样式变量的文件。
     *
     * @default "vuepress-plugin-sass-palette/styles/default/config.scss"
     */
    defaultConfig?: string;
    /**
     * User palette file path, relative to source dir.
     *
     * @description This is the file where user control injected css variables. All the variables will be converted in to kebab-case and injected.
     *
     * 用户的调色板文件路径，相对于源文件夹。
     *
     * @description 这是用户控制注入 CSS 变量的文件。所有的变量会被转换为连字符格式然后被注入。
     *
     * @default `.vuepress/styles/${id}-palette.scss`
     */
    palette?: string;
    /**
     * Default palette file path, should be absolute path.
     *
     * @description This is the file you should use to provide default css variables with `!default`. All the variable will be converted in to kebab-case and injected.
     *
     * 默认的调色板文件路径，应为绝对路径。
     *
     * @description 这是你应该通过 `!default` 来提供默认调色板值的文件。所有的变量会被转换为连字符格式然后被注入。
     *
     * @default "vuepress-plugin-sass-palette/styles/default/palette.scss"
     */
    defaultPalette?: string;
    /**
     * Custom generator, used to generate derivative values with palette config
     *
     * e.g: You may want to provide a `$theme-color-light` based on `$themeColor`.
     *
     * 自定义的生成器，用于生成调色板配置的衍生值。
     *
     * 如: 你可能想要根据 `$theme-color` 的值提供一个 `$theme-color-light`。
     */
    generator?: string;
    /**
     * User style file path, relative to source dir.
     *
     * 用户的样式文件路径，相对于源文件夹。
     */
    style?: string;
}

declare const sassPalettePlugin: (options: SassPalettePluginOptions) => PluginFunction;

declare const removePalettePlugin: (app: App, id: string) => void;

declare const useSassPalettePlugin: (app: App, options: SassPalettePluginOptions) => void;

export { type SassPalettePluginOptions, removePalettePlugin, sassPalettePlugin, useSassPalettePlugin };