wxt 0.17.4 → 0.17.6

package/dist/{index-vpYNIeCJ.d.cts → index-l43sonfW.d.cts}

@@ -6,6 +6,7 @@ import { PluginVisualizerOptions } from '@aklinker1/rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
 import { ResolvedConfig as ResolvedConfig$1 } from 'c12';
 import { NestedHooks, Hookable } from 'hookable';
+import * as Nypm from 'nypm';
 
 declare class WxtLocationChangeEvent extends Event {
     readonly newUrl: URL;
@@ -138,6 +139,9 @@ interface InlineConfig {
      * Directory containing all source code. Set to `"src"` to move all source code to a `src/`
      * directory.
      *
+     * After changing, don't forget to move the `public/` and `entrypoints/` directories into the new
+     * source dir.
+     *
      * @default config.root
      */
     srcDir?: string;
@@ -289,6 +293,31 @@ interface InlineConfig {
          * ]
          */
         excludeSources?: string[];
+        /**
+         * The Firefox review process requires the extension be buildable from source to make reviewing
+         * easier. This field allows you to use private packages without exposing your auth tokens.
+         *
+         * Just list the name of all the packages you want to download and include in the sources zip.
+         * Usually, these will be private packages behind auth tokens, but they don't have to be.
+         *
+         * All packages listed here will be downloaded to in `.wxt/local_modules/` and an `overrides` or
+         * `resolutions` field (depending on your package manager) will be added to the `package.json`,
+         * pointing to the downloaded packages.
+         *
+         * > ***DO NOT include versions or version filters.*** Just the package name. If multiple
+         * > versions of a package are present in the project, all versions will be downloaded and
+         * > referenced in the package.json correctly.
+         *
+         * @default []
+         *
+         * @example
+         * // Correct:
+         * ["@scope/package-name", "package-name"]
+         *
+         * // Incorrect, don't include versions!!!
+         * ["@scope/package-name@1.1.3", "package-name@^2"]
+         */
+        downloadPackages?: string[];
     };
     /**
      * @deprecated Use `hooks.build.manifestGenerated` to modify your manifest instead. This option
@@ -757,14 +786,23 @@ type ResolvedPerBrowserOptions<T, TOmitted extends keyof T = never> = {
 type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'background' | 'chrome_url_overrides' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox'>>;
 type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
 interface ConfigEnv {
+    /**
+     * The build mode passed into the CLI. By default, `wxt` uses `"development"` and `wxt build|zip`
+     * uses `"production"`.
+     */
     mode: string;
+    /**
+     * The command used to run WXT. `"serve"` during development and `"build"` for any other command.
+     */
     command: 'build' | 'serve';
     /**
-     * Browser passed in from the CLI
+     * Browser passed in from the CLI via the `-b` or `--browser` flag. Defaults to `"chrome"` when not passed.
      */
     browser: TargetBrowser;
     /**
-     * Manifest version passed in from the CLI
+     * Manifest version passed in from the CLI via the `--mv2` or `--mv3` flags. When not passed, it depends on the target browser. See
+     * [the guide](https://wxt.dev/guide/multiple-browsers.html#target-manifest-version) for more
+     * details.
      */
     manifestVersion: 2 | 3;
 }
@@ -964,6 +1002,10 @@ interface Wxt {
      * Reload config file and update the `config` field with the result.
      */
     reloadConfig: () => Promise<void>;
+    /**
+     * Package manager utilities.
+     */
+    pm: WxtPackageManager;
 }
 interface ResolvedConfig {
     root: string;
@@ -998,6 +1040,8 @@ interface ResolvedConfig {
         includeSources: string[];
         excludeSources: string[];
         sourcesRoot: string;
+        downloadedPackagesDir: string;
+        downloadPackages: string[];
     };
     transformManifest: (manifest: Manifest.WebExtensionManifest) => void;
     analysis: {
@@ -1072,5 +1116,41 @@ type WxtUnimportOptions = Partial<UnimportOptions> & {
 type WxtResolvedUnimportOptions = Partial<UnimportOptions> & {
     eslintrc: ResolvedEslintrc;
 };
+/**
+ * Package management utils built on top of [`nypm`](https://www.npmjs.com/package/nypm)
+ */
+interface WxtPackageManager extends Nypm.PackageManager {
+    addDependency: typeof Nypm.addDependency;
+    addDevDependency: typeof Nypm.addDevDependency;
+    ensureDependencyInstalled: typeof Nypm.ensureDependencyInstalled;
+    installDependencies: typeof Nypm.installDependencies;
+    removeDependency: typeof Nypm.removeDependency;
+    /**
+     * Download a package's TGZ file and move it into the `downloadDir`. Use's `npm pack <name>`, so
+     * you must have setup authorization in `.npmrc` file, regardless of the package manager used.
+     *
+     * @param id Name of the package to download, can include a version (like `wxt@0.17.1`)
+     * @param downloadDir Where to store the package.
+     * @returns Absolute path to downloaded file.
+     */
+    downloadDependency: (id: string, downloadDir: string) => Promise<string>;
+    /**
+     * Run `npm ls`, `pnpm ls`, or `bun pm ls`, or `yarn list` and return the results.
+     *
+     * WARNING: Yarn always returns all dependencies
+     */
+    listDependencies: (options?: {
+        cwd?: string;
+        all?: boolean;
+    }) => Promise<Dependency[]>;
+    /**
+     * Key used to override package versions. Sometimes called "resolutions".
+     */
+    overridesKey: string;
+}
+interface Dependency {
+    name: string;
+    version: string;
+}
 
-export type { EslintGlobalsPropValue as $, UserManifest as A, BuildOutput as B, ContentScriptEntrypoint as C, UserManifestFn as D, ExtensionRunnerConfig as E, ConfigEnv as F, GenericEntrypoint as G, WxtBuilder as H, InlineConfig as I, WxtBuilderServer as J, ServerInfo as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, HookResult as N, OutputFile as O, PopupEntrypointOptions as P, WxtHooks as Q, ReloadContentScriptPayload as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, Wxt as V, WxtDevServer as W, ResolvedConfig as X, FsCache as Y, ExtensionRunner as Z, VirtualEntrypointType as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BackgroundEntrypointOptions as g, BaseContentScriptEntrypointOptions as h, IsolatedWorldContentScriptEntrypointOptions as i, OptionsEntrypointOptions as j, BaseEntrypoint as k, BackgroundEntrypoint as l, PopupEntrypoint as m, OptionsEntrypoint as n, SidepanelEntrypoint as o, Entrypoint as p, EntrypointGroup as q, OnContentScriptStopped as r, IsolatedWorldContentScriptDefinition as s, MainWorldContentScriptDefinition as t, ContentScriptDefinition as u, BackgroundDefinition as v, UnlistedScriptDefinition as w, PerBrowserOption as x, PerBrowserMap as y, ResolvedPerBrowserOptions as z };
+export type { EslintGlobalsPropValue as $, UserManifest as A, BuildOutput as B, ContentScriptEntrypoint as C, UserManifestFn as D, ExtensionRunnerConfig as E, ConfigEnv as F, GenericEntrypoint as G, WxtBuilder as H, InlineConfig as I, WxtBuilderServer as J, ServerInfo as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, HookResult as N, OutputFile as O, PopupEntrypointOptions as P, WxtHooks as Q, ReloadContentScriptPayload as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, Wxt as V, WxtDevServer as W, ResolvedConfig as X, FsCache as Y, ExtensionRunner as Z, VirtualEntrypointType as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BackgroundEntrypointOptions as g, BaseContentScriptEntrypointOptions as h, IsolatedWorldContentScriptEntrypointOptions as i, OptionsEntrypointOptions as j, BaseEntrypoint as k, BackgroundEntrypoint as l, PopupEntrypoint as m, OptionsEntrypoint as n, SidepanelEntrypoint as o, Entrypoint as p, EntrypointGroup as q, OnContentScriptStopped as r, IsolatedWorldContentScriptDefinition as s, MainWorldContentScriptDefinition as t, ContentScriptDefinition as u, BackgroundDefinition as v, UnlistedScriptDefinition as w, PerBrowserOption as x, PerBrowserMap as y, ResolvedPerBrowserOptions as z };

package/dist/{index-vpYNIeCJ.d.ts → index-l43sonfW.d.ts}

@@ -6,6 +6,7 @@ import { PluginVisualizerOptions } from '@aklinker1/rollup-plugin-visualizer';
 import { FSWatcher } from 'chokidar';
 import { ResolvedConfig as ResolvedConfig$1 } from 'c12';
 import { NestedHooks, Hookable } from 'hookable';
+import * as Nypm from 'nypm';
 
 declare class WxtLocationChangeEvent extends Event {
     readonly newUrl: URL;
@@ -138,6 +139,9 @@ interface InlineConfig {
      * Directory containing all source code. Set to `"src"` to move all source code to a `src/`
      * directory.
      *
+     * After changing, don't forget to move the `public/` and `entrypoints/` directories into the new
+     * source dir.
+     *
      * @default config.root
      */
     srcDir?: string;
@@ -289,6 +293,31 @@ interface InlineConfig {
          * ]
          */
         excludeSources?: string[];
+        /**
+         * The Firefox review process requires the extension be buildable from source to make reviewing
+         * easier. This field allows you to use private packages without exposing your auth tokens.
+         *
+         * Just list the name of all the packages you want to download and include in the sources zip.
+         * Usually, these will be private packages behind auth tokens, but they don't have to be.
+         *
+         * All packages listed here will be downloaded to in `.wxt/local_modules/` and an `overrides` or
+         * `resolutions` field (depending on your package manager) will be added to the `package.json`,
+         * pointing to the downloaded packages.
+         *
+         * > ***DO NOT include versions or version filters.*** Just the package name. If multiple
+         * > versions of a package are present in the project, all versions will be downloaded and
+         * > referenced in the package.json correctly.
+         *
+         * @default []
+         *
+         * @example
+         * // Correct:
+         * ["@scope/package-name", "package-name"]
+         *
+         * // Incorrect, don't include versions!!!
+         * ["@scope/package-name@1.1.3", "package-name@^2"]
+         */
+        downloadPackages?: string[];
     };
     /**
      * @deprecated Use `hooks.build.manifestGenerated` to modify your manifest instead. This option
@@ -757,14 +786,23 @@ type ResolvedPerBrowserOptions<T, TOmitted extends keyof T = never> = {
 type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'background' | 'chrome_url_overrides' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox'>>;
 type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
 interface ConfigEnv {
+    /**
+     * The build mode passed into the CLI. By default, `wxt` uses `"development"` and `wxt build|zip`
+     * uses `"production"`.
+     */
     mode: string;
+    /**
+     * The command used to run WXT. `"serve"` during development and `"build"` for any other command.
+     */
     command: 'build' | 'serve';
     /**
-     * Browser passed in from the CLI
+     * Browser passed in from the CLI via the `-b` or `--browser` flag. Defaults to `"chrome"` when not passed.
      */
     browser: TargetBrowser;
     /**
-     * Manifest version passed in from the CLI
+     * Manifest version passed in from the CLI via the `--mv2` or `--mv3` flags. When not passed, it depends on the target browser. See
+     * [the guide](https://wxt.dev/guide/multiple-browsers.html#target-manifest-version) for more
+     * details.
      */
     manifestVersion: 2 | 3;
 }
@@ -964,6 +1002,10 @@ interface Wxt {
      * Reload config file and update the `config` field with the result.
      */
     reloadConfig: () => Promise<void>;
+    /**
+     * Package manager utilities.
+     */
+    pm: WxtPackageManager;
 }
 interface ResolvedConfig {
     root: string;
@@ -998,6 +1040,8 @@ interface ResolvedConfig {
         includeSources: string[];
         excludeSources: string[];
         sourcesRoot: string;
+        downloadedPackagesDir: string;
+        downloadPackages: string[];
     };
     transformManifest: (manifest: Manifest.WebExtensionManifest) => void;
     analysis: {
@@ -1072,5 +1116,41 @@ type WxtUnimportOptions = Partial<UnimportOptions> & {
 type WxtResolvedUnimportOptions = Partial<UnimportOptions> & {
     eslintrc: ResolvedEslintrc;
 };
+/**
+ * Package management utils built on top of [`nypm`](https://www.npmjs.com/package/nypm)
+ */
+interface WxtPackageManager extends Nypm.PackageManager {
+    addDependency: typeof Nypm.addDependency;
+    addDevDependency: typeof Nypm.addDevDependency;
+    ensureDependencyInstalled: typeof Nypm.ensureDependencyInstalled;
+    installDependencies: typeof Nypm.installDependencies;
+    removeDependency: typeof Nypm.removeDependency;
+    /**
+     * Download a package's TGZ file and move it into the `downloadDir`. Use's `npm pack <name>`, so
+     * you must have setup authorization in `.npmrc` file, regardless of the package manager used.
+     *
+     * @param id Name of the package to download, can include a version (like `wxt@0.17.1`)
+     * @param downloadDir Where to store the package.
+     * @returns Absolute path to downloaded file.
+     */
+    downloadDependency: (id: string, downloadDir: string) => Promise<string>;
+    /**
+     * Run `npm ls`, `pnpm ls`, or `bun pm ls`, or `yarn list` and return the results.
+     *
+     * WARNING: Yarn always returns all dependencies
+     */
+    listDependencies: (options?: {
+        cwd?: string;
+        all?: boolean;
+    }) => Promise<Dependency[]>;
+    /**
+     * Key used to override package versions. Sometimes called "resolutions".
+     */
+    overridesKey: string;
+}
+interface Dependency {
+    name: string;
+    version: string;
+}
 
-export type { EslintGlobalsPropValue as $, UserManifest as A, BuildOutput as B, ContentScriptEntrypoint as C, UserManifestFn as D, ExtensionRunnerConfig as E, ConfigEnv as F, GenericEntrypoint as G, WxtBuilder as H, InlineConfig as I, WxtBuilderServer as J, ServerInfo as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, HookResult as N, OutputFile as O, PopupEntrypointOptions as P, WxtHooks as Q, ReloadContentScriptPayload as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, Wxt as V, WxtDevServer as W, ResolvedConfig as X, FsCache as Y, ExtensionRunner as Z, VirtualEntrypointType as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BackgroundEntrypointOptions as g, BaseContentScriptEntrypointOptions as h, IsolatedWorldContentScriptEntrypointOptions as i, OptionsEntrypointOptions as j, BaseEntrypoint as k, BackgroundEntrypoint as l, PopupEntrypoint as m, OptionsEntrypoint as n, SidepanelEntrypoint as o, Entrypoint as p, EntrypointGroup as q, OnContentScriptStopped as r, IsolatedWorldContentScriptDefinition as s, MainWorldContentScriptDefinition as t, ContentScriptDefinition as u, BackgroundDefinition as v, UnlistedScriptDefinition as w, PerBrowserOption as x, PerBrowserMap as y, ResolvedPerBrowserOptions as z };
+export type { EslintGlobalsPropValue as $, UserManifest as A, BuildOutput as B, ContentScriptEntrypoint as C, UserManifestFn as D, ExtensionRunnerConfig as E, ConfigEnv as F, GenericEntrypoint as G, WxtBuilder as H, InlineConfig as I, WxtBuilderServer as J, ServerInfo as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, HookResult as N, OutputFile as O, PopupEntrypointOptions as P, WxtHooks as Q, ReloadContentScriptPayload as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, Wxt as V, WxtDevServer as W, ResolvedConfig as X, FsCache as Y, ExtensionRunner as Z, VirtualEntrypointType as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BackgroundEntrypointOptions as g, BaseContentScriptEntrypointOptions as h, IsolatedWorldContentScriptEntrypointOptions as i, OptionsEntrypointOptions as j, BaseEntrypoint as k, BackgroundEntrypoint as l, PopupEntrypoint as m, OptionsEntrypoint as n, SidepanelEntrypoint as o, Entrypoint as p, EntrypointGroup as q, OnContentScriptStopped as r, IsolatedWorldContentScriptDefinition as s, MainWorldContentScriptDefinition as t, ContentScriptDefinition as u, BackgroundDefinition as v, UnlistedScriptDefinition as w, PerBrowserOption as x, PerBrowserMap as y, ResolvedPerBrowserOptions as z };