chrome-types 0.1.90 → 0.1.93

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Tue Mar 01 2022 22:28:05 GMT+0000 (Coordinated Universal Time)
-// Built at ef59a59c1fee2af6315d9eebd0920baf5b494243
+// Generated on Wed Mar 09 2022 22:28:07 GMT+0000 (Coordinated Universal Time)
+// Built at 0cac0c047f8f4d2aef880f7d28b7aa418a194e98
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -1604,7 +1604,6 @@ declare namespace chrome {
    *
    * @since Chrome 59
    * @chrome-permission audio
-   * @chrome-platform-apps
    * @chrome-platform chromeos
    */
   export namespace audio {
@@ -9081,7 +9080,7 @@ declare namespace chrome {
       isUrlFilterCaseSensitive?: boolean;
 
       /**
-       * The rule will only match network requests originating from the list of `domains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
+       * The rule will only match network requests originating from the list of `initiatorDomains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
        *
        * Notes:
        *
@@ -9089,11 +9088,13 @@ declare namespace chrome {
        * *   The entries must consist of only ascii characters.
        * *   Use punycode encoding for internationalized domains.
        * *   This matches against the request initiator and not the request url.
+       *
+       * @since Pending
        */
-      domains?: string[];
+      initiatorDomains?: string[];
 
       /**
-       * The rule will not match network requests originating from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `domains`.
+       * The rule will not match network requests originating from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `initiatorDomains`.
        *
        * Notes:
        *
@@ -9101,6 +9102,48 @@ declare namespace chrome {
        * *   The entries must consist of only ascii characters.
        * *   Use punycode encoding for internationalized domains.
        * *   This matches against the request initiator and not the request url.
+       *
+       * @since Pending
+       */
+      excludedInitiatorDomains?: string[];
+
+      /**
+       * The rule will only match network requests when the domain matches one from the list of `requestDomains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
+       *
+       * Notes:
+       *
+       * *   Sub-domains like "a.example.com" are also allowed.
+       * *   The entries must consist of only ascii characters.
+       * *   Use punycode encoding for internationalized domains.
+       *
+       * @since Pending
+       */
+      requestDomains?: string[];
+
+      /**
+       * The rule will not match network requests when the domains matches one from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `requestDomains`.
+       *
+       * Notes:
+       *
+       * *   Sub-domains like "a.example.com" are also allowed.
+       * *   The entries must consist of only ascii characters.
+       * *   Use punycode encoding for internationalized domains.
+       *
+       * @since Pending
+       */
+      excludedRequestDomains?: string[];
+
+      /**
+       * The rule will only match network requests originating from the list of `domains`.
+       *
+       * @deprecated Use {@link initiatorDomains} instead
+       */
+      domains?: string[];
+
+      /**
+       * The rule will not match network requests originating from the list of `excludedDomains`.
+       *
+       * @deprecated Use {@link excludedInitiatorDomains} instead
        */
       excludedDomains?: string[];
 
@@ -20793,6 +20836,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 +20862,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 +20888,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 +20935,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 +21017,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 +21064,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 +30088,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 +30133,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 +30153,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.
      */

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Tue Mar 01 2022 22:28:01 GMT+0000 (Coordinated Universal Time)
-// Built at ef59a59c1fee2af6315d9eebd0920baf5b494243
+// Generated on Wed Mar 09 2022 22:28:02 GMT+0000 (Coordinated Universal Time)
+// Built at 0cac0c047f8f4d2aef880f7d28b7aa418a194e98
 
 // Includes MV3+ APIs only.
 
@@ -849,6 +849,245 @@ declare namespace chrome {
     ): void;
   }
 
+  /**
+   * The `chrome.audio` API is provided to allow users to get information about and control the audio devices attached to the system. This API is currently only available in kiosk mode for ChromeOS.
+   *
+   * @since Chrome 59
+   * @chrome-permission audio
+   * @chrome-platform chromeos
+   */
+  export namespace audio {
+
+    /**
+     * Type of stream an audio device provides.
+     */
+    export type StreamType = "INPUT" | "OUTPUT";
+
+    /**
+     * Available audio device types.
+     */
+    export type DeviceType = "HEADPHONE" | "MIC" | "USB" | "BLUETOOTH" | "HDMI" | "INTERNAL_SPEAKER" | "INTERNAL_MIC" | "FRONT_MIC" | "REAR_MIC" | "KEYBOARD_MIC" | "HOTWORD" | "LINEOUT" | "POST_MIX_LOOPBACK" | "POST_DSP_LOOPBACK" | "ALSA_LOOPBACK" | "OTHER";
+
+    export interface AudioDeviceInfo {
+
+      /**
+       * The unique identifier of the audio device.
+       */
+      id: string;
+
+      /**
+       * Stream type associated with this device.
+       */
+      streamType: StreamType;
+
+      /**
+       * Type of the device.
+       */
+      deviceType: DeviceType;
+
+      /**
+       * The user-friendly name (e.g. "USB Microphone").
+       */
+      displayName: string;
+
+      /**
+       * Device name.
+       */
+      deviceName: string;
+
+      /**
+       * True if this is the current active device.
+       */
+      isActive: boolean;
+
+      /**
+       * The sound level of the device, volume for output, gain for input.
+       */
+      level: number;
+
+      /**
+       * The stable/persisted device id string when available.
+       */
+      stableDeviceId?: string;
+    }
+
+    export interface DeviceFilter {
+
+      /**
+       * If set, only audio devices whose stream type is included in this list will satisfy the filter.
+       */
+      streamTypes?: StreamType[];
+
+      /**
+       * If set, only audio devices whose active state matches this value will satisfy the filter.
+       */
+      isActive?: boolean;
+    }
+
+    export interface DeviceProperties {
+
+      /**
+       * The audio device's desired sound level. Defaults to the device's current sound level.
+       *
+       * If used with audio input device, represents audio device gain.
+       *
+       * If used with audio output device, represents audio device volume.
+       */
+      level?: number;
+    }
+
+    export interface DeviceIdLists {
+
+      /**
+       * List of input devices specified by their ID.
+       *
+       * To indicate input devices should be unaffected, leave this property unset.
+       */
+      input?: string[];
+
+      /**
+       * List of output devices specified by their ID.
+       *
+       * To indicate output devices should be unaffected, leave this property unset.
+       */
+      output?: string[];
+    }
+
+    export interface MuteChangedEvent {
+
+      /**
+       * The type of the stream for which the mute value changed. The updated mute value applies to all devices with this stream type.
+       */
+      streamType: StreamType;
+
+      /**
+       * Whether or not the stream is now muted.
+       */
+      isMuted: boolean;
+    }
+
+    export interface LevelChangedEvent {
+
+      /**
+       * ID of device whose sound level has changed.
+       */
+      deviceId: string;
+
+      /**
+       * The device's new sound level.
+       */
+      level: number;
+    }
+
+    /**
+     * Fired when sound level changes for an active audio device.
+     */
+    export const onLevelChanged: events.Event<(
+      event: LevelChangedEvent,
+    ) => void>;
+
+    /**
+     * Fired when the mute state of the audio input or output changes. Note that mute state is system-wide and the new value applies to every audio device with specified stream type.
+     */
+    export const onMuteChanged: events.Event<(
+      event: MuteChangedEvent,
+    ) => void>;
+
+    /**
+     * Fired when audio devices change, either new devices being added, or existing devices being removed.
+     */
+    export const onDeviceListChanged: events.Event<(
+      devices: AudioDeviceInfo[],
+    ) => void>;
+
+    /**
+     * Gets a list of audio devices filtered based on `filter`.
+     *
+     * @param filter Device properties by which to filter the list of returned audio devices. If the filter is not set or set to `{}`, returned device list will contain all available audio devices.
+     * @param callback Reports the requested list of audio devices.
+     */
+    export function getDevices(
+
+      filter: DeviceFilter,
+
+      callback: (
+        devices: AudioDeviceInfo[],
+      ) => void,
+    ): void;
+
+    /**
+     * Gets a list of audio devices filtered based on `filter`.
+     *
+     * @param callback Reports the requested list of audio devices.
+     */
+    export function getDevices(
+
+      callback: (
+        devices: AudioDeviceInfo[],
+      ) => void,
+    ): void;
+
+    /**
+     * Sets lists of active input and/or output devices.
+     *
+     * @param ids
+
+    Specifies IDs of devices that should be active. If either the input or output list is not set, devices in that category are unaffected.
+
+    It is an error to pass in a non-existent device ID.
+
+    **NOTE:** While the method signature allows device IDs to be passed as a list of strings, this method of setting active devices is deprecated and should not be relied upon to work. Please use {@link DeviceIdLists} instead.
+     */
+    export function setActiveDevices(
+
+      ids: DeviceIdLists | string[],
+
+      callback: () => void,
+    ): void;
+
+    /**
+     * Sets the properties for the input or output device.
+     */
+    export function setProperties(
+
+      id: string,
+
+      properties: DeviceProperties,
+
+      callback: () => void,
+    ): void;
+
+    /**
+     * Gets the system-wide mute state for the specified stream type.
+     *
+     * @param streamType Stream type for which mute state should be fetched.
+     * @param callback Callback reporting whether mute is set or not for specified stream type.
+     */
+    export function getMute(
+
+      streamType: StreamType,
+
+      callback: (
+        value: boolean,
+      ) => void,
+    ): void;
+
+    /**
+     * Sets mute state for a stream type. The mute state will apply to all audio devices with the specified audio stream type.
+     *
+     * @param streamType Stream type for which mute state should be set.
+     * @param isMuted New mute value.
+     */
+    export function setMute(
+
+      streamType: StreamType,
+
+      isMuted: boolean,
+
+      callback?: () => void,
+    ): void;
+  }
+
   /**
    * The `chrome.automation` API allows developers to access the automation (accessibility) tree for the browser. The tree resembles the DOM tree, but only exposes the _semantic_ structure of a page. It can be used to programmatically interact with a page by examining names, roles, and states, listening for events, and performing actions on nodes.
    *
@@ -5643,7 +5882,7 @@ declare namespace chrome {
       isUrlFilterCaseSensitive?: boolean;
 
       /**
-       * The rule will only match network requests originating from the list of `domains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
+       * The rule will only match network requests originating from the list of `initiatorDomains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
        *
        * Notes:
        *
@@ -5651,11 +5890,13 @@ declare namespace chrome {
        * *   The entries must consist of only ascii characters.
        * *   Use punycode encoding for internationalized domains.
        * *   This matches against the request initiator and not the request url.
+       *
+       * @since Pending
        */
-      domains?: string[];
+      initiatorDomains?: string[];
 
       /**
-       * The rule will not match network requests originating from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `domains`.
+       * The rule will not match network requests originating from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `initiatorDomains`.
        *
        * Notes:
        *
@@ -5663,6 +5904,48 @@ declare namespace chrome {
        * *   The entries must consist of only ascii characters.
        * *   Use punycode encoding for internationalized domains.
        * *   This matches against the request initiator and not the request url.
+       *
+       * @since Pending
+       */
+      excludedInitiatorDomains?: string[];
+
+      /**
+       * The rule will only match network requests when the domain matches one from the list of `requestDomains`. If the list is omitted, the rule is applied to requests from all domains. An empty list is not allowed.
+       *
+       * Notes:
+       *
+       * *   Sub-domains like "a.example.com" are also allowed.
+       * *   The entries must consist of only ascii characters.
+       * *   Use punycode encoding for internationalized domains.
+       *
+       * @since Pending
+       */
+      requestDomains?: string[];
+
+      /**
+       * The rule will not match network requests when the domains matches one from the list of `excludedDomains`. If the list is empty or omitted, no domains are excluded. This takes precedence over `requestDomains`.
+       *
+       * Notes:
+       *
+       * *   Sub-domains like "a.example.com" are also allowed.
+       * *   The entries must consist of only ascii characters.
+       * *   Use punycode encoding for internationalized domains.
+       *
+       * @since Pending
+       */
+      excludedRequestDomains?: string[];
+
+      /**
+       * The rule will only match network requests originating from the list of `domains`.
+       *
+       * @deprecated Use {@link initiatorDomains} instead
+       */
+      domains?: string[];
+
+      /**
+       * The rule will not match network requests originating from the list of `excludedDomains`.
+       *
+       * @deprecated Use {@link excludedInitiatorDomains} instead
        */
       excludedDomains?: string[];
 
@@ -19985,6 +20268,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 +20313,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 +20333,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.
      */

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "fd1f46065e5a50b7"
+    "build-hash": "0c1e8e266ce57545"
   },
   "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.90"
+  "version": "0.1.93"
 }