@types/chrome 0.0.289 → 0.0.291

chrome/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for chrome (http://developer.chrome.com/e
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome.
 
 ### Additional Details
- * Last updated: Thu, 02 Jan 2025 21:02:18 GMT
+ * Last updated: Wed, 08 Jan 2025 18:02:30 GMT
  * Dependencies: [@types/filesystem](https://npmjs.com/package/@types/filesystem), [@types/har-format](https://npmjs.com/package/@types/har-format)
 
 # Credits

chrome/index.d.ts

@@ -14,60 +14,125 @@ declare namespace chrome {
     // Accessibility Features
     ////////////////////
     /**
-     * Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request accessibilityFeatures.read permission. For modifying feature state, the extension needs accessibilityFeatures.modify permission. Note that accessibilityFeatures.modify does not imply accessibilityFeatures.read permission.
-     * @since Chrome 37
-     * Permissions: "accessibilityFeatures.read"
-     * Important: This API works only on Chrome OS.
+     * Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request `accessibilityFeatures.read` permission. For modifying feature state, the extension needs `accessibilityFeatures.modify` permission. Note that `accessibilityFeatures.modify` does not imply `accessibilityFeatures.read` permission.
+     * Permissions: "accessibilityFeatures.read", "accessibilityFeatures.modify"
      */
     export namespace accessibilityFeatures {
-        /** **ChromeOS only.** Spoken feedback (text-to-speech). */
-        export var spokenFeedback: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** Enlarged cursor. */
-        export var largeCursor: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** Sticky modifier keys (like shift or alt). */
-        export var stickyKeys: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** High contrast rendering mode. */
-        export var highContrast: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** Full screen magnification. */
-        export var screenMagnifier: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** Auto mouse click after mouse stops moving. */
-        export var autoclick: chrome.types.ChromeSetting<boolean>;
-        /** **ChromeOS only.** Virtual on-screen keyboard. */
-        export var virtualKeyboard: chrome.types.ChromeSetting<boolean>;
-        /**
-         * **ChromeOS only.**
-         * Caret highlighting.
+        /** `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission. */
+        export const animationPolicy: chrome.types.ChromeSetting<"allowed" | "once" | "none">;
+
+        /**
+         * Auto mouse click after mouse stops moving. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const autoclick: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Caret highlighting. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          * @since Chrome 51
          */
-        export var caretHighlight: chrome.types.ChromeSetting<boolean>;
+        export const caretHighlight: chrome.types.ChromeSetting<boolean>;
+
         /**
-         * **ChromeOS only.**
-         * Cursor highlighting.
+         * Cursor color. The value indicates whether the feature is enabled or not, doesn't indicate the color of it.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         * @since Chrome 85
+         */
+        export const cursorColor: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Cursor highlighting. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          * @since Chrome 51
          */
-        export var cursorHighlight: chrome.types.ChromeSetting<boolean>;
+        export const cursorHighlight: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Dictation. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         * @since Chrome 90
+         */
+        export const dictation: chrome.types.ChromeSetting<boolean>;
+
         /**
-         * **ChromeOS only.**
-         * Focus highlighting.
+         * Docked magnifier. The value indicates whether docked magnifier feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         * @since Chrome 87
+         */
+        export const dockedMagnifier: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Focus highlighting. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          * @since Chrome 51
          */
-        export var focusHighlight: chrome.types.ChromeSetting<boolean>;
+        export const focusHighlight: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * High contrast rendering mode. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const highContrast: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Enlarged cursor. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const largeCursor: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Full screen magnification. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const screenMagnifier: chrome.types.ChromeSetting<boolean>;
+
         /**
-         * **ChromeOS only.**
-         * Select-to-speak.
+         * Select-to-speak. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          * @since Chrome 51
          */
-        export var selectToSpeak: chrome.types.ChromeSetting<boolean>;
+        export const selectToSpeak: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Spoken feedback (text-to-speech). The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const spokenFeedback: chrome.types.ChromeSetting<boolean>;
+
+        /**
+         * Sticky modifier keys (like shift or alt). The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
+         */
+        export const stickyKeys: chrome.types.ChromeSetting<boolean>;
+
         /**
-         * **ChromeOS only.**
-         * Switch Access.
+         * Switch Access. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          * @since Chrome 51
          */
-        export var switchAccess: chrome.types.ChromeSetting<boolean>;
+        export const switchAccess: chrome.types.ChromeSetting<boolean>;
+
         /**
-         * @since Chrome 42
+         * Virtual on-screen keyboard. The value indicates whether the feature is enabled or not.
+         * `get()` requires `accessibilityFeatures.read` permission. `set()` and `clear()` require `accessibilityFeatures.modify` permission.
+         * @platform ChromeOS only
          */
-        export var animationPolicy: chrome.types.ChromeSetting<"allowed" | "once" | "none">;
+        export const virtualKeyboard: chrome.types.ChromeSetting<boolean>;
     }
 
     ////////////////////
@@ -112,8 +177,6 @@ declare namespace chrome {
             popup: string;
         }
 
-        export interface BrowserClickedEvent extends chrome.events.Event<(tab: chrome.tabs.Tab) => void> {}
-
         export interface TabIconDetails {
             /** Optional. Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'  */
             path?: string | { [index: number]: string } | undefined;
@@ -133,11 +196,21 @@ declare namespace chrome {
             tabId?: number | undefined;
         }
 
+        /**
+         * The collection of user-specified settings relating to an extension's action.
+         * @since Chrome 91
+         */
         export interface UserSettings {
             /** 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). */
             isOnToolbar: boolean;
         }
 
+        /** @since Chrome 130 */
+        export interface UserSettingsChange {
+            /** 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). */
+            isOnToolbar?: boolean;
+        }
+
         /**
          * @since Chrome 88
          * Disables the action for a tab.
@@ -358,7 +431,13 @@ declare namespace chrome {
         export function setTitle(details: TitleDetails, callback: () => void): void;
 
         /** Fired when an action icon is clicked. This event will not fire if the action has a popup. */
-        export var onClicked: BrowserClickedEvent;
+        export const onClicked: chrome.events.Event<(tab: chrome.tabs.Tab) => void>;
+
+        /**
+         * Fired when user-specified settings relating to an extension's action change.
+         * @since Chrome 130
+         */
+        export const onUserSettingsChanged: chrome.events.Event<(change: UserSettingsChange) => void>;
     }
 
     ////////////////////
@@ -3408,15 +3487,15 @@ declare namespace chrome {
             id: string;
             /**
              * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are hardware-backed.
-             * Only non-extractable RSASSA-PKCS1-V1_5 keys with modulusLength up to 2048 and ECDSA with namedCurve P-256 can be generated. Each key can be used for signing data at most once.
-             * Keys generated on a specific Token cannot be used with any other Tokens, nor can they be used with window.crypto.subtle. Equally, Key objects created with window.crypto.subtle cannot be used with this interface.
+             * Only non-extractable keys can be generated. The supported key types are RSASSA-PKCS1-V1_5 and RSA-OAEP (on Chrome versions 134+) with `modulusLength` up to 2048 and ECDSA with `namedCurve` P-256. Each RSASSA-PKCS1-V1_5 and ECDSA key can be used for signing data at most once, unless the extension is allowlisted through the KeyPermissions policy, in which case the key can be used indefinitely. RSA-OAEP keys are supported since Chrome version 134 and can be used by extensions allowlisted through that same policy to unwrap other keys.
+             * Keys generated on a specific `Token` cannot be used with any other Tokens, nor can they be used with `window.crypto.subtle`. Equally, `Key` objects created with `window.crypto.subtle` cannot be used with this interface.
              */
             subtleCrypto: SubtleCrypto;
             /**
              * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are software-backed.
              * Protection of the keys, and thus implementation of the non-extractable property, is done in software, so the keys are less protected than hardware-backed keys.
-             * Only non-extractable RSASSA-PKCS1-V1_5 keys with modulusLength up to 2048 can be generated. Each key can be used for signing data at most once.
-             * Keys generated on a specific Token cannot be used with any other Tokens, nor can they be used with window.crypto.subtle. Equally, Key objects created with window.crypto.subtle cannot be used with this interface.
+             * Only non-extractable keys can be generated. The supported key types are RSASSA-PKCS1-V1_5 and RSA-OAEP (on Chrome versions 134+) with `modulusLength` up to 2048. Each RSASSA-PKCS1-V1_5 key can be used for signing data at most once, unless the extension is allowlisted through the KeyPermissions policy, in which case the key can be used indefinitely. RSA-OAEP keys are supported since Chrome version 134 and can be used by extensions allowlisted through that same policy to unwrap other keys.
+             * Keys generated on a specific `Token` cannot be used with any other Tokens, nor can they be used with `window.crypto.subtle`. Equally, `Key` objects created with `window.crypto.subtle` cannot be used with this interface.
              * @since Chrome 97
              */
             softwareBackedSubtleCrypto: SubtleCrypto;
@@ -8266,7 +8345,7 @@ declare namespace chrome {
         export function connectNative(application: string): Port;
         /**
          * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
-         * @since MV3
+         * @deprecated Background pages do not exist in MV3 extensions.
          */
         export function getBackgroundPage(): Promise<Window>;
         /** Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set. */
@@ -12718,37 +12797,74 @@ declare namespace chrome {
 
     export namespace declarativeNetRequest {
         /** Ruleset ID for the dynamic rules added by the extension. */
-        export const DYNAMIC_RULESET_ID: string;
+        export const DYNAMIC_RULESET_ID: "_dynamic";
 
-        /** Time interval within which MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules calls can be made, specified in minutes.
-         * Additional calls will fail immediately and set runtime.lastError.
-         * Note: getMatchedRules calls associated with a user gesture are exempt from the quota.
+        /**
+         * Time interval within which `MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules` calls can be made, specified in minutes.
+         * Additional calls will fail immediately and set {@link runtime.lastError}.
+         * Note: `getMatchedRules` calls associated with a user gesture are exempt from the quota.
          */
-        export const GETMATCHEDRULES_QUOTA_INTERVAL: number;
+        export const GETMATCHEDRULES_QUOTA_INTERVAL: 10;
 
-        /** The minimum number of static rules guaranteed to an extension across its enabled static rulesets.
+        /**
+         * The minimum number of static rules guaranteed to an extension across its enabled static rulesets.
          * Any rules above this limit will count towards the global rule limit.
+         * @since Chrome 89
          */
-        export const GUARANTEED_MINIMUM_STATIC_RULES: number;
+        export const GUARANTEED_MINIMUM_STATIC_RULES: 30000;
+
+        /** The number of times `getMatchedRules` can be called within a period of `GETMATCHEDRULES_QUOTA_INTERVAL`. */
+        export const MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL: 20;
 
-        /** The number of times getMatchedRules can be called within a period of GETMATCHEDRULES_QUOTA_INTERVAL. */
-        export const MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL: number;
+        /** The maximum number of dynamic rules that an extension can add. */
+        export const MAX_NUMBER_OF_DYNAMIC_RULES: 30000;
+
+        /**
+         * The maximum number of static `Rulesets` an extension can enable at any one time.
+         * @since Chrome 94
+         */
+        export const MAX_NUMBER_OF_ENABLED_STATIC_RULESETS: 50;
 
         /** The maximum number of combined dynamic and session scoped rules an extension can add. */
-        export const MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES: number;
+        export const MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES: 5000;
 
-        /** The maximum number of regular expression rules that an extension can add.
+        /**
+         * The maximum number of regular expression rules that an extension can add.
          * This limit is evaluated separately for the set of dynamic rules and those specified in the rule resources file.
          */
-        export const MAX_NUMBER_OF_REGEX_RULES: number;
+        export const MAX_NUMBER_OF_REGEX_RULES: 1000;
+
+        /**
+         * The maximum number of session scoped rules that an extension can add.
+         * @since Chrome 120
+         */
+        export const MAX_NUMBER_OF_SESSION_RULES: 5000;
+
+        /** The maximum number of static `Rulesets` an extension can specify as part of the `"rule_resources"` manifest key. */
+        export const MAX_NUMBER_OF_STATIC_RULESETS: 100;
+
+        /**
+         * The maximum number of "unsafe" dynamic rules that an extension can add.
+         * @since Chrome 120
+         */
+        export const MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES: 5000;
 
-        /** The maximum number of static Rulesets an extension can specify as part of the "rule_resources" manifest key. */
-        export const MAX_NUMBER_OF_STATIC_RULESETS: number;
+        /**
+         * The maximum number of "unsafe" session scoped rules that an extension can add.
+         * @since Chrome 120
+         */
+        export const MAX_NUMBER_OF_UNSAFE_SESSION_RULES: 5000;
 
-        /** Ruleset ID for the session-scoped rules added by the extension. */
-        export const SESSION_RULESET_ID: string;
+        /**
+         * Ruleset ID for the session-scoped rules added by the extension.
+         * @since Chrome 90
+         */
+        export const SESSION_RULESET_ID: "_session";
 
-        /** This describes the HTTP request method of a network request.  */
+        /**
+         * This describes the HTTP request method of a network request.
+         * @since Chrome 91
+         */
         export enum RequestMethod {
             CONNECT = "connect",
             DELETE = "delete",
@@ -12758,6 +12874,7 @@ declare namespace chrome {
             PATCH = "patch",
             POST = "post",
             PUT = "put",
+            OTHER = "other",
         }
 
         /** This describes the resource type of the network request. */
@@ -12774,37 +12891,59 @@ declare namespace chrome {
             CSP_REPORT = "csp_report",
             MEDIA = "media",
             WEBSOCKET = "websocket",
+            WEBTRANSPORT = "webtransport",
+            WEBBUNDLE = "webbundle",
             OTHER = "other",
         }
 
         /** Describes the kind of action to take if a given RuleCondition matches. */
         export enum RuleActionType {
+            /** Block the network request. */
             BLOCK = "block",
+            /** Redirect the network request. */
             REDIRECT = "redirect",
+            /** Allow the network request. The request won't be intercepted if there is an allow rule which matches it. */
             ALLOW = "allow",
+            /** Upgrade the network request url's scheme to https if the request is http or ftp. */
             UPGRADE_SCHEME = "upgradeScheme",
+            /** Modify request/response headers from the network request. */
             MODIFY_HEADERS = "modifyHeaders",
+            /** Allow all requests within a frame hierarchy, including the frame request itself. */
             ALLOW_ALL_REQUESTS = "allowAllRequests",
         }
 
-        /** Describes the reason why a given regular expression isn't supported. */
+        /**
+         * Describes the reason why a given regular expression isn't supported.
+         * @since Chrome 87
+         */
         export enum UnsupportedRegexReason {
+            /** The regular expression is syntactically incorrect, or uses features not available in the RE2 syntax. */
             SYNTAX_ERROR = "syntaxError",
+            /** The regular expression exceeds the memory limit. */
             MEMORY_LIMIT_EXCEEDED = "memoryLimitExceeded",
         }
 
-        /** TThis describes whether the request is first or third party to the frame in which it originated.
+        /**
+         * This describes whether the request is first or third party to the frame in which it originated.
          * A request is said to be first party if it has the same domain (eTLD+1) as the frame in which the request originated.
          */
         export enum DomainType {
+            /** The network request is first party to the frame in which it originated. */
             FIRST_PARTY = "firstParty",
+            /* The network request is third party to the frame in which it originated. */
             THIRD_PARTY = "thirdParty",
         }
 
-        /** This describes the possible operations for a "modifyHeaders" rule. */
+        /**
+         * This describes the possible operations for a "modifyHeaders" rule.
+         * @since Chrome 86
+         */
         export enum HeaderOperation {
+            /** Adds a new entry for the specified header. This operation is not supported for request headers. */
             APPEND = "append",
+            /** Sets a new value for the specified header, removing any existing headers with the same name. */
             SET = "set",
+            /** Removes all entries for the specified header. */
             REMOVE = "remove",
         }
 
@@ -13673,7 +13812,7 @@ declare namespace chrome {
             id: string;
             /** Specifies wildcard patterns for pages this user script will be injected into. */
             includeGlobs?: string[];
-            /** The list of ScriptSource objects defining sources of scripts to be injected into matching pages. */
+            /** The list of ScriptSource objects defining sources of scripts to be injected into matching pages. This property must be specified for {@link register}, and when specified it must be a non-empty array.*/
             js: ScriptSource[];
             /** Specifies which pages this user script will be injected into. See Match Patterns for more details on the syntax of these strings. This property must be specified for ${ref:register}. */
             matches?: string[];

chrome/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/chrome",
-    "version": "0.0.289",
+    "version": "0.0.291",
     "description": "TypeScript definitions for chrome",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome",
     "license": "MIT",
@@ -94,6 +94,6 @@
         "@types/har-format": "*"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "56c695cd33a0165d7b0484e89eba4947466c5b5bdc9baa278b1a67707371ab20",
+    "typesPublisherContentHash": "dbf0463e5c551f12fa07437137f3aaf7830c2e455201602adbe89debf1dcf956",
     "typeScriptVersion": "5.0"
 }