@tomjs/vite-plugin-html/dist/index.d.ts

import { PluginOption } from 'vite';
import { Options } from 'html-minifier-terser';

/**
 * cdn module configuration
 */
interface NpmModule {
    /**
     * Package name
     */
    name: string;
    /**
     * Global variable name, defaults to camel case of the package name if not specified
     */
    var?: string;
    /**
     * Package version, defaults to the version in node_modules if not specified
     */
    version?: string;
    /**
     * Path to the resource js/css files to be loaded
     */
    file?: string | string[];
    /**
     * Set npm module path
     */
    modulePath?: string;
    /**
     * Dependency modules or modules files. For example, [{"dayjs":["plugin/isoWeek.js"]}]
     */
    deps?: DepModuleFiles[];
    /**
     * These codes will be inserted before the script/link tag of the current module
     *
     * The `{{url}}` keyword in the code will be replaced with relevant information about the current module.
     */
    injectBefore?: string | string[];
    /**
     * These codes will be inserted after the script/link tag of the current module
     *
     * The `{{url}}` keyword in the code will be replaced with relevant information about the current module.
     */
    injectAfter?: string | string[];
    /**
     * Local module
     */
    local?: boolean;
}
/**
 * Dependency module name or files
 *
 * @example
 * ```ts
 * const deps: DepModuleFiles[] = [
      'vue',
      {
        dayjs: [
          'plugin/customParseFormat.js',
        ],
        'vue-demi': 'lib/index.iife.js'
      },
    ]
 * ```
 */
type DepModuleFiles = string | Record<string, string | string[]>;
type Union<T> = T | (string & {});
/**
 * Default supported types
 */
type PresetNpmModule = Union<'dayjs' | 'axios' | 'lodash' | 'vue' | 'vue-router' | 'vue-demi' | 'pinia' | 'ant-design-vue' | 'ant-design-vue3' | '@vueuse/core' | '@vueuse/shared' | 'element-plus' | 'react' | 'react-dom' | 'react-router-dom' | 'antd' | 'ahooks' | '@ant-design/charts'>;
/**
 * Injected code
 */
interface HtmlInjectCode {
    /**
     * Injected HTML code
     */
    code: string | string[];
    [key: string]: any;
}
/**
 * All types of cdn module configurations
 */
type HtmlCdnModule = PresetNpmModule | NpmModule | HtmlInjectCode;
/**
 * Local cdn configuration
 */
interface HtmlCdnLocal {
    /**
     * Local mode or specify modules as local modules. Default is false.
     * @default false
     */
    modules: boolean | PresetNpmModule[];
    /**
     * Same as vite configuration base option. Default is "/".
     * @default "/"
     */
    base?: string;
    /**
     * Local output directory, same as vite configuration build.outDir option. Default is "dist".
     * @default 'dist'
     */
    outDir?: string;
    /**
     * Local output path, the module URL will also be replaced with this path. Default is "npm/{name}@{version}".
     * @default "npm/{name}@{version}"
     */
    path?: string;
    /**
     * Whether to copy to local. Default is true.
     * @default true
     */
    copy?: boolean;
}
/**
 * cdn plugin configuration
 */
interface HtmlCdnOptions {
    /**
     * Module configuration
     */
    modules: HtmlCdnModule[];
    /**
     * Tag selector where the cdn will be added. Default is "title".
     * @default "title"
     */
    selector?: string;
    /**
     * `CDN` source type, parameters `name`/`version`/`file` are taken from the modules configuration.
     *
     * When the OS language is `zh_CN` , the default value is `npmmirror`, otherwise it is `jsdelivr`.
     *
     * * npmmirror: url defaults to https://registry.npmmirror.com/{name}/{version}/files/{file}
     * * jsdelivr: url defaults to https://cdn.jsdelivr.net/npm/{name}@{version}/{file}
     * * unpkg: url defaults to https://unpkg.com/{name}@{version}/{file}
     * * custom: custom url can be defined
     *
     * @default "npmmirror"
     */
    type?: 'npmmirror' | 'unpkg' | 'jsdelivr' | 'custom';
    /**
     * Used in conjunction with the type parameter, sets different urls, the final path will be {url}/{file}
     *
     * * npmmirror: url defaults to https://registry.npmmirror.com/{name}/{version}/files
     * * jsdelivr: url defaults to https://cdn.jsdelivr.net/npm/{name}@{version}
     * * unpkg: url defaults to https://unpkg.com/{name}@{version}
     * * custom: custom url can be defined
     */
    url?: string;
    /**
     * Local mode or specify modules as local modules. Default is false.
     * @default false
     */
    local?: boolean | PresetNpmModule[] | HtmlCdnLocal;
}

/**
 * Vite HTML plugin with CDN and other support
 * @returns
 */
declare function useHtmlCdnPlugin(options: HtmlCdnOptions): PluginOption;

/**
 * Detailed configuration for the loading plugin
 */
interface HtmlLoadingOptions {
    /**
     * Selector for the node to insert the loading into. Defaults to `#app`
     * @default '#app'
     */
    selector?: string;
    /**
     * Custom style code
     */
    style?: string;
    /**
     * Code to add before the loading code
     */
    before?: string;
    /**
     * Code to add after the loading code
     */
    after?: string;
}

/**
 * HTML loading plugin
 * @param options Configuration options, default is true
 * @returns
 */
declare function useHtmlLoadingPlugin(options?: boolean | HtmlLoadingOptions): PluginOption;

/**
 * Detailed configuration for html minification plugin
 */
type HtmlMinifyOptions = Options;
/**
 * Configuration for html minification plugin
 */
type HtmlMinifyPluginOptions = boolean | HtmlMinifyOptions;

/**
 * HTML compression plugin
 * @param minify Configuration parameter, default is true
 */
declare function useHtmlMinifyPlugin(minify?: boolean | HtmlMinifyOptions): PluginOption;

/**
 * Html Plugin Configuration
 */
interface HtmlPluginOptions {
    /**
     * Minification plugin configuration, default is true
     */
    minify?: boolean | HtmlMinifyOptions;
    /**
     * Loading plugin configuration, default is false
     */
    loading?: boolean | HtmlLoadingOptions;
    /**
     * CDN configuration, default is true
     */
    cdn?: false | HtmlCdnOptions;
}
/**
 * Html Plugin
 */
declare function useHtmlPlugin(options?: HtmlPluginOptions): PluginOption[];

export { type DepModuleFiles, type HtmlCdnLocal, type HtmlCdnModule, type HtmlCdnOptions, type HtmlInjectCode, type HtmlLoadingOptions, type HtmlMinifyOptions, type HtmlMinifyPluginOptions, type HtmlPluginOptions, type NpmModule, type PresetNpmModule, type Union, useHtmlPlugin as default, useHtmlCdnPlugin, useHtmlLoadingPlugin, useHtmlMinifyPlugin, useHtmlPlugin };