refactor: Rename internal popup mv2Key option to actionType (#2249)

Author: aklinker1

packages/wxt/src/core/utils/__tests__/manifest.test.ts

@@ -38,7 +38,7 @@ describe('Manifest Utils', () => {
         fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force this to be undefined instead of inheriting the random value
-            mv2Key: type ?? null,
+            actionType: type ?? null,
             defaultIcon: {
               '16': '/icon/16.png',
             },
@@ -135,7 +135,7 @@ describe('Manifest Utils', () => {
         const popup = fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force this to be undefined
-            mv2Key: null,
+            actionType: null,
             defaultArea: 'navbar',
           },
           outputDir: outDir,
@@ -165,7 +165,7 @@ describe('Manifest Utils', () => {
         const popup = fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force this to be undefined
-            mv2Key: null,
+            actionType: null,
             themeIcons,
           },
           outputDir: outDir,
@@ -191,7 +191,7 @@ describe('Manifest Utils', () => {
         const popup = fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force this to be undefined
-            mv2Key: null,
+            actionType: null,
             defaultArea: 'menupanel',
           },
           outputDir: outDir,
@@ -560,7 +560,7 @@ describe('Manifest Utils', () => {
         fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force undefined instead of the random value
-            mv2Key: null,
+            actionType: null,
           },
           outputDir: outDir,
           skipped: false,
@@ -782,7 +782,7 @@ describe('Manifest Utils', () => {
         const popup = fakePopupEntrypoint({
           options: {
             // @ts-expect-error: Force undefined
-            mv2Key: null,
+            actionType: null,
             themeIcons: userThemeIcons,
           },
           outputDir: outDir,

packages/wxt/src/core/utils/building/find-entrypoints.ts

@@ -280,17 +280,34 @@ async function getPopupEntrypoint(
     {
       ...perBrowserOptions,
       defaultTitle: title,
-      mv2Key: type,
+      actionType: type,
     },
     wxt.config.browser,
   );
-  if (strictOptions.mv2Key && strictOptions.mv2Key !== 'page_action')
-    strictOptions.mv2Key = 'browser_action';
+  if (strictOptions.actionType && strictOptions.actionType !== 'page_action')
+    strictOptions.actionType = 'browser_action';
+
+  // Sync deprecated `mv2Key` with `actionType` via getter/setter so modules
+  // that read or write either property stay in sync.
+  const opts = { ...strictOptions, themeIcons } as PopupEntrypoint['options'];
+  let _actionType = opts.actionType;
+  Object.defineProperty(opts, 'actionType', {
+    get: () => _actionType,
+    set: (v: typeof _actionType) => (_actionType = v),
+    enumerable: true,
+    configurable: true,
+  });
+  Object.defineProperty(opts, 'mv2Key', {
+    get: () => _actionType,
+    set: (v: typeof _actionType) => (_actionType = v),
+    enumerable: true,
+    configurable: true,
+  });
 
   return {
     type: 'popup',
     name: 'popup',
-    options: { ...strictOptions, themeIcons },
+    options: opts,
     inputPath: info.inputPath,
     outputDir: wxt.config.outDir,
   };

packages/wxt/src/core/utils/manifest.ts

@@ -292,9 +292,9 @@ function addEntrypoints(
 
     const actionKey =
       manifest.manifest_version === 2
-        ? (popup.options.mv2Key ?? 'browser_action')
+        ? (popup.options.actionType ?? 'browser_action')
         : wxt.config.browser === 'firefox'
-          ? (popup.options.mv2Key ?? 'action')
+          ? (popup.options.actionType ?? 'action')
           : 'action';
 
     manifest[actionKey] = {

packages/wxt/src/core/utils/testing/fake-objects.ts

@@ -139,7 +139,7 @@ export const fakePopupEntrypoint = fakeObjectCreator<PopupEntrypoint>(() => ({
         '64': 'icon/64.png',
       },
     ]),
-    mv2Key: faker.helpers.arrayElement([
+    actionType: faker.helpers.arrayElement([
       'browser_action',
       'page_action',
       undefined,

packages/wxt/src/types.ts

@@ -722,12 +722,14 @@ export interface ThemeIcon {
 
 export interface PopupEntrypointOptions extends BaseEntrypointOptions {
   /**
-   * Defaults to "browser_action" to be equivalent to MV3's "action" key.
+   * The type of action to use in the manifest.
    *
-   * This option name is bad - it is also respected for Firefox MV3 (though
-   * `browser_action` is converted to `action`) to allow using a `page_action`
-   * in MV3.
+   * In MV2, defaults to `"browser_action"`. In MV3, `"browser_action"` is
+   * converted to `"action"`, while `"page_action"` is kept as-is (Firefox MV3
+   * only).
    */
+  actionType?: PerBrowserOption<'browser_action' | 'page_action'>;
+  /** @deprecated Use `actionType` instead. */
   mv2Key?: PerBrowserOption<'browser_action' | 'page_action'>;
   defaultIcon?: Record<string, string>;
   defaultTitle?: PerBrowserOption<string>;