chrome-types 0.1.72 → 0.1.76

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sun Nov 28 2021 22:27:41 GMT+0000 (Coordinated Universal Time)
-// Built at 1eb17e15be59ac864df2dd46b1d5cf8452086414
+// Generated on Tue Dec 28 2021 22:28:31 GMT+0000 (Coordinated Universal Time)
+// Built at 7965be8be52e2689ad17e4cdf599aa2fc88fb968
 
 // 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;
@@ -12589,6 +12618,13 @@ declare namespace chrome {
       windowId?: number,
     ): Window[];
 
+    /**
+     * Retrieves the state of the extension's access to Incognito-mode. This corresponds to the user-controlled per-extension 'Allowed in Incognito' setting accessible via the chrome://extensions page.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isAllowedIncognitoAccess(): Promise<boolean>;
+
     /**
      * Retrieves the state of the extension's access to Incognito-mode. This corresponds to the user-controlled per-extension 'Allowed in Incognito' setting accessible via the chrome://extensions page.
      */
@@ -12597,11 +12633,18 @@ declare namespace chrome {
       /**
        * @param isAllowedAccess True if the extension has access to Incognito mode, false otherwise.
        */
-      callback: (
+      callback?: (
         isAllowedAccess: boolean,
       ) => void,
     ): void;
 
+    /**
+     * Retrieves the state of the extension's access to the 'file://' scheme. This corresponds to the user-controlled per-extension 'Allow access to File URLs' setting accessible via the chrome://extensions page.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isAllowedFileSchemeAccess(): Promise<boolean>;
+
     /**
      * Retrieves the state of the extension's access to the 'file://' scheme. This corresponds to the user-controlled per-extension 'Allow access to File URLs' setting accessible via the chrome://extensions page.
      */
@@ -12610,7 +12653,7 @@ declare namespace chrome {
       /**
        * @param isAllowedAccess True if the extension can access the 'file://' scheme, false otherwise.
        */
-      callback: (
+      callback?: (
         isAllowedAccess: boolean,
       ) => void,
     ): void;
@@ -12990,6 +13033,7 @@ declare namespace chrome {
    * @chrome-permission fileBrowserHandler
    * @chrome-disallow-service-workers
    * @chrome-platform chromeos
+   * @chrome-platform lacros
    */
   export namespace fileBrowserHandler {
 
@@ -22442,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.
      *
@@ -22452,7 +22504,7 @@ declare namespace chrome {
       /**
        * @param backgroundPage The JavaScript 'window' object for the background page.
        */
-      callback: (
+      callback?: (
         backgroundPage?: Window,
       ) => void,
     ): void;
@@ -22588,6 +22640,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}.
      *
@@ -22610,8 +22703,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;
@@ -22635,12 +22729,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.
      *
@@ -22656,8 +22766,9 @@ 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;
@@ -27120,7 +27231,7 @@ declare namespace chrome {
     /**
      * The group's color.
      */
-    export type Color = "grey" | "blue" | "red" | "yellow" | "green" | "pink" | "purple" | "cyan";
+    export type Color = "grey" | "blue" | "red" | "yellow" | "green" | "pink" | "purple" | "cyan" | "orange";
 
     export interface TabGroup {
 
@@ -27939,6 +28050,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.
      *
@@ -27953,12 +28078,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.
      *
@@ -27980,8 +28127,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

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sun Nov 28 2021 22:27:36 GMT+0000 (Coordinated Universal Time)
-// Built at 1eb17e15be59ac864df2dd46b1d5cf8452086414
+// Generated on Tue Dec 28 2021 22:28:26 GMT+0000 (Coordinated Universal Time)
+// Built at 7965be8be52e2689ad17e4cdf599aa2fc88fb968
 
 // Includes MV3+ APIs only.
 
@@ -8455,6 +8455,13 @@ declare namespace chrome {
      */
     export function getBackgroundPage(): Window | undefined;
 
+    /**
+     * Retrieves the state of the extension's access to Incognito-mode. This corresponds to the user-controlled per-extension 'Allowed in Incognito' setting accessible via the chrome://extensions page.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isAllowedIncognitoAccess(): Promise<boolean>;
+
     /**
      * Retrieves the state of the extension's access to Incognito-mode. This corresponds to the user-controlled per-extension 'Allowed in Incognito' setting accessible via the chrome://extensions page.
      */
@@ -8463,11 +8470,18 @@ declare namespace chrome {
       /**
        * @param isAllowedAccess True if the extension has access to Incognito mode, false otherwise.
        */
-      callback: (
+      callback?: (
         isAllowedAccess: boolean,
       ) => void,
     ): void;
 
+    /**
+     * Retrieves the state of the extension's access to the 'file://' scheme. This corresponds to the user-controlled per-extension 'Allow access to File URLs' setting accessible via the chrome://extensions page.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function isAllowedFileSchemeAccess(): Promise<boolean>;
+
     /**
      * Retrieves the state of the extension's access to the 'file://' scheme. This corresponds to the user-controlled per-extension 'Allow access to File URLs' setting accessible via the chrome://extensions page.
      */
@@ -8476,7 +8490,7 @@ declare namespace chrome {
       /**
        * @param isAllowedAccess True if the extension can access the 'file://' scheme, false otherwise.
        */
-      callback: (
+      callback?: (
         isAllowedAccess: boolean,
       ) => void,
     ): void;
@@ -8856,6 +8870,7 @@ declare namespace chrome {
    * @chrome-permission fileBrowserHandler
    * @chrome-disallow-service-workers
    * @chrome-platform chromeos
+   * @chrome-platform lacros
    */
   export namespace fileBrowserHandler {
 
@@ -15353,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.
      *
@@ -15363,7 +15386,7 @@ declare namespace chrome {
       /**
        * @param backgroundPage The JavaScript 'window' object for the background page.
        */
-      callback: (
+      callback?: (
         backgroundPage?: Window,
       ) => void,
     ): void;
@@ -15499,6 +15522,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}.
      *
@@ -15521,8 +15585,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;
@@ -15546,12 +15611,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.
      *
@@ -15567,8 +15648,9 @@ 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;
@@ -17569,7 +17651,7 @@ declare namespace chrome {
     /**
      * The group's color.
      */
-    export type Color = "grey" | "blue" | "red" | "yellow" | "green" | "pink" | "purple" | "cyan";
+    export type Color = "grey" | "blue" | "red" | "yellow" | "green" | "pink" | "purple" | "cyan" | "orange";
 
     export interface TabGroup {
 
@@ -18333,6 +18415,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.
      *
@@ -18354,8 +18457,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": "2c997a3731772930"
+    "build-hash": "41b904c21a85313d"
   },
   "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.72"
+  "version": "0.1.76"
 }