wxt 0.11.1 → 0.12.0

package/dist/client.d.ts

@@ -1,15 +1,16 @@
-import { B as BackgroundDefinition, C as ContentScriptContext, a as ContentScriptDefinition } from './external-PmmO6xnl.js';
+import { a as ContentScriptContext } from './external-TYmXqKVq.js';
 import * as wxt_browser from 'wxt/browser';
 import 'webextension-polyfill';
 
-declare function defineBackground(main: () => void): BackgroundDefinition;
-declare function defineBackground(definition: BackgroundDefinition): BackgroundDefinition;
-
 type ContentScriptOverlayAlignment = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+/**
+ * ![Visualization of different append modes](https://wxt.dev/content-script-ui-append.png)
+ */
 type ContentScriptAppendMode = 'last' | 'first' | 'replace' | 'before' | 'after' | ((anchor: Element, ui: Element) => void);
-type ContentScriptPositioningOptions = {
+interface ContentScriptInlinePositioningOptions {
     type: 'inline';
-} | {
+}
+interface ContentScriptOverlayPositioningOptions {
     type: 'overlay';
     /**
      * The `z-index` used on the `shadowHost`. Set to a positive number to show your UI over website
@@ -20,17 +21,26 @@ type ContentScriptPositioningOptions = {
      * When using `type: "overlay"`, the mounted element is 0px by 0px in size. Alignment specifies
      * which corner is aligned with that 0x0 pixel space.
      *
+     * ![Visualization of alignment options](https://wxt.dev/content-script-ui-alignment.png)
+     *
      * @default "top-left"
      */
     alignment?: ContentScriptOverlayAlignment;
-} | {
+}
+interface ContentScriptModalPositioningOptions {
     type: 'modal';
     /**
      * The `z-index` used on the `shadowHost`. Set to a positive number to show your UI over website
      * content.
      */
     zIndex?: number;
-};
+}
+/**
+ * Choose between `"inline"`, `"overlay"`, or `"modal" `types.
+ *
+ * ![Visualization of different types](https://wxt.dev/content-script-ui-type.png)
+ */
+type ContentScriptPositioningOptions = ContentScriptInlinePositioningOptions | ContentScriptOverlayPositioningOptions | ContentScriptModalPositioningOptions;
 interface ContentScriptAnchoredOptions {
     /**
      * A CSS selector, element, or function that returns one of the two. Along with `append`, the
@@ -54,7 +64,7 @@ interface ContentScriptAnchoredOptions {
  * Utility for mounting content script UI's with isolated styles. Automatically removed from the DOM
  * when the content script's context is invalidated.
  *
- * See https://wxt.dev/entrypoints/content-scripts.html#ui for full documentation.
+ * See https://wxt.dev/guide/content-script-ui.html for full documentation.
  *
  * @example
  * // entrypoints/example-ui.content/index.ts
@@ -129,7 +139,7 @@ type ContentScriptUiOptions<TApp> = ContentScriptPositioningOptions & ContentScr
      * set `cssInjectionMode: "ui"`, the imported CSS will be included automatically. You do not need
      * to pass those styles in here. This is for any additional styles not in the imported CSS.
      *
-     * See https://wxt.dev/entrypoints/content-scripts.html#ui for more info.
+     * See https://wxt.dev/guide/content-script-ui.html for more info.
      */
     css?: string;
 };
@@ -179,6 +189,4 @@ type ContentScriptIframeOptions = ContentScriptPositioningOptions & ContentScrip
     page: wxt_browser.PublicPath;
 };
 
-declare function defineContentScript(definition: ContentScriptDefinition): ContentScriptDefinition;
-
-export { ContentScriptContext, type ContentScriptIframe, type ContentScriptIframeOptions, type ContentScriptUi, type ContentScriptUiOptions, createContentScriptIframe, createContentScriptUi, defineBackground, defineContentScript };
+export { type ContentScriptAnchoredOptions, type ContentScriptAppendMode, ContentScriptContext, type ContentScriptIframe, type ContentScriptIframeOptions, type ContentScriptInlinePositioningOptions, type ContentScriptModalPositioningOptions, type ContentScriptOverlayAlignment, type ContentScriptOverlayPositioningOptions, type ContentScriptPositioningOptions, type ContentScriptUi, type ContentScriptUiOptions, createContentScriptIframe, createContentScriptUi };

package/dist/client.js

@@ -2,13 +2,6 @@ import {
   browser
 } from "./chunk-FNTE2L27.js";
 
-// src/client/define-background.ts
-function defineBackground(arg) {
-  if (typeof arg === "function")
-    return { main: arg };
-  return arg;
-}
-
 // src/client/utils/logger.ts
 function print(method, ...args) {
   if (import.meta.env.MODE === "production")
@@ -393,15 +386,8 @@ function createContentScriptIframe(ctx, options) {
     remove
   };
 }
-
-// src/client/content-scripts/define-content-script.ts
-function defineContentScript(definition) {
-  return definition;
-}
 export {
   ContentScriptContext,
   createContentScriptIframe,
-  createContentScriptUi,
-  defineBackground,
-  defineContentScript
+  createContentScriptUi
 };

package/dist/{external-PmmO6xnl.d.ts → external-TYmXqKVq.d.ts}

@@ -97,7 +97,29 @@ interface WxtContentScriptEventMap extends WindowEventMap {
 }
 
 type TargetBrowser = string;
-interface ContentScriptDefinition extends ExcludableEntrypoint {
+type ContentScriptDefinition = ContentScriptIsolatedWorldDefinition | ContentScriptMainWorldDefinition;
+interface ContentScriptIsolatedWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     * @default "ISOLATED"
+     */
+    world?: 'ISOLATED';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(ctx: ContentScriptContext): void | Promise<void>;
+}
+interface ContentScriptMainWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     */
+    world: 'MAIN';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(): void | Promise<void>;
+}
+interface ContentScriptBaseDefinition extends ExcludableEntrypoint {
     matches: PerBrowserOption<Manifest.ContentScript['matches']>;
     /**
      * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
@@ -134,11 +156,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default false
      */
     matchOriginAsFallback?: PerBrowserOption<boolean>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default "ISOLATED"
-     */
-    world?: PerBrowserOption<'ISOLATED' | 'MAIN'>;
     /**
      * Customize how imported/generated styles are injected with the content script. Regardless of the
      * mode selected, CSS will always be built and included in the output directory.
@@ -153,10 +170,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default "manifest"
      */
     cssInjectionMode?: PerBrowserOption<'manifest' | 'manual' | 'ui'>;
-    /**
-     * Main function executed when the content script is loaded.
-     */
-    main(ctx: ContentScriptContext): void | Promise<void>;
 }
 interface BackgroundDefinition extends ExcludableEntrypoint {
     type?: PerBrowserOption<'module'>;
@@ -189,4 +202,4 @@ interface ExcludableEntrypoint {
     exclude?: TargetBrowser[];
 }
 
-export { type BackgroundDefinition as B, ContentScriptContext as C, type UnlistedScriptDefinition as U, type ContentScriptDefinition as a };
+export { type BackgroundDefinition as B, type ContentScriptDefinition as C, type UnlistedScriptDefinition as U, ContentScriptContext as a };

package/dist/{external-irU6kFSB.d.cts → external-tVP-84Pg.d.cts}

@@ -483,7 +483,29 @@ interface OptionsEntrypoint extends BaseEntrypoint {
 type Entrypoint = GenericEntrypoint | BackgroundEntrypoint | ContentScriptEntrypoint | PopupEntrypoint | OptionsEntrypoint;
 type EntrypointGroup = Entrypoint | Entrypoint[];
 type OnContentScriptStopped = (cb: () => void) => void;
-interface ContentScriptDefinition extends ExcludableEntrypoint {
+type ContentScriptDefinition = ContentScriptIsolatedWorldDefinition | ContentScriptMainWorldDefinition;
+interface ContentScriptIsolatedWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     * @default "ISOLATED"
+     */
+    world?: 'ISOLATED';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(ctx: ContentScriptContext): void | Promise<void>;
+}
+interface ContentScriptMainWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     */
+    world: 'MAIN';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(): void | Promise<void>;
+}
+interface ContentScriptBaseDefinition extends ExcludableEntrypoint {
     matches: PerBrowserOption<Manifest.ContentScript['matches']>;
     /**
      * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
@@ -520,11 +542,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default false
      */
     matchOriginAsFallback?: PerBrowserOption<boolean>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default "ISOLATED"
-     */
-    world?: PerBrowserOption<'ISOLATED' | 'MAIN'>;
     /**
      * Customize how imported/generated styles are injected with the content script. Regardless of the
      * mode selected, CSS will always be built and included in the output directory.
@@ -539,10 +556,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default "manifest"
      */
     cssInjectionMode?: PerBrowserOption<'manifest' | 'manual' | 'ui'>;
-    /**
-     * Main function executed when the content script is loaded.
-     */
-    main(ctx: ContentScriptContext): void | Promise<void>;
 }
 interface BackgroundDefinition extends ExcludableEntrypoint {
     type?: PerBrowserOption<'module'>;
@@ -707,4 +720,4 @@ interface ServerInfo {
     origin: string;
 }
 
-export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, BackgroundDefinition as n, UnlistedScriptDefinition as o, PerBrowserOption as p, ExcludableEntrypoint as q, UserManifest as r, UserManifestFn as s, ConfigEnv as t, WxtBuilder as u, WxtBuilderServer as v };
+export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y };

package/dist/{external-irU6kFSB.d.ts → external-tVP-84Pg.d.ts}

@@ -483,7 +483,29 @@ interface OptionsEntrypoint extends BaseEntrypoint {
 type Entrypoint = GenericEntrypoint | BackgroundEntrypoint | ContentScriptEntrypoint | PopupEntrypoint | OptionsEntrypoint;
 type EntrypointGroup = Entrypoint | Entrypoint[];
 type OnContentScriptStopped = (cb: () => void) => void;
-interface ContentScriptDefinition extends ExcludableEntrypoint {
+type ContentScriptDefinition = ContentScriptIsolatedWorldDefinition | ContentScriptMainWorldDefinition;
+interface ContentScriptIsolatedWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     * @default "ISOLATED"
+     */
+    world?: 'ISOLATED';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(ctx: ContentScriptContext): void | Promise<void>;
+}
+interface ContentScriptMainWorldDefinition extends ContentScriptBaseDefinition {
+    /**
+     * See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world
+     */
+    world: 'MAIN';
+    /**
+     * Main function executed when the content script is loaded.
+     */
+    main(): void | Promise<void>;
+}
+interface ContentScriptBaseDefinition extends ExcludableEntrypoint {
     matches: PerBrowserOption<Manifest.ContentScript['matches']>;
     /**
      * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
@@ -520,11 +542,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default false
      */
     matchOriginAsFallback?: PerBrowserOption<boolean>;
-    /**
-     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
-     * @default "ISOLATED"
-     */
-    world?: PerBrowserOption<'ISOLATED' | 'MAIN'>;
     /**
      * Customize how imported/generated styles are injected with the content script. Regardless of the
      * mode selected, CSS will always be built and included in the output directory.
@@ -539,10 +556,6 @@ interface ContentScriptDefinition extends ExcludableEntrypoint {
      * @default "manifest"
      */
     cssInjectionMode?: PerBrowserOption<'manifest' | 'manual' | 'ui'>;
-    /**
-     * Main function executed when the content script is loaded.
-     */
-    main(ctx: ContentScriptContext): void | Promise<void>;
 }
 interface BackgroundDefinition extends ExcludableEntrypoint {
     type?: PerBrowserOption<'module'>;
@@ -707,4 +720,4 @@ interface ServerInfo {
     origin: string;
 }
 
-export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, BackgroundDefinition as n, UnlistedScriptDefinition as o, PerBrowserOption as p, ExcludableEntrypoint as q, UserManifest as r, UserManifestFn as s, ConfigEnv as t, WxtBuilder as u, WxtBuilderServer as v };
+export type { BuildOutput as B, ContentScriptEntrypoint as C, ExtensionRunnerConfig as E, GenericEntrypoint as G, InlineConfig as I, Logger as L, OutputFile as O, PopupEntrypoint as P, ServerInfo as S, TargetBrowser as T, UserConfig as U, WxtDevServer as W, WxtViteConfig as a, OutputChunk as b, OutputAsset as c, BuildStepOutput as d, TargetManifestVersion as e, BaseEntrypointOptions as f, BaseEntrypoint as g, BackgroundEntrypoint as h, OptionsEntrypoint as i, Entrypoint as j, EntrypointGroup as k, OnContentScriptStopped as l, ContentScriptDefinition as m, ContentScriptIsolatedWorldDefinition as n, ContentScriptMainWorldDefinition as o, ContentScriptBaseDefinition as p, BackgroundDefinition as q, UnlistedScriptDefinition as r, PerBrowserOption as s, ExcludableEntrypoint as t, UserManifest as u, UserManifestFn as v, ConfigEnv as w, WxtBuilder as x, WxtBuilderServer as y };