chrome-types 0.1.74 → 0.1.75

package/_all.d.ts

@@ -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 Thu Dec 23 2021 22:27:55 GMT+0000 (Coordinated Universal Time)
+// Built at 1c12e5c64d415f66405ebf2161c9d396ccd0fd6c
 
 // 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;
@@ -22603,6 +22632,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 +22695,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,8 +22721,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;
@@ -27954,6 +28026,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 +28054,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 +28103,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 Wed Dec 15 2021 22:29:01 GMT+0000 (Coordinated Universal Time)
-// Built at 3b76b1d66afc55f20ba6462f45fbafd2d3d026d6
+// Generated on Thu Dec 23 2021 22:27:51 GMT+0000 (Coordinated Universal Time)
+// Built at 1c12e5c64d415f66405ebf2161c9d396ccd0fd6c
 
 // Includes MV3+ APIs only.
 
@@ -15514,6 +15514,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 +15577,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,8 +15603,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;
@@ -18348,6 +18391,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 +18433,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": "f90541d5ad8767fe"
   },
   "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.75"
 }