chrome-types 0.1.91 → 0.1.92

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Wed Mar 02 2022 22:28:11 GMT+0000 (Coordinated Universal Time)
-// Built at a3f419cb3268f372f2f366d9c03c5d88ad660e99
+// 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.
 
@@ -20793,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.
      *
@@ -20808,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.
      *
@@ -20823,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.
      */
@@ -20849,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.
      */
@@ -20890,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.
      */
@@ -20916,12 +21021,22 @@ declare namespace chrome {
 
     /**
      * Gets the html document set as the popup for this page action.
+     *
+     * @chrome-returns-extra since Pending
      */
     export function getPopup(
 
       details: TabDetails,
+    ): Promise<string>;
 
-      callback: (
+    /**
+     * Gets the html document set as the popup for this page action.
+     */
+    export function getPopup(
+
+      details: TabDetails,
+
+      callback?: (
         result: string,
       ) => void,
     ): void;
@@ -29930,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.
      *
@@ -29961,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.
      */
@@ -29974,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.
      */
@@ -32214,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.
@@ -32227,7 +32370,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
     ): Promise<{
 
@@ -32259,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.
@@ -32272,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 Wed Mar 02 2022 22:28:06 GMT+0000 (Coordinated Universal Time)
-// Built at a3f419cb3268f372f2f366d9c03c5d88ad660e99
+// Generated on Fri Mar 04 2022 22:28:21 GMT+0000 (Coordinated Universal Time)
+// Built at c6cc7dcbef1fabbd413a688e661edfa570780914
 
 // Includes MV3+ APIs only.
 
@@ -19985,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.
      *
@@ -20016,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.
      */
@@ -20029,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.
      */
@@ -21495,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.
@@ -21508,7 +21536,7 @@ declare namespace chrome {
         /**
          * The ID of the frame in the given tab.
          */
-        frameId: number,
+        frameId?: number,
       },
     ): Promise<{
 
@@ -21540,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.
@@ -21553,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": "21231b17eb475d39"
+    "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.91"
+  "version": "0.1.92"
 }