wxt 0.18.9 → 0.18.11

package/dist/{index-B0efqfEK.d.ts → index-CER9SLWP.d.cts}

@@ -1041,6 +1041,23 @@ interface WxtHooks {
      * @returns Promise
      */
     ready: (wxt: Wxt) => HookResult;
+    /**
+     * Called before WXT writes .wxt/tsconfig.json and .wxt/wxt.d.ts, allowing
+     * addition of custom references and declarations in wxt.d.ts, or directly
+     * modifying the options in `tsconfig.json`.
+     *
+     * @example
+     * wxt.hooks.hook("prepare:types", (wxt, entries) => {
+     *   // Add a file, ".wxt/types/example.d.ts", that defines a global
+     *   // variable called "example" in the TS project.
+     *   entries.push({
+     *     path: "types/example.d.ts",
+     *     textContent: "declare const a: string;",
+     *     tsReference: true,
+     *   });
+     * })
+     */
+    'prepare:types': (wxt: Wxt, entries: WxtDirEntry[]) => HookResult;
     /**
      * Called before the build is started in both dev mode and build mode.
      *
@@ -1193,7 +1210,8 @@ interface ResolvedConfig {
         reloadCommand: string | false;
     };
     hooks: NestedHooks<WxtHooks>;
-    modules: WxtModuleWithMetadata<any>[];
+    builtinModules: WxtModule<any>[];
+    userModules: WxtModuleWithMetadata<any>[];
     /**
      * An array of string to import plugins from. These paths should be
      * resolvable by vite, and they should `export default defineWxtPlugin(...)`.
@@ -1216,17 +1234,21 @@ interface Eslintrc {
     /**
      * When true, generates a file that can be used by ESLint to know which variables are valid globals.
      *
-     * - `'auto'`: Check if eslint is installed, and if it is, generate the helper file
-     * - `true`: Generate the helper file
-     * - `false`: Don't generate the file
+     * - `false`: Don't generate the file.
+     * - `'auto'`: Check if eslint is installed, and if it is, generate a compatible config file.
+     * - `true`: Same as `8`.
+     * - `8`: Generate a config file compatible with ESLint 8.
+     * - `9`: Generate a config file compatible with ESLint 9.
      *
      * @default 'auto'
      */
-    enabled?: boolean | 'auto';
+    enabled?: false | true | 'auto' | 8 | 9;
     /**
      * File path to save the generated eslint config.
      *
-     * @default './.wxt/eslintrc-auto-import.json'
+     * Default depends on version of ESLint used:
+     * - 9 and above: './.wxt/eslint-auto-imports.mjs'
+     * - 8 and below: './.wxt/eslintrc-auto-import.json'
      */
     filePath?: string;
     /**
@@ -1235,7 +1257,8 @@ interface Eslintrc {
     globalsPropValue?: EslintGlobalsPropValue;
 }
 interface ResolvedEslintrc {
-    enabled: boolean;
+    /** False if disabled, otherwise the major version of ESLint installed */
+    enabled: false | 8 | 9;
     /** Absolute path */
     filePath: string;
     globalsPropValue: EslintGlobalsPropValue;
@@ -1316,20 +1339,53 @@ interface WxtModuleWithMetadata<TOptions extends WxtModuleOptions> extends WxtMo
     type: 'local' | 'node_module';
     id: string;
 }
-interface ResolvedPublicFile {
+type ResolvedPublicFile = CopiedPublicFile | GeneratedPublicFile;
+interface ResolvedBasePublicFile {
+    /**
+     * The relative path in the output directory to copy the file to.
+     * @example
+     * "content-scripts/base-styles.css"
+     */
+    relativeDest: string;
+}
+interface CopiedPublicFile extends ResolvedBasePublicFile {
     /**
      * The absolute path to the file that will be copied to the output directory.
      * @example
      * "/path/to/any/file.css"
      */
     absoluteSrc: string;
+}
+interface GeneratedPublicFile extends ResolvedBasePublicFile {
     /**
-     * The relative path in the output directory to copy the file to.
-     * @example
-     * "content-scripts/base-styles.css"
+     * Text to write to the file.
      */
-    relativeDest: string;
+    contents: string;
 }
 type WxtPlugin = () => void;
+type WxtDirEntry = WxtDirTypeReferenceEntry | WxtDirFileEntry;
+/**
+ * Represents type reference to a node module to be added to `.wxt/wxt.d.ts` file
+ */
+interface WxtDirTypeReferenceEntry {
+    module: string;
+}
+/**
+ * Represents a file to be written to the project's `.wxt/` directory.
+ */
+interface WxtDirFileEntry {
+    /**
+     * Path relative to the `.wxt/` directory. So "tsconfig.json" would resolve to ".wxt/tsconfig.json".
+     */
+    path: string;
+    /**
+     * The text that will be written to the file.
+     */
+    text: string;
+    /**
+     * Set to `true` to add a reference to this file in `.wxt/wxt.d.ts`.
+     */
+    tsReference?: boolean;
+}
 
-export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, WxtPlugin as ab, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };
+export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, ResolvedBasePublicFile as ab, CopiedPublicFile as ac, GeneratedPublicFile as ad, WxtPlugin as ae, WxtDirEntry as af, WxtDirTypeReferenceEntry as ag, WxtDirFileEntry as ah, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };

package/dist/{index-B0efqfEK.d.cts → index-CER9SLWP.d.ts}

@@ -1041,6 +1041,23 @@ interface WxtHooks {
      * @returns Promise
      */
     ready: (wxt: Wxt) => HookResult;
+    /**
+     * Called before WXT writes .wxt/tsconfig.json and .wxt/wxt.d.ts, allowing
+     * addition of custom references and declarations in wxt.d.ts, or directly
+     * modifying the options in `tsconfig.json`.
+     *
+     * @example
+     * wxt.hooks.hook("prepare:types", (wxt, entries) => {
+     *   // Add a file, ".wxt/types/example.d.ts", that defines a global
+     *   // variable called "example" in the TS project.
+     *   entries.push({
+     *     path: "types/example.d.ts",
+     *     textContent: "declare const a: string;",
+     *     tsReference: true,
+     *   });
+     * })
+     */
+    'prepare:types': (wxt: Wxt, entries: WxtDirEntry[]) => HookResult;
     /**
      * Called before the build is started in both dev mode and build mode.
      *
@@ -1193,7 +1210,8 @@ interface ResolvedConfig {
         reloadCommand: string | false;
     };
     hooks: NestedHooks<WxtHooks>;
-    modules: WxtModuleWithMetadata<any>[];
+    builtinModules: WxtModule<any>[];
+    userModules: WxtModuleWithMetadata<any>[];
     /**
      * An array of string to import plugins from. These paths should be
      * resolvable by vite, and they should `export default defineWxtPlugin(...)`.
@@ -1216,17 +1234,21 @@ interface Eslintrc {
     /**
      * When true, generates a file that can be used by ESLint to know which variables are valid globals.
      *
-     * - `'auto'`: Check if eslint is installed, and if it is, generate the helper file
-     * - `true`: Generate the helper file
-     * - `false`: Don't generate the file
+     * - `false`: Don't generate the file.
+     * - `'auto'`: Check if eslint is installed, and if it is, generate a compatible config file.
+     * - `true`: Same as `8`.
+     * - `8`: Generate a config file compatible with ESLint 8.
+     * - `9`: Generate a config file compatible with ESLint 9.
      *
      * @default 'auto'
      */
-    enabled?: boolean | 'auto';
+    enabled?: false | true | 'auto' | 8 | 9;
     /**
      * File path to save the generated eslint config.
      *
-     * @default './.wxt/eslintrc-auto-import.json'
+     * Default depends on version of ESLint used:
+     * - 9 and above: './.wxt/eslint-auto-imports.mjs'
+     * - 8 and below: './.wxt/eslintrc-auto-import.json'
      */
     filePath?: string;
     /**
@@ -1235,7 +1257,8 @@ interface Eslintrc {
     globalsPropValue?: EslintGlobalsPropValue;
 }
 interface ResolvedEslintrc {
-    enabled: boolean;
+    /** False if disabled, otherwise the major version of ESLint installed */
+    enabled: false | 8 | 9;
     /** Absolute path */
     filePath: string;
     globalsPropValue: EslintGlobalsPropValue;
@@ -1316,20 +1339,53 @@ interface WxtModuleWithMetadata<TOptions extends WxtModuleOptions> extends WxtMo
     type: 'local' | 'node_module';
     id: string;
 }
-interface ResolvedPublicFile {
+type ResolvedPublicFile = CopiedPublicFile | GeneratedPublicFile;
+interface ResolvedBasePublicFile {
+    /**
+     * The relative path in the output directory to copy the file to.
+     * @example
+     * "content-scripts/base-styles.css"
+     */
+    relativeDest: string;
+}
+interface CopiedPublicFile extends ResolvedBasePublicFile {
     /**
      * The absolute path to the file that will be copied to the output directory.
      * @example
      * "/path/to/any/file.css"
      */
     absoluteSrc: string;
+}
+interface GeneratedPublicFile extends ResolvedBasePublicFile {
     /**
-     * The relative path in the output directory to copy the file to.
-     * @example
-     * "content-scripts/base-styles.css"
+     * Text to write to the file.
      */
-    relativeDest: string;
+    contents: string;
 }
 type WxtPlugin = () => void;
+type WxtDirEntry = WxtDirTypeReferenceEntry | WxtDirFileEntry;
+/**
+ * Represents type reference to a node module to be added to `.wxt/wxt.d.ts` file
+ */
+interface WxtDirTypeReferenceEntry {
+    module: string;
+}
+/**
+ * Represents a file to be written to the project's `.wxt/` directory.
+ */
+interface WxtDirFileEntry {
+    /**
+     * Path relative to the `.wxt/` directory. So "tsconfig.json" would resolve to ".wxt/tsconfig.json".
+     */
+    path: string;
+    /**
+     * The text that will be written to the file.
+     */
+    text: string;
+    /**
+     * Set to `true` to add a reference to this file in `.wxt/wxt.d.ts`.
+     */
+    tsReference?: boolean;
+}
 
-export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, WxtPlugin as ab, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };
+export type { EslintGlobalsPropValue as $, PerBrowserMap as A, BuildOutput as B, ContentScriptEntrypoint as C, ResolvedPerBrowserOptions as D, ExtensionRunnerConfig as E, UserManifest as F, GenericEntrypoint as G, UserManifestFn as H, InlineConfig as I, ConfigEnv as J, WxtCommand as K, Logger as L, MainWorldContentScriptEntrypointOptions as M, WxtBuilder as N, OutputFile as O, PopupEntrypointOptions as P, WxtBuilderServer as Q, ResolvedConfig as R, SidepanelEntrypointOptions as S, TargetBrowser as T, UserConfig as U, ServerInfo as V, WxtDevServer as W, HookResult as X, Wxt as Y, FsCache as Z, ExtensionRunner as _, WxtViteConfig as a, Eslintrc as a0, ResolvedEslintrc as a1, WxtUnimportOptions as a2, WxtResolvedUnimportOptions as a3, WxtPackageManager as a4, Dependency as a5, WxtModuleOptions as a6, WxtModuleSetup as a7, WxtModule as a8, WxtModuleWithMetadata as a9, ResolvedPublicFile as aa, ResolvedBasePublicFile as ab, CopiedPublicFile as ac, GeneratedPublicFile as ad, WxtPlugin as ae, WxtDirEntry as af, WxtDirTypeReferenceEntry as ag, WxtDirFileEntry as ah, WxtHooks as b, OutputChunk as c, OutputAsset as d, BuildStepOutput as e, ReloadContentScriptPayload as f, TargetManifestVersion as g, BaseEntrypointOptions as h, BackgroundEntrypointOptions as i, BaseContentScriptEntrypointOptions as j, IsolatedWorldContentScriptEntrypointOptions as k, OptionsEntrypointOptions as l, BaseEntrypoint as m, BackgroundEntrypoint as n, PopupEntrypoint as o, OptionsEntrypoint as p, SidepanelEntrypoint as q, Entrypoint as r, EntrypointGroup as s, OnContentScriptStopped as t, IsolatedWorldContentScriptDefinition as u, MainWorldContentScriptDefinition as v, ContentScriptDefinition as w, BackgroundDefinition as x, UnlistedScriptDefinition as y, PerBrowserOption as z };