@wxt-dev/browser 0.1.43 → 0.2.2

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.43",
+  "version": "0.2.2",
   "type": "module",
   "main": "src/index.mjs",
   "types": "src/index.d.ts",
@@ -25,7 +25,7 @@
     "src"
   ],
   "devDependencies": {
-    "@types/chrome": "0.1.43",
+    "@types/chrome": "0.2.2",
     "@types/node": "^20.17.6",
     "nano-spawn": "^2.0.0",
     "typescript": "^6.0.3",

package/src/gen/index.d.ts

@@ -383,22 +383,53 @@ export namespace Browser {
      * Permissions: "alarms"
      */
     export namespace alarms {
-        interface AlarmCreateInfo {
-            /** Length of time in minutes after which the {@link onAlarm} event should fire.  */
-            delayInMinutes?: number | undefined;
-            /** If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once. */
-            periodInMinutes?: number | undefined;
-            /** Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`). */
-            when?: number | undefined;
-        }
+        type AlarmCreateInfo =
+            & {
+                /**
+                 * Whether the alarm should persist across sessions (browser restarts). In Chrome, this defaults to true to match historical behavior, but you should set this explicitly to maximize compatibility across browsers.
+                 * @since Chrome 150
+                 */
+                persistAcrossSessions?: boolean | undefined;
+            }
+            & (
+                | {
+                    /** Length of time in minutes after which the {@link onAlarm} event should fire.  */
+                    delayInMinutes: number;
+                    /** If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once. */
+                    periodInMinutes?: number | undefined;
+                    /** Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`). */
+                    when?: never | undefined;
+                }
+                | {
+                    /** Length of time in minutes after which the {@link onAlarm} event should fire.  */
+                    delayInMinutes?: number | undefined;
+                    /** If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once. */
+                    periodInMinutes: number;
+                    /** Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`). */
+                    when?: number | undefined;
+                }
+                | {
+                    /** Length of time in minutes after which the {@link onAlarm} event should fire.  */
+                    delayInMinutes?: never | undefined;
+                    /** If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once. */
+                    periodInMinutes?: number | undefined;
+                    /** Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`). */
+                    when: number;
+                }
+            );
 
         interface Alarm {
+            /** Name of this alarm. */
+            name: string;
             /** If not null, the alarm is a repeating alarm and will fire again in `periodInMinutes` minutes. */
             periodInMinutes?: number;
+            /**
+             * Whether the alarm should persist across sessions (browser restarts).
+             * @since Chrome 150
+             */
+            persistAcrossSessions: boolean;
             /** Time at which this alarm was scheduled to fire, in milliseconds past the epoch (e.g. `Date.now() + n`). For performance reasons, the alarm may have been delayed an arbitrary amount beyond this. */
             scheduledTime: number;
-            /** Name of this alarm. */
-            name: string;
         }
 
         /**
@@ -2250,7 +2281,7 @@ export namespace Browser {
      *
      * Permissions: "debugger"
      */
-    export namespace _debugger {
+    namespace _debugger {
         /** Debuggee identifier. Either tabId, extensionId or targetId must be specified */
         interface Debuggee {
             /** The id of the tab which you intend to debug. */
@@ -7606,7 +7637,7 @@ export namespace Browser {
          * Creates a new offscreen document for the extension.
          * @param parameters The parameters describing the offscreen document to create.
          *
-         * Can return its result via Promise in Manifest V3.
+         * Can return its result via Promise.
          */
         function createDocument(parameters: CreateParameters): Promise<void>;
         function createDocument(parameters: CreateParameters, callback: () => void): void;
@@ -7614,7 +7645,7 @@ export namespace Browser {
         /**
          * Closes the currently-open offscreen document for the extension.
          *
-         * Can return its result via Promise in Manifest V3.
+         * Can return its result via Promise.
          */
         function closeDocument(): Promise<void>;
         function closeDocument(callback: () => void): void;
@@ -7622,7 +7653,8 @@ export namespace Browser {
         /**
          * Determines whether the extension has an active document.
          *
-         * Can return its result via Promise in Manifest V3.
+         * Can return its result via Promise.
+         * @since Chrome 150
          */
         function hasDocument(): Promise<boolean>;
         function hasDocument(callback: (result: boolean) => void): void;
@@ -9184,6 +9216,7 @@ export namespace Browser {
             | "identity"
             | "identity.email"
             | "idle"
+            | "input"
             | "loginState"
             | "management"
             | "nativeMessaging"
@@ -9225,11 +9258,6 @@ export namespace Browser {
             | "webRequestBlocking"
             | "webRequestAuthProvider";
 
-        /**
-         * @deprecated Use `ManifestPermission` instead.
-         */
-        type ManifestPermissions = ManifestPermission;
-
         /** Source : https://developer.chrome.com/docs/extensions/reference/api/permissions */
         type ManifestOptionalPermission = Exclude<
             ManifestPermission,
@@ -9247,11 +9275,6 @@ export namespace Browser {
             | "webAuthenticationProxy"
         >;
 
-        /**
-         * @deprecated Use `ManifestOptionalPermission` instead.
-         */
-        type ManifestOptionalPermissions = ManifestOptionalPermission;
-
         interface SearchProvider {
             name?: string | undefined;
             keyword?: string | undefined;
@@ -10120,12 +10143,7 @@ export namespace Browser {
      * Permissions: "storage"
      */
     export namespace storage {
-        /** NoInfer for old TypeScript versions (Required TS 5.4+) */
-        type NoInferX<T> = T[][T extends any ? 0 : never];
-        // The next line prevents things without the export keyword from being automatically exported (like NoInferX)
-        export {};
-
-        export interface StorageArea {
+        interface StorageArea {
             /**
              * Gets the amount of space (in bytes) being used by one or more items.
              * @param keys A single key or list of keys to get the total usage for. An empty list will return 0. Pass in `null` to get the total usage of all of storage.
@@ -10172,11 +10190,11 @@ export namespace Browser {
              * Can return its result via Promise in Manifest V3 or later since Chrome 95.
              */
             get<T = { [key: string]: unknown }>(
-                keys?: NoInferX<keyof T> | Array<NoInferX<keyof T>> | Partial<NoInferX<T>> | null,
+                keys?: NoInfer<keyof T> | Array<NoInfer<keyof T>> | Partial<NoInfer<T>> | null | undefined,
             ): Promise<T>;
             get<T = { [key: string]: unknown }>(callback: (items: T) => void): void;
             get<T = { [key: string]: unknown }>(
-                keys: NoInferX<keyof T> | Array<NoInferX<keyof T>> | Partial<NoInferX<T>> | null | undefined,
+                keys: NoInfer<keyof T> | Array<NoInfer<keyof T>> | Partial<NoInfer<T>> | null | undefined,
                 callback: (items: T) => void,
             ): void;
 
@@ -10203,19 +10221,19 @@ export namespace Browser {
             getKeys(callback: (keys: string[]) => void): void;
         }
 
-        export interface StorageChange {
+        interface StorageChange {
             /** The new value of the item, if there is a new value. */
             newValue?: unknown;
             /** The old value of the item, if there was an old value. */
             oldValue?: unknown;
         }
 
-        export interface LocalStorageArea extends StorageArea {
+        interface LocalStorageArea extends StorageArea {
             /** The maximum amount (in bytes) of data that can be stored in local storage, as measured by the JSON stringification of every value plus every key's length. This value will be ignored if the extension has the unlimitedStorage permission. Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError when using a callback, or a rejected Promise if using async/await. */
             QUOTA_BYTES: 10485760;
         }
 
-        export interface SyncStorageArea extends StorageArea {
+        interface SyncStorageArea extends StorageArea {
             /** @deprecated The storage.sync API no longer has a sustained write operation quota. */
             MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE: 1000000;
             /** The maximum total amount (in bytes) of data that can be stored in sync storage, as measured by the JSON stringification of every value plus every key's length. Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError when using a callback, or when a Promise is rejected. */
@@ -10238,18 +10256,18 @@ export namespace Browser {
             MAX_WRITE_OPERATIONS_PER_MINUTE: 120;
         }
 
-        export interface SessionStorageArea extends StorageArea {
+        interface SessionStorageArea extends StorageArea {
             /** The maximum amount (in bytes) of data that can be stored in memory, as measured by estimating the dynamically allocated memory usage of every value and key. Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError when using a callback, or when a Promise is rejected. */
             QUOTA_BYTES: 10485760;
         }
 
-        export type AreaName = "sync" | "local" | "managed" | "session";
+        type AreaName = "sync" | "local" | "managed" | "session";
 
         /**
          * The storage area's access level.
          * @since Chrome 102
          */
-        export enum AccessLevel {
+        enum AccessLevel {
             /** Specifies contexts originating from the extension itself. */
             TRUSTED_CONTEXTS = "TRUSTED_CONTEXTS",
             /** Specifies contexts originating from outside the extension. */
@@ -10257,13 +10275,13 @@ export namespace Browser {
         }
 
         /** Items in the `local` storage area are local to each machine. */
-        export const local: LocalStorageArea;
+        const local: LocalStorageArea;
 
         /** Items in the `sync` storage area are synced using Chrome Sync. */
-        export const sync: SyncStorageArea;
+        const sync: SyncStorageArea;
 
         /** Items in the `managed` storage area are set by an enterprise policy configured by the domain administrator, and are read-only for the extension; trying to modify this namespace results in an error. For information on configuring a policy, see Manifest for storage areas. */
-        export const managed: StorageArea;
+        const managed: StorageArea;
 
         /**
          * Items in the `session` storage area are stored in-memory and will not be persisted to disk.
@@ -10271,10 +10289,10 @@ export namespace Browser {
          * MV3 only
          * @since Chrome 102
          */
-        export const session: SessionStorageArea;
+        const session: SessionStorageArea;
 
         /** Fired when one or more items change. */
-        export const onChanged: events.Event<(changes: { [key: string]: StorageChange }, areaName: AreaName) => void>;
+        const onChanged: events.Event<(changes: { [key: string]: StorageChange }, areaName: AreaName) => void>;
     }
 
     ////////////////////
@@ -10297,10 +10315,6 @@ export namespace Browser {
             total: number;
         }
 
-        /** @deprecated Use {@link CpuTime} instead. */
-        // eslint-disable-next-line @typescript-eslint/no-empty-interface
-        interface ProcessorUsage extends CpuTime {}
-
         interface ProcessorInfo {
             /** Cumulative usage info for this logical processor. */
             usage: CpuTime;
@@ -12533,10 +12547,6 @@ export namespace Browser {
             reconnect?: string | undefined;
         }
 
-        /** @deprecated Use {@link Parameters} instead */
-        // eslint-disable-next-line @typescript-eslint/no-empty-interface
-        interface VpnSessionParameters extends Parameters {}
-
         /** The enum is used by the platform to notify the client of the VPN session status. */
         enum PlatformMessage {
             /** Indicates that the VPN configuration connected. */
@@ -13441,7 +13451,6 @@ export namespace Browser {
 
         /** Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. */
         const onBeforeSendHeaders: WebRequestEvent<
-            // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
             (details: OnBeforeSendHeadersDetails) => BlockingResponse | undefined,
             `${OnBeforeSendHeadersOptions}`[]
         >;