wxt 0.7.5 → 0.8.1

package/dist/index.d.cts

@@ -15,7 +15,7 @@ declare class ContentScriptContext extends AbortController {
     #private;
     private readonly contentScriptName;
     readonly options?: Omit<ContentScriptDefinition, "main"> | undefined;
-    static SCRIPT_STARTED_MESSAGE_TYPE: string;
+    private static SCRIPT_STARTED_MESSAGE_TYPE;
     constructor(contentScriptName: string, options?: Omit<ContentScriptDefinition, "main"> | undefined);
     get isInvalid(): boolean;
     get isValid(): boolean;
@@ -76,6 +76,7 @@ declare class ContentScriptContext extends AbortController {
      */
     addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
     /**
+     * @internal
      * Abort the abort controller and execute all `onInvalidated` listeners.
      */
     notifyInvalidated(): void;
@@ -185,12 +186,12 @@ interface InlineConfig {
          *
          * Available template variables:
          *
-         * - `{name}` - The project's name converted to kebab-case
-         * - `{version}` - The version_name or version from the manifest
-         * - `{browser}` - The target browser from the `--browser` CLI flag
-         * - `{manifestVersion}` - Either "2" or "3"
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}}` - The version_name or version from the manifest
+         * - `{{browser}}` - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
          *
-         * @default "{name}-{version}-{browser}.zip"
+         * @default "{{name}}-{{version}}-{{browser}}.zip"
          */
         artifactTemplate?: string;
         /**
@@ -198,12 +199,12 @@ interface InlineConfig {
          *
          * Available template variables:
          *
-         * - `{name}` - The project's name converted to kebab-case
-         * - `{version}` - The version_name or version from the manifest
-         * - `{browser}` - The target browser from the `--browser` CLI flag
-         * - `{manifestVersion}` - Either "2" or "3"
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}}` - The version_name or version from the manifest
+         * - `{{browser}}` - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
          *
-         * @default "{name}-{version}-sources.zip"
+         * @default "{{name}}-{{version}}-sources.zip"
          */
         sourcesTemplate?: string;
         /**
@@ -465,11 +466,17 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      */
     main(ctx: ContentScriptContext): void | Promise<void>;
 }
-interface BackgroundScriptDefintition extends ExcludableEntrypoint {
+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;
 };
@@ -565,23 +572,40 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  * Remove generated/temp files from the directory.
  *
  * @param root The directory to look for generated/temp files in. Defaults to `process.cwd()`. Can be relative to `process.cwd()` or absolute.
+ *
+ * @example
+ * await clean();
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.7.5";
+var version = "0.8.1";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 
 declare function defineRunnerConfig(config: ExtensionRunnerConfig): ExtensionRunnerConfig;
 
+/**
+ * @module wxt
+ */
+
 /**
  * Bundles the extension for production. Returns a promise of the build result.
+ *
+ * @example
+ * const res = await build({
+ *   // Enter config...
+ * })
  */
 declare function build(config: InlineConfig): Promise<BuildOutput>;
 /**
- * Creates a dev server, pre-builds all the files that need to exist to load the extension, and open
- * the browser with the extension installed.
+ * Creates a dev server and pre-builds all the files that need to exist before loading the extension.
+ *
+ * @example
+ * const server = await wxt.createServer({
+ *   // Enter config...
+ * });
+ * await server.start();
  */
 declare function createServer(config?: InlineConfig): Promise<WxtDevServer>;
 
-export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PerBrowserOption, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, WxtViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };
+export { BackgroundDefinition, BackgroundEntrypoint, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PerBrowserOption, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UnlistedScriptDefinition, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, WxtViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };

package/dist/index.d.ts

@@ -15,7 +15,7 @@ declare class ContentScriptContext extends AbortController {
     #private;
     private readonly contentScriptName;
     readonly options?: Omit<ContentScriptDefinition, "main"> | undefined;
-    static SCRIPT_STARTED_MESSAGE_TYPE: string;
+    private static SCRIPT_STARTED_MESSAGE_TYPE;
     constructor(contentScriptName: string, options?: Omit<ContentScriptDefinition, "main"> | undefined);
     get isInvalid(): boolean;
     get isValid(): boolean;
@@ -76,6 +76,7 @@ declare class ContentScriptContext extends AbortController {
      */
     addEventListener(target: any, type: string, handler: (event: Event) => void, options?: AddEventListenerOptions): void;
     /**
+     * @internal
      * Abort the abort controller and execute all `onInvalidated` listeners.
      */
     notifyInvalidated(): void;
@@ -185,12 +186,12 @@ interface InlineConfig {
          *
          * Available template variables:
          *
-         * - `{name}` - The project's name converted to kebab-case
-         * - `{version}` - The version_name or version from the manifest
-         * - `{browser}` - The target browser from the `--browser` CLI flag
-         * - `{manifestVersion}` - Either "2" or "3"
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}}` - The version_name or version from the manifest
+         * - `{{browser}}` - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
          *
-         * @default "{name}-{version}-{browser}.zip"
+         * @default "{{name}}-{{version}}-{{browser}}.zip"
          */
         artifactTemplate?: string;
         /**
@@ -198,12 +199,12 @@ interface InlineConfig {
          *
          * Available template variables:
          *
-         * - `{name}` - The project's name converted to kebab-case
-         * - `{version}` - The version_name or version from the manifest
-         * - `{browser}` - The target browser from the `--browser` CLI flag
-         * - `{manifestVersion}` - Either "2" or "3"
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}}` - The version_name or version from the manifest
+         * - `{{browser}}` - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
          *
-         * @default "{name}-{version}-sources.zip"
+         * @default "{{name}}-{{version}}-sources.zip"
          */
         sourcesTemplate?: string;
         /**
@@ -465,11 +466,17 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      */
     main(ctx: ContentScriptContext): void | Promise<void>;
 }
-interface BackgroundScriptDefintition extends ExcludableEntrypoint {
+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;
 };
@@ -565,23 +572,40 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  * Remove generated/temp files from the directory.
  *
  * @param root The directory to look for generated/temp files in. Defaults to `process.cwd()`. Can be relative to `process.cwd()` or absolute.
+ *
+ * @example
+ * await clean();
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.7.5";
+var version = "0.8.1";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 
 declare function defineRunnerConfig(config: ExtensionRunnerConfig): ExtensionRunnerConfig;
 
+/**
+ * @module wxt
+ */
+
 /**
  * Bundles the extension for production. Returns a promise of the build result.
+ *
+ * @example
+ * const res = await build({
+ *   // Enter config...
+ * })
  */
 declare function build(config: InlineConfig): Promise<BuildOutput>;
 /**
- * Creates a dev server, pre-builds all the files that need to exist to load the extension, and open
- * the browser with the extension installed.
+ * Creates a dev server and pre-builds all the files that need to exist before loading the extension.
+ *
+ * @example
+ * const server = await wxt.createServer({
+ *   // Enter config...
+ * });
+ * await server.start();
  */
 declare function createServer(config?: InlineConfig): Promise<WxtDevServer>;
 
-export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PerBrowserOption, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, WxtViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };
+export { BackgroundDefinition, BackgroundEntrypoint, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PerBrowserOption, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UnlistedScriptDefinition, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, WxtViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };

package/dist/index.js

@@ -1208,7 +1208,11 @@ function getUnimportOptions(config) {
   const defaultOptions = {
     debugLog: config.logger.debug,
     imports: [{ name: "defineConfig", from: "wxt" }],
-    presets: [{ package: "wxt/client" }, { package: "wxt/browser" }],
+    presets: [
+      { package: "wxt/client" },
+      { package: "wxt/browser" },
+      { package: "wxt/sandbox" }
+    ],
     warn: config.logger.warn,
     dirs: ["components", "composables", "hooks", "utils"]
   };
@@ -1249,7 +1253,7 @@ function unimport(config) {
 // src/core/vite-plugins/virtualEntrypoint.ts
 import fs4 from "fs-extra";
 import { resolve as resolve5 } from "path";
-function virtualEntrypoin(type, config) {
+function virtualEntrypoint(type, config) {
   const virtualId = `virtual:wxt-${type}?`;
   const resolvedVirtualId = `\0${virtualId}`;
   return {
@@ -1574,10 +1578,13 @@ async function resolveInternalViteConfig(env, mergedConfig, finalConfig) {
   internalVite.plugins.push(devHtmlPrerender(finalConfig));
   internalVite.plugins.push(unimport(finalConfig));
   internalVite.plugins.push(
-    virtualEntrypoin("background", finalConfig)
+    virtualEntrypoint("background", finalConfig)
   );
   internalVite.plugins.push(
-    virtualEntrypoin("content-script", finalConfig)
+    virtualEntrypoint("content-script", finalConfig)
+  );
+  internalVite.plugins.push(
+    virtualEntrypoint("unlisted-script", finalConfig)
   );
   internalVite.plugins.push(devServerGlobals(finalConfig));
   internalVite.plugins.push(tsconfigPaths(finalConfig));
@@ -1742,7 +1749,11 @@ async function buildEntrypoints(groups, config, spinner) {
   return { publicAssets, steps };
 }
 async function buildSingleEntrypoint(entrypoint, config) {
-  const isVirtual = ["background", "content-script"].includes(entrypoint.type);
+  const isVirtual = [
+    "background",
+    "content-script",
+    "unlisted-script"
+  ].includes(entrypoint.type);
   const entry = isVirtual ? `virtual:wxt-${entrypoint.type}?${entrypoint.inputPath}` : entrypoint.inputPath;
   const plugins = [];
   if (entrypoint.type === "content-script-style" || entrypoint.type === "unlisted-style") {
@@ -1881,6 +1892,7 @@ function removeImportStatements(text) {
 function removeProjectImportStatements(text) {
   const noImports = removeImportStatements(text);
   return `import { defineContentScript, defineBackground } from 'wxt/client';
+import { defineUnlistedScript } from 'wxt/sandbox';
 
 ${noImports}`;
 }
@@ -1906,7 +1918,6 @@ async function importEntrypointFile(path9, config) {
     cache: false,
     debug: config.debug,
     esmResolve: true,
-    interopDefault: true,
     alias: {
       "webextension-polyfill": resolve7(
         config.root,
@@ -1925,7 +1936,8 @@ async function importEntrypointFile(path9, config) {
     }
   });
   try {
-    return await jiti(path9);
+    const res = await jiti(path9);
+    return res.default;
   } catch (err) {
     config.logger.error(err);
     throw err;
@@ -1983,15 +1995,14 @@ ${JSON.stringify(
           hasBackground = true;
           break;
         case "content-script":
-          entrypoint = await getContentScriptEntrypoint(
-            config,
-            getEntrypointName(config.entrypointsDir, path9),
-            path9
-          );
+          entrypoint = await getContentScriptEntrypoint(config, path9);
           break;
         case "unlisted-page":
           entrypoint = await getUnlistedPageEntrypoint(config, path9);
           break;
+        case "unlisted-script":
+          entrypoint = await getUnlistedScriptEntrypoint(config, path9);
+          break;
         case "content-script-style":
           entrypoint = {
             type,
@@ -2135,19 +2146,46 @@ async function getUnlistedPageEntrypoint(config, path9) {
     options: getHtmlBaseOptions(document)
   };
 }
+async function getUnlistedScriptEntrypoint(config, path9) {
+  const name = getEntrypointName(config.entrypointsDir, path9);
+  const defaultExport = await importEntrypointFile(
+    path9,
+    config
+  );
+  if (defaultExport == null) {
+    throw Error(
+      `${name}: Default export not found, did you forget to call "export default defineUnlistedScript(...)"?`
+    );
+  }
+  const { main: _, ...moduleOptions } = defaultExport;
+  const options = moduleOptions;
+  return {
+    type: "unlisted-script",
+    name,
+    inputPath: path9,
+    outputDir: config.outDir,
+    options
+  };
+}
 async function getBackgroundEntrypoint(config, path9) {
+  const name = "background";
   let options = {};
   if (path9 !== VIRTUAL_NOOP_BACKGROUND_MODULE_ID) {
-    const defaultExport = await importEntrypointFile(path9, config);
+    const defaultExport = await importEntrypointFile(
+      path9,
+      config
+    );
     if (defaultExport == null) {
-      throw Error("Background script does not have a default export");
+      throw Error(
+        `${name}: Default export not found, did you forget to call "export default defineBackground(...)"?`
+      );
     }
     const { main: _, ...moduleOptions } = defaultExport;
     options = moduleOptions;
   }
   return {
     type: "background",
-    name: "background",
+    name,
     inputPath: path9,
     outputDir: config.outDir,
     options: {
@@ -2157,14 +2195,17 @@ async function getBackgroundEntrypoint(config, path9) {
     }
   };
 }
-async function getContentScriptEntrypoint(config, name, path9) {
+async function getContentScriptEntrypoint(config, path9) {
+  const name = getEntrypointName(config.entrypointsDir, path9);
   const { main: _, ...options } = await importEntrypointFile(path9, config);
   if (options == null) {
-    throw Error(`Content script ${name} does not have a default export`);
+    throw Error(
+      `${name}: Default export not found, did you forget to call "export default defineContentScript(...)"?`
+    );
   }
   return {
     type: "content-script",
-    name: getEntrypointName(config.entrypointsDir, path9),
+    name,
     inputPath: path9,
     outputDir: resolve8(config.outDir, CONTENT_SCRIPT_OUT_DIR),
     options
@@ -2686,7 +2727,8 @@ function addEntrypoints(manifest, entrypoints, buildOutput, config) {
     );
     const options2 = {
       default_icon: popup.options.defaultIcon,
-      default_title: popup.options.defaultTitle
+      default_title: popup.options.defaultTitle,
+      browser_style: popup.options.browserStyle
     };
     if (manifest.manifest_version === 3) {
       manifest.action = {
@@ -4566,7 +4608,7 @@ async function clean(root = process.cwd()) {
 }
 
 // package.json
-var version2 = "0.7.5";
+var version2 = "0.8.1";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {