chrome-types 0.1.74 → 0.1.78

package/_all.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Wed Dec 15 2021 22:29:07 GMT+0000 (Coordinated Universal Time)
-// Built at 3b76b1d66afc55f20ba6462f45fbafd2d3d026d6
+// Generated on Sat Jan 01 2022 22:28:08 GMT+0000 (Coordinated Universal Time)
+// Built at 06fe0d4ea8eed0657b3cbed751442d15746d0af5
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -12487,6 +12487,33 @@ declare namespace chrome {
       sendResponse: () => void,
     ) => void>;
 
+    /**
+     * Sends a single request to other listeners within the extension. Similar to {@link runtime.connect}, but only sends a single request with an optional response. The {@link extension.onRequest} event is fired in each page of the extension.
+     *
+     * @chrome-returns-extra since Pending
+     * @param extensionId The extension ID of the extension you want to connect to. If omitted, default is your own extension.
+     * @deprecated Please use {@link runtime.sendMessage}.
+     * @chrome-max-manifest MV2
+     */
+    export function sendRequest(
+
+      extensionId: string,
+
+      request: any,
+    ): Promise<any>;
+
+    /**
+     * Sends a single request to other listeners within the extension. Similar to {@link runtime.connect}, but only sends a single request with an optional response. The {@link extension.onRequest} event is fired in each page of the extension.
+     *
+     * @chrome-returns-extra since Pending
+     * @deprecated Please use {@link runtime.sendMessage}.
+     * @chrome-max-manifest MV2
+     */
+    export function sendRequest(
+
+      request: any,
+    ): Promise<any>;
+
     /**
      * Sends a single request to other listeners within the extension. Similar to {@link runtime.connect}, but only sends a single request with an optional response. The {@link extension.onRequest} event is fired in each page of the extension.
      *
@@ -12502,8 +12529,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
@@ -12520,8 +12548,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
@@ -22457,6 +22486,14 @@ declare namespace chrome {
       reason: OnRestartRequiredReason,
     ) => void>;
 
+    /**
+     * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
+     *
+     * @chrome-returns-extra since Pending
+     * @chrome-disallow-service-workers
+     */
+    export function getBackgroundPage(): Promise<Window | undefined>;
+
     /**
      * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
      *
@@ -22467,11 +22504,22 @@ declare namespace chrome {
       /**
        * @param backgroundPage The JavaScript 'window' object for the background page.
        */
-      callback: (
+      callback?: (
         backgroundPage?: Window,
       ) => void,
     ): void;
 
+    /**
+     * Open your Extension's options page, if possible.
+     *
+     * The precise behavior may depend on your manifest's `[options_ui](https://developer.chrome.com/docs/extensions/optionsV2)` or `[options_page](https://developer.chrome.com/docs/extensions/options)` key, or what Chrome happens to support at the time. For example, the page may be opened in a new tab, within chrome://extensions, within an App, or it may just focus an open options page. It will never cause the caller page to reload.
+     *
+     * If your Extension does not declare an options page, or Chrome failed to create one for some other reason, the callback will set {@link lastError}.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function openOptionsPage(): Promise<void>;
+
     /**
      * Open your Extension's options page, if possible.
      *
@@ -22502,6 +22550,17 @@ declare namespace chrome {
       path: string,
     ): string;
 
+    /**
+     * Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.
+     *
+     * @chrome-returns-extra since Pending
+     * @param url URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation.
+     */
+    export function setUninstallURL(
+
+      url: string,
+    ): Promise<void>;
+
     /**
      * Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.
      *
@@ -22553,6 +22612,18 @@ declare namespace chrome {
      */
     export function restart(): void;
 
+    /**
+     * Restart the ChromeOS device when the app runs in kiosk mode after the given seconds. If called again before the time ends, the reboot will be delayed. If called with a value of -1, the reboot will be cancelled. It's a no-op in non-kiosk mode. It's only allowed to be called repeatedly by the first extension to invoke this API.
+     *
+     * @chrome-returns-extra since Pending
+     * @param seconds Time to wait in seconds before rebooting the device, or -1 to cancel a scheduled reboot.
+     * @since Chrome 53
+     */
+    export function restartAfterDelay(
+
+      seconds: number,
+    ): Promise<void>;
+
     /**
      * Restart the ChromeOS device when the app runs in kiosk mode after the given seconds. If called again before the time ends, the reboot will be delayed. If called with a value of -1, the reboot will be cancelled. It's a no-op in non-kiosk mode. It's only allowed to be called repeatedly by the first extension to invoke this API.
      *
@@ -22603,6 +22674,47 @@ declare namespace chrome {
       application: string,
     ): Port;
 
+    /**
+     * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
+     *
+     * @chrome-returns-extra since Pending
+     * @param extensionId The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for [web messaging](https://developer.chrome.com/docs/extensions/manifest/externally_connectable).
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      extensionId: string,
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.
+         */
+        includeTlsChannelId?: boolean,
+      },
+    ): Promise<any>;
+
+    /**
+     * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.
+         */
+        includeTlsChannelId?: boolean,
+      },
+    ): Promise<any>;
+
     /**
      * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
      *
@@ -22625,8 +22737,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
@@ -22650,12 +22763,28 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
 
+    /**
+     * Send a single message to a native application.
+     *
+     * @chrome-returns-extra since Pending
+     * @param application The name of the native messaging host.
+     * @param message The message that will be passed to the native messaging host.
+     * @chrome-permission nativeMessaging
+     */
+    export function sendNativeMessage(
+
+      application: string,
+
+      message: {[name: string]: any},
+    ): Promise<any>;
+
     /**
      * Send a single message to a native application.
      *
@@ -22671,12 +22800,20 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
 
+    /**
+     * Returns information about the current platform.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getPlatformInfo(): Promise<PlatformInfo>;
+
     /**
      * Returns information about the current platform.
      *
@@ -22684,7 +22821,7 @@ declare namespace chrome {
      */
     export function getPlatformInfo(
 
-      callback: (
+      callback?: (
         platformInfo: PlatformInfo,
       ) => void,
     ): void;
@@ -27954,6 +28091,20 @@ declare namespace chrome {
       },
     ): runtime.Port;
 
+    /**
+     * Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link extension.onRequest} event is fired in each content script running in the specified tab for the current extension.
+     *
+     * @chrome-returns-extra since Pending
+     * @deprecated Please use {@link runtime.sendMessage}.
+     * @chrome-max-manifest MV2
+     */
+    export function sendRequest(
+
+      tabId: number,
+
+      request: any,
+    ): Promise<any>;
+
     /**
      * Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link extension.onRequest} event is fired in each content script running in the specified tab for the current extension.
      *
@@ -27968,12 +28119,34 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
 
+    /**
+     * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      tabId: number,
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Send a message to a specific [frame](https://developer.chrome.com/docs/extensions/reference/webNavigation/#frame_ids) identified by `frameId` instead of all frames in the tab.
+         */
+        frameId?: number,
+      },
+    ): Promise<any>;
+
     /**
      * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
      *
@@ -27995,8 +28168,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;

package/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Wed Dec 15 2021 22:29:01 GMT+0000 (Coordinated Universal Time)
-// Built at 3b76b1d66afc55f20ba6462f45fbafd2d3d026d6
+// Generated on Sat Jan 01 2022 22:28:03 GMT+0000 (Coordinated Universal Time)
+// Built at 06fe0d4ea8eed0657b3cbed751442d15746d0af5
 
 // Includes MV3+ APIs only.
 
@@ -15368,6 +15368,14 @@ declare namespace chrome {
       reason: OnRestartRequiredReason,
     ) => void>;
 
+    /**
+     * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
+     *
+     * @chrome-returns-extra since Pending
+     * @chrome-disallow-service-workers
+     */
+    export function getBackgroundPage(): Promise<Window | undefined>;
+
     /**
      * Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set.
      *
@@ -15378,11 +15386,22 @@ declare namespace chrome {
       /**
        * @param backgroundPage The JavaScript 'window' object for the background page.
        */
-      callback: (
+      callback?: (
         backgroundPage?: Window,
       ) => void,
     ): void;
 
+    /**
+     * Open your Extension's options page, if possible.
+     *
+     * The precise behavior may depend on your manifest's `[options_ui](https://developer.chrome.com/docs/extensions/optionsV2)` or `[options_page](https://developer.chrome.com/docs/extensions/options)` key, or what Chrome happens to support at the time. For example, the page may be opened in a new tab, within chrome://extensions, within an App, or it may just focus an open options page. It will never cause the caller page to reload.
+     *
+     * If your Extension does not declare an options page, or Chrome failed to create one for some other reason, the callback will set {@link lastError}.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function openOptionsPage(): Promise<void>;
+
     /**
      * Open your Extension's options page, if possible.
      *
@@ -15413,6 +15432,17 @@ declare namespace chrome {
       path: string,
     ): string;
 
+    /**
+     * Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.
+     *
+     * @chrome-returns-extra since Pending
+     * @param url URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation.
+     */
+    export function setUninstallURL(
+
+      url: string,
+    ): Promise<void>;
+
     /**
      * Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.
      *
@@ -15464,6 +15494,18 @@ declare namespace chrome {
      */
     export function restart(): void;
 
+    /**
+     * Restart the ChromeOS device when the app runs in kiosk mode after the given seconds. If called again before the time ends, the reboot will be delayed. If called with a value of -1, the reboot will be cancelled. It's a no-op in non-kiosk mode. It's only allowed to be called repeatedly by the first extension to invoke this API.
+     *
+     * @chrome-returns-extra since Pending
+     * @param seconds Time to wait in seconds before rebooting the device, or -1 to cancel a scheduled reboot.
+     * @since Chrome 53
+     */
+    export function restartAfterDelay(
+
+      seconds: number,
+    ): Promise<void>;
+
     /**
      * Restart the ChromeOS device when the app runs in kiosk mode after the given seconds. If called again before the time ends, the reboot will be delayed. If called with a value of -1, the reboot will be cancelled. It's a no-op in non-kiosk mode. It's only allowed to be called repeatedly by the first extension to invoke this API.
      *
@@ -15514,6 +15556,47 @@ declare namespace chrome {
       application: string,
     ): Port;
 
+    /**
+     * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
+     *
+     * @chrome-returns-extra since Pending
+     * @param extensionId The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for [web messaging](https://developer.chrome.com/docs/extensions/manifest/externally_connectable).
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      extensionId: string,
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.
+         */
+        includeTlsChannelId?: boolean,
+      },
+    ): Promise<any>;
+
+    /**
+     * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.
+         */
+        includeTlsChannelId?: boolean,
+      },
+    ): Promise<any>;
+
     /**
      * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to {@link runtime.connect} but only sends a single message, with an optional response. If sending to your extension, the {@link runtime.onMessage} event will be fired in every frame of your extension (except for the sender's frame), or {@link runtime.onMessageExternal}, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use {@link tabs.sendMessage}.
      *
@@ -15536,8 +15619,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
@@ -15561,12 +15645,28 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
 
+    /**
+     * Send a single message to a native application.
+     *
+     * @chrome-returns-extra since Pending
+     * @param application The name of the native messaging host.
+     * @param message The message that will be passed to the native messaging host.
+     * @chrome-permission nativeMessaging
+     */
+    export function sendNativeMessage(
+
+      application: string,
+
+      message: {[name: string]: any},
+    ): Promise<any>;
+
     /**
      * Send a single message to a native application.
      *
@@ -15582,12 +15682,20 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;
 
+    /**
+     * Returns information about the current platform.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getPlatformInfo(): Promise<PlatformInfo>;
+
     /**
      * Returns information about the current platform.
      *
@@ -15595,7 +15703,7 @@ declare namespace chrome {
      */
     export function getPlatformInfo(
 
-      callback: (
+      callback?: (
         platformInfo: PlatformInfo,
       ) => void,
     ): void;
@@ -18348,6 +18456,27 @@ declare namespace chrome {
       },
     ): runtime.Port;
 
+    /**
+     * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message The message to send. This message should be a JSON-ifiable object.
+     */
+    export function sendMessage(
+
+      tabId: number,
+
+      message: any,
+
+      options?: {
+
+        /**
+         * Send a message to a specific [frame](https://developer.chrome.com/docs/extensions/reference/webNavigation/#frame_ids) identified by `frameId` instead of all frames in the tab.
+         */
+        frameId?: number,
+      },
+    ): Promise<any>;
+
     /**
      * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The {@link runtime.onMessage} event is fired in each content script running in the specified tab for the current extension.
      *
@@ -18369,8 +18498,9 @@ 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
        */
-      responseCallback?: (
+      callback?: (
         response: any,
       ) => void,
     ): void;

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "5dbc01a35996ed47"
+    "build-hash": "1bd2fdd933fcc8f3"
   },
   "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.74"
+  "version": "0.1.78"
 }