chrome-types 0.1.258 → 0.1.260

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sat Feb 03 2024 22:29:01 GMT+0000 (Coordinated Universal Time)
-// Built at edbee24a2e062db732d90e5b23858cbc1a4a8ebf
+// Generated on Tue Feb 06 2024 22:28:50 GMT+0000 (Coordinated Universal Time)
+// Built at f1c1b2fcda4cbf2e21dd3d1d4234eeedae74cb9a
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -213,7 +213,7 @@ declare namespace chrome {
     export interface OpenPopupOptions {
 
       /**
-       * The id of the window to open the action popup in. Defaults to the currently-active window if unspecified.
+       * The ID of the window to open the action popup in. Defaults to the currently-active window if unspecified.
        */
       windowId?: number;
     }
@@ -588,7 +588,7 @@ declare namespace chrome {
     /**
      * Enables the action for a tab. By default, actions are enabled.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function enable(
 
@@ -598,7 +598,7 @@ declare namespace chrome {
     /**
      * Enables the action for a tab. By default, actions are enabled.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function enable(
 
@@ -610,7 +610,7 @@ declare namespace chrome {
     /**
      * Disables the action for a tab.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function disable(
 
@@ -620,7 +620,7 @@ declare namespace chrome {
     /**
      * Disables the action for a tab.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function disable(
 
@@ -632,7 +632,7 @@ declare namespace chrome {
     /**
      * Indicates whether the extension action is enabled for a tab (or globally if no `tabId` is provided). Actions enabled using only {@link declarativeContent} always return false.
      *
-     * @param tabId The id of the tab for which you want check enabled status.
+     * @param tabId The ID of the tab for which you want check enabled status.
      * @since Chrome 110
      */
     export function isEnabled(
@@ -643,7 +643,7 @@ declare namespace chrome {
     /**
      * Indicates whether the extension action is enabled for a tab (or globally if no `tabId` is provided). Actions enabled using only {@link declarativeContent} always return false.
      *
-     * @param tabId The id of the tab for which you want check enabled status.
+     * @param tabId The ID of the tab for which you want check enabled status.
      * @since Chrome 110
      */
     export function isEnabled(
@@ -6597,6 +6597,75 @@ declare namespace chrome {
       checked?: boolean;
     }
 
+    /**
+     * Properties of the new context menu item.
+     *
+     * @since Pending
+     */
+    export interface CreateProperties {
+
+      /**
+       * The type of menu item. Defaults to `normal`.
+       */
+      type?: ItemType;
+
+      /**
+       * The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
+       */
+      id?: string;
+
+      /**
+       * The text to display in the item; this is _required_ unless `type` is `separator`. When the context is `selection`, use `%s` within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".
+       */
+      title?: string;
+
+      /**
+       * The initial state of a checkbox or radio button: `true` for selected, `false` for unselected. Only one radio button can be selected at a time in a given group.
+       */
+      checked?: boolean;
+
+      /**
+       * List of contexts this menu item will appear in. Defaults to `['page']`.
+       */
+      contexts?: [ContextType, ...ContextType[]];
+
+      /**
+       * Whether the item is visible in the menu.
+       */
+      visible?: boolean;
+
+      /**
+       * A function that is called back when the menu item is clicked. This is not available inside of a service worker; instead, they should register a listener for {@link contextMenus.onClicked}.
+       *
+       * @param info Information about the item clicked and the context where the click happened.
+       * @param tab The details of the tab where the click took place. This parameter is not present for platform apps.
+       */
+      onclick?: (
+        info: OnClickData,
+        tab: tabs.Tab,
+      ) => void;
+
+      /**
+       * The ID of a parent menu item; this makes the item a child of a previously added item.
+       */
+      parentId?: number | string;
+
+      /**
+       * Restricts the item to apply only to documents or frames whose URL matches one of the given patterns. For details on pattern formats, see [Match Patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns).
+       */
+      documentUrlPatterns?: string[];
+
+      /**
+       * Similar to `documentUrlPatterns`, filters based on the `src` attribute of `img`, `audio`, and `video` tags and the `href` attribute of `a` tags.
+       */
+      targetUrlPatterns?: string[];
+
+      /**
+       * Whether this context menu item is enabled or disabled. Defaults to `true`.
+       */
+      enabled?: boolean;
+    }
+
     /**
      * The maximum number of top level extension items that can be added to an extension action context menu. Any items beyond this limit will be ignored.
      */
@@ -6618,31 +6687,30 @@ declare namespace chrome {
      */
     export function create(
 
-      createProperties: {
+      createProperties: CreateProperties,
 
-        /**
-         * The type of menu item. Defaults to `normal`.
-         */
-        type?: ItemType,
+      callback?: () => void,
+    ): number | string;
 
-        /**
-         * The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
-         */
-        id?: string,
+    /**
+     * Updates a previously created context menu item.
+     *
+     * @chrome-returns-extra since Pending
+     * @param id The ID of the item to update.
+     * @param updateProperties The properties to update. Accepts the same values as the {@link contextMenus.create} function.
+     */
+    export function update(
+
+      id: number | string,
+
+      updateProperties: {
+
+        type?: ItemType,
 
-        /**
-         * The text to display in the item; this is _required_ unless `type` is `separator`. When the context is `selection`, use `%s` within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".
-         */
         title?: string,
 
-        /**
-         * The initial state of a checkbox or radio button: `true` for selected, `false` for unselected. Only one radio button can be selected at a time in a given group.
-         */
         checked?: boolean,
 
-        /**
-         * List of contexts this menu item will appear in. Defaults to `['page']`.
-         */
         contexts?: [ContextType, ...ContextType[]],
 
         /**
@@ -6653,39 +6721,31 @@ declare namespace chrome {
         visible?: boolean,
 
         /**
-         * A function that is called back when the menu item is clicked. This is not available inside of a service worker; instead, they should register a listener for {@link contextMenus.onClicked}.
-         *
-         * @param info Information about the item clicked and the context where the click happened.
          * @param tab The details of the tab where the click took place. This parameter is not present for platform apps.
          */
         onclick?: (
+          /**
+           * @since Chrome 44
+           */
           info: OnClickData,
+          /**
+           * @since Chrome 44
+           */
           tab: tabs.Tab,
         ) => void,
 
         /**
-         * The ID of a parent menu item; this makes the item a child of a previously added item.
+         * The ID of the item to be made this item's parent. Note: You cannot set an item to become a child of its own descendant.
          */
         parentId?: number | string,
 
-        /**
-         * Restricts the item to apply only to documents or frames whose URL matches one of the given patterns. For details on pattern formats, see [Match Patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns).
-         */
         documentUrlPatterns?: string[],
 
-        /**
-         * Similar to `documentUrlPatterns`, filters based on the `src` attribute of `img`, `audio`, and `video` tags and the `href` attribute of `a` tags.
-         */
         targetUrlPatterns?: string[],
 
-        /**
-         * Whether this context menu item is enabled or disabled. Defaults to `true`.
-         */
         enabled?: boolean,
       },
-
-      callback?: () => void,
-    ): number | string;
+    ): Promise<void>;
 
     /**
      * Updates a previously created context menu item.
@@ -6744,6 +6804,17 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Removes a context menu item.
+     *
+     * @chrome-returns-extra since Pending
+     * @param menuItemId The ID of the context menu item to remove.
+     */
+    export function remove(
+
+      menuItemId: number | string,
+    ): Promise<void>;
+
     /**
      * Removes a context menu item.
      *
@@ -6757,6 +6828,13 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Removes all context menu items added by this extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function removeAll(): Promise<void>;
+
     /**
      * Removes all context menu items added by this extension.
      *
@@ -11814,6 +11892,13 @@ declare namespace chrome {
        * Matches if the port of the URL is contained in any of the specified port lists. For example `[80, 443, [1000, 1200]]` matches all requests on port 80, 443 and in the range 1000-1200.
        */
       ports?: (number | number[])[];
+
+      /**
+       * Matches if the host part of the URL is an IP address and is contained in any of the CIDR blocks specified in the array.
+       *
+       * @since Pending
+       */
+      cidrBlocks?: string[];
     }
   }
 

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sat Feb 03 2024 22:28:56 GMT+0000 (Coordinated Universal Time)
-// Built at edbee24a2e062db732d90e5b23858cbc1a4a8ebf
+// Generated on Tue Feb 06 2024 22:28:45 GMT+0000 (Coordinated Universal Time)
+// Built at f1c1b2fcda4cbf2e21dd3d1d4234eeedae74cb9a
 
 // Includes MV3+ APIs only.
 
@@ -271,7 +271,7 @@ declare namespace chrome {
     export interface OpenPopupOptions {
 
       /**
-       * The id of the window to open the action popup in. Defaults to the currently-active window if unspecified.
+       * The ID of the window to open the action popup in. Defaults to the currently-active window if unspecified.
        */
       windowId?: number;
     }
@@ -646,7 +646,7 @@ declare namespace chrome {
     /**
      * Enables the action for a tab. By default, actions are enabled.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function enable(
 
@@ -656,7 +656,7 @@ declare namespace chrome {
     /**
      * Enables the action for a tab. By default, actions are enabled.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function enable(
 
@@ -668,7 +668,7 @@ declare namespace chrome {
     /**
      * Disables the action for a tab.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function disable(
 
@@ -678,7 +678,7 @@ declare namespace chrome {
     /**
      * Disables the action for a tab.
      *
-     * @param tabId The id of the tab for which you want to modify the action.
+     * @param tabId The ID of the tab for which you want to modify the action.
      */
     export function disable(
 
@@ -690,7 +690,7 @@ declare namespace chrome {
     /**
      * Indicates whether the extension action is enabled for a tab (or globally if no `tabId` is provided). Actions enabled using only {@link declarativeContent} always return false.
      *
-     * @param tabId The id of the tab for which you want check enabled status.
+     * @param tabId The ID of the tab for which you want check enabled status.
      * @since Chrome 110
      */
     export function isEnabled(
@@ -701,7 +701,7 @@ declare namespace chrome {
     /**
      * Indicates whether the extension action is enabled for a tab (or globally if no `tabId` is provided). Actions enabled using only {@link declarativeContent} always return false.
      *
-     * @param tabId The id of the tab for which you want check enabled status.
+     * @param tabId The ID of the tab for which you want check enabled status.
      * @since Chrome 110
      */
     export function isEnabled(
@@ -3343,6 +3343,75 @@ declare namespace chrome {
       checked?: boolean;
     }
 
+    /**
+     * Properties of the new context menu item.
+     *
+     * @since Pending
+     */
+    export interface CreateProperties {
+
+      /**
+       * The type of menu item. Defaults to `normal`.
+       */
+      type?: ItemType;
+
+      /**
+       * The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
+       */
+      id?: string;
+
+      /**
+       * The text to display in the item; this is _required_ unless `type` is `separator`. When the context is `selection`, use `%s` within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".
+       */
+      title?: string;
+
+      /**
+       * The initial state of a checkbox or radio button: `true` for selected, `false` for unselected. Only one radio button can be selected at a time in a given group.
+       */
+      checked?: boolean;
+
+      /**
+       * List of contexts this menu item will appear in. Defaults to `['page']`.
+       */
+      contexts?: [ContextType, ...ContextType[]];
+
+      /**
+       * Whether the item is visible in the menu.
+       */
+      visible?: boolean;
+
+      /**
+       * A function that is called back when the menu item is clicked. This is not available inside of a service worker; instead, they should register a listener for {@link contextMenus.onClicked}.
+       *
+       * @param info Information about the item clicked and the context where the click happened.
+       * @param tab The details of the tab where the click took place. This parameter is not present for platform apps.
+       */
+      onclick?: (
+        info: OnClickData,
+        tab: tabs.Tab,
+      ) => void;
+
+      /**
+       * The ID of a parent menu item; this makes the item a child of a previously added item.
+       */
+      parentId?: number | string;
+
+      /**
+       * Restricts the item to apply only to documents or frames whose URL matches one of the given patterns. For details on pattern formats, see [Match Patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns).
+       */
+      documentUrlPatterns?: string[];
+
+      /**
+       * Similar to `documentUrlPatterns`, filters based on the `src` attribute of `img`, `audio`, and `video` tags and the `href` attribute of `a` tags.
+       */
+      targetUrlPatterns?: string[];
+
+      /**
+       * Whether this context menu item is enabled or disabled. Defaults to `true`.
+       */
+      enabled?: boolean;
+    }
+
     /**
      * The maximum number of top level extension items that can be added to an extension action context menu. Any items beyond this limit will be ignored.
      */
@@ -3364,31 +3433,30 @@ declare namespace chrome {
      */
     export function create(
 
-      createProperties: {
+      createProperties: CreateProperties,
 
-        /**
-         * The type of menu item. Defaults to `normal`.
-         */
-        type?: ItemType,
+      callback?: () => void,
+    ): number | string;
 
-        /**
-         * The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
-         */
-        id?: string,
+    /**
+     * Updates a previously created context menu item.
+     *
+     * @chrome-returns-extra since Pending
+     * @param id The ID of the item to update.
+     * @param updateProperties The properties to update. Accepts the same values as the {@link contextMenus.create} function.
+     */
+    export function update(
+
+      id: number | string,
+
+      updateProperties: {
+
+        type?: ItemType,
 
-        /**
-         * The text to display in the item; this is _required_ unless `type` is `separator`. When the context is `selection`, use `%s` within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".
-         */
         title?: string,
 
-        /**
-         * The initial state of a checkbox or radio button: `true` for selected, `false` for unselected. Only one radio button can be selected at a time in a given group.
-         */
         checked?: boolean,
 
-        /**
-         * List of contexts this menu item will appear in. Defaults to `['page']`.
-         */
         contexts?: [ContextType, ...ContextType[]],
 
         /**
@@ -3399,39 +3467,31 @@ declare namespace chrome {
         visible?: boolean,
 
         /**
-         * A function that is called back when the menu item is clicked. This is not available inside of a service worker; instead, they should register a listener for {@link contextMenus.onClicked}.
-         *
-         * @param info Information about the item clicked and the context where the click happened.
          * @param tab The details of the tab where the click took place. This parameter is not present for platform apps.
          */
         onclick?: (
+          /**
+           * @since Chrome 44
+           */
           info: OnClickData,
+          /**
+           * @since Chrome 44
+           */
           tab: tabs.Tab,
         ) => void,
 
         /**
-         * The ID of a parent menu item; this makes the item a child of a previously added item.
+         * The ID of the item to be made this item's parent. Note: You cannot set an item to become a child of its own descendant.
          */
         parentId?: number | string,
 
-        /**
-         * Restricts the item to apply only to documents or frames whose URL matches one of the given patterns. For details on pattern formats, see [Match Patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns).
-         */
         documentUrlPatterns?: string[],
 
-        /**
-         * Similar to `documentUrlPatterns`, filters based on the `src` attribute of `img`, `audio`, and `video` tags and the `href` attribute of `a` tags.
-         */
         targetUrlPatterns?: string[],
 
-        /**
-         * Whether this context menu item is enabled or disabled. Defaults to `true`.
-         */
         enabled?: boolean,
       },
-
-      callback?: () => void,
-    ): number | string;
+    ): Promise<void>;
 
     /**
      * Updates a previously created context menu item.
@@ -3490,6 +3550,17 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Removes a context menu item.
+     *
+     * @chrome-returns-extra since Pending
+     * @param menuItemId The ID of the context menu item to remove.
+     */
+    export function remove(
+
+      menuItemId: number | string,
+    ): Promise<void>;
+
     /**
      * Removes a context menu item.
      *
@@ -3503,6 +3574,13 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Removes all context menu items added by this extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function removeAll(): Promise<void>;
+
     /**
      * Removes all context menu items added by this extension.
      *
@@ -7944,6 +8022,13 @@ declare namespace chrome {
        * Matches if the port of the URL is contained in any of the specified port lists. For example `[80, 443, [1000, 1200]]` matches all requests on port 80, 443 and in the range 1000-1200.
        */
       ports?: (number | number[])[];
+
+      /**
+       * Matches if the host part of the URL is an IP address and is contained in any of the CIDR blocks specified in the array.
+       *
+       * @since Pending
+       */
+      cidrBlocks?: string[];
     }
   }
 

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "2be4403461326f5f"
+    "build-hash": "b8a137e15f9ca6f2"
   },
   "repository": {
     "type": "git",
@@ -16,5 +16,5 @@
     "url": "https://github.com/GoogleChrome/chrome-types/issues"
   },
   "homepage": "https://github.com/GoogleChrome/chrome-types",
-  "version": "0.1.258"
+  "version": "0.1.260"
 }