wxt 0.5.5 → 0.6.0-alpha1

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
@@ -82,11 +134,13 @@ interface InlineConfig {
      */
     logger?: Logger;
     /**
-     * Custom Vite options, see <https://vitejs.dev/config/shared-options.html>.
+     * Return custom Vite options from a function. See
+     * <https://vitejs.dev/config/shared-options.html>.
      *
-     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config.
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config
+     * instead of Vite's.
      */
-    vite?: WxtViteConfig | ((env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>);
+    vite?: (env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>;
     /**
      * Customize the `manifest.json` output. Can be an object, promise, or function that returns an
      * object or promise.
@@ -331,7 +385,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 +480,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.5.5";
+var version = "0.6.0-alpha1";
 
 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
@@ -82,11 +134,13 @@ interface InlineConfig {
      */
     logger?: Logger;
     /**
-     * Custom Vite options, see <https://vitejs.dev/config/shared-options.html>.
+     * Return custom Vite options from a function. See
+     * <https://vitejs.dev/config/shared-options.html>.
      *
-     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config.
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config
+     * instead of Vite's.
      */
-    vite?: WxtViteConfig | ((env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>);
+    vite?: (env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>;
     /**
      * Customize the `manifest.json` output. Can be an object, promise, or function that returns an
      * object or promise.
@@ -331,7 +385,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 +480,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.5.5";
+var version = "0.6.0-alpha1";
 
 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) {
@@ -497,6 +506,7 @@ async function getInternalConfig(inlineConfig, command) {
     command,
     debug,
     entrypointsDir,
+    env,
     fsCache: createFsCache(wxtDir),
     imports: mergedConfig.imports ?? {},
     logger,
@@ -510,16 +520,12 @@ async function getInternalConfig(inlineConfig, command) {
     runnerConfig,
     srcDir,
     typesDir,
-    vite: {},
+    vite: () => ({}),
     // Real value added after this object is initialized.
     wxtDir,
     zip: resolveInternalZipConfig(root, mergedConfig)
   };
-  finalConfig.vite = await resolveInternalViteConfig(
-    env,
-    mergedConfig,
-    finalConfig
-  );
+  finalConfig.vite = (env2) => resolveInternalViteConfig(env2, mergedConfig, finalConfig);
   return finalConfig;
 }
 async function resolveManifestConfig(env, manifest) {
@@ -543,9 +549,9 @@ function mergeInlineConfig(inlineConfig, userConfig) {
     return vite2.mergeConfig(user, inline);
   };
   const viteConfig = async (env) => {
-    const user = await resolveViteConfig(env, userConfig.vite);
-    const inline = await resolveViteConfig(env, inlineConfig.vite);
-    return vite2.mergeConfig(user, inline);
+    const user = await userConfig.vite?.(env);
+    const inline = await inlineConfig.vite?.(env);
+    return vite2.mergeConfig(user ?? {}, inline ?? {});
   };
   const runner = vite2.mergeConfig(
     userConfig.runner ?? {},
@@ -573,9 +579,6 @@ function mergeInlineConfig(inlineConfig, userConfig) {
     zip
   };
 }
-async function resolveViteConfig(env, vite6) {
-  return await (typeof vite6 === "function" ? vite6(env) : vite6 ?? {});
-}
 function resolveInternalZipConfig(root, mergedConfig) {
   return {
     sourcesTemplate: "{{name}}-{{version}}-sources.zip",
@@ -597,10 +600,7 @@ function resolveInternalZipConfig(root, mergedConfig) {
   };
 }
 async function resolveInternalViteConfig(env, mergedConfig, finalConfig) {
-  const internalVite = await resolveViteConfig(
-    env,
-    mergedConfig.vite
-  );
+  const internalVite = await mergedConfig.vite?.(env) ?? {};
   internalVite.root = finalConfig.root;
   internalVite.configFile = false;
   internalVite.logLevel = "warn";
@@ -810,9 +810,12 @@ 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
+    await config.vite(config.env)
   );
   const result = await vite3.build(entryConfig);
   return {
@@ -838,11 +841,15 @@ 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
+    await config.vite(config.env)
   );
   const result = await vite3.build(entryConfig);
   return {
@@ -1362,7 +1369,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,
     [
@@ -2145,7 +2152,7 @@ async function getServerInfo() {
 async function setupServer(serverInfo, config) {
   const runner = createWebExtRunner();
   const viteServer = await vite5.createServer(
-    vite5.mergeConfig(serverInfo, config.vite)
+    vite5.mergeConfig(serverInfo, await config.vite(config.env))
   );
   const start = async () => {
     await viteServer.listen(server.port);
@@ -2246,7 +2253,7 @@ async function clean(root = process.cwd()) {
 }
 
 // package.json
-var version2 = "0.5.5";
+var version2 = "0.6.0-alpha1";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {
@@ -2269,7 +2276,7 @@ async function createServer2(config) {
     return getInternalConfig(
       {
         ...config,
-        vite: serverInfo.viteServerConfig
+        vite: () => serverInfo.viteServerConfig
       },
       "serve"
     );