@types/chrome 0.0.291 → 0.0.293

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: Wed, 08 Jan 2025 18:02:30 GMT
+ * Last updated: Thu, 09 Jan 2025 14:35:38 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

@@ -1980,25 +1980,7 @@ declare namespace chrome {
             visible?: boolean | undefined;
         }
 
-        export interface UpdateProperties {
-            documentUrlPatterns?: string[] | undefined;
-            checked?: boolean | undefined;
-            title?: string | undefined;
-            contexts?: ContextType[] | undefined;
-            /** Optional. @since Chrome 20  */
-            enabled?: boolean | undefined;
-            targetUrlPatterns?: string[] | undefined;
-            onclick?: Function | undefined;
-            /** Optional. Note: You cannot change an item to be a child of one of its own descendants.  */
-            parentId?: number | string;
-            type?: ContextItemType | undefined;
-            /**
-             * Optional.
-             * @since Chrome 62
-             * Whether the item is visible in the menu.
-             */
-            visible?: boolean | undefined;
-        }
+        export interface UpdateProperties extends Omit<CreateProperties, "id"> {}
 
         export interface MenuClickedEvent
             extends chrome.events.Event<(info: OnClickData, tab?: chrome.tabs.Tab) => void>
@@ -2010,30 +1992,48 @@ declare namespace chrome {
          */
         export var ACTION_MENU_TOP_LEVEL_LIMIT: number;
 
+        /**
+         * Removes all context menu items added by this extension.
+         * @since Chrome 123
+         */
+        export function removeAll(): Promise<void>;
         /**
          * Removes all context menu items added by this extension.
          * @param callback Called when removal is complete.
          */
-        export function removeAll(callback?: () => void): void;
+        export function removeAll(callback: () => void): void;
         /**
          * Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.runtime.lastError).
          * @param callback Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.runtime.lastError.
          * @return The ID of the newly created item.
          */
         export function create(createProperties: CreateProperties, callback?: () => void): number | string;
+        /**
+         * Updates a previously created context menu item.
+         * @param id The ID of the item to update.
+         * @param updateProperties The properties to update. Accepts the same values as the create function.
+         * @since Chrome 123
+         */
+        export function update(id: string | number, updateProperties: UpdateProperties): Promise<void>;
         /**
          * Updates a previously created context menu item.
          * @param id The ID of the item to update.
          * @param updateProperties The properties to update. Accepts the same values as the create function.
          * @param callback Called when the context menu has been updated.
          */
-        export function update(id: string | number, updateProperties: UpdateProperties, callback?: () => void): void;
+        export function update(id: string | number, updateProperties: UpdateProperties, callback: () => void): void;
+        /**
+         * Removes a context menu item.
+         * @param menuItemId The ID of the context menu item to remove.
+         * @since Chrome 123
+         */
+        export function remove(menuItemId: string | number): Promise<void>;
         /**
          * Removes a context menu item.
          * @param menuItemId The ID of the context menu item to remove.
          * @param callback Called when the context menu has been removed.
          */
-        export function remove(menuItemId: string | number, callback?: () => void): void;
+        export function remove(menuItemId: string | number, callback: () => void): void;
 
         /**
          * @since Chrome 21
@@ -3807,8 +3807,12 @@ declare namespace chrome {
             originAndPathMatches?: string | undefined;
         }
 
-        export interface BaseEvent<T extends Function> {
-            addListener(callback: T, filter?: webRequest.RequestFilter): void;
+        export interface Event<T extends Function> {
+            /**
+             * Registers an event listener callback to an event.
+             * @param callback Called when an event occurs. The parameters of this function depend on the type of event.
+             */
+            addListener(callback: T): void;
             /**
              * Returns currently registered rules.
              * @param callback Called with registered rules.
@@ -3866,18 +3870,6 @@ declare namespace chrome {
             hasListeners(): boolean;
         }
 
-        /** An object which allows the addition and removal of listeners for a Chrome event. */
-        interface Event<T extends Function> extends BaseEvent<T> {
-            /**
-             * Registers an event listener callback to an event.
-             * @param callback Called when an event occurs. The parameters of this function depend on the type of event.
-             */
-            addListener(callback: T): void;
-        }
-        export interface EventWithRequiredFilterInAddListener<T extends Function> extends BaseEvent<T> {
-            addListener(callback: T, filter: webRequest.RequestFilter): void;
-        }
-
         /** Description of a declarative rule for handling events. */
         export interface Rule {
             /** Optional. Optional priority of this rule. Defaults to 100.  */
@@ -12036,6 +12028,12 @@ declare namespace chrome {
      * @since Chrome 17
      */
     export namespace webRequest {
+        interface WebRequestEvent<T extends Function, U extends string[]>
+            extends Omit<chrome.events.Event<T>, "addListener">
+        {
+            addListener(callback: T, filter: RequestFilter, extraInfoSpec?: U): void;
+        }
+
         /** How the requested resource will be used. */
         export type ResourceType =
             | "main_frame"
@@ -12234,82 +12232,45 @@ declare namespace chrome {
             error: string;
         }
 
-        export interface WebRequestBodyEvent extends
-            chrome.events.EventWithRequiredFilterInAddListener<
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                (details: WebRequestBodyDetails) => BlockingResponse | void
-            >
-        {
-            addListener(
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                callback: (details: WebRequestBodyDetails) => BlockingResponse | void,
-                filter: RequestFilter,
-                opt_extraInfoSpec?: string[],
-            ): void;
-        }
+        export type WebRequestBodyEvent = WebRequestEvent<
+            // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+            (details: WebRequestBodyDetails) => BlockingResponse | void,
+            string[]
+        >;
 
-        export interface WebRequestHeadersSynchronousEvent extends
-            chrome.events.EventWithRequiredFilterInAddListener<
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                (details: WebRequestHeadersDetails) => BlockingResponse | void
-            >
-        {
-            addListener(
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                callback: (details: WebRequestHeadersDetails) => BlockingResponse | void,
-                filter: RequestFilter,
-                opt_extraInfoSpec?: string[],
-            ): void;
-        }
+        export type WebRequestHeadersSynchronousEvent = WebRequestEvent<
+            // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+            (details: WebRequestHeadersDetails) => BlockingResponse | void,
+            string[]
+        >;
 
-        export interface WebRequestHeadersEvent
-            extends chrome.events.EventWithRequiredFilterInAddListener<(details: WebRequestHeadersDetails) => void>
-        {
-            addListener(
-                callback: (details: WebRequestHeadersDetails) => void,
-                filter: RequestFilter,
-                opt_extraInfoSpec?: string[],
-            ): void;
-        }
+        export type WebRequestHeadersEvent = WebRequestEvent<
+            (details: WebRequestHeadersDetails) => void,
+            string[]
+        >;
 
-        export interface _WebResponseHeadersEvent<T extends WebResponseHeadersDetails>
-            extends chrome.events.EventWithRequiredFilterInAddListener<(details: T) => void>
-        {
-            addListener(callback: (details: T) => void, filter: RequestFilter, opt_extraInfoSpec?: string[]): void;
-        }
+        export type _WebResponseHeadersEvent<T extends WebResponseHeadersDetails> = WebRequestEvent<
+            (details: T) => void,
+            string[]
+        >;
 
-        export interface WebResponseHeadersEvent extends
-            chrome.events.EventWithRequiredFilterInAddListener<
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                (details: WebResponseHeadersDetails) => BlockingResponse | void
-            >
-        {
-            addListener(
-                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-                callback: (details: WebResponseHeadersDetails) => BlockingResponse | void,
-                filter: RequestFilter,
-                opt_extraInfoSpec?: string[],
-            ): void;
-        }
+        export type WebResponseHeadersEvent = WebRequestEvent<
+            // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+            (details: WebResponseHeadersDetails) => BlockingResponse | void,
+            string[]
+        >;
 
-        export interface WebResponseCacheEvent extends _WebResponseHeadersEvent<WebResponseCacheDetails> {}
+        export type WebResponseCacheEvent = _WebResponseHeadersEvent<WebResponseCacheDetails>;
 
-        export interface WebRedirectionResponseEvent extends _WebResponseHeadersEvent<WebRedirectionResponseDetails> {}
+        export type WebRedirectionResponseEvent = _WebResponseHeadersEvent<WebRedirectionResponseDetails>;
 
-        export interface WebAuthenticationChallengeEvent extends
-            chrome.events.EventWithRequiredFilterInAddListener<
-                (details: WebAuthenticationChallengeDetails, callback?: (response: BlockingResponse) => void) => void
-            >
-        {
-            addListener(
-                callback: (
-                    details: WebAuthenticationChallengeDetails,
-                    callback?: (response: BlockingResponse) => void,
-                ) => void,
-                filter: RequestFilter,
-                opt_extraInfoSpec?: string[],
-            ): void;
-        }
+        export type WebAuthenticationChallengeEvent = WebRequestEvent<
+            (
+                details: WebAuthenticationChallengeDetails,
+                callback?: (response: BlockingResponse) => void,
+            ) => void,
+            string[]
+        >;
 
         export interface WebResponseErrorEvent extends _WebResponseHeadersEvent<WebResponseErrorDetails> {}
 
@@ -12319,17 +12280,25 @@ declare namespace chrome {
          */
         export var MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES: number;
 
-        /** Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often. */
-        export function handlerBehaviorChanged(callback?: Function): void;
+        /**
+         * Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.
+         * Can return its result via Promise in Manifest V3 or later since Chrome 116.
+         */
+        export function handlerBehaviorChanged(): Promise<void>;
+        export function handlerBehaviorChanged(callback: Function): void;
 
         /** Fired when a request is about to occur. */
-        export var onBeforeRequest: WebRequestBodyEvent;
+        export const onBeforeRequest: WebRequestBodyEvent;
+
         /** 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. */
-        export var onBeforeSendHeaders: WebRequestHeadersSynchronousEvent;
+        export const onBeforeSendHeaders: WebRequestHeadersSynchronousEvent;
+
         /** Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired). */
-        export var onSendHeaders: WebRequestHeadersEvent;
+        export const onSendHeaders: WebRequestHeadersEvent;
+
         /** Fired when HTTP response headers of a request have been received. */
-        export var onHeadersReceived: WebResponseHeadersEvent;
+        export const onHeadersReceived: WebResponseHeadersEvent;
+
         /**
          * Fired when an authentication failure is received.
          * The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge.
@@ -12338,15 +12307,19 @@ declare namespace chrome {
          *
          * Requires the `webRequestAuthProvider` permission.
          */
-        export var onAuthRequired: WebAuthenticationChallengeEvent;
+        export const onAuthRequired: WebAuthenticationChallengeEvent;
+
         /** Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available. */
-        export var onResponseStarted: WebResponseCacheEvent;
+        export const onResponseStarted: WebResponseCacheEvent;
+
         /** Fired when a server-initiated redirect is about to occur. */
-        export var onBeforeRedirect: WebRedirectionResponseEvent;
+        export const onBeforeRedirect: WebRedirectionResponseEvent;
+
         /** Fired when a request is completed. */
-        export var onCompleted: WebResponseCacheEvent;
+        export const onCompleted: WebResponseCacheEvent;
+
         /** Fired when an error occurs. */
-        export var onErrorOccurred: WebResponseErrorEvent;
+        export const onErrorOccurred: WebResponseErrorEvent;
     }
 
     ////////////////////

chrome/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/chrome",
-    "version": "0.0.291",
+    "version": "0.0.293",
     "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": "dbf0463e5c551f12fa07437137f3aaf7830c2e455201602adbe89debf1dcf956",
+    "typesPublisherContentHash": "3562b0db015921b752bed042f4f84e49c863b177ba1695d426f93a479b4c3f62",
     "typeScriptVersion": "5.0"
 }