wxt 0.20.18 → 0.20.20

package/dist/utils/app-config.mjs

@@ -1,5 +1,4 @@
 import appConfig from "virtual:app-config";
-
 //#region src/utils/app-config.ts
 /** @module wxt/utils/app-config */
 /**
@@ -18,6 +17,5 @@ function getAppConfig() {
 function useAppConfig() {
 	return getAppConfig();
 }
-
 //#endregion
-export { getAppConfig, useAppConfig };
+export { getAppConfig, useAppConfig };

package/dist/utils/content-script-context.d.mts

@@ -3,20 +3,22 @@ import { ContentScriptDefinition } from "../types.mjs";
 
 //#region src/utils/content-script-context.d.ts
 /**
- * Implements [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * 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.
  *
- * 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`.
+ * 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`.
  *
  * To create context for testing, you can use the class's constructor:
  *
  * ```ts
  * import { ContentScriptContext } from 'wxt/utils/content-scripts-context';
  *
- * test("storage listener should be removed when context is invalidated", () => {
+ * test('storage listener should be removed when context is invalidated', () => {
  *   const ctx = new ContentScriptContext('test');
- *   const item = storage.defineItem("local:count", { defaultValue: 0 });
+ *   const item = storage.defineItem('local:count', { defaultValue: 0 });
  *   const watcher = vi.fn();
  *
  *   const unwatch = item.watch(watcher);
@@ -45,75 +47,83 @@ declare class ContentScriptContext implements AbortController {
   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.
+   * Add a listener that is called when the content script's context is
+   * invalidated.
    *
    * @example
-   * browser.runtime.onMessage.addListener(cb);
-   * const removeInvalidatedListener = ctx.onInvalidated(() => {
-   *   browser.runtime.onMessage.removeListener(cb);
-   * })
-   * // ...
-   * removeInvalidatedListener();
+   *   browser.runtime.onMessage.addListener(cb);
+   *   const removeInvalidatedListener = ctx.onInvalidated(() => {
+   *     browser.runtime.onMessage.removeListener(cb);
+   *   });
+   *   // ...
+   *   removeInvalidatedListener();
+   *
+   * @returns A function to remove the listener.
    */
   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.
+   * 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();
+   *   const getValueFromStorage = async () => {
+   *     if (ctx.isInvalid) return ctx.block();
    *
-   *   // ...
-   * }
+   *     // ...
+   *   };
    */
   block<T>(): Promise<T>;
   /**
-   * Wrapper around `window.setInterval` that automatically clears the interval when invalidated.
+   * Wrapper around `window.setInterval` that automatically clears the interval
+   * when invalidated.
    *
    * Intervals can be cleared by calling the normal `clearInterval` function.
    */
   setInterval(handler: () => void, timeout?: number): number;
   /**
-   * Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.
+   * Wrapper around `window.setTimeout` that automatically clears the interval
+   * when invalidated.
    *
    * Timeouts can be cleared by calling the normal `setTimeout` function.
    */
   setTimeout(handler: () => void, timeout?: number): number;
   /**
-   * Wrapper around `window.requestAnimationFrame` that automatically cancels the request when
-   * invalidated.
+   * Wrapper around `window.requestAnimationFrame` that automatically cancels
+   * the request when invalidated.
    *
-   * Callbacks can be canceled by calling the normal `cancelAnimationFrame` function.
+   * Callbacks can be canceled by calling the normal `cancelAnimationFrame`
+   * function.
    */
   requestAnimationFrame(callback: FrameRequestCallback): number;
   /**
-   * Wrapper around `window.requestIdleCallback` that automatically cancels the request when
-   * invalidated.
+   * Wrapper around `window.requestIdleCallback` that automatically cancels the
+   * request when invalidated.
    *
-   * Callbacks can be canceled by calling the normal `cancelIdleCallback` function.
+   * Callbacks can be canceled by calling the normal `cancelIdleCallback`
+   * function.
    */
   requestIdleCallback(callback: IdleRequestCallback, options?: IdleRequestOptions): number;
   /**
-   * Call `target.addEventListener` and remove the event listener when the context is invalidated.
+   * Call `target.addEventListener` and remove the event listener when the
+   * context is invalidated.
    *
-   * Listeners can be canceled by calling the normal `removeEventListener` function.
+   * Listeners can be canceled by calling the normal `removeEventListener`
+   * function.
    *
    * 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.
+   * - `"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(document, "visibilitychange", () => {
-   *   // ...
-   * });
-   * ctx.addEventListener(window, "wxt:locationchange", () => {
-   *   // ...
-   * });
+   *   ctx.addEventListener(document, 'visibilitychange', () => {
+   *     // ...
+   *   });
+   *   ctx.addEventListener(window, 'wxt:locationchange', () => {
+   *     // ...
+   *   });
    */
   addEventListener<TType extends keyof WxtWindowEventMap>(target: Window, type: TType, handler: (event: WxtWindowEventMap[TType]) => void, options?: AddEventListenerOptions): void;
   addEventListener<TType extends keyof DocumentEventMap>(target: Document, type: TType, handler: (event: DocumentEventMap[TType]) => void, options?: AddEventListenerOptions): void;

package/dist/utils/content-script-context.mjs

@@ -2,23 +2,24 @@ import { logger } from "./internal/logger.mjs";
 import { getUniqueEventName } from "./internal/custom-events.mjs";
 import { createLocationWatcher } from "./internal/location-watcher.mjs";
 import { browser } from "wxt/browser";
-
 //#region src/utils/content-script-context.ts
 /**
-* Implements [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+* 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.
 *
-* 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`.
+* 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`.
 *
 * To create context for testing, you can use the class's constructor:
 *
 * ```ts
 * import { ContentScriptContext } from 'wxt/utils/content-scripts-context';
 *
-* test("storage listener should be removed when context is invalidated", () => {
+* test('storage listener should be removed when context is invalidated', () => {
 *   const ctx = new ContentScriptContext('test');
-*   const item = storage.defineItem("local:count", { defaultValue: 0 });
+*   const item = storage.defineItem('local:count', { defaultValue: 0 });
 *   const watcher = vi.fn();
 *
 *   const unwatch = item.watch(watcher);
@@ -61,38 +62,40 @@ var ContentScriptContext = class ContentScriptContext {
 		return !this.isInvalid;
 	}
 	/**
-	* Add a listener that is called when the content script's context is invalidated.
-	*
-	* @returns A function to remove the listener.
+	* Add a listener that is called when the content script's context is
+	* invalidated.
 	*
 	* @example
-	* browser.runtime.onMessage.addListener(cb);
-	* const removeInvalidatedListener = ctx.onInvalidated(() => {
-	*   browser.runtime.onMessage.removeListener(cb);
-	* })
-	* // ...
-	* removeInvalidatedListener();
+	*   browser.runtime.onMessage.addListener(cb);
+	*   const removeInvalidatedListener = ctx.onInvalidated(() => {
+	*     browser.runtime.onMessage.removeListener(cb);
+	*   });
+	*   // ...
+	*   removeInvalidatedListener();
+	*
+	* @returns A function to remove the listener.
 	*/
 	onInvalidated(cb) {
 		this.signal.addEventListener("abort", cb);
 		return () => this.signal.removeEventListener("abort", cb);
 	}
 	/**
-	* Return a promise that never resolves. Useful if you have an async function that shouldn't run
-	* after the context is expired.
+	* 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();
+	*   const getValueFromStorage = async () => {
+	*     if (ctx.isInvalid) return ctx.block();
 	*
-	*   // ...
-	* }
+	*     // ...
+	*   };
 	*/
 	block() {
 		return new Promise(() => {});
 	}
 	/**
-	* Wrapper around `window.setInterval` that automatically clears the interval when invalidated.
+	* Wrapper around `window.setInterval` that automatically clears the interval
+	* when invalidated.
 	*
 	* Intervals can be cleared by calling the normal `clearInterval` function.
 	*/
@@ -104,7 +107,8 @@ var ContentScriptContext = class ContentScriptContext {
 		return id;
 	}
 	/**
-	* Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.
+	* Wrapper around `window.setTimeout` that automatically clears the interval
+	* when invalidated.
 	*
 	* Timeouts can be cleared by calling the normal `setTimeout` function.
 	*/
@@ -116,10 +120,11 @@ var ContentScriptContext = class ContentScriptContext {
 		return id;
 	}
 	/**
-	* Wrapper around `window.requestAnimationFrame` that automatically cancels the request when
-	* invalidated.
+	* Wrapper around `window.requestAnimationFrame` that automatically cancels
+	* the request when invalidated.
 	*
-	* Callbacks can be canceled by calling the normal `cancelAnimationFrame` function.
+	* Callbacks can be canceled by calling the normal `cancelAnimationFrame`
+	* function.
 	*/
 	requestAnimationFrame(callback) {
 		const id = requestAnimationFrame((...args) => {
@@ -129,10 +134,11 @@ var ContentScriptContext = class ContentScriptContext {
 		return id;
 	}
 	/**
-	* Wrapper around `window.requestIdleCallback` that automatically cancels the request when
-	* invalidated.
+	* Wrapper around `window.requestIdleCallback` that automatically cancels the
+	* request when invalidated.
 	*
-	* Callbacks can be canceled by calling the normal `cancelIdleCallback` function.
+	* Callbacks can be canceled by calling the normal `cancelIdleCallback`
+	* function.
 	*/
 	requestIdleCallback(callback, options) {
 		const id = requestIdleCallback((...args) => {
@@ -183,6 +189,5 @@ var ContentScriptContext = class ContentScriptContext {
 		this.onInvalidated(() => document.removeEventListener(ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE, cb));
 	}
 };
-
 //#endregion
-export { ContentScriptContext };
+export { ContentScriptContext };

package/dist/utils/content-script-ui/iframe.d.mts

@@ -10,31 +10,30 @@ import * as wxt_browser0 from "wxt/browser";
  */
 declare function createIframeUi<TMounted>(ctx: ContentScriptContext, options: IframeContentScriptUiOptions<TMounted>): IframeContentScriptUi<TMounted>;
 interface IframeContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
-  /**
-   * The iframe added to the DOM.
-   */
+  /** The iframe added to the DOM. */
   iframe: HTMLIFrameElement;
-  /**
-   * A wrapper div that assists in positioning.
-   */
+  /** A wrapper div that assists in positioning. */
   wrapper: HTMLDivElement;
 }
 type IframeContentScriptUiOptions<TMounted> = ContentScriptUiOptions<TMounted> & {
   /**
-   * The path to the HTML page that will be shown in the iframe. This string is passed into
-   * `browser.runtime.getURL`.
+   * The path to the HTML page that will be shown in the iframe. This string
+   * is passed into `browser.runtime.getURL`.
    */
   page: wxt_browser0.HtmlPublicPath;
   /**
-   * Callback executed when mounting the UI. Use this function to customize the iframe or wrapper
-   * element's appearance. It is called every time `ui.mount()` is called.
+   * Callback executed when mounting the UI. Use this function to customize
+   * the iframe or wrapper element's appearance. It is called every time
+   * `ui.mount()` is called.
    *
-   * Optionally return a value that can be accessed at `ui.mounted` or in the `onRemove` callback.
+   * Optionally return a value that can be accessed at `ui.mounted` or in the
+   * `onRemove` callback.
    */
   onMount?: (wrapper: HTMLElement, iframe: HTMLIFrameElement) => TMounted;
   /**
-   * Callback executed before mounting the UI. Use this function to customize the iframe or wrapper
-   * elements before they are injected into the DOM. It is called every time `ui.mount()` is called.
+   * Callback executed before mounting the UI. Use this function to customize
+   * the iframe or wrapper elements before they are injected into the DOM. It
+   * is called every time `ui.mount()` is called.
    */
   onBeforeMount?: (wrapper: HTMLElement, iframe: HTMLIFrameElement) => void;
 };

package/dist/utils/content-script-ui/iframe.mjs

@@ -1,6 +1,5 @@
 import { applyPosition, createMountFunctions, mountUi } from "./shared.mjs";
 import { browser } from "wxt/browser";
-
 //#region src/utils/content-script-ui/iframe.ts
 /** @module wxt/utils/content-script-ui/iframe */
 /**
@@ -39,6 +38,5 @@ function createIframeUi(ctx, options) {
 		...mountFunctions
 	};
 }
-
 //#endregion
-export { createIframeUi };
+export { createIframeUi };

package/dist/utils/content-script-ui/integrated.d.mts

@@ -10,26 +10,27 @@ import { ContentScriptUi, ContentScriptUiOptions } from "./types.mjs";
 declare function createIntegratedUi<TMounted>(ctx: ContentScriptContext, options: IntegratedContentScriptUiOptions<TMounted>): IntegratedContentScriptUi<TMounted>;
 /**
  * Shared types for the different `wxt/utils/content-script-ui/*` modules.
+ *
  * @module wxt/utils/content-script-ui/types
  */
 interface IntegratedContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
-  /**
-   * A wrapper div that assists in positioning.
-   */
+  /** A wrapper div that assists in positioning. */
   wrapper: HTMLElement;
 }
 type IntegratedContentScriptUiOptions<TMounted> = ContentScriptUiOptions<TMounted> & {
   /**
    * Tag used to create the wrapper element.
    *
-   * @default "div"
+   * @default 'div'
    */
   tag?: string;
   /**
-   * Callback executed when mounting the UI. This function should create and append the UI to the
-   * `wrapper` element. It is called every time `ui.mount()` is called.
+   * Callback executed when mounting the UI. This function should create and
+   * append the UI to the `wrapper` element. It is called every time
+   * `ui.mount()` is called.
    *
-   * Optionally return a value that can be accessed at `ui.mounted` or in the `onRemove` callback.
+   * Optionally return a value that can be accessed at `ui.mounted` or in the
+   * `onRemove` callback.
    */
   onMount: (wrapper: HTMLElement) => TMounted;
 };

package/dist/utils/content-script-ui/integrated.mjs

@@ -1,5 +1,4 @@
 import { applyPosition, createMountFunctions, mountUi } from "./shared.mjs";
-
 //#region src/utils/content-script-ui/integrated.ts
 /**
 * Create a content script UI without any isolation.
@@ -33,6 +32,5 @@ function createIntegratedUi(ctx, options) {
 		...mountFunctions
 	};
 }
-
 //#endregion
-export { createIntegratedUi };
+export { createIntegratedUi };

package/dist/utils/content-script-ui/shadow-root.d.mts

@@ -3,7 +3,8 @@ import { ContentScriptUi, ContentScriptUiOptions } from "./types.mjs";
 
 //#region src/utils/content-script-ui/shadow-root.d.ts
 /**
- * Create a content script UI inside a [`ShadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot).
+ * Create a content script UI inside a
+ * [`ShadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot).
  *
  * > This function is async because it has to load the CSS via a network call.
  *
@@ -12,67 +13,78 @@ import { ContentScriptUi, ContentScriptUiOptions } from "./types.mjs";
 declare function createShadowRootUi<TMounted>(ctx: ContentScriptContext, options: ShadowRootContentScriptUiOptions<TMounted>): Promise<ShadowRootContentScriptUi<TMounted>>;
 interface ShadowRootContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
   /**
-   * The `HTMLElement` hosting the shadow root used to isolate the UI's styles. This is the element
-   * that get's added to the DOM. This element's style is not isolated from the webpage.
+   * The `HTMLElement` hosting the shadow root used to isolate the UI's styles.
+   * This is the element that get's added to the DOM. This element's style is
+   * not isolated from the webpage.
    */
   shadowHost: HTMLElement;
   /**
-   * The container element inside the `ShadowRoot` whose styles are isolated. The UI is mounted
-   * inside this `HTMLElement`.
+   * The container element inside the `ShadowRoot` whose styles are isolated.
+   * The UI is mounted inside this `HTMLElement`.
    */
   uiContainer: HTMLElement;
-  /**
-   * The shadow root performing the isolation.
-   */
+  /** The shadow root performing the isolation. */
   shadow: ShadowRoot;
 }
 type ShadowRootContentScriptUiOptions<TMounted> = ContentScriptUiOptions<TMounted> & {
   /**
-   * The name of the custom component used to host the ShadowRoot. Must be kebab-case.
+   * The name of the custom component used to host the ShadowRoot. Must be
+   * kebab-case.
    */
   name: string;
   /**
-   * Custom CSS text to apply to the UI. If your content script imports/generates CSS and you've
-   * set `cssInjectionMode: "ui"`, the imported CSS will be included automatically. You do not need
-   * to pass those styles in here. This is for any additional styles not in the imported CSS.
+   * Custom CSS text to apply to the UI. If your content script
+   * imports/generates CSS and you've set `cssInjectionMode: "ui"`, the
+   * imported CSS will be included automatically. You do not need to pass
+   * those styles in here. This is for any additional styles not in the
+   * imported CSS.
    */
   css?: string;
   /**
    * ShadowRoot's mode.
    *
+   * @default 'open'
    * @see https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/mode
-   * @default "open"
    */
   mode?: 'open' | 'closed';
   /**
-   * When enabled, `event.stopPropagation` will be called on events trying to bubble out of the
-   * shadow root.
+   * When enabled, `event.stopPropagation` will be called on events trying to
+   * bubble out of the shadow root.
    *
    * - Set to `true` to stop the propagation of a default set of events,
    *   `["keyup", "keydown", "keypress"]`
-   * - Set to an array of event names to stop the propagation of a custom list of events
+   * - Set to an array of event names to stop the propagation of a custom list
+   *   of events
    */
   isolateEvents?: boolean | string[];
   /**
    * By default, WXT adds `all: initial` to the shadow root before the rest of
-   * your CSS. This resets any inheritable CSS styles that
-   * [normally pierce the Shadow DOM](https://open-wc.org/guides/knowledge/styling/styles-piercing-shadow-dom/).
+   * your CSS. This resets any inheritable CSS styles that [normally pierce
+   * the Shadow
+   * DOM](https://open-wc.org/guides/knowledge/styling/styles-piercing-shadow-dom/).
    *
    * WXT resets everything but:
-   * - **`rem` Units**: they continue to scale based off the webpage's HTML `font-size`.
-   * - **CSS Variables/Custom Properties**: CSS variables defined outside the shadow root can be accessed inside it.
-   * - **`@font-face` Definitions**: Fonts defined outside the shadow root can be used inside it.
    *
-   * To disable this behavior and inherit styles from the webpage, set `inheritStyles: true`.
+   * - **`rem` Units**: they continue to scale based off the webpage's HTML
+   *   `font-size`.
+   * - **CSS Variables/Custom Properties**: CSS variables defined outside the
+   *   shadow root can be accessed inside it.
+   * - **`@font-face` Definitions**: Fonts defined outside the shadow root can
+   *   be used inside it.
+   *
+   * To disable this behavior and inherit styles from the webpage, set
+   * `inheritStyles: true`.
    *
    * @default false
    */
   inheritStyles?: boolean;
   /**
-   * Callback executed when mounting the UI. This function should create and append the UI to the
-   * `uiContainer` element. It is called every time `ui.mount()` is called.
+   * Callback executed when mounting the UI. This function should create and
+   * append the UI to the `uiContainer` element. It is called every time
+   * `ui.mount()` is called.
    *
-   * Optionally return a value that can be accessed at `ui.mounted` or in the `onRemove` callback.
+   * Optionally return a value that can be accessed at `ui.mounted` or in the
+   * `onRemove` callback.
    */
   onMount: (uiContainer: HTMLElement, shadow: ShadowRoot, shadowHost: HTMLElement) => TMounted;
 };

package/dist/utils/content-script-ui/shadow-root.mjs

@@ -3,11 +3,11 @@ import { applyPosition, createMountFunctions, mountUi } from "./shared.mjs";
 import { splitShadowRootCss } from "../split-shadow-root-css.mjs";
 import { browser } from "wxt/browser";
 import { createIsolatedElement } from "@webext-core/isolated-element";
-
 //#region src/utils/content-script-ui/shadow-root.ts
 /** @module wxt/utils/content-script-ui/shadow-root */
 /**
-* Create a content script UI inside a [`ShadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot).
+* Create a content script UI inside a
+* [`ShadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot).
 *
 * > This function is async because it has to load the CSS via a network call.
 *
@@ -63,9 +63,7 @@ async function createShadowRootUi(ctx, options) {
 		}
 	};
 }
-/**
-* Load the CSS for the current entrypoint.
-*/
+/** Load the CSS for the current entrypoint. */
 async function loadCss() {
 	const url = browser.runtime.getURL(`/content-scripts/${import.meta.env.ENTRYPOINT}.css`);
 	try {
@@ -75,6 +73,5 @@ async function loadCss() {
 		return "";
 	}
 }
-
 //#endregion
-export { createShadowRootUi };
+export { createShadowRootUi };

package/dist/utils/content-script-ui/shared.mjs

@@ -1,7 +1,6 @@
 import { logger } from "../internal/logger.mjs";
 import { waitElement } from "@1natsu/wait-element";
 import { isExist, isNotExist } from "@1natsu/wait-element/detectors";
-
 //#region src/utils/content-script-ui/shared.ts
 function applyPosition(root, positionedElement, options) {
 	if (options.position === "inline") return;
@@ -117,6 +116,5 @@ function autoMountUi(uiCallbacks, options) {
 	observeElement(resolvedAnchor);
 	return { stopAutoMount: _stopAutoMount };
 }
-
 //#endregion
-export { applyPosition, createMountFunctions, mountUi };
+export { applyPosition, createMountFunctions, mountUi };