chrome-types 0.1.89 → 0.1.92

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Fri Feb 18 2022 22:28:05 GMT+0000 (Coordinated Universal Time)
-// Built at d8e5cbade765a5019c53f0fd73a6cb010edf80e3
+// Generated on Fri Mar 04 2022 22:28:25 GMT+0000 (Coordinated Universal Time)
+// Built at c6cc7dcbef1fabbd413a688e661edfa570780914
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -208,7 +208,7 @@ declare namespace chrome {
     }
 
     /**
-     * @since Pending
+     * @since Chrome 99
      */
     export interface OpenPopupOptions {
 
@@ -602,8 +602,9 @@ declare namespace chrome {
     /**
      * Opens the extension's popup.
      *
+     * @chrome-returns-extra since Pending
      * @param options Specifies options for opening the popup.
-     * @since Pending
+     * @since Chrome 99
      */
     export function openPopup(
 
@@ -614,7 +615,7 @@ declare namespace chrome {
      * Opens the extension's popup.
      *
      * @param options Specifies options for opening the popup.
-     * @since Pending
+     * @since Chrome 99
      */
     export function openPopup(
 
@@ -7345,7 +7346,7 @@ declare namespace chrome {
       /**
        * Whether the script should inject into any frames where the URL belongs to a scheme that would never match a specified Match Pattern, including about:, data:, blob:, and filesystem: schemes. In these cases, in order to determine if the script should inject, the origin of the URL is checked. If the origin is `null` (as is the case for data: URLs), then the "initiator" or "creator" origin is used (i.e., the origin of the frame that created or navigated this frame). Note that this may not be the parent frame, if the frame was navigated by another frame in the document hierarchy.
        *
-       * @since Pending
+       * @since Chrome 99
        */
       match_origin_as_fallback?: boolean;
 
@@ -12578,7 +12579,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -12597,7 +12598,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -20792,6 +20793,17 @@ declare namespace chrome {
       tab: tabs.Tab,
     ) => void>;
 
+    /**
+     * Shows the page action. The page action is shown whenever the tab is selected.
+     *
+     * @chrome-returns-extra since Pending
+     * @param tabId The id of the tab for which you want to modify the page action.
+     */
+    export function show(
+
+      tabId: number,
+    ): Promise<void>;
+
     /**
      * Shows the page action. The page action is shown whenever the tab is selected.
      *
@@ -20807,6 +20819,17 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Hides the page action. Hidden page actions still appear in the Chrome toolbar, but are grayed out.
+     *
+     * @chrome-returns-extra since Pending
+     * @param tabId The id of the tab for which you want to modify the page action.
+     */
+    export function hide(
+
+      tabId: number,
+    ): Promise<void>;
+
     /**
      * Hides the page action. Hidden page actions still appear in the Chrome toolbar, but are grayed out.
      *
@@ -20822,6 +20845,27 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Sets the title of the page action. This is displayed in a tooltip over the page action.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setTitle(
+
+      details: {
+
+        /**
+         * The id of the tab for which you want to modify the page action.
+         */
+        tabId: number,
+
+        /**
+         * The tooltip string.
+         */
+        title: string,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the title of the page action. This is displayed in a tooltip over the page action.
      */
@@ -20848,16 +20892,57 @@ declare namespace chrome {
 
     /**
      * Gets the title of the page action.
+     *
+     * @chrome-returns-extra since Pending
      */
     export function getTitle(
 
       details: TabDetails,
+    ): Promise<string>;
 
-      callback: (
+    /**
+     * Gets the title of the page action.
+     */
+    export function getTitle(
+
+      details: TabDetails,
+
+      callback?: (
         result: string,
       ) => void,
     ): void;
 
+    /**
+     * Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the **path** or the **imageData** property must be specified.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setIcon(
+
+      details: {
+
+        /**
+         * The id of the tab for which you want to modify the page action.
+         */
+        tabId: number,
+
+        /**
+         * Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals `scale`, then image with size `scale` \* n will be selected, where n is the size of the icon in the UI. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'16': foo}'
+         */
+        imageData?: ImageDataType | {[name: string]: any},
+
+        /**
+         * Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals `scale`, then image with size `scale` \* n will be selected, where n is the size of the icon in the UI. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.path = {'16': foo}'
+         */
+        path?: string | {[name: string]: any},
+
+        /**
+         * **Deprecated.** This argument is ignored.
+         */
+        iconIndex?: number,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the **path** or the **imageData** property must be specified.
      */
@@ -20889,6 +20974,27 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Sets the HTML document to be opened as a popup when the user clicks on the page action's icon.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setPopup(
+
+      details: {
+
+        /**
+         * The id of the tab for which you want to modify the page action.
+         */
+        tabId: number,
+
+        /**
+         * The relative path to the HTML file to show in a popup. If set to the empty string (`''`), no popup is shown.
+         */
+        popup: string,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the HTML document to be opened as a popup when the user clicks on the page action's icon.
      */
@@ -20913,6 +21019,16 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets the html document set as the popup for this page action.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getPopup(
+
+      details: TabDetails,
+    ): Promise<string>;
+
     /**
      * Gets the html document set as the popup for this page action.
      */
@@ -20920,7 +21036,7 @@ declare namespace chrome {
 
       details: TabDetails,
 
-      callback: (
+      callback?: (
         result: string,
       ) => void,
     ): void;
@@ -22878,7 +22994,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -22904,7 +23020,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -22941,7 +23057,7 @@ declare namespace chrome {
 
       /**
        * @param response The response message sent by the native messaging host. If an error occurs while connecting to the native messaging host, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -28260,7 +28376,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback is called with no arguments and {@link runtime.lastError} is set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -28309,7 +28425,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback is called with no arguments and {@link runtime.lastError} is set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -29929,6 +30045,20 @@ declare namespace chrome {
       eventTypes?: EventType[];
     }
 
+    /**
+     * Speaks text using a text-to-speech engine.
+     *
+     * @chrome-returns-extra since Pending
+     * @param utterance The text to speak, either plain text or a complete, well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters.
+     * @param options The speech options.
+     */
+    export function speak(
+
+      utterance: string,
+
+      options?: TtsOptions,
+    ): Promise<void>;
+
     /**
      * Speaks text using a text-to-speech engine.
      *
@@ -29960,6 +30090,13 @@ declare namespace chrome {
      */
     export function resume(): void;
 
+    /**
+     * Checks whether the engine is currently speaking. On Mac OS X, the result is true whenever the system speech engine is speaking, even if the speech wasn't initiated by Chrome.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isSpeaking(): Promise<boolean>;
+
     /**
      * Checks whether the engine is currently speaking. On Mac OS X, the result is true whenever the system speech engine is speaking, even if the speech wasn't initiated by Chrome.
      */
@@ -29973,6 +30110,13 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Gets an array of all available voices.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getVoices(): Promise<TtsVoice[]>;
+
     /**
      * Gets an array of all available voices.
      */
@@ -32213,7 +32357,7 @@ declare namespace chrome {
         /**
          * The ID of the tab in which the frame is.
          */
-        tabId: number,
+        tabId?: number,
 
         /**
          * The ID of the process that runs the renderer for this tab.
@@ -32226,7 +32370,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
     ): Promise<{
 
@@ -32258,7 +32402,7 @@ declare namespace chrome {
         /**
          * The ID of the tab in which the frame is.
          */
-        tabId: number,
+        tabId?: number,
 
         /**
          * The ID of the process that runs the renderer for this tab.
@@ -32271,7 +32415,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
 
       /**

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Fri Feb 18 2022 22:28:00 GMT+0000 (Coordinated Universal Time)
-// Built at d8e5cbade765a5019c53f0fd73a6cb010edf80e3
+// Generated on Fri Mar 04 2022 22:28:21 GMT+0000 (Coordinated Universal Time)
+// Built at c6cc7dcbef1fabbd413a688e661edfa570780914
 
 // Includes MV3+ APIs only.
 
@@ -266,7 +266,7 @@ declare namespace chrome {
     }
 
     /**
-     * @since Pending
+     * @since Chrome 99
      */
     export interface OpenPopupOptions {
 
@@ -660,8 +660,9 @@ declare namespace chrome {
     /**
      * Opens the extension's popup.
      *
+     * @chrome-returns-extra since Pending
      * @param options Specifies options for opening the popup.
-     * @since Pending
+     * @since Chrome 99
      */
     export function openPopup(
 
@@ -672,7 +673,7 @@ declare namespace chrome {
      * Opens the extension's popup.
      *
      * @param options Specifies options for opening the popup.
-     * @since Pending
+     * @since Chrome 99
      */
     export function openPopup(
 
@@ -3907,7 +3908,7 @@ declare namespace chrome {
       /**
        * Whether the script should inject into any frames where the URL belongs to a scheme that would never match a specified Match Pattern, including about:, data:, blob:, and filesystem: schemes. In these cases, in order to determine if the script should inject, the origin of the URL is checked. If the origin is `null` (as is the case for data: URLs), then the "initiator" or "creator" origin is used (i.e., the origin of the frame that created or navigated this frame). Note that this may not be the parent frame, if the frame was navigated by another frame in the document hierarchy.
        *
-       * @since Pending
+       * @since Chrome 99
        */
       match_origin_as_fallback?: boolean;
 
@@ -15755,7 +15756,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -15781,7 +15782,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -15818,7 +15819,7 @@ declare namespace chrome {
 
       /**
        * @param response The response message sent by the native messaging host. If an error occurs while connecting to the native messaging host, the callback will be called with no arguments and {@link runtime.lastError} will be set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -18634,7 +18635,7 @@ declare namespace chrome {
 
       /**
        * @param response The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback is called with no arguments and {@link runtime.lastError} is set to the error message.
-       * @since Pending
+       * @since Chrome 99
        */
       callback?: (
         response: any,
@@ -19984,6 +19985,20 @@ declare namespace chrome {
       eventTypes?: EventType[];
     }
 
+    /**
+     * Speaks text using a text-to-speech engine.
+     *
+     * @chrome-returns-extra since Pending
+     * @param utterance The text to speak, either plain text or a complete, well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters.
+     * @param options The speech options.
+     */
+    export function speak(
+
+      utterance: string,
+
+      options?: TtsOptions,
+    ): Promise<void>;
+
     /**
      * Speaks text using a text-to-speech engine.
      *
@@ -20015,6 +20030,13 @@ declare namespace chrome {
      */
     export function resume(): void;
 
+    /**
+     * Checks whether the engine is currently speaking. On Mac OS X, the result is true whenever the system speech engine is speaking, even if the speech wasn't initiated by Chrome.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isSpeaking(): Promise<boolean>;
+
     /**
      * Checks whether the engine is currently speaking. On Mac OS X, the result is true whenever the system speech engine is speaking, even if the speech wasn't initiated by Chrome.
      */
@@ -20028,6 +20050,13 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Gets an array of all available voices.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getVoices(): Promise<TtsVoice[]>;
+
     /**
      * Gets an array of all available voices.
      */
@@ -21494,7 +21523,7 @@ declare namespace chrome {
         /**
          * The ID of the tab in which the frame is.
          */
-        tabId: number,
+        tabId?: number,
 
         /**
          * The ID of the process that runs the renderer for this tab.
@@ -21507,7 +21536,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
     ): Promise<{
 
@@ -21539,7 +21568,7 @@ declare namespace chrome {
         /**
          * The ID of the tab in which the frame is.
          */
-        tabId: number,
+        tabId?: number,
 
         /**
          * The ID of the process that runs the renderer for this tab.
@@ -21552,7 +21581,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
 
       /**

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "0b4f465463d2fbfc"
+    "build-hash": "79efa02505957528"
   },
   "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.89"
+  "version": "0.1.92"
 }