vite-plugin-web-extension/dist/index.d.cts


import * as vite from 'vite';
import * as webext from 'web-ext-option-types';
import Browser from 'webextension-polyfill';

type Manifest = any;
type WebExtConfig = Omit<webext.RunOptions, "reload"> & {
    /**
     * @deprecated Use `firefoxBinary` instead.
     */
    firefox?: string;
};
interface UserOptions {
    /**
     * The path to your manifest.json or a  function that returns your manifest as a JS object. It's a
     * function that returns a generated or dynamic javascript object representing the manifest
     *
     * Defaults to `"manifest.json"`
     *
     * @example
     * () => ({
     *   name: "Extension Name",
     *   manifest_version: 3,
     *   ...
     * })
     */
    manifest?: string | (() => Manifest) | (() => Promise<Manifest>) | undefined;
    /**
     * An optional transform function to modify the manifest just before the plugin writes
     * it to the output directory.
     */
    transformManifest?: (manifest: Browser.Manifest.WebExtensionManifest) => Browser.Manifest.WebExtensionManifest | Promise<Browser.Manifest.WebExtensionManifest>;
    /**
     * Used to include additional files, like content scripts, not mentioned in the final
     * `manifest.json`. Paths should be relative to Vite's `root` (or `process.cwd()` if not set)
     */
    additionalInputs?: string[];
    /**
     * Used to disable auto-installing the extension when in watch mode. Default value is `false`.
     */
    disableAutoLaunch?: boolean;
    /**
     * Absolute path or relative path to the Vite root to files to watch. When these files change, a
     * full reload of the extension is triggered in both watch and dev mode.
     *
     * If your manifest is generated from a function, you can add all the files that generate it here
     * so the browser restarts when you make a change.
     */
    watchFilePaths?: string[];
    /**
     * The browser to target and open.
     *
     * @default "chrome"
     */
    browser?: 'chrome' | 'firefox' | (string & {}) | null;
    /**
     * Do not validate your manifest to make sure it can be loaded by browsers.
     *
     * @default false
     */
    skipManifestValidation?: boolean;
    /**
     * Whether or not to print the summary block showing what files are being used as entry-points
     *
     * @default true
     */
    printSummary?: boolean;
    /**
     * Custom vite config to be merged with when building html inputs (popup, options, sandbox, etc)
     */
    htmlViteConfig?: vite.InlineConfig;
    /**
     * Custom vite config to be merged with when building script inputs (background scripts/service
     * worker, content scripts, etc)
     */
    scriptViteConfig?: vite.InlineConfig;
    /**
     * Optional startup configuration for web-ext. For list of options, see
     * <https://github.com/mozilla/web-ext/blob/666886f40a967b515d43cf38fc9aec67ad744d89/src/program.js#L559>.
     */
    webExtConfig?: WebExtConfig;
    /**
     * Output path to a JSON file containing information about the generated bundles.
     */
    bundleInfoJsonPath?: string;
    /**
     * Action to be executed after build ends.
     */
    onBundleReady?: () => void | Promise<void>;
}

declare function webExtension(options?: UserOptions): vite.PluginOption;
/**
 * Helper function for `JSON.parse(fs.readFileSync(..., "utf-8"))`.
 */
declare function readJsonFile(file: string): any;

export { type UserOptions as PluginOptions, webExtension as default, readJsonFile };