🤖 Merge PR DefinitelyTyped#73717 updated types for webextension-polyfill by @Lusito

Lusito · web-flow · commit a8ba2117f39f · 2025-09-30T14:40:49.000-07:00
diff --git a/types/webextension-polyfill/index.d.ts b/types/webextension-polyfill/index.d.ts
@@ -364,13 +364,12 @@ declare namespace Browser {
     const storage: Storage.Static;
 
     /**
-     * Chrome API (only available for Chrome)
-     * Use the <code>chrome.tabGroups</code> API to interact with the browser's tab grouping system.
-     * You can use this API to modify and rearrange tab groups in the browser. To group and ungroup tabs,
-     * or to query what tabs are in groups, use the <code>browser.tabs</code> API.
-     * Optional.
+     * Use the browser.tabGroups API to interact with the browser's tab grouping system. You can use this API to modify,
+     * and rearrange tab groups.
+     *
+     * Permissions: "tabGroups"
      */
-    const tabGroups: TabGroups.Static | undefined;
+    const tabGroups: TabGroups.Static;
 
     /**
      * Use the <code>browser.tabs</code> API to interact with the browser's tab system. You can use this API to create, modify,
@@ -731,13 +730,12 @@ declare namespace Browser {
         storage: Storage.Static;
 
         /**
-         * Chrome API (only available for Chrome)
-         * Use the <code>chrome.tabGroups</code> API to interact with the browser's tab grouping system.
-         * You can use this API to modify and rearrange tab groups in the browser. To group and ungroup tabs,
-         * or to query what tabs are in groups, use the <code>browser.tabs</code> API.
-         * Optional.
+         * Use the browser.tabGroups API to interact with the browser's tab grouping system. You can use this API to modify,
+         * and rearrange tab groups.
+         *
+         * Permissions: "tabGroups"
          */
-        tabGroups?: TabGroups.Static;
+        tabGroups: TabGroups.Static;
 
         /**
          * Use the <code>browser.tabs</code> API to interact with the browser's tab system. You can use this API to create, modify,
diff --git a/types/webextension-polyfill/namespaces/action.d.ts b/types/webextension-polyfill/namespaces/action.d.ts
@@ -137,6 +137,15 @@ export namespace Action {
         windowId?: number;
     }
 
+    interface OnUserSettingsChangedChangeType {
+        /**
+         * Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e.,
+         * whether the extension has been 'pinned' by the user).
+         * Optional.
+         */
+        isOnToolbar?: boolean;
+    }
+
     type OnClickDataModifiersItemEnum = "Shift" | "Alt" | "Command" | "Ctrl" | "MacCtrl";
 
     interface Static {
@@ -235,5 +244,10 @@ export namespace Action {
          * @param info Optional.
          */
         onClicked: Events.Event<(tab: Tabs.Tab, info: OnClickData | undefined) => void>;
+
+        /**
+         * Fired when user-specified settings relating to an extension's action change.
+         */
+        onUserSettingsChanged: Events.Event<(change: OnUserSettingsChangedChangeType) => void>;
     }
 }
diff --git a/types/webextension-polyfill/namespaces/alarms.d.ts b/types/webextension-polyfill/namespaces/alarms.d.ts
@@ -65,7 +65,7 @@ export namespace Alarms {
          * Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided,
          * then the alarm recurs repeatedly after that many minutes.
          */
-        create(name: string | undefined, alarmInfo: CreateAlarmInfoType): void;
+        create(name: string | undefined, alarmInfo: CreateAlarmInfoType): Promise<void>;
 
         /**
          * Creates an alarm. After the delay is expired, the onAlarm event is fired. If there is another alarm with the same name
@@ -77,7 +77,7 @@ export namespace Alarms {
          * Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided,
          * then the alarm recurs repeatedly after that many minutes.
          */
-        create(alarmInfo: CreateAlarmInfoType): void;
+        create(alarmInfo: CreateAlarmInfoType): Promise<void>;
 
         /**
          * Retrieves details about the specified alarm.
diff --git a/types/webextension-polyfill/namespaces/browserSettings.d.ts b/types/webextension-polyfill/namespaces/browserSettings.d.ts
@@ -115,6 +115,11 @@ export namespace BrowserSettings {
          */
         zoomSiteSpecific: Types.Setting;
 
+        /**
+         * This boolean setting controls whether vertical tabs are enabled.
+         */
+        verticalTabs: Types.Setting;
+
         colorManagement: BrowserSettingsColorManagement.Static;
     }
 }
diff --git a/types/webextension-polyfill/namespaces/contentScripts.d.ts b/types/webextension-polyfill/namespaces/contentScripts.d.ts
@@ -77,6 +77,12 @@ export namespace ContentScripts {
          */
         world?: ExtensionTypes.ExecutionWorld;
 
+        /**
+         * The css origin of the stylesheet to inject. Defaults to "author".
+         * Optional.
+         */
+        cssOrigin?: ExtensionTypes.CSSOrigin;
+
         /**
          * limit the set of matched tabs to those that belong to the given cookie store id
          * Optional.
diff --git a/types/webextension-polyfill/namespaces/cookies.d.ts b/types/webextension-polyfill/namespaces/cookies.d.ts
@@ -13,7 +13,7 @@ export namespace Cookies {
      * 'no_restriction' corresponds to a cookie set without a 'SameSite' attribute, 'lax' to 'SameSite=Lax',
      * and 'strict' to 'SameSite=Strict'.
      */
-    type SameSiteStatus = "no_restriction" | "lax" | "strict";
+    type SameSiteStatus = "unspecified" | "no_restriction" | "lax" | "strict";
 
     /**
      * The description of the storage partition of a cookie. This object may be omitted (null) if a cookie is not partitioned.
diff --git a/types/webextension-polyfill/namespaces/declarativeNetRequest.d.ts b/types/webextension-polyfill/namespaces/declarativeNetRequest.d.ts
@@ -8,6 +8,7 @@
 export namespace DeclarativeNetRequest {
     /**
      * How the requested resource will be used. Comparable to the webRequest.ResourceType type.
+     * object_subrequest is unsupported.
      */
     type ResourceType =
         | "main_frame"
diff --git a/types/webextension-polyfill/namespaces/i18n.d.ts b/types/webextension-polyfill/namespaces/i18n.d.ts
@@ -60,6 +60,12 @@ export namespace I18n {
          */
         getMessage(messageName: string, substitutions?: string[] | string): string;
 
+        /**
+         * Gets the preferred locales of the operating system. This is different from the locales set in the browser; to get those,
+         * use $(ref:i18n.getAcceptLanguages).
+         */
+        getPreferredSystemLanguages(): Promise<LanguageCode[]>;
+
         /**
          * Gets the browser UI language of the browser. This is different from $(ref:i18n.getAcceptLanguages)
          * which returns the preferred user languages.
diff --git a/types/webextension-polyfill/namespaces/manifest.d.ts b/types/webextension-polyfill/namespaces/manifest.d.ts
@@ -27,7 +27,7 @@ export namespace Manifest {
         browser_specific_settings?: BrowserSpecificSettings;
 
         /**
-         * Name must be at least 2, at should be at most 75 characters
+         * Name must be at least 2, and should be at most 75 characters
          */
         name: string;
 
@@ -287,6 +287,7 @@ export namespace Manifest {
         | "menus.overrideContext"
         | "scripting"
         | "search"
+        | "tabGroups"
         | "activeTab"
         | "webRequest"
         | "webRequestAuthProvider"
@@ -315,7 +316,6 @@ export namespace Manifest {
         | "proxy"
         | "nativeMessaging"
         | "sessions"
-        | "tabGroups"
         | "tabs"
         | "tabHide"
         | "topSites"
@@ -326,6 +326,23 @@ export namespace Manifest {
 
     type PermissionPrivileged = "mozillaAddons" | "activityLog" | "networkStatus" | "normandyAddonStudy";
 
+    type CommonDataCollectionPermission =
+        | "authenticationInfo"
+        | "bookmarksInfo"
+        | "browsingActivity"
+        | "financialAndPaymentInfo"
+        | "healthInfo"
+        | "locationInfo"
+        | "personalCommunications"
+        | "personallyIdentifyingInfo"
+        | "searchTerms"
+        | "websiteActivity"
+        | "websiteContent";
+
+    type DataCollectionPermission = CommonDataCollectionPermission | "none";
+
+    type OptionalDataCollectionPermission = CommonDataCollectionPermission | "technicalAndInteraction";
+
     type PermissionNoPrompt =
         | OptionalPermissionNoPrompt
         | PermissionPrivileged
@@ -381,6 +398,11 @@ export namespace Manifest {
          * Optional.
          */
         admin_install_only?: boolean;
+
+        /**
+         * Optional.
+         */
+        data_collection_permissions?: FirefoxSpecificPropertiesDataCollectionPermissionsType;
     }
 
     interface GeckoAndroidSpecificProperties {
@@ -456,6 +478,11 @@ export namespace Manifest {
          */
         css?: ExtensionURL[];
 
+        /**
+         * Optional.
+         */
+        css_origin?: ExtensionTypes.CSSOrigin;
+
         /**
          * The list of JS files to inject
          * Optional.
@@ -1007,6 +1034,23 @@ export namespace Manifest {
         paths?: string[];
     }
 
+    interface FirefoxSpecificPropertiesDataCollectionPermissionsType {
+        /**
+         * Optional.
+         */
+        required?: DataCollectionPermission[];
+
+        /**
+         * Optional.
+         */
+        optional?: OptionalDataCollectionPermission[];
+
+        /**
+         * Optional.
+         */
+        has_previous_consent?: boolean;
+    }
+
     /**
      * Defines the location the browserAction will appear by default.  The default location is navbar.
      */
diff --git a/types/webextension-polyfill/namespaces/menus.d.ts b/types/webextension-polyfill/namespaces/menus.d.ts
@@ -27,10 +27,10 @@ export namespace Menus {
         | "audio"
         | "launcher"
         | "bookmark"
+        | "page_action"
         | "tab"
         | "tools_menu"
         | "browser_action"
-        | "page_action"
         | "action";
 
     /**
diff --git a/types/webextension-polyfill/namespaces/permissions.d.ts b/types/webextension-polyfill/namespaces/permissions.d.ts
@@ -19,6 +19,11 @@ export namespace Permissions {
          * Optional.
          */
         origins?: Manifest.MatchPattern[];
+
+        /**
+         * Optional.
+         */
+        data_collection?: Manifest.OptionalDataCollectionPermission[];
     }
 
     interface AnyPermissions {
@@ -31,6 +36,11 @@ export namespace Permissions {
          * Optional.
          */
         origins?: Manifest.MatchPattern[];
+
+        /**
+         * Optional.
+         */
+        data_collection?: Manifest.OptionalDataCollectionPermission[];
     }
 
     interface Static {
diff --git a/types/webextension-polyfill/namespaces/runtime.d.ts b/types/webextension-polyfill/namespaces/runtime.d.ts
@@ -193,7 +193,7 @@ export namespace Runtime {
     /**
      * The machine's processor architecture.
      */
-    type PlatformArch = "aarch64" | "arm" | "ppc64" | "s390x" | "sparc64" | "x86-32" | "x86-64" | "noarch";
+    type PlatformArch = "aarch64" | "arm" | "ppc64" | "riscv64" | "s390x" | "sparc64" | "x86-32" | "x86-64" | "noarch";
 
     /**
      * An object containing information about the current platform.
diff --git a/types/webextension-polyfill/namespaces/scripting.d.ts b/types/webextension-polyfill/namespaces/scripting.d.ts
@@ -216,6 +216,11 @@ export namespace Scripting {
          * Optional.
          */
         css?: Manifest.ExtensionURL[];
+
+        /**
+         * Optional.
+         */
+        cssOrigin?: ExtensionTypes.CSSOrigin;
     }
 
     /**
diff --git a/types/webextension-polyfill/namespaces/storage.d.ts b/types/webextension-polyfill/namespaces/storage.d.ts
@@ -33,52 +33,6 @@ export namespace Storage {
          */
         get(keys?: null | string | string[] | Record<string, unknown>): Promise<Record<string, unknown>>;
 
-        /**
-         * Sets multiple items.
-         *
-         * @param items <p>An object which gives each key/value pair to update storage with. Any other key/value pairs in storage
-         * will not be affected.</p><p>Primitive values such as numbers will serialize as expected. Values with a <code>
-         * typeof</code> <code>"object"</code> and <code>"function"</code> will typically serialize to <code>{}</code>,
-         * with the exception of <code>Array</code> (serializes as expected), <code>Date</code>, and <code>Regex</code>
-         * (serialize using their <code>String</code> representation).</p>
-         * @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
-         */
-        set(items: Record<string, unknown>): Promise<void>;
-
-        /**
-         * Removes one or more items from storage.
-         *
-         * @param keys A single key or a list of keys for items to remove.
-         * @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
-         */
-        remove(keys: string | string[]): Promise<void>;
-
-        /**
-         * Removes all items from storage.
-         *
-         * @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
-         */
-        clear(): Promise<void>;
-
-        /**
-         * Fired when one or more items change.
-         *
-         * @param changes Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item.
-         */
-        onChanged: Events.Event<(changes: StorageAreaOnChangedChangesType) => void>;
-    }
-
-    interface StorageAreaWithUsage {
-        /**
-         * Gets one or more items from storage.
-         *
-         * @param keys Optional. A single key to get, list of keys to get, or a dictionary specifying default values (see
-         * description of the object).  An empty list or object will return an empty result object.  Pass in <code>null</code>
-         * to get the entire contents of storage.
-         * @returns Callback with storage items, or on failure (in which case $(ref:runtime.lastError) will be set).
-         */
-        get(keys?: null | string | string[] | Record<string, unknown>): Promise<Record<string, unknown>>;
-
         /**
          * Gets the amount of space (in bytes) being used by one or more items.
          *
@@ -89,6 +43,14 @@ export namespace Storage {
          */
         getBytesInUse(keys?: null | string | string[]): Promise<number>;
 
+        /**
+         * Gets the keys of all items in storage.
+         *
+         * @returns Callback with the keys of all items in storage, or on failure (in which case $(ref:runtime.lastError)
+         * will be set).
+         */
+        getKeys(): Promise<string[]>;
+
         /**
          * Sets multiple items.
          *
@@ -121,7 +83,7 @@ export namespace Storage {
          *
          * @param changes Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item.
          */
-        onChanged: Events.Event<(changes: StorageAreaWithUsageOnChangedChangesType) => void>;
+        onChanged: Events.Event<(changes: StorageAreaOnChangedChangesType) => void>;
     }
 
     /**
@@ -131,13 +93,6 @@ export namespace Storage {
         [s: string]: StorageChange;
     }
 
-    /**
-     * Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item.
-     */
-    interface StorageAreaWithUsageOnChangedChangesType {
-        [s: string]: StorageChange;
-    }
-
     interface Static {
         /**
          * Fired when one or more items change.
@@ -151,7 +106,7 @@ export namespace Storage {
         /**
          * Items in the <code>sync</code> storage area are synced by the browser.
          */
-        sync: StorageAreaWithUsage;
+        sync: StorageArea;
 
         /**
          * Items in the <code>local</code> storage area are local to each machine.
@@ -168,6 +123,6 @@ export namespace Storage {
          * Items in the <code>session</code> storage area are kept in memory, and only until the either browser or extension is
          * closed or reloaded.
          */
-        session: StorageAreaWithUsage;
+        session: StorageArea;
     }
 }
diff --git a/types/webextension-polyfill/namespaces/tabGroups.d.ts b/types/webextension-polyfill/namespaces/tabGroups.d.ts
diff --git a/types/webextension-polyfill/namespaces/tabs.d.ts b/types/webextension-polyfill/namespaces/tabs.d.ts
diff --git a/types/webextension-polyfill/namespaces/webRequest.d.ts b/types/webextension-polyfill/namespaces/webRequest.d.ts
diff --git a/types/webextension-polyfill/package.json b/types/webextension-polyfill/package.json

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,11 @@ export namespace BrowserSettings {`
`115`	`115`	`*/`
`116`	`116`	`zoomSiteSpecific: Types.Setting;`
`117`	`117`
	`118`	`+ /**`
	`119`	`+ * This boolean setting controls whether vertical tabs are enabled.`
	`120`	`+ */`
	`121`	`+ verticalTabs: Types.Setting;`
	`122`	`+`
`118`	`123`	`colorManagement: BrowserSettingsColorManagement.Static;`
`119`	`124`	`}`
`120`	`125`	`}`