wxt 0.5.5 → 0.5.6

package/dist/index.d.cts

@@ -3,6 +3,58 @@ import { Manifest, Scripting } from 'webextension-polyfill';
 import { UnimportOptions } from 'unimport';
 import { LogLevel } from 'consola';
 
+/**
+ * Extends [`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 extends AbortController {
+    #private;
+    private readonly contentScriptName;
+    static SCRIPT_STARTED_MESSAGE_TYPE: string;
+    constructor(contentScriptName: string);
+    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;
+    /**
+     * 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;
+    /**
+     * Abort the abort controller and execute all `onInvalidated` listeners.
+     */
+    notifyInvalidated(): void;
+}
+
 interface InlineConfig {
     /**
      * Your project's root directory containing the `package.json` used to fill out the
@@ -331,7 +383,7 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
     /**
      * Main function executed when the content script is loaded.
      */
-    main(): void | Promise<void>;
+    main(ctx: ContentScriptContext): void | Promise<void>;
 }
 interface BackgroundScriptDefintition extends ExcludableEntrypoint {
     type?: 'module';
@@ -426,7 +478,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.5.5";
+var version = "0.5.6";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 

package/dist/index.d.ts

@@ -3,6 +3,58 @@ import { Manifest, Scripting } from 'webextension-polyfill';
 import { UnimportOptions } from 'unimport';
 import { LogLevel } from 'consola';
 
+/**
+ * Extends [`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 extends AbortController {
+    #private;
+    private readonly contentScriptName;
+    static SCRIPT_STARTED_MESSAGE_TYPE: string;
+    constructor(contentScriptName: string);
+    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;
+    /**
+     * 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;
+    /**
+     * Abort the abort controller and execute all `onInvalidated` listeners.
+     */
+    notifyInvalidated(): void;
+}
+
 interface InlineConfig {
     /**
      * Your project's root directory containing the `package.json` used to fill out the
@@ -331,7 +383,7 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
     /**
      * Main function executed when the content script is loaded.
      */
-    main(): void | Promise<void>;
+    main(ctx: ContentScriptContext): void | Promise<void>;
 }
 interface BackgroundScriptDefintition extends ExcludableEntrypoint {
     type?: 'module';
@@ -426,7 +478,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.5.5";
+var version = "0.5.6";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 

package/dist/index.js

@@ -451,6 +451,15 @@ function getGlobals(config) {
     }
   ];
 }
+function getEntrypointGlobals(config, entrypointName) {
+  return [
+    {
+      name: "__ENTRYPOINT__",
+      value: entrypointName,
+      type: `string`
+    }
+  ];
+}
 
 // src/core/utils/getInternalConfig.ts
 async function getInternalConfig(inlineConfig, command) {
@@ -810,6 +819,9 @@ async function buildSingleEntrypoint(entrypoint, config) {
       "process.env.NODE_ENV": JSON.stringify(config.mode)
     }
   };
+  for (const global of getEntrypointGlobals(config, entrypoint.name)) {
+    libMode.define[global.name] = JSON.stringify(global.value);
+  }
   const entryConfig = vite3.mergeConfig(
     libMode,
     config.vite
@@ -838,8 +850,12 @@ async function buildMultipleEntrypoints(entrypoints, config) {
           assetFileNames: "assets/[name]-[hash].[ext]"
         }
       }
-    }
+    },
+    define: {}
   };
+  for (const global of getEntrypointGlobals(config, "html")) {
+    multiPage.define[global.name] = JSON.stringify(global.value);
+  }
   const entryConfig = vite3.mergeConfig(
     multiPage,
     config.vite
@@ -1362,7 +1378,7 @@ declare module "wxt/browser" {
 }
 async function writeGlobalsDeclarationFile(config) {
   const filePath = resolve9(config.typesDir, "globals.d.ts");
-  const globals = getGlobals(config);
+  const globals = [...getGlobals(config), ...getEntrypointGlobals(config, "")];
   await writeFileIfDifferent(
     filePath,
     [
@@ -2246,7 +2262,7 @@ async function clean(root = process.cwd()) {
 }
 
 // package.json
-var version2 = "0.5.5";
+var version2 = "0.5.6";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {