@wxt-dev/browser 0.1.37 → 0.1.39

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wxt-dev/browser",
   "description": "Provides a cross-browser API for using extension APIs and types based on @types/chrome",
-  "version": "0.1.37",
+  "version": "0.1.39",
   "type": "module",
   "main": "src/index.mjs",
   "types": "src/index.d.ts",
@@ -19,8 +19,8 @@
     "src"
   ],
   "devDependencies": {
-    "@types/chrome": "0.1.37",
-    "fs-extra": "^11.3.3",
+    "@types/chrome": "0.1.39",
+    "@types/node": "^20.0.0",
     "nano-spawn": "^2.0.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"

package/src/gen/index.d.ts

@@ -348,9 +348,10 @@ export namespace Browser {
         export function setIcon(details: TabIconDetails, callback: () => void): void;
 
         /**
-         * Sets the html document to be opened as a popup when the user clicks on the action's icon.
+         * Sets the HTML document to be opened as a popup when the user clicks on the action's icon.
          *
          * Can return its result via Promise.
+         * @since Chrome 96
          */
         export function setPopup(details: PopupDetails): Promise<void>;
         export function setPopup(details: PopupDetails, callback: () => void): void;
@@ -1167,6 +1168,7 @@ export namespace Browser {
          * Clears websites' cache storage data.
          *
          * Can return its result via Promise in Manifest V3 or later since Chrome 96.
+         * @since Chrome 72
          */
         export function removeCacheStorage(options: RemovalOptions): Promise<void>;
         export function removeCacheStorage(options: RemovalOptions, callback: () => void): void;
@@ -2435,7 +2437,17 @@ export namespace Browser {
          * Exactly one of `imageData` or `path` must be specified. Both are dictionaries mapping a number of pixels to an image representation. The image representation in `imageData` is an `ImageData` object; for example, from a `canvas` element, while the image representation in `path` is the path to an image file relative to the extension's manifest. If `scale` screen pixels fit into a device-independent pixel, the `scale * n` icon is used. If that scale is missing, another image is resized to the required size.
          */
         export class SetIcon {
-            constructor(options?: { imageData?: ImageData | { [size: string]: ImageData } | undefined });
+            constructor(
+                options:
+                    | {
+                        imageData: ImageData | { [index: number]: ImageData };
+                        path?: string | { [index: number]: string } | undefined;
+                    }
+                    | {
+                        imageData?: ImageData | { [index: number]: ImageData } | undefined;
+                        path: string | { [index: number]: string };
+                    },
+            );
         }
 
         /** Provides the Declarative Event API consisting of {@link events.Event.addRules addRules}, {@link events.Event.removeRules removeRules}, and {@link events.Event.getRules getRules}. */
@@ -3332,7 +3344,7 @@ export namespace Browser {
             /** Indicates the data type of the option. The requested data type must match the real data type of the underlying option. */
             type: `${OptionType}`;
             /** Indicates the value to set. Leave unset to request automatic setting for options that have `autoSettable` enabled. The data type supplied for `value` must match `type`. */
-            value?: string | number | boolean | number;
+            value?: string | number | boolean | number[];
         }
 
         /**
@@ -3562,6 +3574,8 @@ export namespace Browser {
         /**
          * Performs a document scan and returns a Promise that resolves with a {@link ScanResults} object. If a callback is passed to this function, the returned data is passed to it instead.
          * @param options An object containing scan parameters.
+         *
+         * Can return its result via Promise in Manifest V3 or later since Chrome 96.
          */
         export function scan(options: ScanOptions): Promise<ScanResults>;
         export function scan(options: ScanOptions, callback: (result: ScanResults) => void): void;
@@ -4076,14 +4090,17 @@ export namespace Browser {
             id: string;
             /**
              * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are hardware-backed.
-             * 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.
+             *
+             * Only non-extractable keys can be generated. The supported key types are RSASSA-PKCS1-V1_5 with `modulusLength` up to 2048 and ECDSA with `namedCurve` P-256. Each key can be used for signing data at most once, unless the extension is allowlisted by the KeyPermissions policy, in which case the key can be used indefinitely.
+             *
              * 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 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.
+             * 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 keys can be generated. The only supported key type is RSASSA-PKCS1-V1_5 with `modulusLength` up to 2048. up to 2048. Each 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.
+             *
              * 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
              */
@@ -4363,9 +4380,12 @@ export namespace Browser {
         }
 
         /**
-         * Retrieves the network details of the device's default network. If the user is not affiliated or the device is not connected to a network, runtime.lastError will be set with a failure reason.
+         * Retrieves the network details of the device's default network. If the user is not affiliated or the device is not connected to a network, {@link runtime.lastError} will be set with a failure reason.
          * @param callback Called with the device's default network's NetworkDetails.
+         *
+         * Can return its result via Promise in Manifest V3 or later since Chrome 96.
          */
+        export function getNetworkDetails(): Promise<NetworkDetails>;
         export function getNetworkDetails(callback: (networkDetails: NetworkDetails) => void): void;
     }
 
@@ -6307,7 +6327,7 @@ export namespace Browser {
          * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
          * @param details Profile options.
          *
-         * Can return its result via Promise since Chrome 105.
+         * Can return its result via Promise since Chrome 106.
          */
         export function getProfileUserInfo(details?: ProfileDetails): Promise<ProfileUserInfo>;
         export function getProfileUserInfo(
@@ -6322,7 +6342,7 @@ export namespace Browser {
          * If an access token is discovered to be invalid, it should be passed to removeCachedAuthToken to remove it from the cache. The app may then retrieve a fresh token with `getAuthToken`.
          * @param details Token information.
          *
-         * Can return its result via Promise since Chrome 105.
+         * Can return its result via Promise since Chrome 106.
          */
         export function removeCachedAuthToken(details: InvalidTokenDetails): Promise<void>;
         export function removeCachedAuthToken(details: InvalidTokenDetails, callback: () => void): void;
@@ -7910,7 +7930,7 @@ export namespace Browser {
 
         export enum ClientCertificateType {
             ECDSA_SIGN = "ecdsaSign",
-            RAS_SIGN = "rasSign",
+            RSA_SIGN = "rsaSign",
         }
 
         export interface SelectDetails {
@@ -8805,7 +8825,7 @@ export namespace Browser {
         export type QueryInfo =
             & {
                 /** String to query with the default search provider. */
-                text?: string | undefined;
+                text: string;
             }
             & (
                 | {
@@ -9692,7 +9712,7 @@ export namespace Browser {
         /** Sent after onSuspend to indicate that the app won't be unloaded after all. */
         export const onSuspendCanceled: events.Event<() => void>;
 
-        /** Fired when a message is sent from either an extension process (by {@link runtime.sendMessage}) or a content script (by {@link tabs.sendMessage}). */
+        /** Fired when a message is sent from either {@link runtime.sendMessage} or {@link tabs.sendMessage}. */
         export const onMessage: events.Event<
             (message: any, sender: MessageSender, sendResponse: (response?: any) => void) => void
         >;
@@ -11058,7 +11078,7 @@ export namespace Browser {
             sessionId?: string | undefined;
             /**
              * The ID of the Split View that the tab belongs to.
-             * @since Chrome 145
+             * @since Chrome 140
              */
             splitViewId?: number | undefined;
             /**
@@ -11134,7 +11154,7 @@ export namespace Browser {
 
         /**
          * An ID that represents the absence of a split tab.
-         * @since Chrome 145
+         * @since Chrome 140
          */
         export const SPLIT_VIEW_ID_NONE: -1;
 
@@ -11581,7 +11601,7 @@ export namespace Browser {
         export function duplicate(tabId: number, callback: (tab?: Tab) => void): void;
 
         /**
-         * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
+         * Sends a single message to the content script(s) in the specified tab. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
          *
          * Can return its result via Promise in Manifest V3 or later since Chrome 99.
          */
@@ -12141,7 +12161,7 @@ export namespace Browser {
          * Called when the list of {@link TtsVoice} that would be returned by getVoices has changed.
          * @since Chrome 124
          */
-        const onVoicesChanged: Browser.events.Event<() => void>;
+        export const onVoicesChanged: Browser.events.Event<() => void>;
     }
 
     ////////////////////
@@ -13093,7 +13113,7 @@ export namespace Browser {
             EXTRA_HEADERS = "extraHeaders",
         }
 
-        /** @since Chrome 44 */
+        /** @since Chrome 79 */
         export enum OnErrorOccurredOptions {
             /** Specifies that headers can violate Cross-Origin Resource Sharing (CORS). */
             EXTRA_HEADERS = "extraHeaders",
@@ -13285,14 +13305,14 @@ export namespace Browser {
             extends SetPartial<WebRequestDetails, "documentId" | "documentLifecycle" | "frameType">
         {
             /** Contains the HTTP request body data. Only provided if extraInfoSpec contains 'requestBody'. */
-            requestBody: {
+            requestBody?: {
                 /** Errors when obtaining request body data. */
                 error?: string;
                 /** If the request method is POST and the body is a sequence of key-value pairs encoded in UTF8, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. An example value of this dictionary is {'key': \['value1', 'value2'\]}. */
                 formData?: { [key: string]: FormDataItem[] };
                 /** If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in this array. */
                 raw?: UploadData[];
-            } | undefined;
+            };
         }
 
         export interface OnBeforeSendHeadersDetails extends WebRequestDetails {
@@ -14344,7 +14364,7 @@ export namespace Browser {
              * The headers provided by a hypothetical response if the request does not get blocked or redirected before it is sent. Represented as an object which maps a header name to a list of string values. If not specified, the hypothetical response would return empty response headers, which can match rules which match on the non-existence of headers. E.g. `{"content-type": ["text/html; charset=utf-8", "multipart/form-data"]}`
              * @since Chrome 129
              */
-            responseHeaders?: { [name: string]: unknown };
+            responseHeaders?: { [name: string]: string[] };
             /** The ID of the tab in which the hypothetical request takes place. Does not need to correspond to a real tab ID. Default is -1, meaning that the request isn't related to a tab. */
             tabId?: number;
             /**
@@ -14682,13 +14702,13 @@ export namespace Browser {
          * Fired when the extension's side panel is closed.
          * @since Chrome 142
          */
-        const onClosed: events.Event<(info: PanelClosedInfo) => void>;
+        export const onClosed: events.Event<(info: PanelClosedInfo) => void>;
 
         /**
          * Fired when the extension's side panel is opened.
          * @since Chrome 141
          */
-        const onOpened: events.Event<(info: PanelOpenedInfo) => void>;
+        export const onOpened: events.Event<(info: PanelOpenedInfo) => void>;
     }
 
     ////////////////////
@@ -14794,7 +14814,7 @@ export namespace Browser {
             /** Specifies wildcard patterns for pages this user script will be injected into. */
             includeGlobs?: string[] | undefined;
             /** 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[];
+            js?: ScriptSource[] | undefined;
             /** 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 {@link register}. */
             matches?: string[] | undefined;
             /** Specifies when JavaScript files are injected into the web page. The preferred and default value is `document_idle` */