@wxt-dev/browser 0.0.331 → 0.1.0

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.0.331",
+  "version": "0.1.0",
   "type": "module",
   "main": "src/index.mjs",
   "types": "src/index.d.ts",
@@ -19,7 +19,7 @@
     "src"
   ],
   "devDependencies": {
-    "@types/chrome": "0.0.331",
+    "@types/chrome": "0.1.0",
     "fs-extra": "^11.3.0",
     "nano-spawn": "^0.2.0",
     "tsx": "4.19.4",

package/src/gen/index.d.ts

@@ -647,40 +647,6 @@ export namespace Browser {
         export const onMuteChanged: Browser.events.Event<(event: MuteChangedEvent) => void>;
     }
 
-    ////////////////////
-    // Browser
-    ////////////////////
-    /**
-     * Use the Browser.browser API to interact with the Chrome browser associated with
-     * the current application and Chrome profile.
-     * @deprecated Part of the deprecated Chrome Apps platform
-     */
-    export namespace browser {
-        export interface Options {
-            /** The URL to navigate to when the new tab is initially opened. */
-            url: string;
-        }
-
-        /**
-         * Opens a new tab in a browser window associated with the current application
-         * and Chrome profile. If no browser window for the Chrome profile is opened,
-         * a new one is opened prior to creating the new tab.
-         * @param options Configures how the tab should be opened.
-         * @param callback Called when the tab was successfully
-         * created, or failed to be created. If failed, runtime.lastError will be set.
-         */
-        export function openTab(options: Options, callback: () => void): void;
-
-        /**
-         * Opens a new tab in a browser window associated with the current application
-         * and Chrome profile. If no browser window for the Chrome profile is opened,
-         * a new one is opened prior to creating the new tab.
-         * @since Chrome 42
-         * @param options Configures how the tab should be opened.
-         */
-        export function openTab(options: Options): void;
-    }
-
     ////////////////////
     // Bookmarks
     ////////////////////
@@ -7180,55 +7146,6 @@ export namespace Browser {
         export var onEnabled: ManagementEnabledEvent;
     }
 
-    ////////////////////
-    // Networking
-    ////////////////////
-    /**
-     * Use the networking.config API to authenticate to captive portals.
-     * Permissions:  "networking.config"
-     * Important: This API works only on Chrome OS.
-     * @since Chrome 43
-     */
-    export namespace networking.config {
-        export interface NetworkInfo {
-            /** Currently only WiFi supported. */
-            Type: string;
-            /** Optional. A unique identifier of the network. */
-            GUID?: string | undefined;
-            /** Optional. A hex-encoded byte sequence. */
-            HexSSID?: string | undefined;
-            /** Optional. The decoded SSID of the network (default encoding is UTF-8). To filter for non-UTF-8 SSIDs, use HexSSID instead. */
-            SSID?: string | undefined;
-            /** Optional. The basic service set identification (BSSID) uniquely identifying the basic service set. BSSID is represented as a human readable, hex-encoded string with bytes separated by colons, e.g. 45:67:89:ab:cd:ef. */
-            BSSID?: string | undefined;
-            /** Optional. Identifier indicating the security type of the network. Valid values are None, WEP-PSK, WPA-PSK and WPA-EAP. */
-            Security?: string | undefined;
-        }
-
-        export interface CaptivePorttalDetectedEvent extends Browser.events.Event<(networkInfo: NetworkInfo) => void> {}
-
-        /**
-         * Allows an extension to define network filters for the networks it can handle. A call to this function will remove all filters previously installed by the extension before setting the new list.
-         * @param networks Network filters to set. Every NetworkInfo must either have the SSID or HexSSID set. Other fields will be ignored.
-         * @param callback Called back when this operation is finished.
-         */
-        export function setNetworkFilter(networks: NetworkInfo[], callback: () => void): void;
-        /**
-         * Called by the extension to notify the network config API that it finished a captive portal authentication attempt and hand over the result of the attempt. This function must only be called with the GUID of the latest onCaptivePortalDetected event.
-         * @param GUID Unique network identifier obtained from onCaptivePortalDetected.
-         * @param result The result of the authentication attempt.
-         * unhandled: The extension does not handle this network or captive portal (e.g. server end-point not found or not compatible).
-         * succeeded: The extension handled this network and authenticated successfully.
-         * rejected: The extension handled this network, tried to authenticate, however was rejected by the server.
-         * failed: The extension handled this network, tried to authenticate, however failed due to an unspecified error.
-         * @param callback Called back when this operation is finished.
-         */
-        export function finishAuthentication(GUID: string, result: string, callback?: () => void): void;
-
-        /** This event fires everytime a captive portal is detected on a network matching any of the currently registered network filters and the user consents to use the extension for authentication. Network filters may be set using the setNetworkFilter. Upon receiving this event the extension should start its authentication attempt with the captive portal. When the extension finishes its attempt, it must call finishAuthentication with the GUID received with this event and the appropriate authentication result. */
-        export var onCaptivePortalDetected: CaptivePorttalDetectedEvent;
-    }
-
     ////////////////////
     // Notifications
     ////////////////////
@@ -8666,274 +8583,6 @@ export namespace Browser {
         export function query(options: QueryInfo): Promise<void>;
     }
 
-    ////////////////////
-    // Serial
-    ////////////////////
-    /**
-     * Use the <code>Browser.serial</code> API to read from and write to a device connected to a serial port.
-     * Permissions:  "enterprise.serial"
-     * @since Chrome 29
-     * Important: This API works only on Chrome OS.
-     * @deprecated Part of the deprecated Chrome Apps platform
-     */
-    export namespace serial {
-        export const DataBits: {
-            SEVEN: "seven";
-            EIGHT: "eight";
-        };
-        export const ParityBit: {
-            NO: "no";
-            ODD: "odd";
-            EVEN: "even";
-        };
-        export const StopBits: {
-            ONE: "one";
-            TWO: "two";
-        };
-
-        export interface DeviceInfo {
-            /** The device's system path. This should be passed as the path argument to Browser.serial.connect in order to connect to this device. */
-            path: string;
-            /** Optional. A PCI or USB vendor ID if one can be determined for the underlying device. */
-            vendorId?: number | undefined;
-            /** Optional. A USB product ID if one can be determined for the underlying device. */
-            productId?: number | undefined;
-            /** Optional. A human-readable display name for the underlying device if one can be queried from the host driver. */
-            displayName?: number | undefined;
-        }
-
-        export interface ConnectionInfo {
-            /** The id of the serial port connection. */
-            connectionId?: number | undefined;
-            /** Flag indicating whether the connection is blocked from firing onReceive events. */
-            paused: boolean;
-            /** See ConnectionOptions.persistent */
-            persistent: boolean;
-            /** See ConnectionOptions.name */
-            name: string;
-            /** See ConnectionOptions.bufferSize */
-            bufferSize: number;
-            /** See ConnectionOptions.receiveTimeout */
-            receiveTimeout?: number | undefined;
-            /** See ConnectionOptions.sendTimeout */
-            sendTimeout?: number | undefined;
-            /** Optional. See ConnectionOptions.bitrate.
-             * This field may be omitted or inaccurate if a non-standard bitrate is in use, or if an error occurred while querying the underlying device. */
-            bitrate?: number | undefined;
-            /** Optional. See ConnectionOptions.dataBits. This field may be omitted if an error occurred while querying the underlying device. */
-            dataBits?: typeof DataBits[keyof typeof DataBits] | undefined;
-            /** Optional. See ConnectionOptions.parityBit. This field may be omitted if an error occurred while querying the underlying device. */
-            parityBit?: typeof ParityBit[keyof typeof ParityBit] | undefined;
-            /** Optional. See ConnectionOptions.stopBits. This field may be omitted if an error occurred while querying the underlying device. */
-            stopBits?: typeof StopBits[keyof typeof StopBits] | undefined;
-            /** Optional. Flag indicating whether or not to enable RTS/CTS hardware flow control. Defaults to false. */
-            ctsFlowControl?: boolean | undefined;
-        }
-
-        export interface ConnectionOptions {
-            /** Optional. Flag indicating whether or not the connection should be left open when the application is suspended (see Manage App Lifecycle: https://developer.chrome.com/apps/app_lifecycle).
-             *  The default value is "false." When the application is loaded, any serial connections previously opened with persistent=true can be fetched with getConnections. */
-            persistent?: boolean | undefined;
-            /** Optional. An application-defined string to associate with the connection. */
-            name?: string | undefined;
-            /** Optional. The size of the buffer used to receive data. The default value is 4096. */
-            bufferSize?: number | undefined;
-            /** Optional. The requested bitrate of the connection to be opened.
-             * For compatibility with the widest range of hardware, this number should match one of commonly-available bitrates,
-             * such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200.
-             * There is no guarantee, of course, that the device connected to the serial port will support the requested bitrate, even if the port itself supports that bitrate.
-             * 9600 will be passed by default. */
-            bitrate?: number | undefined;
-            /** Optional. "eight" will be passed by default. */
-            dataBits?: typeof DataBits[keyof typeof DataBits] | undefined;
-            /** Optional. "no" will be passed by default. */
-            parityBit?: typeof ParityBit[keyof typeof ParityBit] | undefined;
-            /** Optional. "one" will be passed by default. */
-            stopBits?: typeof StopBits[keyof typeof StopBits] | undefined;
-            /** Optional. Flag indicating whether or not to enable RTS/CTS hardware flow control. Defaults to false. */
-            ctsFlowControl?: boolean | undefined;
-            /** Optional. The maximum amount of time (in milliseconds) to wait for new data before raising an onReceiveError event with a "timeout" error.
-             * If zero, receive timeout errors will not be raised for the connection.
-             * Defaults to 0. */
-            receiveTimeout?: number | undefined;
-            /** Optional. The maximum amount of time (in milliseconds) to wait for a send operation to complete before calling the callback with a "timeout" error.
-             * If zero, send timeout errors will not be triggered.
-             * Defaults to 0. */
-            sendTimeout?: number | undefined;
-        }
-
-        /**
-         * @since Chrome 33
-         * @description Returns information about available serial devices on the system. The list is regenerated each time this method is called.
-         * @param callback Called with the list of DeviceInfo objects.
-         */
-        export function getDevices(callback: (ports: DeviceInfo[]) => void): void;
-
-        /**
-         * @since Chrome 33
-         * @description Connects to a given serial port.
-         * @param path The system path of the serial port to open.
-         * @param options Port configuration options.
-         * @param callback Called when the connection has been opened.
-         */
-        export function connect(
-            path: string,
-            options: ConnectionOptions,
-            callback: (connectionInfo: ConnectionInfo) => void,
-        ): void;
-
-        /**
-         * @since Chrome 33
-         * @description Update the option settings on an open serial port connection.
-         * @param connectionId The id of the opened connection.
-         * @param options Port configuration options.
-         * @param callback Called when the configuration has completed.
-         */
-        export function update(
-            connectionId: number,
-            options: ConnectionOptions,
-            callback: (result: boolean) => void,
-        ): void;
-
-        /**
-         * @since Chrome 33
-         * @description Disconnects from a serial port.
-         * @param connectionId The id of the opened connection.
-         * @param callback Called when the connection has been closed.
-         */
-        export function disconnect(connectionId: number, callback: (result: boolean) => void): void;
-
-        /**
-         * @since Chrome 33
-         * @description Pauses or unpauses an open connection.
-         * @param connectionId The id of the opened connection.
-         * @param paused Flag to indicate whether to pause or unpause.
-         * @param callback Called when the connection has been successfully paused or unpaused.
-         */
-        export function setPaused(connectionId: number, paused: boolean, callback: () => void): void;
-
-        /**
-         * @since Chrome 33
-         * @description Retrieves the state of a given connection.
-         * @param callback Called with connection state information when available.
-         */
-        export function getInfo(callback: (connectionInfos: ConnectionInfo[]) => void): void;
-
-        /**
-         * @since Chrome 33
-         * @description Retrieves the list of currently opened serial port connections owned by the application.
-         * @param callback Called with the list of connections when available.
-         */
-        export function getConnections(callback: (connectionInfos: ConnectionInfo[]) => void): void;
-
-        /**
-         * @since Chrome 33
-         * @description Writes data to the given connection.
-         * @param connectionId The id of the connection.
-         * @param data The data to send.
-         * @param callback Called when the operation has completed.
-         */
-        export function send(connectionId: number, data: ArrayBuffer, callback: (sendInfo: object) => void): void;
-
-        /**
-         * @description Flushes all bytes in the given connection's input and output buffers.
-         * @param connectionId The id of the connection.
-         * @param callback
-         */
-        export function flush(connectionId: number, callback: (result: boolean) => void): void;
-
-        /**
-         * @description Retrieves the state of control signals on a given connection.
-         * @param connectionId The id of the connection.
-         * @param callback Called when the control signals are available.
-         */
-        export function getControlSignals(connectionId: number, callback: (signals: object) => void): void;
-
-        /**
-         * @description Sets the state of control signals on a given connection.
-         * @param connectionId The id of the connection.
-         * @param signals The set of signal changes to send to the device:
-         * boolean:    (optional) dtr - DTR (Data Terminal Ready).
-         * boolean:    (optional) rts - RTS (Request To Send).
-         * @param callback Called once the control signals have been set.
-         */
-        export function setControlSignals(
-            connectionId: number,
-            signals: object,
-            callback: (result: boolean) => void,
-        ): void;
-
-        /**
-         * @since Chrome 45
-         * @description Suspends character transmission on a given connection and places the transmission line in a break state until the clearBreak is called.
-         * @param connectionId The id of the connection.
-         * @param callback
-         */
-        export function setBreak(connectionId: number, callback: (result: boolean) => void): void;
-
-        /**
-         * @since Chrome 45
-         * @description Restore character transmission on a given connection and place the transmission line in a nonbreak state.
-         * @param connectionId The id of the connection.
-         * @param callback
-         */
-        export function clearBreak(connectionId: number, callback: (result: boolean) => void): void;
-    }
-
-    export namespace serial.onReceive {
-        export interface OnReceiveInfo {
-            /** The connection identifier. */
-            connectionId: number;
-            /** The data received. */
-            data: ArrayBuffer;
-        }
-
-        /**
-         * @since Chrome 33
-         * @description Event raised when data has been read from the connection.
-         * @param callback
-         */
-        export function addListener(callback: (info: OnReceiveInfo) => void): void;
-    }
-
-    export namespace serial.onReceiveError {
-        export const OnReceiveErrorEnum: {
-            /* The connection was disconnected. */
-            disconnected: "disconnected";
-            /* No data has been received for receiveTimeout milliseconds. */
-            timeout: "timeout";
-            /* The device was most likely disconnected from the host. */
-            device_lost: "device_lost";
-            /* The device detected a break condition. */
-            break: "break";
-            /* The device detected a framing error. */
-            frame_error: "frame_error";
-            /* A character-buffer overrun has occurred. The next character is lost. */
-            overrun: "overrun";
-            /* An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character. */
-            buffer_overflow: "buffer_overflow";
-            /* The device detected a parity error. */
-            parity_error: "parity_error";
-            /* A system error occurred and the connection may be unrecoverable. */
-            system_error: "system_error";
-        };
-
-        export interface OnReceiveErrorInfo {
-            /** The connection identifier. */
-            connectionId: number;
-            /** The data received. */
-            error: ArrayBuffer;
-        }
-
-        /**
-         * @since Chrome 33
-         * @description Event raised when an error occurred while the runtime was waiting for data on the serial port.
-         * Once this event is raised, the connection may be set to paused. A "timeout" error does not pause the connection.
-         * @param callback
-         */
-        export function addListener(callback: (info: OnReceiveErrorInfo) => void): void;
-    }
-
     ////////////////////
     // Runtime
     ////////////////////
@@ -8941,11 +8590,13 @@ export namespace Browser {
      * Use the `Browser.runtime` API to retrieve the service worker, return details about the manifest, and listen for and respond to events in the extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs.
      */
     export namespace runtime {
-        /** Populated with an error message if calling an API function fails; otherwise undefined. This is only defined within the scope of that function's callback. If an error is produced, but `runtime.lastError` is not accessed within the callback, a message is logged to the console listing the API function that produced the error. API functions that return promises do not set this property. */
-        export const lastError: {
+        export interface LastError {
             /** Details about the error which occurred.  */
             message?: string;
-        } | undefined;
+        }
+
+        /** Populated with an error message if calling an API function fails; otherwise undefined. This is only defined within the scope of that function's callback. If an error is produced, but `runtime.lastError` is not accessed within the callback, a message is logged to the console listing the API function that produced the error. API functions that return promises do not set this property. */
+        export const lastError: LastError | undefined;
 
         /** The ID of the extension/app. */
         export const id: string;
@@ -9173,6 +8824,11 @@ export namespace Browser {
             name: string;
         }
 
+        export interface UpdateAvailableDetails {
+            /** The version number of the available update. */
+            version: string;
+        }
+
         export interface UpdateCheckDetails {
             /** The version of the available update. */
             version: string;
@@ -9652,7 +9308,7 @@ export namespace Browser {
          */
         export function requestUpdateCheck(): Promise<RequestUpdateCheckResult>;
         export function requestUpdateCheck(
-            callback: (status: `${RequestUpdateCheckStatus}`, details?: { version: string }) => void,
+            callback: (status: `${RequestUpdateCheckStatus}`, details?: UpdateCheckDetails) => void,
         ): void;
 
         /** Restart the ChromeOS device when the app runs in kiosk mode. Otherwise, it's no-op. */
@@ -9771,7 +9427,7 @@ export namespace Browser {
         export const onRestartRequired: events.Event<(reason: `${OnRestartRequiredReason}`) => void>;
 
         /** Fired when an update is available, but isn't installed immediately because the app is currently running. If you do nothing, the update will be installed the next time the background page gets unloaded, if you want it to be installed sooner you can explicitly call Browser.runtime.reload(). If your extension is using a persistent background page, the background page of course never gets unloaded, so unless you call Browser.runtime.reload() manually in response to this event the update will not get installed until the next time Chrome itself restarts. If no handlers are listening for this event, and your extension has a persistent background page, it behaves as if Browser.runtime.reload() is called in response to this event. */
-        export const onUpdateAvailable: events.Event<(details: { version: string }) => void>;
+        export const onUpdateAvailable: events.Event<(details: UpdateAvailableDetails) => void>;
 
         /**
          * Fired when a Chrome update is available, but isn't installed immediately because a browser restart is required.
@@ -10374,99 +10030,6 @@ export namespace Browser {
         export var onChanged: StorageChangedEvent;
     }
 
-    ////////////////////
-    // Socket
-    ////////////////////
-    /**
-     * @deprecated Part of the deprecated Chrome Apps platform
-     */
-    export namespace socket {
-        export interface CreateInfo {
-            socketId: number;
-        }
-
-        export interface AcceptInfo {
-            resultCode: number;
-            socketId?: number | undefined;
-        }
-
-        export interface ReadInfo {
-            resultCode: number;
-            data: ArrayBuffer;
-        }
-
-        export interface WriteInfo {
-            bytesWritten: number;
-        }
-
-        export interface RecvFromInfo {
-            resultCode: number;
-            data: ArrayBuffer;
-            port: number;
-            address: string;
-        }
-
-        export interface SocketInfo {
-            socketType: string;
-            localPort?: number | undefined;
-            peerAddress?: string | undefined;
-            peerPort?: number | undefined;
-            localAddress?: string | undefined;
-            connected: boolean;
-        }
-
-        export interface NetworkInterface {
-            name: string;
-            address: string;
-        }
-
-        export function create(
-            type: string,
-            options?: { [key: string]: unknown },
-            callback?: (createInfo: CreateInfo) => void,
-        ): void;
-        export function destroy(socketId: number): void;
-        export function connect(
-            socketId: number,
-            hostname: string,
-            port: number,
-            callback: (result: number) => void,
-        ): void;
-        export function bind(socketId: number, address: string, port: number, callback: (result: number) => void): void;
-        export function disconnect(socketId: number): void;
-        export function read(socketId: number, bufferSize?: number, callback?: (readInfo: ReadInfo) => void): void;
-        export function write(socketId: number, data: ArrayBuffer, callback?: (writeInfo: WriteInfo) => void): void;
-        export function recvFrom(
-            socketId: number,
-            bufferSize?: number,
-            callback?: (recvFromInfo: RecvFromInfo) => void,
-        ): void;
-        export function sendTo(
-            socketId: number,
-            data: ArrayBuffer,
-            address: string,
-            port: number,
-            callback?: (writeInfo: WriteInfo) => void,
-        ): void;
-        export function listen(
-            socketId: number,
-            address: string,
-            port: number,
-            backlog?: number,
-            callback?: (result: number) => void,
-        ): void;
-        export function accept(socketId: number, callback?: (acceptInfo: AcceptInfo) => void): void;
-        export function setKeepAlive(
-            socketId: number,
-            enable: boolean,
-            delay?: number,
-            callback?: (result: boolean) => void,
-        ): void;
-        export function setNoDelay(socketId: number, noDelay: boolean, callback?: (result: boolean) => void): void;
-        export function getInfo(socketId: number, callback: (result: SocketInfo) => void): void;
-        export function getNetworkList(callback: (result: NetworkInterface[]) => void): void;
-    }
-
     ////////////////////
     // System CPU
     ////////////////////