wxt 0.8.4 → 0.8.6

package/dist/external-9107db91.d.ts

@@ -0,0 +1,176 @@
+import { Manifest } from 'webextension-polyfill';
+
+/**
+ * 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`.
+ */
+declare class ContentScriptContext implements AbortController {
+    #private;
+    private readonly contentScriptName;
+    readonly options?: Omit<ContentScriptDefinition, "main"> | undefined;
+    private static SCRIPT_STARTED_MESSAGE_TYPE;
+    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.
+     */
+    setInterval(handler: () => void, timeout?: number): number;
+    /**
+     * Wrapper around `window.setTimeout` that automatically clears the interval when invalidated.
+     */
+    setTimeout(handler: () => void, timeout?: number): number;
+    /**
+     * Wrapper around `window.requestAnimationFrame` that automatically cancels the request when
+     * invalidated.
+     */
+    requestAnimationFrame(callback: FrameRequestCallback): number;
+    /**
+     * Wrapper around `window.requestIdleCallback` that automatically cancels the request when
+     * invalidated.
+     */
+    requestIdleCallback(callback: IdleRequestCallback, options?: IdleRequestOptions): number;
+    /**
+     * Call `target.addEventListener` and remove the event listener when the context is invalidated.
+     *
+     * @example
+     * ctx.addEventListener(window, "mousemove", () => {
+     *   // ...
+     * });
+     * ctx.addEventListener(document, "visibilitychange", () => {
+     *   // ...
+     * });
+     */
+    addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
+    /**
+     * @internal
+     * Abort the abort controller and execute all `onInvalidated` listeners.
+     */
+    notifyInvalidated(): void;
+}
+
+type TargetBrowser = string;
+interface ContentScriptDefinition extends ExcludableEntrypoint {
+    matches: PerBrowserOption<Manifest.ContentScript['matches']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default "documentIdle"
+     */
+    runAt?: PerBrowserOption<Manifest.ContentScript['run_at']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
+    matchAboutBlank?: PerBrowserOption<Manifest.ContentScript['match_about_blank']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    excludeMatches?: PerBrowserOption<Manifest.ContentScript['exclude_matches']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    includeGlobs?: PerBrowserOption<Manifest.ContentScript['include_globs']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    excludeGlobs?: PerBrowserOption<Manifest.ContentScript['exclude_globs']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
+    allFrames?: PerBrowserOption<Manifest.ContentScript['all_frames']>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
+    matchOriginAsFallback?: PerBrowserOption<boolean>;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default "ISOLATED"
+     */
+    world?: PerBrowserOption<'ISOLATED' | 'MAIN'>;
+    /**
+     * Customize how imported/generated styles are injected with the content script. Regardless of the
+     * mode selected, CSS will always be built and included in the output directory.
+     *
+     * - `"manifest"` - Include the CSS in the manifest, under the content script's `css` array.
+     * - `"manual"` - Exclude the CSS from the manifest. You are responsible for manually loading it
+     *   onto the page. Use `browser.runtime.getURL("content-scripts/<name>.css")` to get the file's
+     *   URL
+     * - `"ui"` - Exclude the CSS from the manifest. CSS will be automatically added to your UI when
+     *   calling `createContentScriptUi`
+     *
+     * @default "manifest"
+     */
+    cssInjectionMode?: PerBrowserOption<'manifest' | 'manual' | 'ui'>;
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(ctx: ContentScriptContext): void | Promise<void>;
+}
+interface BackgroundDefinition extends ExcludableEntrypoint {
+    type?: PerBrowserOption<'module'>;
+    persistent?: PerBrowserOption<boolean>;
+    main(): void;
+}
+interface UnlistedScriptDefinition extends ExcludableEntrypoint {
+    /**
+     * Main function executed when the unlisted script is ran.
+     */
+    main(): void | Promise<void>;
+}
+type PerBrowserOption<T> = T | {
+    [browser: TargetBrowser]: T;
+};
+interface ExcludableEntrypoint {
+    /**
+     * List of target browsers to include this entrypoint in. Defaults to being included in all
+     * builds. Cannot be used with `exclude`. You must choose one of the two options.
+     *
+     * @default undefined
+     */
+    include?: TargetBrowser[];
+    /**
+     * List of target browsers to exclude this entrypoint from. Cannot be used with `include`. You
+     * must choose one of the two options.
+     *
+     * @default undefined
+     */
+    exclude?: TargetBrowser[];
+}
+
+export { BackgroundDefinition as B, ContentScriptContext as C, UnlistedScriptDefinition as U, ContentScriptDefinition as a };