wxt 0.10.4 → 0.11.1

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { B as BackgroundDefinition, C as ContentScriptContext, a as ContentScriptDefinition } from './external-9107db91.js';
+import { B as BackgroundDefinition, C as ContentScriptContext, a as ContentScriptDefinition } from './external-PmmO6xnl.js';
 import * as wxt_browser from 'wxt/browser';
 import 'webextension-polyfill';
 
@@ -181,4 +181,4 @@ type ContentScriptIframeOptions = ContentScriptPositioningOptions & ContentScrip
 
 declare function defineContentScript(definition: ContentScriptDefinition): ContentScriptDefinition;
 
-export { ContentScriptContext, ContentScriptIframe, ContentScriptIframeOptions, ContentScriptUi, ContentScriptUiOptions, createContentScriptIframe, createContentScriptUi, defineBackground, defineContentScript };
+export { ContentScriptContext, type ContentScriptIframe, type ContentScriptIframeOptions, type ContentScriptUi, type ContentScriptUiOptions, createContentScriptIframe, createContentScriptUi, defineBackground, defineContentScript };

package/dist/client.js

@@ -27,6 +27,44 @@ var logger = {
   error: (...args) => print(console.error, ...args)
 };
 
+// src/client/content-scripts/custom-events.ts
+var WxtLocationChangeEvent = class _WxtLocationChangeEvent extends Event {
+  constructor(newUrl, oldUrl) {
+    super(_WxtLocationChangeEvent.EVENT_NAME, {});
+    this.newUrl = newUrl;
+    this.oldUrl = oldUrl;
+  }
+  static EVENT_NAME = getUniqueEventName("wxt:locationchange");
+};
+function getUniqueEventName(eventName) {
+  const entrypointName = typeof __ENTRYPOINT__ === "undefined" ? "build" : __ENTRYPOINT__;
+  return `${browser.runtime.id}:${entrypointName}:${eventName}`;
+}
+
+// src/client/content-scripts/location-watcher.ts
+function createLocationWatcher(ctx) {
+  let interval;
+  let oldUrl;
+  return {
+    /**
+     * Ensure the location watcher is actively looking for URL changes. If it's already watching,
+     * this is a noop.
+     */
+    run() {
+      if (interval != null)
+        return;
+      oldUrl = new URL(location.href);
+      interval = ctx.setInterval(() => {
+        let newUrl = new URL(location.href);
+        if (newUrl.href !== oldUrl.href) {
+          window.dispatchEvent(new WxtLocationChangeEvent(newUrl, oldUrl));
+          oldUrl = newUrl;
+        }
+      }, 1e3);
+    }
+  };
+}
+
 // src/client/content-scripts/content-script-context.ts
 var ContentScriptContext = class _ContentScriptContext {
   constructor(contentScriptName, options) {
@@ -43,6 +81,7 @@ var ContentScriptContext = class _ContentScriptContext {
   static SCRIPT_STARTED_MESSAGE_TYPE = "wxt:content-script-started";
   #isTopFrame = window.self === window.top;
   #abortController;
+  #locationWatcher = createLocationWatcher(this);
   get signal() {
     return this.#abortController.signal;
   }
@@ -139,18 +178,33 @@ var ContentScriptContext = class _ContentScriptContext {
   /**
    * Call `target.addEventListener` and remove the event listener when the context is invalidated.
    *
+   * Includes additional events useful for content scripts:
+   *
+   * - `"wxt:locationchange"` - Triggered when HTML5 history mode is used to change URL. Content
+   *   scripts are not reloaded when navigating this way, so this can be used to reset the content
+   *   script state on URL change, or run custom code.
+   *
    * @example
-   * ctx.addEventListener(window, "mousemove", () => {
+   * ctx.addEventListener(document, "visibilitychange", () => {
    *   // ...
    * });
-   * ctx.addEventListener(document, "visibilitychange", () => {
+   * ctx.addEventListener(document, "wxt:locationchange", () => {
    *   // ...
    * });
    */
   addEventListener(target, type, handler, options) {
-    target.addEventListener?.(type, handler, options);
-    this.onInvalidated(
-      () => target.removeEventListener?.(type, handler, options)
+    if (type === "wxt:locationchange") {
+      if (this.isValid)
+        this.#locationWatcher.run();
+    }
+    target.addEventListener?.(
+      type.startsWith("wxt:") ? getUniqueEventName(type) : type,
+      // @ts-expect-error: Event don't match, but that's OK, EventTarget doesn't allow custom types in the callback
+      handler,
+      {
+        ...options,
+        signal: this.signal
+      }
     );
   }
   /**

package/dist/{execa-Z7B33P3C.js → execa-4F7CCWCA.js}

@@ -2,7 +2,7 @@ import {
   __commonJS,
   __require,
   __toESM
-} from "./chunk-YUG22S6W.js";
+} from "./chunk-VBXJIVYU.js";
 
 // node_modules/.pnpm/isexe@2.0.0/node_modules/isexe/windows.js
 var require_windows = __commonJS({
@@ -1816,8 +1816,8 @@ var getSpawnedResult = async ({ stdout, stderr, all }, { encoding, buffer, maxBu
 };
 
 // node_modules/.pnpm/execa@8.0.1/node_modules/execa/lib/promise.js
-var nativePromisePrototype = (/* @__PURE__ */ (async () => {
-})()).constructor.prototype;
+var nativePromisePrototype = (async () => {
+})().constructor.prototype;
 var descriptors = ["then", "catch", "finally"].map((property) => [
   property,
   Reflect.getOwnPropertyDescriptor(nativePromisePrototype, property)

package/dist/{external-9107db91.d.ts → external-PmmO6xnl.d.ts}

@@ -1,5 +1,12 @@
 import { Manifest } from 'webextension-polyfill';
 
+declare class WxtLocationChangeEvent extends Event {
+    readonly newUrl: URL;
+    readonly oldUrl: URL;
+    static EVENT_NAME: string;
+    constructor(newUrl: URL, oldUrl: URL);
+}
+
 /**
  * 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.
@@ -64,21 +71,30 @@ declare class ContentScriptContext implements AbortController {
     /**
      * Call `target.addEventListener` and remove the event listener when the context is invalidated.
      *
+     * Includes additional events useful for content scripts:
+     *
+     * - `"wxt:locationchange"` - Triggered when HTML5 history mode is used to change URL. Content
+     *   scripts are not reloaded when navigating this way, so this can be used to reset the content
+     *   script state on URL change, or run custom code.
+     *
      * @example
-     * ctx.addEventListener(window, "mousemove", () => {
+     * ctx.addEventListener(document, "visibilitychange", () => {
      *   // ...
      * });
-     * ctx.addEventListener(document, "visibilitychange", () => {
+     * ctx.addEventListener(document, "wxt:locationchange", () => {
      *   // ...
      * });
      */
-    addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
+    addEventListener<TTarget extends EventTarget, TType extends keyof WxtContentScriptEventMap>(target: TTarget, type: TType, handler: (event: WxtContentScriptEventMap[TType]) => void, options?: AddEventListenerOptions): void;
     /**
      * @internal
      * Abort the abort controller and execute all `onInvalidated` listeners.
      */
     notifyInvalidated(): void;
 }
+interface WxtContentScriptEventMap extends WindowEventMap {
+    'wxt:locationchange': WxtLocationChangeEvent;
+}
 
 type TargetBrowser = string;
 interface ContentScriptDefinition extends ExcludableEntrypoint {
@@ -173,4 +189,4 @@ interface ExcludableEntrypoint {
     exclude?: TargetBrowser[];
 }
 
-export { BackgroundDefinition as B, ContentScriptContext as C, UnlistedScriptDefinition as U, ContentScriptDefinition as a };
+export { type BackgroundDefinition as B, ContentScriptContext as C, type UnlistedScriptDefinition as U, type ContentScriptDefinition as a };

package/dist/{external-32209cff.d.ts → external-irU6kFSB.d.cts}

@@ -3,6 +3,14 @@ import { Manifest, Scripting } from 'webextension-polyfill';
 import { UnimportOptions } from 'unimport';
 import { LogLevel } from 'consola';
 import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
+import { FSWatcher } from 'chokidar';
+
+declare class WxtLocationChangeEvent extends Event {
+    readonly newUrl: URL;
+    readonly oldUrl: URL;
+    static EVENT_NAME: string;
+    constructor(newUrl: URL, oldUrl: URL);
+}
 
 /**
  * Implements [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
@@ -68,21 +76,30 @@ declare class ContentScriptContext implements AbortController {
     /**
      * Call `target.addEventListener` and remove the event listener when the context is invalidated.
      *
+     * Includes additional events useful for content scripts:
+     *
+     * - `"wxt:locationchange"` - Triggered when HTML5 history mode is used to change URL. Content
+     *   scripts are not reloaded when navigating this way, so this can be used to reset the content
+     *   script state on URL change, or run custom code.
+     *
      * @example
-     * ctx.addEventListener(window, "mousemove", () => {
+     * ctx.addEventListener(document, "visibilitychange", () => {
      *   // ...
      * });
-     * ctx.addEventListener(document, "visibilitychange", () => {
+     * ctx.addEventListener(document, "wxt:locationchange", () => {
      *   // ...
      * });
      */
-    addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
+    addEventListener<TTarget extends EventTarget, TType extends keyof WxtContentScriptEventMap>(target: TTarget, type: TType, handler: (event: WxtContentScriptEventMap[TType]) => void, options?: AddEventListenerOptions): void;
     /**
      * @internal
      * Abort the abort controller and execute all `onInvalidated` listeners.
      */
     notifyInvalidated(): void;
 }
+interface WxtContentScriptEventMap extends WindowEventMap {
+    'wxt:locationchange': WxtLocationChangeEvent;
+}
 
 interface InlineConfig {
     /**
@@ -168,17 +185,6 @@ interface InlineConfig {
      * 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.
@@ -278,10 +284,6 @@ interface InlineConfig {
      * Add additional paths to the `.wxt/tsconfig.json`. Use this instead of overwriting the `paths`
      * in the root `tsconfig.json` if you want to add new paths.
      *
-     * Passed into Vite's
-     * [`resolve.alias`](https://vitejs.dev/config/shared-options.html#resolve-alias) option and used
-     * to generate the `.wxt/tsconfig.json`.
-     *
      * The key is the import alias and the value is either a relative path to the root directory or an absolute path.
      *
      * @example
@@ -316,39 +318,65 @@ interface InlineConfig {
         includeBrowserPolyfill?: boolean;
     };
 }
-interface WxtInlineViteConfig extends Omit<vite.InlineConfig, 'root' | 'configFile' | 'mode' | 'build'> {
-    build?: Omit<vite.BuildOptions, 'outDir'>;
+interface InlineConfig {
+    /**
+     * 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>;
 }
+type WxtViteConfig = Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
 interface BuildOutput {
     manifest: Manifest.WebExtensionManifest;
-    publicAssets: vite.Rollup.OutputAsset[];
+    publicAssets: OutputAsset[];
     steps: BuildStepOutput[];
 }
-interface BuildStepOutput {
-    entrypoints: EntrypointGroup;
-    chunks: (vite.Rollup.OutputChunk | vite.Rollup.OutputAsset)[];
-}
-interface WxtDevServer extends vite.ViteDevServer {
+type OutputFile = OutputChunk | OutputAsset;
+interface OutputChunk {
+    type: 'chunk';
     /**
-     * Ex: `3000`
+     * Relative, normalized path relative to the output directory.
+     *
+     * Ex: "content-scripts/overlay.js"
      */
-    port: number;
+    fileName: string;
     /**
-     * Ex: `"localhost"`
+     * Absolute, normalized paths to all dependencies this chunk relies on.
      */
-    hostname: string;
+    moduleIds: string[];
+}
+interface OutputAsset {
+    type: 'asset';
     /**
-     * Ex: `"http://localhost:3000"`
+     * Relative, normalized path relative to the output directory.
+     *
+     * Ex: "icons/16.png"
      */
-    origin: string;
+    fileName: string;
+}
+interface BuildStepOutput {
+    entrypoints: EntrypointGroup;
+    chunks: OutputFile[];
+}
+interface WxtDevServer extends Omit<WxtBuilderServer, 'listen'>, ServerInfo {
     /**
      * Stores the current build output of the server.
      */
     currentOutput: BuildOutput;
     /**
-     * Start the server on the first open port.
+     * Start the server.
      */
     start(): Promise<void>;
+    /**
+     * Transform the HTML for dev mode.
+     */
+    transformHtml(url: string, html: string, originalUrl?: string | undefined): Promise<string>;
     /**
      * Tell the extension to reload by running `browser.runtime.reload`.
      */
@@ -614,6 +642,69 @@ interface ExtensionRunnerConfig {
      */
     startUrls?: string[];
 }
-type WxtViteConfig = Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
+interface WxtBuilder {
+    /**
+     * Name of tool used to build. Ex: "Vite" or "Webpack".
+     */
+    name: string;
+    /**
+     * Version of tool used to build. Ex: "5.0.2"
+     */
+    version: string;
+    /**
+     * Build a single entrypoint group. This is effectively one of the multiple "steps" during the
+     * build process.
+     */
+    build(group: EntrypointGroup): Promise<BuildStepOutput>;
+    /**
+     * Start a dev server at the provided port.
+     */
+    createServer(info: ServerInfo): Promise<WxtBuilderServer>;
+}
+interface WxtBuilderServer {
+    /**
+     * Start the server.
+     */
+    listen(): Promise<void>;
+    /**
+     * Transform the HTML for dev mode.
+     */
+    transformHtml(url: string, html: string, originalUrl?: string | undefined): Promise<string>;
+    /**
+     * The web socket server used to communicate with the extension.
+     */
+    ws: {
+        /**
+         * Send a message via the server's websocket, with an optional payload.
+         *
+         * @example
+         * ws.send("wxt:reload-extension");
+         * ws.send("wxt:reload-content-script", { ... });
+         */
+        send(message: string, payload?: any): void;
+        /**
+         * Listen for messages over the server's websocket.
+         */
+        on(message: string, cb: (payload: any) => void): void;
+    };
+    /**
+     * Chokidar file watcher instance.
+     */
+    watcher: FSWatcher;
+}
+interface ServerInfo {
+    /**
+     * Ex: `3000`
+     */
+    port: number;
+    /**
+     * Ex: `"localhost"`
+     */
+    hostname: string;
+    /**
+     * Ex: `"http://localhost:3000"`
+     */
+    origin: string;
+}
 
-export { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OptionsEntrypoint as O, PopupEntrypoint as P, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtInlineViteConfig as a, BuildStepOutput as b, TargetManifestVersion as c, BaseEntrypointOptions as d, BaseEntrypoint as e, BackgroundEntrypoint as f, Entrypoint as g, EntrypointGroup as h, OnContentScriptStopped as i, ContentScriptDefinition as j, BackgroundDefinition as k, UnlistedScriptDefinition as l, PerBrowserOption as m, ExcludableEntrypoint as n, UserManifest as o, UserManifestFn as p, ConfigEnv as q, WxtViteConfig as r };
+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, BackgroundDefinition as n, UnlistedScriptDefinition as o, PerBrowserOption as p, ExcludableEntrypoint as q, UserManifest as r, UserManifestFn as s, ConfigEnv as t, WxtBuilder as u, WxtBuilderServer as v };