wxt 0.20.13 → 0.20.15

package/dist/utils/app-config.d.ts

@@ -1,2 +0,0 @@
-import type { WxtAppConfig } from './define-app-config';
-export declare function useAppConfig(): WxtAppConfig;

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

@@ -1,134 +0,0 @@
-/** @module wxt/utils/content-script-context */
-import { ContentScriptDefinition } from '../types';
-import { WxtLocationChangeEvent } from './internal/custom-events';
-/**
- * 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`.
- *
- * 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", () => {
- *   const ctx = new ContentScriptContext('test');
- *   const item = storage.defineItem("local:count", { defaultValue: 0 });
- *   const watcher = vi.fn();
- *
- *   const unwatch = item.watch(watcher);
- *   ctx.onInvalidated(unwatch); // Listen for invalidate here
- *
- *   await item.setValue(1);
- *   expect(watcher).toBeCalledTimes(1);
- *   expect(watcher).toBeCalledWith(1, 0);
- *
- *   ctx.notifyInvalidated(); // Use this function to invalidate the context
- *   await item.setValue(2);
- *   expect(watcher).toBeCalledTimes(1);
- * });
- * ```
- */
-export declare class ContentScriptContext implements AbortController {
-    private readonly contentScriptName;
-    readonly options?: Omit<ContentScriptDefinition, "main"> | undefined;
-    private static SCRIPT_STARTED_MESSAGE_TYPE;
-    private isTopFrame;
-    private abortController;
-    private locationWatcher;
-    private receivedMessageIds;
-    constructor(contentScriptName: string, options?: Omit<ContentScriptDefinition, "main"> | undefined);
-    get signal(): AbortSignal;
-    abort(reason?: any): void;
-    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.
-     *
-     * @example
-     * browser.runtime.onMessage.addListener(cb);
-     * const removeInvalidatedListener = ctx.onInvalidated(() => {
-     *   browser.runtime.onMessage.removeListener(cb);
-     * })
-     * // ...
-     * removeInvalidatedListener();
-     */
-    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.
-     *
-     * @example
-     * const getValueFromStorage = async () => {
-     *   if (ctx.isInvalid) return ctx.block();
-     *
-     *   // ...
-     * }
-     */
-    block<T>(): Promise<T>;
-    /**
-     * 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.
-     *
-     * 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.
-     *
-     * 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.
-     *
-     * 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.
-     *
-     * 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.
-     *
-     * @example
-     * 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;
-    addEventListener<TTarget extends EventTarget>(target: TTarget, ...params: Parameters<TTarget['addEventListener']>): void;
-    /**
-     * @internal
-     * Abort the abort controller and execute all `onInvalidated` listeners.
-     */
-    notifyInvalidated(): void;
-    stopOldScripts(): void;
-    verifyScriptStartedEvent(event: MessageEvent): boolean;
-    listenForNewerScripts(options?: {
-        ignoreFirstEvent?: boolean;
-    }): void;
-}
-export interface WxtWindowEventMap extends WindowEventMap {
-    'wxt:locationchange': WxtLocationChangeEvent;
-}

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

@@ -1,32 +0,0 @@
-import { ContentScriptContext } from '../content-script-context';
-import type { ContentScriptUi, ContentScriptUiOptions } from './types';
-/**
- * Create a content script UI using an iframe.
- *
- * @see https://wxt.dev/guide/essentials/content-scripts.html#iframe
- */
-export declare function createIframeUi<TMounted>(ctx: ContentScriptContext, options: IframeContentScriptUiOptions<TMounted>): IframeContentScriptUi<TMounted>;
-export interface IframeContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
-    /**
-     * The iframe added to the DOM.
-     */
-    iframe: HTMLIFrameElement;
-    /**
-     * A wrapper div that assists in positioning.
-     */
-    wrapper: HTMLDivElement;
-}
-export 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`.
-     */
-    page: import('wxt/browser').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.
-     *
-     * Optionally return a value that can be accessed at `ui.mounted` or in the `onRemove` callback.
-     */
-    onMount?: (wrapper: HTMLElement, iframe: HTMLIFrameElement) => TMounted;
-};

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

@@ -1,34 +0,0 @@
-/** @module wxt/utils/content-script-ui/integrated */
-import { ContentScriptContext } from '../content-script-context';
-import type { ContentScriptUi, ContentScriptUiOptions } from './types';
-/**
- * Create a content script UI without any isolation.
- *
- * @see https://wxt.dev/guide/essentials/content-scripts.html#integrated
- */
-export 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
- */
-export interface IntegratedContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
-    /**
-     * A wrapper div that assists in positioning.
-     */
-    wrapper: HTMLElement;
-}
-export type IntegratedContentScriptUiOptions<TMounted> = ContentScriptUiOptions<TMounted> & {
-    /**
-     * Tag used to create the wrapper element.
-     *
-     * @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.
-     *
-     * 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/shadow-root.d.ts

@@ -1,76 +0,0 @@
-import { ContentScriptContext } from '../content-script-context';
-import type { ContentScriptUi, ContentScriptUiOptions } from './types';
-/**
- * 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.
- *
- * @see https://wxt.dev/guide/essentials/content-scripts.html#shadow-root
- */
-export declare function createShadowRootUi<TMounted>(ctx: ContentScriptContext, options: ShadowRootContentScriptUiOptions<TMounted>): Promise<ShadowRootContentScriptUi<TMounted>>;
-export 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.
-     */
-    shadowHost: 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.
-     */
-    shadow: ShadowRoot;
-}
-export type ShadowRootContentScriptUiOptions<TMounted> = ContentScriptUiOptions<TMounted> & {
-    /**
-     * 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.
-     */
-    css?: string;
-    /**
-     * ShadowRoot's mode.
-     *
-     * @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.
-     *
-     * - 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
-     */
-    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/).
-     *
-     * 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`.
-     *
-     * @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.
-     *
-     * 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/shared.d.ts

@@ -1,5 +0,0 @@
-import type { ContentScriptAnchoredOptions, ContentScriptPositioningOptions, BaseMountFunctions, ContentScriptUiOptions, MountFunctions } from './types';
-export declare function applyPosition(root: HTMLElement, positionedElement: HTMLElement | undefined | null, options: ContentScriptPositioningOptions): void;
-export declare function getAnchor(options: ContentScriptAnchoredOptions): Element | undefined;
-export declare function mountUi(root: HTMLElement, options: ContentScriptAnchoredOptions): void;
-export declare function createMountFunctions<TMounted>(baseFunctions: BaseMountFunctions, options: ContentScriptUiOptions<TMounted>): MountFunctions;

package/dist/utils/content-script-ui/types.d.ts

@@ -1,104 +0,0 @@
-/** @module wxt/utils/content-script-ui/types */
-export interface ContentScriptUi<TMounted> extends MountFunctions {
-    mounted: TMounted | undefined;
-}
-export type ContentScriptUiOptions<TMounted> = ContentScriptPositioningOptions & ContentScriptAnchoredOptions & {
-    /**
-     * Callback called before the UI is removed from the webpage. Use to cleanup your UI, like
-     * unmounting your Vue or React apps.
-     *
-     * Note that this callback is called only when `ui.remove` is called - that means it is
-     * not called automatically when the anchor is removed, unless you use `autoMount`.
-     */
-    onRemove?: (mounted: TMounted | undefined) => void;
-};
-export type ContentScriptOverlayAlignment = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-/**
- * ![Visualization of different append modes](https://wxt.dev/content-script-ui-append.png)
- */
-export type ContentScriptAppendMode = 'last' | 'first' | 'replace' | 'before' | 'after' | ((anchor: Element, ui: Element) => void);
-export interface ContentScriptInlinePositioningOptions {
-    position: 'inline';
-}
-export interface ContentScriptOverlayPositioningOptions {
-    position: 'overlay';
-    /**
-     * The `z-index` used on the `wrapper` element. Set to a positive number to show your UI over website
-     * content.
-     */
-    zIndex?: number;
-    /**
-     * When using `type: "overlay"`, the mounted element is 0px by 0px in size. Alignment specifies
-     * which corner is aligned with that 0x0 pixel space.
-     *
-     * ![Visualization of alignment options](https://wxt.dev/content-script-ui-alignment.png)
-     *
-     * @default "top-left"
-     */
-    alignment?: ContentScriptOverlayAlignment;
-}
-export interface ContentScriptModalPositioningOptions {
-    position: 'modal';
-    /**
-     * The `z-index` used on the `shadowHost`. Set to a positive number to show your UI over website
-     * content.
-     */
-    zIndex?: number;
-}
-/**
- * Choose between `"inline"`, `"overlay"`, or `"modal"` positions.
- *
- * ![Visualization of different types](https://wxt.dev/content-script-ui-position.png)
- */
-export type ContentScriptPositioningOptions = ContentScriptInlinePositioningOptions | ContentScriptOverlayPositioningOptions | ContentScriptModalPositioningOptions;
-export interface ContentScriptAnchoredOptions {
-    /**
-     * A CSS selector, XPath expression, element, or function that returns one of the three. Along with `append`, the
-     * `anchor` dictates where in the page the UI will be added.
-     */
-    anchor?: string | Element | null | undefined | (() => string | Element | null | undefined);
-    /**
-     * In combination with `anchor`, decide how to add the UI to the DOM.
-     *
-     * - `"last"` (default) - Add the UI as the last child of the `anchor` element
-     * - `"first"` - Add the UI as the first child of the `anchor` element
-     * - `"replace"` - Replace the `anchor` element with the UI.
-     * - `"before"` - Add the UI as the sibling before the `anchor` element
-     * - `"after"` - Add the UI as the sibling after the `anchor` element
-     * - `(anchor, ui) => void` - Customizable function that let's you add the UI to the DOM
-     */
-    append?: ContentScriptAppendMode | ((anchor: Element, ui: Element) => void);
-}
-export interface BaseMountFunctions {
-    /**
-     * Function that mounts or remounts the UI on the page.
-     */
-    mount: () => void;
-    /**
-     * Function that removes the UI from the webpage.
-     */
-    remove: () => void;
-}
-export interface MountFunctions extends BaseMountFunctions {
-    /**
-     * Call `ui.autoMount()` to automatically mount and remove the UI as the anchor is dynamically added/removed by the webpage.
-     */
-    autoMount: (options?: AutoMountOptions) => void;
-}
-export type AutoMountOptions = {
-    /**
-     * When true, only mount and unmount a UI once.
-     */
-    once?: boolean;
-    /**
-     * The callback triggered when `StopAutoMount` is called.
-     */
-    onStop?: () => void;
-};
-export type StopAutoMount = () => void;
-export interface AutoMount {
-    /**
-     * Stop watching the anchor element for changes, but keep the UI mounted.
-     */
-    stopAutoMount: StopAutoMount;
-}

package/dist/utils/define-background.d.ts

@@ -1,4 +0,0 @@
-/** @module wxt/utils/define-background */
-import type { BackgroundDefinition } from '../types';
-export declare function defineBackground(main: () => void): BackgroundDefinition;
-export declare function defineBackground(definition: BackgroundDefinition): BackgroundDefinition;

package/dist/utils/define-content-script.d.ts

@@ -1,3 +0,0 @@
-/** @module wxt/utils/define-content-script */
-import type { ContentScriptDefinition } from '../types';
-export declare function defineContentScript(definition: ContentScriptDefinition): ContentScriptDefinition;

package/dist/utils/define-unlisted-script.d.ts

@@ -1,4 +0,0 @@
-/** @module wxt/utils/define-unlisted-script */
-import type { UnlistedScriptDefinition } from '../types';
-export declare function defineUnlistedScript(main: () => void): UnlistedScriptDefinition;
-export declare function defineUnlistedScript(definition: UnlistedScriptDefinition): UnlistedScriptDefinition;

package/dist/utils/define-wxt-plugin.d.ts

@@ -1,3 +0,0 @@
-/** @module wxt/utils/define-wxt-plugin */
-import type { WxtPlugin } from '../types';
-export declare function defineWxtPlugin(plugin: WxtPlugin): WxtPlugin;

package/dist/utils/inject-script.d.ts

@@ -1,36 +0,0 @@
-export type ScriptPublicPath = Extract<import('wxt/browser').PublicPath, `${string}.js`>;
-/**
- * This function can only be called inside content scripts.
- *
- * Inject an unlisted script into the page. Scripts are added to the `<head>`
- * element or `document.documentElement` if there is no head.
- *
- * Make sure to add the injected script to your manifest's
- * `web_accessible_resources`.
- *
- * @returns A result object containing the created script element.
- */
-export declare function injectScript(path: ScriptPublicPath, options?: InjectScriptOptions): Promise<InjectScriptResult>;
-export interface InjectScriptOptions {
-    /**
-     * By default, the injected script is removed from the DOM after being
-     * injected. To disable this behavior, set this flag to true.
-     */
-    keepInDom?: boolean;
-    /**
-     * Modify the script element just before it is added to the DOM.
-     *
-     * It can be used to e.g. modify `script.async`/`script.defer`, add event
-     * listeners to the element, or pass data to the script via `script.dataset`
-     * (which can be accessed by the script via `document.currentScript`).
-     */
-    modifyScript?: (script: HTMLScriptElement) => Promise<void> | void;
-}
-export interface InjectScriptResult {
-    /**
-     * The created script element. It can be used to e.g. send messages to the
-     * script in the form of custom events. The script can add an event listener
-     * for them via `document.currentScript`.
-     */
-    script: HTMLScriptElement;
-}

package/dist/utils/internal/custom-events.d.ts

@@ -1,10 +0,0 @@
-export declare class WxtLocationChangeEvent extends Event {
-    readonly newUrl: URL;
-    readonly oldUrl: URL;
-    static EVENT_NAME: string;
-    constructor(newUrl: URL, oldUrl: URL);
-}
-/**
- * Returns an event name unique to the extension and content script that's running.
- */
-export declare function getUniqueEventName(eventName: string): string;

package/dist/utils/internal/dev-server-websocket.d.ts

@@ -1,21 +0,0 @@
-export interface WxtWebSocket extends WebSocket {
-    addWxtEventListener(type: 'wxt:reload-extension', callback: (event: CustomEvent<undefined>) => void, options?: AddEventListenerOptions | boolean): void;
-    addWxtEventListener(type: 'wxt:reload-content-script', callback?: (event: CustomEvent<ReloadContentScriptPayload>) => void, options?: AddEventListenerOptions | boolean): void;
-    addWxtEventListener(type: 'wxt:reload-page', callback?: (event: CustomEvent<string>) => void, options?: AddEventListenerOptions | boolean): void;
-    sendCustom(event: string, payload?: any): void;
-}
-/**
- * Connect to the websocket and listen for messages.
- *
- * @param onMessage Optional callback that is called when a message is recieved and we've verified
- *                  it's structure is what we expect.
- */
-export declare function getDevServerWebSocket(): WxtWebSocket;
-export interface ReloadContentScriptPayload {
-    registration?: 'manifest' | 'runtime';
-    contentScript: {
-        matches: string[];
-        js?: string[];
-        css?: string[];
-    };
-}

package/dist/utils/internal/dev-server-websocket.mjs

@@ -1,37 +0,0 @@
-import { logger } from "./logger.mjs";
-let ws;
-export function getDevServerWebSocket() {
-  if (import.meta.env.COMMAND !== "serve")
-    throw Error(
-      "Must be running WXT dev command to connect to call getDevServerWebSocket()"
-    );
-  if (ws == null) {
-    const serverUrl = __DEV_SERVER_ORIGIN__;
-    logger.debug("Connecting to dev server @", serverUrl);
-    ws = new WebSocket(serverUrl, "vite-hmr");
-    ws.addWxtEventListener = ws.addEventListener.bind(ws);
-    ws.sendCustom = (event, payload) => ws?.send(JSON.stringify({ type: "custom", event, payload }));
-    ws.addEventListener("open", () => {
-      logger.debug("Connected to dev server");
-    });
-    ws.addEventListener("close", () => {
-      logger.debug("Disconnected from dev server");
-    });
-    ws.addEventListener("error", (event) => {
-      logger.error("Failed to connect to dev server", event);
-    });
-    ws.addEventListener("message", (e) => {
-      try {
-        const message = JSON.parse(e.data);
-        if (message.type === "custom") {
-          ws?.dispatchEvent(
-            new CustomEvent(message.event, { detail: message.data })
-          );
-        }
-      } catch (err) {
-        logger.error("Failed to handle message", err);
-      }
-    });
-  }
-  return ws;
-}

package/dist/utils/internal/location-watcher.d.ts

@@ -1,12 +0,0 @@
-import { ContentScriptContext } from '../content-script-context';
-/**
- * Create a util that watches for URL changes, dispatching the custom event when detected. Stops
- * watching when content script is invalidated.
- */
-export declare function createLocationWatcher(ctx: ContentScriptContext): {
-    /**
-     * Ensure the location watcher is actively looking for URL changes. If it's already watching,
-     * this is a noop.
-     */
-    run(): void;
-};

package/dist/utils/internal/logger.d.ts

@@ -1,9 +0,0 @@
-/**
- * Wrapper around `console` with a "[wxt]" prefix
- */
-export declare const logger: {
-    debug: (...args: any[]) => void;
-    log: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    error: (...args: any[]) => void;
-};

package/dist/utils/match-patterns.d.ts

@@ -1,5 +0,0 @@
-/**
- * Re-export the [`@webext-core/match-patterns` package](https://www.npmjs.com/package/@webext-core/match-patterns).
- * @module wxt/utils/match-patterns
- */
-export * from '@webext-core/match-patterns';

package/dist/utils/storage.d.ts

@@ -1,5 +0,0 @@
-/**
- * Re-export the [`@wxt-dev/storage` package](https://www.npmjs.com/package/@wxt-dev/storage).
- * @module wxt/utils/storage
- */
-export * from '@wxt-dev/storage';

package/dist/version.d.ts

@@ -1 +0,0 @@
-export declare const version = "{{version}}";