wxt 0.18.4 → 0.18.6

package/dist/{index-CiL7hzu6.d.ts → index-Bk-a0SkY.d.ts}

@@ -269,5 +269,6 @@ type PerBrowserOption<T> = T | PerBrowserMap<T>;
 type PerBrowserMap<T> = {
     [browser: TargetBrowser]: T;
 };
+type WxtPlugin = () => void;
 
-export { type BackgroundDefinition as B, type ContentScriptDefinition as C, type UnlistedScriptDefinition as U, ContentScriptContext as a };
+export { type BackgroundDefinition as B, type ContentScriptDefinition as C, type UnlistedScriptDefinition as U, type WxtPlugin as W, ContentScriptContext as a };

package/dist/{index-xOGXP3vY.d.cts → index-D6lH9OkP.d.cts}

@@ -1,6 +1,6 @@
 import * as vite from 'vite';
 import { Manifest, Scripting } from 'webextension-polyfill';
-import { UnimportOptions } from 'unimport';
+import { UnimportOptions, Import } from 'unimport';
 import { LogLevel } from 'consola';
 import { PluginVisualizerOptions } from '@aklinker1/rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
@@ -155,6 +155,10 @@ interface InlineConfig {
      * @default "${config.srcDir}/entrypoints"
      */
     entrypointsDir?: string;
+    /**
+     * @default "${config.srcDir}/modules"
+     */
+    modulesDir?: string;
     /**
      * A list of entrypoint names (`"popup"`, `"options"`, etc.) to build. Will speed up the build if
      * your extension has lots of entrypoints, and you don't need to build all of them to develop a
@@ -467,6 +471,12 @@ interface InlineConfig {
      * Project hooks for running logic during the build process.
      */
     hooks?: NestedHooks<WxtHooks>;
+    /**
+     * List of WXT module names to include. Can be the full package name
+     * ("wxt-module-analytics"), or just the suffix ("analytics" would resolve to
+     * "wxt-module-analytics").
+     */
+    modules?: string[];
 }
 interface InlineConfig {
     /**
@@ -734,7 +744,7 @@ interface BaseEntrypoint {
      */
     inputPath: string;
     /**
-     * Absolute path to the entrypoint's output directory. Can be the`InternalConfg.outDir` or a
+     * Absolute path to the entrypoint's output directory. Can be `wxt.config.outDir` or a
      * subdirectory of it.
      */
     outputDir: string;
@@ -1059,6 +1069,13 @@ interface WxtHooks {
      * @param entrypoints The list of groups to build in each build step
      */
     'entrypoints:grouped': (wxt: Wxt, groups: EntrypointGroup[]) => HookResult;
+    /**
+     * Called when public assets are found. You can modify the `files` list by
+     * reference to add or remove public files.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of files that will be copied into the output directory
+     */
+    'build:publicAssets': (wxt: Wxt, files: ResolvedPublicFile[]) => HookResult;
 }
 interface Wxt {
     config: ResolvedConfig;
@@ -1091,15 +1108,31 @@ interface ResolvedConfig {
     root: string;
     srcDir: string;
     publicDir: string;
+    /**
+     * Absolute path pointing to `.wxt` directory in project root.
+     * @example
+     * "/path/to/project/.wxt"
+     */
     wxtDir: string;
     typesDir: string;
     entrypointsDir: string;
+    modulesDir: string;
     filterEntrypoints?: Set<string>;
+    /**
+     * Absolute path to the `.output` directory
+     * @example
+     * "/path/to/project/.output"
+     */
     outBaseDir: string;
+    /**
+     * Absolute path to the target output directory.
+     * @example
+     * "/path/to/project/.output/chrome-mv3"
+     */
     outDir: string;
     debug: boolean;
     /**
-     * Directory pointing to `node_modules/wxt`, wherever WXT is installed.
+     * Absolute path pointing to the `node_modules/wxt` directory, wherever WXT is installed.
      */
     wxtModuleDir: string;
     mode: string;
@@ -1157,6 +1190,15 @@ interface ResolvedConfig {
         reloadCommand: string | false;
     };
     hooks: NestedHooks<WxtHooks>;
+    modules: WxtModuleWithMetadata<any>[];
+    /**
+     * An array of string to import plugins from. These paths should be
+     * resolvable by vite, and they should `export default defineWxtPlugin(...)`.
+     *
+     * @example
+     * ["@wxt-dev/module-vue/plugin", "wxt-module-google-analytics/plugin"]
+     */
+    plugins: string[];
 }
 interface FsCache {
     set(key: string, value: string): Promise<void>;
@@ -1197,7 +1239,11 @@ interface ResolvedEslintrc {
 }
 type WxtUnimportOptions = Partial<UnimportOptions> & {
     /**
-     * When eslint is installed,
+     * When using ESLint, auto-imported variables are linted as "undeclared
+     * globals". This option lets you configure a base eslintrc that, when
+     * extended, fixes these lint errors.
+     *
+     * See <https://wxt.dev/guide/key-concepts/auto-imports.html#eslint>
      */
     eslintrc?: Eslintrc;
 };
@@ -1240,5 +1286,47 @@ interface Dependency {
     name: string;
     version: string;
 }
+type WxtModuleOptions = Record<string, any>;
+type WxtModuleSetup<TOptions extends WxtModuleOptions> = (wxt: Wxt, moduleOptions?: TOptions) => void | Promise<void>;
+interface WxtModule<TOptions extends WxtModuleOptions> {
+    name?: string;
+    /**
+     * Key for users to pass options into your module from their `wxt.config.ts` file.
+     */
+    configKey?: string;
+    /**
+     * Provide a list of imports to add to auto-imports.
+     */
+    imports?: Import[];
+    /**
+     * Alternative to adding hooks in setup function with `wxt.hooks`. Hooks are
+     * added before the `setup` function is called.
+     */
+    hooks?: WxtHooks;
+    /**
+     * A custom function that can be used to setup hooks and call module-specific
+     * APIs.
+     */
+    setup?: WxtModuleSetup<TOptions>;
+}
+interface WxtModuleWithMetadata<TOptions extends WxtModuleOptions> extends WxtModule<TOptions> {
+    type: 'local' | 'node_module';
+    id: string;
+}
+interface ResolvedPublicFile {
+    /**
+     * The absolute path to the file that will be copied to the output directory.
+     * @example
+     * "/path/to/any/file.css"
+     */
+    absoluteSrc: string;
+    /**
+     * The relative path in the output directory to copy the file to.
+     * @example
+     * "content-scripts/base-styles.css"
+     */
+    relativeDest: string;
+}
+type WxtPlugin = () => void;
 
-export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };
+export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, WxtPlugin as ab, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };

package/dist/{index-xOGXP3vY.d.ts → index-D6lH9OkP.d.ts}

@@ -1,6 +1,6 @@
 import * as vite from 'vite';
 import { Manifest, Scripting } from 'webextension-polyfill';
-import { UnimportOptions } from 'unimport';
+import { UnimportOptions, Import } from 'unimport';
 import { LogLevel } from 'consola';
 import { PluginVisualizerOptions } from '@aklinker1/rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
@@ -155,6 +155,10 @@ interface InlineConfig {
      * @default "${config.srcDir}/entrypoints"
      */
     entrypointsDir?: string;
+    /**
+     * @default "${config.srcDir}/modules"
+     */
+    modulesDir?: string;
     /**
      * A list of entrypoint names (`"popup"`, `"options"`, etc.) to build. Will speed up the build if
      * your extension has lots of entrypoints, and you don't need to build all of them to develop a
@@ -467,6 +471,12 @@ interface InlineConfig {
      * Project hooks for running logic during the build process.
      */
     hooks?: NestedHooks<WxtHooks>;
+    /**
+     * List of WXT module names to include. Can be the full package name
+     * ("wxt-module-analytics"), or just the suffix ("analytics" would resolve to
+     * "wxt-module-analytics").
+     */
+    modules?: string[];
 }
 interface InlineConfig {
     /**
@@ -734,7 +744,7 @@ interface BaseEntrypoint {
      */
     inputPath: string;
     /**
-     * Absolute path to the entrypoint's output directory. Can be the`InternalConfg.outDir` or a
+     * Absolute path to the entrypoint's output directory. Can be `wxt.config.outDir` or a
      * subdirectory of it.
      */
     outputDir: string;
@@ -1059,6 +1069,13 @@ interface WxtHooks {
      * @param entrypoints The list of groups to build in each build step
      */
     'entrypoints:grouped': (wxt: Wxt, groups: EntrypointGroup[]) => HookResult;
+    /**
+     * Called when public assets are found. You can modify the `files` list by
+     * reference to add or remove public files.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of files that will be copied into the output directory
+     */
+    'build:publicAssets': (wxt: Wxt, files: ResolvedPublicFile[]) => HookResult;
 }
 interface Wxt {
     config: ResolvedConfig;
@@ -1091,15 +1108,31 @@ interface ResolvedConfig {
     root: string;
     srcDir: string;
     publicDir: string;
+    /**
+     * Absolute path pointing to `.wxt` directory in project root.
+     * @example
+     * "/path/to/project/.wxt"
+     */
     wxtDir: string;
     typesDir: string;
     entrypointsDir: string;
+    modulesDir: string;
     filterEntrypoints?: Set<string>;
+    /**
+     * Absolute path to the `.output` directory
+     * @example
+     * "/path/to/project/.output"
+     */
     outBaseDir: string;
+    /**
+     * Absolute path to the target output directory.
+     * @example
+     * "/path/to/project/.output/chrome-mv3"
+     */
     outDir: string;
     debug: boolean;
     /**
-     * Directory pointing to `node_modules/wxt`, wherever WXT is installed.
+     * Absolute path pointing to the `node_modules/wxt` directory, wherever WXT is installed.
      */
     wxtModuleDir: string;
     mode: string;
@@ -1157,6 +1190,15 @@ interface ResolvedConfig {
         reloadCommand: string | false;
     };
     hooks: NestedHooks<WxtHooks>;
+    modules: WxtModuleWithMetadata<any>[];
+    /**
+     * An array of string to import plugins from. These paths should be
+     * resolvable by vite, and they should `export default defineWxtPlugin(...)`.
+     *
+     * @example
+     * ["@wxt-dev/module-vue/plugin", "wxt-module-google-analytics/plugin"]
+     */
+    plugins: string[];
 }
 interface FsCache {
     set(key: string, value: string): Promise<void>;
@@ -1197,7 +1239,11 @@ interface ResolvedEslintrc {
 }
 type WxtUnimportOptions = Partial<UnimportOptions> & {
     /**
-     * When eslint is installed,
+     * When using ESLint, auto-imported variables are linted as "undeclared
+     * globals". This option lets you configure a base eslintrc that, when
+     * extended, fixes these lint errors.
+     *
+     * See <https://wxt.dev/guide/key-concepts/auto-imports.html#eslint>
      */
     eslintrc?: Eslintrc;
 };
@@ -1240,5 +1286,47 @@ interface Dependency {
     name: string;
     version: string;
 }
+type WxtModuleOptions = Record<string, any>;
+type WxtModuleSetup<TOptions extends WxtModuleOptions> = (wxt: Wxt, moduleOptions?: TOptions) => void | Promise<void>;
+interface WxtModule<TOptions extends WxtModuleOptions> {
+    name?: string;
+    /**
+     * Key for users to pass options into your module from their `wxt.config.ts` file.
+     */
+    configKey?: string;
+    /**
+     * Provide a list of imports to add to auto-imports.
+     */
+    imports?: Import[];
+    /**
+     * Alternative to adding hooks in setup function with `wxt.hooks`. Hooks are
+     * added before the `setup` function is called.
+     */
+    hooks?: WxtHooks;
+    /**
+     * A custom function that can be used to setup hooks and call module-specific
+     * APIs.
+     */
+    setup?: WxtModuleSetup<TOptions>;
+}
+interface WxtModuleWithMetadata<TOptions extends WxtModuleOptions> extends WxtModule<TOptions> {
+    type: 'local' | 'node_module';
+    id: string;
+}
+interface ResolvedPublicFile {
+    /**
+     * The absolute path to the file that will be copied to the output directory.
+     * @example
+     * "/path/to/any/file.css"
+     */
+    absoluteSrc: string;
+    /**
+     * The relative path in the output directory to copy the file to.
+     * @example
+     * "content-scripts/base-styles.css"
+     */
+    relativeDest: string;
+}
+type WxtPlugin = () => void;
 
-export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };
+export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, WxtPlugin as ab, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };