wxt 0.16.1 → 0.16.3

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { a as ContentScriptContext } from './external-TYmXqKVq.js';
+import { a as ContentScriptContext } from './index-TYmXqKVq.js';
 import 'webextension-polyfill';
 
 interface IntegratedContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {

package/dist/{external-2QTHXYDU.d.cts → index-wltPoSyr.d.cts}

@@ -4,6 +4,8 @@ import { UnimportOptions } from 'unimport';
 import { LogLevel } from 'consola';
 import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
+import { ResolvedConfig as ResolvedConfig$1 } from 'c12';
+import { NestedHooks, Hookable } from 'hookable';
 
 declare class WxtLocationChangeEvent extends Event {
     readonly newUrl: URL;
@@ -266,6 +268,9 @@ interface InlineConfig {
         excludeSources?: string[];
     };
     /**
+     * @deprecated Use `hooks.build.manifestGenerated` to modify your manifest instead. This option
+     *             will be removed in v1.0
+     *
      * 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.
      *
@@ -354,6 +359,10 @@ interface InlineConfig {
          */
         reloadCommand?: string | false;
     };
+    /**
+     * Project hooks for running logic during the build process.
+     */
+    hooks?: NestedHooks<WxtHooks>;
 }
 interface InlineConfig {
     /**
@@ -800,5 +809,115 @@ interface ServerInfo {
      */
     origin: string;
 }
+type HookResult = Promise<void> | void;
+interface WxtHooks {
+    /**
+     * Called after WXT initialization, when the WXT instance is ready to work.
+     * @param wxt The configured WXT object
+     * @returns Promise
+     */
+    ready: (wxt: Wxt) => HookResult;
+    /**
+     * Called before the build is started in both dev mode and build mode.
+     *
+     * @param wxt The configured WXT object
+     */
+    'build:before': (wxt: Wxt) => HookResult;
+    /**
+     * Called once the build process has finished.
+     * @param wxt The configured WXT object
+     * @param output The results of the build
+     */
+    'build:done': (wxt: Wxt, output: Readonly<BuildOutput>) => HookResult;
+    /**
+     * Called once the manifest has been generated. Used to transform the manifest by reference before
+     * it is written to the output directory.
+     * @param wxt The configured WXT object
+     * @param manifest The manifest that was generated
+     */
+    'build:manifestGenerated': (wxt: Wxt, manifest: Manifest.WebExtensionManifest) => HookResult;
+    /**
+     * Called once all entrypoints have been loaded from the `entrypointsDir`.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of entrypoints to be built
+     */
+    'entrypoints:resolved': (wxt: Wxt, entrypoints: Entrypoint[]) => HookResult;
+    /**
+     * Called once all entrypoints have been grouped into their build groups.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of groups to build in each build step
+     */
+    'entrypoints:grouped': (wxt: Wxt, groups: EntrypointGroup[]) => HookResult;
+}
+interface Wxt {
+    config: ResolvedConfig;
+    hooks: Hookable<WxtHooks>;
+    /**
+     * Alias for config.logger
+     */
+    logger: Logger;
+    /**
+     * Reload config file and update the `config` field with the result.
+     */
+    reloadConfig: () => Promise<void>;
+}
+interface ResolvedConfig {
+    root: string;
+    srcDir: string;
+    publicDir: string;
+    wxtDir: string;
+    typesDir: string;
+    entrypointsDir: string;
+    filterEntrypoints?: Set<string>;
+    outBaseDir: string;
+    outDir: string;
+    debug: boolean;
+    mode: string;
+    command: 'build' | 'serve';
+    browser: TargetBrowser;
+    manifestVersion: TargetManifestVersion;
+    env: ConfigEnv;
+    logger: Logger;
+    imports: false | Partial<UnimportOptions>;
+    manifest: UserManifest;
+    fsCache: FsCache;
+    server?: WxtDevServer;
+    runnerConfig: ResolvedConfig$1<ExtensionRunnerConfig>;
+    zip: {
+        name?: string;
+        artifactTemplate: string;
+        sourcesTemplate: string;
+        includeSources: string[];
+        excludeSources: string[];
+        sourcesRoot: string;
+    };
+    transformManifest: (manifest: Manifest.WebExtensionManifest) => void;
+    analysis: {
+        enabled: boolean;
+        template: NonNullable<PluginVisualizerOptions['template']>;
+    };
+    userConfigMetadata: Omit<ResolvedConfig$1<UserConfig>, 'config'>;
+    /**
+     * Import aliases to absolute paths.
+     */
+    alias: Record<string, string>;
+    experimental: {
+        includeBrowserPolyfill: boolean;
+    };
+    builder: WxtBuilder;
+    dev: {
+        reloadCommand: string | false;
+    };
+    hooks: Partial<WxtHooks>;
+}
+interface FsCache {
+    set(key: string, value: string): Promise<void>;
+    get(key: string): Promise<string | undefined>;
+}
+interface ExtensionRunner {
+    openBrowser(): Promise<void>;
+    closeBrowser(): Promise<void>;
+}
+type VirtualEntrypointType = 'content-script-main-world' | 'content-script-isolated-world' | 'background' | 'unlisted-script';
 
-export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y };
+export type { Wxt as A, BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunner as D, ExtensionRunnerConfig as E, FsCache as F, GenericEntrypoint as G, HookResult as H, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ResolvedConfig as R, ServerInfo as S, TargetBrowser as T, UserConfig as U, VirtualEntrypointType as V, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y, WxtHooks as z };

package/dist/{external-2QTHXYDU.d.ts → index-wltPoSyr.d.ts}

@@ -4,6 +4,8 @@ import { UnimportOptions } from 'unimport';
 import { LogLevel } from 'consola';
 import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
+import { ResolvedConfig as ResolvedConfig$1 } from 'c12';
+import { NestedHooks, Hookable } from 'hookable';
 
 declare class WxtLocationChangeEvent extends Event {
     readonly newUrl: URL;
@@ -266,6 +268,9 @@ interface InlineConfig {
         excludeSources?: string[];
     };
     /**
+     * @deprecated Use `hooks.build.manifestGenerated` to modify your manifest instead. This option
+     *             will be removed in v1.0
+     *
      * 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.
      *
@@ -354,6 +359,10 @@ interface InlineConfig {
          */
         reloadCommand?: string | false;
     };
+    /**
+     * Project hooks for running logic during the build process.
+     */
+    hooks?: NestedHooks<WxtHooks>;
 }
 interface InlineConfig {
     /**
@@ -800,5 +809,115 @@ interface ServerInfo {
      */
     origin: string;
 }
+type HookResult = Promise<void> | void;
+interface WxtHooks {
+    /**
+     * Called after WXT initialization, when the WXT instance is ready to work.
+     * @param wxt The configured WXT object
+     * @returns Promise
+     */
+    ready: (wxt: Wxt) => HookResult;
+    /**
+     * Called before the build is started in both dev mode and build mode.
+     *
+     * @param wxt The configured WXT object
+     */
+    'build:before': (wxt: Wxt) => HookResult;
+    /**
+     * Called once the build process has finished.
+     * @param wxt The configured WXT object
+     * @param output The results of the build
+     */
+    'build:done': (wxt: Wxt, output: Readonly<BuildOutput>) => HookResult;
+    /**
+     * Called once the manifest has been generated. Used to transform the manifest by reference before
+     * it is written to the output directory.
+     * @param wxt The configured WXT object
+     * @param manifest The manifest that was generated
+     */
+    'build:manifestGenerated': (wxt: Wxt, manifest: Manifest.WebExtensionManifest) => HookResult;
+    /**
+     * Called once all entrypoints have been loaded from the `entrypointsDir`.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of entrypoints to be built
+     */
+    'entrypoints:resolved': (wxt: Wxt, entrypoints: Entrypoint[]) => HookResult;
+    /**
+     * Called once all entrypoints have been grouped into their build groups.
+     * @param wxt The configured WXT object
+     * @param entrypoints The list of groups to build in each build step
+     */
+    'entrypoints:grouped': (wxt: Wxt, groups: EntrypointGroup[]) => HookResult;
+}
+interface Wxt {
+    config: ResolvedConfig;
+    hooks: Hookable<WxtHooks>;
+    /**
+     * Alias for config.logger
+     */
+    logger: Logger;
+    /**
+     * Reload config file and update the `config` field with the result.
+     */
+    reloadConfig: () => Promise<void>;
+}
+interface ResolvedConfig {
+    root: string;
+    srcDir: string;
+    publicDir: string;
+    wxtDir: string;
+    typesDir: string;
+    entrypointsDir: string;
+    filterEntrypoints?: Set<string>;
+    outBaseDir: string;
+    outDir: string;
+    debug: boolean;
+    mode: string;
+    command: 'build' | 'serve';
+    browser: TargetBrowser;
+    manifestVersion: TargetManifestVersion;
+    env: ConfigEnv;
+    logger: Logger;
+    imports: false | Partial<UnimportOptions>;
+    manifest: UserManifest;
+    fsCache: FsCache;
+    server?: WxtDevServer;
+    runnerConfig: ResolvedConfig$1<ExtensionRunnerConfig>;
+    zip: {
+        name?: string;
+        artifactTemplate: string;
+        sourcesTemplate: string;
+        includeSources: string[];
+        excludeSources: string[];
+        sourcesRoot: string;
+    };
+    transformManifest: (manifest: Manifest.WebExtensionManifest) => void;
+    analysis: {
+        enabled: boolean;
+        template: NonNullable<PluginVisualizerOptions['template']>;
+    };
+    userConfigMetadata: Omit<ResolvedConfig$1<UserConfig>, 'config'>;
+    /**
+     * Import aliases to absolute paths.
+     */
+    alias: Record<string, string>;
+    experimental: {
+        includeBrowserPolyfill: boolean;
+    };
+    builder: WxtBuilder;
+    dev: {
+        reloadCommand: string | false;
+    };
+    hooks: Partial<WxtHooks>;
+}
+interface FsCache {
+    set(key: string, value: string): Promise<void>;
+    get(key: string): Promise<string | undefined>;
+}
+interface ExtensionRunner {
+    openBrowser(): Promise<void>;
+    closeBrowser(): Promise<void>;
+}
+type VirtualEntrypointType = 'content-script-main-world' | 'content-script-isolated-world' | 'background' | 'unlisted-script';
 
-export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y };
+export type { Wxt as A, BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunner as D, ExtensionRunnerConfig as E, FsCache as F, GenericEntrypoint as G, HookResult as H, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ResolvedConfig as R, ServerInfo as S, TargetBrowser as T, UserConfig as U, VirtualEntrypointType as V, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y, WxtHooks as z };