wxt 0.18.4 → 0.18.6

package/dist/cli.js

@@ -46,7 +46,7 @@ var npm = {
   overridesKey: "overrides",
   async downloadDependency(id, downloadDir) {
     await ensureDir(downloadDir);
-    const { execa } = await import("./execa-6HO2IY2B.js");
+    const { execa } = await import("./execa-QQUOQNS3.js");
     const res = await execa("npm", ["pack", id, "--json"], {
       cwd: downloadDir
     });
@@ -58,7 +58,7 @@ var npm = {
     if (options?.all) {
       args.push("--depth", "Infinity");
     }
-    const { execa } = await import("./execa-6HO2IY2B.js");
+    const { execa } = await import("./execa-QQUOQNS3.js");
     const res = await execa("npm", args, { cwd: options?.cwd });
     const project = JSON.parse(res.stdout);
     return flattenNpmListOutput([project]);
@@ -115,7 +115,7 @@ var bun = {
     if (options?.all) {
       args.push("--all");
     }
-    const { execa } = await import("./execa-6HO2IY2B.js");
+    const { execa } = await import("./execa-QQUOQNS3.js");
     const res = await execa("bun", args, { cwd: options?.cwd });
     return dedupeDependencies(
       res.stdout.split("\n").slice(1).map((line) => line.trim()).map((line) => /.* (@?\S+)@(\S+)$/.exec(line)).filter((match) => !!match).map(([_, name, version2]) => ({ name, version: version2 }))
@@ -134,7 +134,7 @@ var yarn = {
     if (options?.all) {
       args.push("--depth", "Infinity");
     }
-    const { execa } = await import("./execa-6HO2IY2B.js");
+    const { execa } = await import("./execa-QQUOQNS3.js");
     const res = await execa("yarn", args, { cwd: options?.cwd });
     const tree = res.stdout.split("\n").map((line) => JSON.parse(line)).find((line) => line.type === "tree")?.data;
     if (tree == null)
@@ -171,7 +171,7 @@ var pnpm = {
     if (typeof process !== "undefined" && process.env.WXT_PNPM_IGNORE_WORKSPACE === "true") {
       args.push("--ignore-workspace");
     }
-    const { execa } = await import("./execa-6HO2IY2B.js");
+    const { execa } = await import("./execa-QQUOQNS3.js");
     const res = await execa("pnpm", args, { cwd: options?.cwd });
     const projects = JSON.parse(res.stdout);
     return flattenNpmListOutput(projects);
@@ -901,6 +901,62 @@ function removeEntrypointMainFunction(config, path11) {
   };
 }
 
+// src/core/builders/vite/plugins/wxtPluginLoader.ts
+import { parseHTML as parseHTML2 } from "linkedom";
+function wxtPluginLoader(config) {
+  const virtualModuleId = "virtual:wxt-plugins";
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  const virtualHtmlModuleId = "virtual:wxt-html-plugins";
+  const resolvedVirtualHtmlModuleId = "\0" + virtualHtmlModuleId;
+  return {
+    name: "wxt:plugin-loader",
+    resolveId(id) {
+      if (id === virtualModuleId)
+        return resolvedVirtualModuleId;
+      if (id === virtualHtmlModuleId)
+        return resolvedVirtualHtmlModuleId;
+    },
+    load(id) {
+      if (id === resolvedVirtualModuleId) {
+        const imports = config.plugins.map(
+          (plugin, i) => `import initPlugin${i} from '${normalizePath(plugin)}';`
+        ).join("\n");
+        const initCalls = config.plugins.map((_, i) => `  initPlugin${i}();`).join("\n");
+        return `${imports}
+
+export function initPlugins() {
+${initCalls}
+}`;
+      }
+      if (id === resolvedVirtualHtmlModuleId) {
+        return `import { initPlugins } from '${virtualModuleId}';
+
+try {
+  initPlugins();
+} catch (err) {
+  console.error("[wxt] Failed to initialize plugins", err);
+}`;
+      }
+    },
+    transformIndexHtml: {
+      // Use "pre" so the new script is added before vite bundles all the scripts
+      order: "pre",
+      handler(html, _ctx) {
+        const { document } = parseHTML2(html);
+        const script = document.createElement("script");
+        script.type = "module";
+        script.src = "virtual:wxt-html-plugins";
+        if (document.head == null) {
+          const newHead = document.createElement("head");
+          document.documentElement.prepend(newHead);
+        }
+        document.head.prepend(script);
+        return document.toString();
+      }
+    }
+  };
+}
+
 // src/core/utils/arrays.ts
 function every(array, predicate) {
   for (let i = 0; i < array.length; i++)
@@ -972,7 +1028,8 @@ async function createViteBuilder(wxtConfig, hooks, server) {
       noopBackground(),
       globals(wxtConfig),
       excludeBrowserPolyfill(wxtConfig),
-      defineImportMeta()
+      defineImportMeta(),
+      wxtPluginLoader(wxtConfig)
     );
     if (wxtConfig.analysis.enabled) {
       config.plugins.push(bundleAnalysis(wxtConfig));
@@ -1208,6 +1265,19 @@ async function registerWxt(command, inlineConfig = {}, getServer) {
     builder,
     server
   };
+  for (const module of config.modules) {
+    if (module.hooks)
+      wxt.hooks.addHooks(module.hooks);
+    if (wxt.config.imports !== false && module.imports) {
+      wxt.config.imports.imports ??= [];
+      wxt.config.imports.imports.push(...module.imports);
+    }
+    await module.setup?.(
+      wxt,
+      // @ts-expect-error: Untyped configKey field
+      module.configKey ? config[module.configKey] : void 0
+    );
+  }
   wxt.hooks.addHooks(config.hooks);
   await wxt.hooks.callHook("ready", wxt);
 }
@@ -1249,18 +1319,21 @@ async function buildEntrypoints(groups, spinner) {
   return { publicAssets, steps };
 }
 async function copyPublicDirectory() {
-  const files = await getPublicFiles();
+  const files = (await getPublicFiles()).map((file) => ({
+    absoluteSrc: resolve6(wxt.config.publicDir, file),
+    relativeDest: file
+  }));
+  await wxt.hooks.callHook("build:publicAssets", wxt, files);
   if (files.length === 0)
     return [];
   const publicAssets = [];
-  for (const file of files) {
-    const srcPath = resolve6(wxt.config.publicDir, file);
-    const outPath = resolve6(wxt.config.outDir, file);
-    await fs4.ensureDir(dirname3(outPath));
-    await fs4.copyFile(srcPath, outPath);
+  for (const { absoluteSrc, relativeDest } of files) {
+    const absoluteDest = resolve6(wxt.config.outDir, relativeDest);
+    await fs4.ensureDir(dirname3(absoluteDest));
+    await fs4.copyFile(absoluteSrc, absoluteDest);
     publicAssets.push({
       type: "asset",
-      fileName: file
+      fileName: relativeDest
     });
   }
   return publicAssets;
@@ -1364,7 +1437,7 @@ function findEffectedSteps(changedFile, currentOutput) {
 import { relative as relative4, resolve as resolve8 } from "path";
 import fs6 from "fs-extra";
 import { minimatch } from "minimatch";
-import { parseHTML as parseHTML2 } from "linkedom";
+import { parseHTML as parseHTML3 } from "linkedom";
 import JSON5 from "json5";
 import glob2 from "fast-glob";
 import pc2 from "picocolors";
@@ -1435,7 +1508,7 @@ async function importEntrypointFile(path11) {
     if (err instanceof ReferenceError) {
       const variableName = err.message.replace(" is not defined", "");
       throw Error(
-        `${filePath}: Cannot use imported variable "${variableName}" outside the main function. See https://wxt.dev/guide/entrypoints.html#side-effects`,
+        `${filePath}: Cannot use imported variable "${variableName}" outside the main function. See https://wxt.dev/guide/go-further/entrypoint-side-effects.html`,
         { cause: err }
       );
     } else {
@@ -1471,7 +1544,7 @@ async function findEntrypoints() {
     const inputPath = resolve8(wxt.config.entrypointsDir, relativePath);
     const name = getEntrypointName(wxt.config.entrypointsDir, inputPath);
     const matchingGlob = pathGlobs.find(
-      (glob6) => minimatch(relativePath, glob6)
+      (glob7) => minimatch(relativePath, glob7)
     );
     if (matchingGlob) {
       const type = PATH_GLOB_TO_TYPE_MAP[matchingGlob];
@@ -1765,7 +1838,7 @@ async function getSidepanelEntrypoint(info) {
 }
 async function getHtmlEntrypointOptions(info, keyMap, queries, parsers) {
   const content = await fs6.readFile(info.inputPath, "utf-8");
-  const { document } = parseHTML2(content);
+  const { document } = parseHTML3(content);
   const options = {};
   const defaultQuery = (manifestKey) => document.querySelector(`meta[name='manifest.${manifestKey}']`)?.getAttribute("content");
   Object.entries(keyMap).forEach(([_key, manifestKey]) => {
@@ -2016,7 +2089,14 @@ async function writeMainDeclarationFile(references) {
       `/// <reference types="wxt/vite-builder-env" />`,
       ...references.map(
         (ref) => `/// <reference types="./${normalizePath(relative5(dir, ref))}" />`
-      )
+      ),
+      // Add references to modules installed from NPM to the TS project so
+      // their type augmentation can update InlineConfig correctly. Local
+      // modules defined in <root>/modules are already apart of the project, so
+      // we don't need to add them.
+      ...wxt.config.modules.filter(
+        (module) => module.type === "node_module" && module.configKey != null
+      ).map((module) => `/// <reference types="${module.id}" />`)
     ].join("\n") + "\n"
   );
   return filePath;
@@ -2109,6 +2189,7 @@ function isModuleInstalled(name) {
 
 // src/core/utils/building/resolve-config.ts
 import fs10 from "fs-extra";
+import glob3 from "fast-glob";
 async function resolveConfig(inlineConfig, command) {
   let userConfig = {};
   let userConfigMetadata;
@@ -2144,6 +2225,7 @@ async function resolveConfig(inlineConfig, command) {
     srcDir,
     mergedConfig.entrypointsDir ?? "entrypoints"
   );
+  const modulesDir = path6.resolve(srcDir, mergedConfig.modulesDir ?? "modules");
   if (await isDirMissing(entrypointsDir)) {
     logMissingDir(logger, "Entrypoints", entrypointsDir);
   }
@@ -2185,11 +2267,20 @@ async function resolveConfig(inlineConfig, command) {
       hostname: "localhost"
     };
   }
+  const modules = await resolveWxtModules(modulesDir, mergedConfig.modules);
+  const moduleOptions = modules.reduce((map, module) => {
+    if (module.configKey) {
+      map[module.configKey] = // @ts-expect-error
+      mergedConfig[module.configKey];
+    }
+    return map;
+  }, {});
   return {
     browser,
     command,
     debug,
     entrypointsDir,
+    modulesDir,
     filterEntrypoints,
     env,
     fsCache: createFsCache(wxtDir),
@@ -2221,7 +2312,10 @@ async function resolveConfig(inlineConfig, command) {
       reloadCommand
     },
     hooks: mergedConfig.hooks ?? {},
-    vite: mergedConfig.vite ?? (() => ({}))
+    vite: mergedConfig.vite ?? (() => ({})),
+    modules,
+    plugins: [],
+    ...moduleOptions
   };
 }
 async function resolveManifestConfig(env, manifest) {
@@ -2360,6 +2454,52 @@ async function mergeBuilderConfig(inlineConfig, userConfig) {
   }
   throw Error("Builder not found. Make sure vite is installed.");
 }
+async function resolveWxtModules(modulesDir, modules = []) {
+  const npmModules = await Promise.all(
+    modules.map(async (moduleId) => {
+      const mod = await import(
+        /* @vite-ignore */
+        moduleId
+      );
+      if (mod.default == null) {
+        throw Error("Module missing default export: " + moduleId);
+      }
+      return {
+        ...mod.default,
+        type: "node_module",
+        id: moduleId
+      };
+    })
+  );
+  const localModulePaths = await glob3(["*.[tj]s", "*/index.[tj]s"], {
+    cwd: modulesDir,
+    onlyFiles: true
+  }).catch(() => []);
+  const localModules = await Promise.all(
+    localModulePaths.map(async (file) => {
+      const absolutePath = normalizePath(path6.resolve(modulesDir, file));
+      const { config } = await loadConfig({
+        configFile: absolutePath,
+        globalRc: false,
+        rcFile: false,
+        packageJson: false,
+        envName: false,
+        dotenv: false
+      });
+      if (config == null)
+        throw Error(
+          `No config found for ${file}. Did you forget to add a default export?`
+        );
+      config.name ??= file;
+      return {
+        ...config,
+        type: "local",
+        id: absolutePath
+      };
+    })
+  );
+  return [...npmModules, ...localModules];
+}
 
 // src/core/utils/building/group-entrypoints.ts
 function groupEntrypoints(entrypoints) {
@@ -2515,7 +2655,7 @@ function getChunkSortWeight(filename) {
 import pc4 from "picocolors";
 
 // package.json
-var version = "0.18.3";
+var version = "0.18.6";
 
 // src/core/utils/log/printHeader.ts
 function printHeader() {
@@ -2524,7 +2664,7 @@ function printHeader() {
 }
 
 // src/core/utils/building/internal-build.ts
-import glob3 from "fast-glob";
+import glob4 from "fast-glob";
 
 // src/core/utils/manifest.ts
 import fs12 from "fs-extra";
@@ -3316,7 +3456,7 @@ async function internalBuild() {
   return output;
 }
 async function combineAnalysisStats() {
-  const unixFiles = await glob3(`${wxt.config.analysis.outputName}-*.json`, {
+  const unixFiles = await glob4(`${wxt.config.analysis.outputName}-*.json`, {
     cwd: wxt.config.analysis.outputDir,
     absolute: true
   });
@@ -3365,7 +3505,7 @@ async function build(config) {
 
 // src/core/clean.ts
 import path8 from "node:path";
-import glob4 from "fast-glob";
+import glob5 from "fast-glob";
 import fs14 from "fs-extra";
 import pc6 from "picocolors";
 async function clean(root = process.cwd()) {
@@ -3377,7 +3517,7 @@ async function clean(root = process.cwd()) {
     ".output/*"
   ];
   consola.debug("Looking for:", tempDirs.map(pc6.cyan).join(", "));
-  const directories = await glob4(tempDirs, {
+  const directories = await glob5(tempDirs, {
     cwd: path8.resolve(root),
     absolute: true,
     onlyDirectories: true,
@@ -3883,7 +4023,7 @@ import path10 from "node:path";
 import fs16 from "fs-extra";
 import { minimatch as minimatch2 } from "minimatch";
 import JSZip from "jszip";
-import glob5 from "fast-glob";
+import glob6 from "fast-glob";
 async function zip(config) {
   await registerWxt("build", config);
   const output = await internalBuild();
@@ -3931,7 +4071,7 @@ async function zip(config) {
 }
 async function zipDir(directory, outputPath, options) {
   const archive = new JSZip();
-  const files = (await glob5("**/*", {
+  const files = (await glob6("**/*", {
     cwd: directory,
     // Ignore node_modules, otherwise this glob step takes forever
     ignore: ["**/node_modules"],
@@ -4049,7 +4189,7 @@ function createAliasedCommand(base, name, alias, bin, docsUrl) {
       const args = process.argv.slice(
         process.argv.indexOf(aliasedCommand.name) + 1
       );
-      const { execa } = await import("./execa-6HO2IY2B.js");
+      const { execa } = await import("./execa-QQUOQNS3.js");
       await execa(bin, args, {
         stdio: "inherit"
       });

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { a as ContentScriptContext } from './index-CiL7hzu6.js';
+import { a as ContentScriptContext } from './index-Bk-a0SkY.js';
 import 'webextension-polyfill';
 
 interface IntegratedContentScriptUi<TMounted> extends ContentScriptUi<TMounted> {
@@ -179,13 +179,13 @@ interface ContentScriptAnchoredOptions {
 /**
  * Create a content script UI without any isolation.
  *
- * @see https://wxt.dev/guide/content-script-ui.html#integrated
+ * @see https://wxt.dev/guide/key-concepts/content-script-ui.html#integrated
  */
 declare function createIntegratedUi<TMounted>(ctx: ContentScriptContext, options: IntegratedContentScriptUiOptions<TMounted>): IntegratedContentScriptUi<TMounted>;
 /**
  * Create a content script UI using an iframe.
  *
- * @see https://wxt.dev/guide/content-script-ui.html#iframe
+ * @see https://wxt.dev/guide/key-concepts/content-script-ui.html#iframe
  */
 declare function createIframeUi<TMounted>(ctx: ContentScriptContext, options: IframeContentScriptUiOptions<TMounted>): IframeContentScriptUi<TMounted>;
 /**
@@ -193,7 +193,7 @@ declare function createIframeUi<TMounted>(ctx: ContentScriptContext, options: If
  *
  * > This function is async because it has to load the CSS via a network call.
  *
- * @see https://wxt.dev/guide/content-script-ui.html#shadowroot
+ * @see https://wxt.dev/guide/key-concepts/content-script-ui.html#shadowroot
  */
 declare function createShadowRootUi<TMounted>(ctx: ContentScriptContext, options: ShadowRootContentScriptUiOptions<TMounted>): Promise<ShadowRootContentScriptUi<TMounted>>;