wxt 0.11.0 → 0.11.1

package/dist/{chunk-6V4H2CZ4.js → chunk-65FJ5ESC.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.11.0";
+var version = "0.11.1";
 
 // src/core/utils/arrays.ts
 function every(array, predicate) {

package/dist/cli.cjs

@@ -2415,7 +2415,7 @@ var init_execa = __esm({
 var import_cac = __toESM(require("cac"), 1);
 
 // package.json
-var version = "0.11.0";
+var version = "0.11.1";
 
 // src/core/utils/fs.ts
 var import_fs_extra = __toESM(require("fs-extra"), 1);

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { B as BackgroundDefinition, C as ContentScriptContext, a as ContentScriptDefinition } from './external-6YqvLCcd.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';
 

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/{external-6YqvLCcd.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 {

package/dist/{external-n9SucYhJ.d.cts → external-irU6kFSB.d.cts}

@@ -5,6 +5,13 @@ 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).
  * Used to detect and stop content script code when the script is invalidated.
@@ -69,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 {
     /**

package/dist/{external-n9SucYhJ.d.ts → external-irU6kFSB.d.ts}

@@ -5,6 +5,13 @@ 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).
  * Used to detect and stop content script code when the script is invalidated.
@@ -69,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 {
     /**

package/dist/index.cjs

@@ -4299,7 +4299,7 @@ function getChunkSortWeight(filename) {
 var import_picocolors3 = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "0.11.0";
+var version = "0.11.1";
 
 // src/core/utils/log/printHeader.ts
 var import_consola2 = require("consola");

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { I as InlineConfig, B as BuildOutput, U as UserConfig, E as ExtensionRunnerConfig, W as WxtDevServer } from './external-n9SucYhJ.cjs';
-export { n as BackgroundDefinition, h as BackgroundEntrypoint, g as BaseEntrypoint, f as BaseEntrypointOptions, d as BuildStepOutput, t as ConfigEnv, m as ContentScriptDefinition, C as ContentScriptEntrypoint, j as Entrypoint, k as EntrypointGroup, q as ExcludableEntrypoint, G as GenericEntrypoint, L as Logger, l as OnContentScriptStopped, i as OptionsEntrypoint, c as OutputAsset, b as OutputChunk, O as OutputFile, p as PerBrowserOption, P as PopupEntrypoint, S as ServerInfo, T as TargetBrowser, e as TargetManifestVersion, o as UnlistedScriptDefinition, r as UserManifest, s as UserManifestFn, u as WxtBuilder, v as WxtBuilderServer, a as WxtViteConfig } from './external-n9SucYhJ.cjs';
+import { I as InlineConfig, B as BuildOutput, U as UserConfig, E as ExtensionRunnerConfig, W as WxtDevServer } from './external-irU6kFSB.cjs';
+export { n as BackgroundDefinition, h as BackgroundEntrypoint, g as BaseEntrypoint, f as BaseEntrypointOptions, d as BuildStepOutput, t as ConfigEnv, m as ContentScriptDefinition, C as ContentScriptEntrypoint, j as Entrypoint, k as EntrypointGroup, q as ExcludableEntrypoint, G as GenericEntrypoint, L as Logger, l as OnContentScriptStopped, i as OptionsEntrypoint, c as OutputAsset, b as OutputChunk, O as OutputFile, p as PerBrowserOption, P as PopupEntrypoint, S as ServerInfo, T as TargetBrowser, e as TargetManifestVersion, o as UnlistedScriptDefinition, r as UserManifest, s as UserManifestFn, u as WxtBuilder, v as WxtBuilderServer, a as WxtViteConfig } from './external-irU6kFSB.cjs';
 import 'vite';
 import 'webextension-polyfill';
 import 'unimport';
@@ -62,6 +62,6 @@ declare function prepare(config: InlineConfig): Promise<void>;
  */
 declare function zip(config?: InlineConfig): Promise<string[]>;
 
-var version = "0.11.0";
+var version = "0.11.1";
 
 export { BuildOutput, ExtensionRunnerConfig, InlineConfig, UserConfig, WxtDevServer, build, clean, createServer, defineConfig, defineRunnerConfig, initialize, prepare, version, zip };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { I as InlineConfig, B as BuildOutput, U as UserConfig, E as ExtensionRunnerConfig, W as WxtDevServer } from './external-n9SucYhJ.js';
-export { n as BackgroundDefinition, h as BackgroundEntrypoint, g as BaseEntrypoint, f as BaseEntrypointOptions, d as BuildStepOutput, t as ConfigEnv, m as ContentScriptDefinition, C as ContentScriptEntrypoint, j as Entrypoint, k as EntrypointGroup, q as ExcludableEntrypoint, G as GenericEntrypoint, L as Logger, l as OnContentScriptStopped, i as OptionsEntrypoint, c as OutputAsset, b as OutputChunk, O as OutputFile, p as PerBrowserOption, P as PopupEntrypoint, S as ServerInfo, T as TargetBrowser, e as TargetManifestVersion, o as UnlistedScriptDefinition, r as UserManifest, s as UserManifestFn, u as WxtBuilder, v as WxtBuilderServer, a as WxtViteConfig } from './external-n9SucYhJ.js';
+import { I as InlineConfig, B as BuildOutput, U as UserConfig, E as ExtensionRunnerConfig, W as WxtDevServer } from './external-irU6kFSB.js';
+export { n as BackgroundDefinition, h as BackgroundEntrypoint, g as BaseEntrypoint, f as BaseEntrypointOptions, d as BuildStepOutput, t as ConfigEnv, m as ContentScriptDefinition, C as ContentScriptEntrypoint, j as Entrypoint, k as EntrypointGroup, q as ExcludableEntrypoint, G as GenericEntrypoint, L as Logger, l as OnContentScriptStopped, i as OptionsEntrypoint, c as OutputAsset, b as OutputChunk, O as OutputFile, p as PerBrowserOption, P as PopupEntrypoint, S as ServerInfo, T as TargetBrowser, e as TargetManifestVersion, o as UnlistedScriptDefinition, r as UserManifest, s as UserManifestFn, u as WxtBuilder, v as WxtBuilderServer, a as WxtViteConfig } from './external-irU6kFSB.js';
 import 'vite';
 import 'webextension-polyfill';
 import 'unimport';
@@ -62,6 +62,6 @@ declare function prepare(config: InlineConfig): Promise<void>;
  */
 declare function zip(config?: InlineConfig): Promise<string[]>;
 
-var version = "0.11.0";
+var version = "0.11.1";
 
 export { BuildOutput, ExtensionRunnerConfig, InlineConfig, UserConfig, WxtDevServer, build, clean, createServer, defineConfig, defineRunnerConfig, initialize, prepare, version, zip };

package/dist/index.js

@@ -15,7 +15,7 @@ import {
   rebuild,
   resolvePerBrowserOption,
   version
-} from "./chunk-6V4H2CZ4.js";
+} from "./chunk-65FJ5ESC.js";
 import "./chunk-VBXJIVYU.js";
 
 // src/core/build.ts

package/dist/sandbox.d.ts

@@ -1,4 +1,4 @@
-import { U as UnlistedScriptDefinition } from './external-6YqvLCcd.js';
+import { U as UnlistedScriptDefinition } from './external-PmmO6xnl.js';
 import 'webextension-polyfill';
 
 declare function defineUnlistedScript(main: () => void): UnlistedScriptDefinition;

package/dist/testing.d.cts

@@ -1,6 +1,6 @@
 export { FakeBrowser, fakeBrowser } from '@webext-core/fake-browser';
 import * as vite from 'vite';
-import { I as InlineConfig } from './external-n9SucYhJ.cjs';
+import { I as InlineConfig } from './external-irU6kFSB.cjs';
 import 'webextension-polyfill';
 import 'unimport';
 import 'consola';

package/dist/testing.d.ts

@@ -1,6 +1,6 @@
 export { FakeBrowser, fakeBrowser } from '@webext-core/fake-browser';
 import * as vite from 'vite';
-import { I as InlineConfig } from './external-n9SucYhJ.js';
+import { I as InlineConfig } from './external-irU6kFSB.js';
 import 'webextension-polyfill';
 import 'unimport';
 import 'consola';

package/dist/testing.js

@@ -6,7 +6,7 @@ import {
   unimport,
   webextensionPolyfillAlias,
   webextensionPolyfillInlineDeps
-} from "./chunk-6V4H2CZ4.js";
+} from "./chunk-65FJ5ESC.js";
 import "./chunk-VBXJIVYU.js";
 
 // src/testing/fake-browser.ts

package/dist/virtual/content-script-entrypoint.js

@@ -23,6 +23,44 @@ var logger = {
 import originalBrowser from "webextension-polyfill";
 var browser = originalBrowser;
 
+// 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) {
@@ -39,6 +77,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;
   }
@@ -135,18 +174,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Next gen framework for developing web extensions",
   "engines": {
     "node": ">=18",