wxt 0.8.4 → 0.8.6

package/dist/index.d.cts

@@ -1,574 +1,25 @@
-import * as vite from 'vite';
-import { Manifest, Scripting } from 'webextension-polyfill';
-import { UnimportOptions } from 'unimport';
-import { LogLevel } from 'consola';
-import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
+import { I as InlineConfig, B as BuildOutput, U as UserConfig, E as ExtensionRunnerConfig, W as WxtDevServer } from './external-cb0967d6.js';
+export { k as BackgroundDefinition, f as BackgroundEntrypoint, e as BaseEntrypoint, d as BaseEntrypointOptions, b as BuildStepOutput, q as ConfigEnv, j as ContentScriptDefinition, C as ContentScriptEntrypoint, g as Entrypoint, h as EntrypointGroup, n as ExcludableEntrypoint, G as GenericEntrypoint, L as Logger, i as OnContentScriptStopped, O as OptionsEntrypoint, m as PerBrowserOption, P as PopupEntrypoint, T as TargetBrowser, c as TargetManifestVersion, l as UnlistedScriptDefinition, o as UserManifest, p as UserManifestFn, a as WxtInlineViteConfig, r as WxtViteConfig } from './external-cb0967d6.js';
+import 'vite';
+import 'webextension-polyfill';
+import 'unimport';
+import 'consola';
+import 'rollup-plugin-visualizer';
 
 /**
- * Implements [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
- * Used to detect and stop content script code when the script is invalidated.
+ * Bundles the extension for production. Returns a promise of the build result. Discovers the `wxt.config.ts` file in
+ * the root directory, and merges that config with what is passed in.
  *
- * It also provides several utilities like `ctx.setTimeout` and `ctx.setInterval` that should be used in
- * content scripts instead of `window.setTimeout` or `window.setInterval`.
- */
-declare class ContentScriptContext implements AbortController {
-    #private;
-    private readonly contentScriptName;
-    readonly options?: Omit<ContentScriptDefinition, "main"> | undefined;
-    private static SCRIPT_STARTED_MESSAGE_TYPE;
-    constructor(contentScriptName: string, options?: Omit<ContentScriptDefinition, "main"> | undefined);
-    get signal(): AbortSignal;
-    abort(reason?: any): void;
-    get isInvalid(): boolean;
-    get isValid(): boolean;
-    /**
-     * Add a listener that is called when the content script's context is invalidated.
-     *
-     * @returns A function to remove the listener.
-     *
-     * @example
-     * browser.runtime.onMessage.addListener(cb);
-     * const removeInvalidatedListener = ctx.onInvalidated(() => {
-     *   browser.runtime.onMessage.removeListener(cb);
-     * })
-     * // ...
-     * removeInvalidatedListener();
-     */
-    onInvalidated(cb: () => void): () => void;
-    /**
-     * Return a promise that never resolves. Useful if you have an async function that shouldn't run
-     * after the context is expired.
-     *
-     * @example
-     * const getValueFromStorage = async () => {
-     *   if (ctx.isInvalid) return ctx.block();
-     *
-     *   // ...
-     * }
-     */
-    block<T>(): Promise<T>;
-    /**
-     * Wrapper around `window.setInterval` that automatically clears the interval when invalidated.
-     */
-    setInterval(handler: () => void, timeout?: number): number;
-    /**
-     * Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.
-     */
-    setTimeout(handler: () => void, timeout?: number): number;
-    /**
-     * Wrapper around `window.requestAnimationFrame` that automatically cancels the request when
-     * invalidated.
-     */
-    requestAnimationFrame(callback: FrameRequestCallback): number;
-    /**
-     * Wrapper around `window.requestIdleCallback` that automatically cancels the request when
-     * invalidated.
-     */
-    requestIdleCallback(callback: IdleRequestCallback, options?: IdleRequestOptions): number;
-    /**
-     * Call `target.addEventListener` and remove the event listener when the context is invalidated.
-     *
-     * @example
-     * ctx.addEventListener(window, "mousemove", () => {
-     *   // ...
-     * });
-     * ctx.addEventListener(document, "visibilitychange", () => {
-     *   // ...
-     * });
-     */
-    addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
-    /**
-     * @internal
-     * Abort the abort controller and execute all `onInvalidated` listeners.
-     */
-    notifyInvalidated(): void;
-}
-
-interface InlineConfig {
-    /**
-     * Your project's root directory containing the `package.json` used to fill out the
-     * `manifest.json`.
-     *
-     * @default process.cwd()
-     */
-    root?: string;
-    /**
-     * Directory containing all source code. Set to `"src"` to move all source code to a `src/`
-     * directory.
-     *
-     * @default config.root
-     */
-    srcDir?: string;
-    /**
-     * Directory containing files that will be copied to the output directory as-is.
-     *
-     * @default "${config.root}/public"
-     */
-    publicDir?: string;
-    /**
-     * @default "${config.srcDir}/entrypoints"
-     */
-    entrypointsDir?: string;
-    /**
-     * > Only available when using the JS API. Not available in `wxt.config.ts` files
-     *
-     * Path to `wxt.config.ts` file or `false` to disable config file discovery.
-     *
-     * @default "wxt.config.ts"
-     */
-    configFile?: string | false;
-    /**
-     * Set to `true` to show debug logs. Overriden by the command line `--debug` option.
-     *
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Explicitly set a mode to run in. This will override the default mode for each command, and can
-     * be overridden by the command line `--mode` option.
-     */
-    mode?: string;
-    /**
-     * Customize auto-import options. Set to `false` to disable auto-imports.
-     *
-     * For example, to add a directory to auto-import from, you can use:
-     *
-     * ```ts
-     * export default defineConfig({
-     *   imports: {
-     *     dirs: ["some-directory"]
-     *   }
-     * })
-     * ```
-     */
-    imports?: Partial<UnimportOptions> | false;
-    /**
-     * Explicitly set a browser to build for. This will override the default browser for each command,
-     * and can be overridden by the command line `--browser` option.
-     *
-     * @default
-     * "chrome"
-     */
-    browser?: TargetBrowser;
-    /**
-     * Explicitly set a manifest version to target. This will override the default manifest version
-     * for each command, and can be overridden by the command line `--mv2` or `--mv3` option.
-     */
-    manifestVersion?: TargetManifestVersion;
-    /**
-     * Override the logger used.
-     *
-     * @default
-     * consola
-     */
-    logger?: Logger;
-    /**
-     * Return custom Vite options from a function. See
-     * <https://vitejs.dev/config/shared-options.html>.
-     *
-     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config
-     * instead of Vite's.
-     *
-     * This is a function because any vite plugins added need to be recreated for each individual
-     * build step, incase they have internal state causing them to fail when reused.
-     */
-    vite?: (env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>;
-    /**
-     * Customize the `manifest.json` output. Can be an object, promise, or function that returns an
-     * object or promise.
-     */
-    manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
-    /**
-     * Custom runner options. Options set here can be overridden in a `web-ext.config.ts` file.
-     */
-    runner?: ExtensionRunnerConfig;
-    zip?: {
-        /**
-         * Configure the filename output when zipping files.
-         *
-         * Available template variables:
-         *
-         * - `{{name}}` - The project's name converted to kebab-case
-         * - `{{version}}` - The version_name or version from the manifest
-         * - `{{browser}}` - The target browser from the `--browser` CLI flag
-         * - `{{manifestVersion}}` - Either "2" or "3"
-         *
-         * @default "{{name}}-{{version}}-{{browser}}.zip"
-         */
-        artifactTemplate?: string;
-        /**
-         * Configure the filename output when zipping files.
-         *
-         * Available template variables:
-         *
-         * - `{{name}}` - The project's name converted to kebab-case
-         * - `{{version}}` - The version_name or version from the manifest
-         * - `{{browser}}` - The target browser from the `--browser` CLI flag
-         * - `{{manifestVersion}}` - Either "2" or "3"
-         *
-         * @default "{{name}}-{{version}}-sources.zip"
-         */
-        sourcesTemplate?: string;
-        /**
-         * Override the artifactTemplate's `{name}` template variable. Defaults to the `package.json`'s
-         * name, or if that doesn't exist, the current working directories name.
-         */
-        name?: string;
-        /**
-         * Root directory to ZIP when generating the sources ZIP.
-         *
-         * @default config.root
-         */
-        sourcesRoot?: string;
-        /**
-         * [Minimatch](https://www.npmjs.com/package/minimatch) patterns of files to exclude when
-         * creating a ZIP of all your source code for Firfox. Patterns are relative to your
-         * `config.zip.sourcesRoot`.
-         *
-         * Hidden files, node_modules, and tests are ignored by default.
-         *
-         * @example
-         * [
-         *   "coverage", // Ignore the coverage directory in the `sourcesRoot`
-         * ]
-         */
-        ignoredSources?: string[];
-    };
-    /**
-     * Transform the final manifest before it's written to the file system. Edit the `manifest`
-     * parameter directly, do not return a new object. Return values are ignored.
-     *
-     * @example
-     * defineConfig({
-     *   // Add a CSS-only content script.
-     *   transformManifest(manifest) {
-     *     manifest.content_scripts.push({
-     *       matches: ["*://google.com/*"],
-     *       css: ["content-scripts/some-example.css"],
-     *     });
-     *   }
-     * })
-     */
-    transformManifest?: (manifest: Manifest.WebExtensionManifest) => void;
-    analysis?: {
-        /**
-         * Explicitly include bundle analysis when running `wxt build`. This can be overridden by the
-         * command line `--analysis` option.
-         *
-         * @default false
-         */
-        enabled?: boolean;
-        /**
-         * When running `wxt build --analyze` or setting `analysis.enabled` to true, customize how the
-         * bundle will be visualized. See
-         * [`rollup-plugin-visualizer`](https://github.com/btd/rollup-plugin-visualizer#how-to-use-generated-files)
-         * for more details.
-         *
-         * @default "treemap"
-         */
-        template?: PluginVisualizerOptions['template'];
-    };
-}
-interface WxtInlineViteConfig extends Omit<vite.InlineConfig, 'root' | 'configFile' | 'mode' | 'build'> {
-    build?: Omit<vite.BuildOptions, 'outDir'>;
-}
-interface BuildOutput {
-    manifest: Manifest.WebExtensionManifest;
-    publicAssets: vite.Rollup.OutputAsset[];
-    steps: BuildStepOutput[];
-}
-interface BuildStepOutput {
-    entrypoints: EntrypointGroup;
-    chunks: (vite.Rollup.OutputChunk | vite.Rollup.OutputAsset)[];
-}
-interface WxtDevServer extends vite.ViteDevServer {
-    /**
-     * Ex: `3000`
-     */
-    port: number;
-    /**
-     * Ex: `"localhost"`
-     */
-    hostname: string;
-    /**
-     * Ex: `"http://localhost:3000"`
-     */
-    origin: string;
-    /**
-     * Stores the current build output of the server.
-     */
-    currentOutput: BuildOutput;
-    /**
-     * Start the server on the first open port.
-     */
-    start(): Promise<void>;
-    /**
-     * Tell the extension to reload by running `browser.runtime.reload`.
-     */
-    reloadExtension: () => void;
-    /**
-     * Tell an extension page to reload.
-     *
-     * The path is the bundle path, not the input paths, so if the input paths is
-     * "src/options/index.html", you would pass "options.html" because that's where it is written to
-     * in the dist directory, and where it's available at in the actual extension.
-     *
-     * @example
-     * server.reloadPage("popup.html")
-     * server.reloadPage("sandbox.html")
-     */
-    reloadPage: (path: string) => void;
-    /**
-     * Tell the extension to restart a content script.
-     *
-     * @param contentScript The manifest definition for a content script
-     */
-    reloadContentScript: (contentScript: Omit<Scripting.RegisteredContentScript, 'id'>) => void;
-}
-type TargetBrowser = string;
-type TargetManifestVersion = 2 | 3;
-type UserConfig = Omit<InlineConfig, 'configFile'>;
-interface Logger {
-    debug(...args: any[]): void;
-    log(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-    fatal(...args: any[]): void;
-    success(...args: any[]): void;
-    level: LogLevel;
-}
-interface BaseEntrypointOptions {
-    include?: TargetBrowser[];
-    exclude?: TargetBrowser[];
-}
-interface BaseEntrypoint {
-    /**
-     * The entrypoint's name. This is the filename or dirname without the type suffix.
-     *
-     * Examples:
-     * - `popup.html` &rarr; `popup`
-     * - `options/index.html` &rarr; `options`
-     * - `named.sandbox.html` &rarr; `named`
-     * - `named.sandbox/index.html` &rarr; `named`
-     * - `sandbox.html` &rarr; `sandbox`
-     * - `sandbox.index.html` &rarr; `sandbox`
-     * - `overlay.content.ts` &rarr; `overlay`
-     * - `overlay.content/index.ts` &rarr; `overlay`
-     *
-     * The name is used when generating an output file:
-     * `<entrypoint.outputDir>/<entrypoint.name>.<ext>`
-     */
-    name: string;
-    /**
-     * Absolute path to the entrypoint's input file.
-     */
-    inputPath: string;
-    /**
-     * Absolute path to the entrypoint's output directory. Can be the`InternalConfg.outDir` or a
-     * subdirectory of it.
-     */
-    outputDir: string;
-    options: BaseEntrypointOptions;
-}
-interface GenericEntrypoint extends BaseEntrypoint {
-    type: 'sandbox' | 'bookmarks' | 'history' | 'newtab' | 'sidepanel' | 'devtools' | 'unlisted-page' | 'unlisted-script' | 'unlisted-style' | 'content-script-style';
-}
-interface BackgroundEntrypoint extends BaseEntrypoint {
-    type: 'background';
-    options: {
-        persistent?: boolean;
-        type?: 'module';
-    } & BaseEntrypointOptions;
-}
-interface ContentScriptEntrypoint extends BaseEntrypoint {
-    type: 'content-script';
-    options: Omit<ContentScriptDefinition, 'main'> & BaseEntrypointOptions;
-}
-interface PopupEntrypoint extends BaseEntrypoint {
-    type: 'popup';
-    options: {
-        /**
-         * Defaults to "browser_action" to be equivalent to MV3's "action" key
-         */
-        mv2Key?: 'browser_action' | 'page_action';
-        defaultIcon?: Record<string, string>;
-        defaultTitle?: string;
-        browserStyle?: boolean;
-    } & BaseEntrypointOptions;
-}
-interface OptionsEntrypoint extends BaseEntrypoint {
-    type: 'options';
-    options: {
-        openInTab?: boolean;
-        browserStyle?: boolean;
-        chromeStyle?: boolean;
-    } & BaseEntrypointOptions;
-}
-type Entrypoint = GenericEntrypoint | BackgroundEntrypoint | ContentScriptEntrypoint | PopupEntrypoint | OptionsEntrypoint;
-type OnContentScriptStopped = (cb: () => void) => void;
-interface ContentScriptDefinition extends ExcludableEntrypoint {
-    matches: PerBrowserOption<Manifest.ContentScript['matches']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default "documentIdle"
-     */
-    runAt?: PerBrowserOption<Manifest.ContentScript['run_at']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default false
-     */
-    matchAboutBlank?: PerBrowserOption<Manifest.ContentScript['match_about_blank']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default []
-     */
-    excludeMatches?: PerBrowserOption<Manifest.ContentScript['exclude_matches']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default []
-     */
-    includeGlobs?: PerBrowserOption<Manifest.ContentScript['include_globs']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default []
-     */
-    excludeGlobs?: PerBrowserOption<Manifest.ContentScript['exclude_globs']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default false
-     */
-    allFrames?: PerBrowserOption<Manifest.ContentScript['all_frames']>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default false
-     */
-    matchOriginAsFallback?: PerBrowserOption<boolean>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default "ISOLATED"
-     */
-    world?: PerBrowserOption<'ISOLATED' | 'MAIN'>;
-    /**
-     * Customize how imported/generated styles are injected with the content script. Regardless of the
-     * mode selected, CSS will always be built and included in the output directory.
-     *
-     * - `"manifest"` - Include the CSS in the manifest, under the content script's `css` array.
-     * - `"manual"` - Exclude the CSS from the manifest. You are responsible for manually loading it
-     *   onto the page. Use `browser.runtime.getURL("content-scripts/<name>.css")` to get the file's
-     *   URL
-     * - `"ui"` - Exclude the CSS from the manifest. CSS will be automatically added to your UI when
-     *   calling `createContentScriptUi`
-     *
-     * @default "manifest"
-     */
-    cssInjectionMode?: PerBrowserOption<'manifest' | 'manual' | 'ui'>;
-    /**
-     * Main function executed when the content script is loaded.
-     */
-    main(ctx: ContentScriptContext): void | Promise<void>;
-}
-interface BackgroundDefinition extends ExcludableEntrypoint {
-    type?: PerBrowserOption<'module'>;
-    persistent?: PerBrowserOption<boolean>;
-    main(): void;
-}
-interface UnlistedScriptDefinition extends ExcludableEntrypoint {
-    /**
-     * Main function executed when the unlisted script is ran.
-     */
-    main(): void | Promise<void>;
-}
-type PerBrowserOption<T> = T | {
-    [browser: TargetBrowser]: T;
-};
-interface ExcludableEntrypoint {
-    /**
-     * List of target browsers to include this entrypoint in. Defaults to being included in all
-     * builds. Cannot be used with `exclude`. You must choose one of the two options.
-     *
-     * @default undefined
-     */
-    include?: TargetBrowser[];
-    /**
-     * List of target browsers to exclude this entrypoint from. Cannot be used with `include`. You
-     * must choose one of the two options.
-     *
-     * @default undefined
-     */
-    exclude?: TargetBrowser[];
-}
-/**
- * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
- * here, they are configured inline.
- */
-type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'background' | 'chrome_url_overrides' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox' | 'sidepanel' | 'sidebar_action'>>;
-type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
-interface ConfigEnv {
-    mode: string;
-    command: 'build' | 'serve';
-    /**
-     * Browser passed in from the CLI
-     */
-    browser: TargetBrowser;
-    /**
-     * Manifest version passed in from the CLI
-     */
-    manifestVersion: 2 | 3;
-}
-/**
- * Configure how the browser starts up.
+ * @example
+ * // Use config from `wxt.config.ts`
+ * const res = await build()
+ *
+ * // or override config `from wxt.config.ts`
+ * const res = await build({
+ *   // Override config...
+ * })
  */
-interface ExtensionRunnerConfig {
-    /**
-     * Whether or not to open the browser with the extension installed in dev mode.
-     *
-     * @default false
-     */
-    disabled?: boolean;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#browser-console
-     */
-    openConsole?: boolean;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#devtools
-     */
-    openDevtools?: boolean;
-    /**
-     * List of browser names and the binary that should be used to open the browser.
-     *
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox
-     */
-    binaries?: Record<string, string>;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile
-     */
-    firefoxProfile?: string;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-profile
-     */
-    chromiumProfile?: string;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#pref
-     */
-    firefoxPrefs?: Record<string, string>;
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
-     */
-    firefoxArgs?: string[];
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
-     */
-    chromiumArgs?: string[];
-    /**
-     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#start-url
-     */
-    startUrls?: string[];
-}
-type WxtViteConfig = Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
-
-type EntrypointGroup = Entrypoint | Entrypoint[];
+declare function build(config?: InlineConfig): Promise<BuildOutput>;
 
 /**
  * Remove generated/temp files from the directory.
@@ -580,25 +31,10 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.8.4";
-
 declare function defineConfig(config: UserConfig): UserConfig;
 
 declare function defineRunnerConfig(config: ExtensionRunnerConfig): ExtensionRunnerConfig;
 
-/**
- * @module wxt
- */
-
-/**
- * Bundles the extension for production. Returns a promise of the build result.
- *
- * @example
- * const res = await build({
- *   // Enter config...
- * })
- */
-declare function build(config: InlineConfig): Promise<BuildOutput>;
 /**
  * Creates a dev server and pre-builds all the files that need to exist before loading the extension.
  *
@@ -610,4 +46,21 @@ declare function build(config: InlineConfig): Promise<BuildOutput>;
  */
 declare function createServer(config?: InlineConfig): Promise<WxtDevServer>;
 
-export { BackgroundDefinition, BackgroundEntrypoint, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PerBrowserOption, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UnlistedScriptDefinition, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, WxtViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };
+declare function initialize(options: {
+    directory: string;
+    template: string;
+    packageManager: string;
+}): Promise<void>;
+
+declare function prepare(config: InlineConfig): Promise<void>;
+
+/**
+ * Build and zip the extension for distribution.
+ * @param config Opitonal config that will override your `<root>/wxt.config.ts`.
+ * @returns A list of all files included in the ZIP.
+ */
+declare function zip(config?: InlineConfig): Promise<string[]>;
+
+var version = "0.8.6";
+
+export { BuildOutput, ExtensionRunnerConfig, InlineConfig, UserConfig, WxtDevServer, build, clean, createServer, defineConfig, defineRunnerConfig, initialize, prepare, version, zip };