@types/chrome 0.0.249 → 0.0.251

chrome/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for chrome (http://developer.chrome.com/e
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome.
 
 ### Additional Details
- * Last updated: Mon, 06 Nov 2023 04:17:54 GMT
+ * Last updated: Thu, 09 Nov 2023 17:36:25 GMT
  * Dependencies: [@types/filesystem](https://npmjs.com/package/@types/filesystem), [@types/har-format](https://npmjs.com/package/@types/har-format)
 
 # Credits

chrome/index.d.ts

@@ -12565,31 +12565,139 @@ declare namespace chrome.declarativeNetRequest {
  */
 declare namespace chrome.sidePanel {
     export interface GetPanelOptions {
+        /**
+         * If specified, the side panel options for the given tab will be returned.
+         * Otherwise, returns the default side panel options (used for any tab that doesn't have specific settings).
+         */
         tabId?: number;
     }
 
+    /**
+     * @since Chrome 116
+     */
+    export type OpenOptions =
+        & {
+            /** The tab in which to open the side panel.
+             * If the corresponding tab has a tab-specific side panel, the panel will only be open for that tab.
+             * If there is not a tab-specific panel, the global panel will be open in the specified tab and any other tabs without a currently-open tab- specific panel.
+             * This will override any currently-active side panel (global or tab-specific) in the corresponding tab.
+             * At least one of this and windowId must be provided. */
+            tabId?: number;
+            /**
+             * The window in which to open the side panel.
+             * This is only applicable if the extension has a global (non-tab-specific) side panel or tabId is also specified.
+             * This will override any currently-active global side panel the user has open in the given window.
+             * At least one of this and tabId must be provided.
+             */
+            windowId?: number;
+        }
+        & ({
+            tabId: number;
+        } | {
+            windowId: number;
+        });
+
     export interface PanelBehavior {
+        /** Whether clicking the extension's icon will toggle showing the extension's entry in the side panel. Defaults to false. */
         openPanelOnActionClick?: boolean;
     }
 
     export interface PanelOptions {
+        /** Whether the side panel should be enabled. This is optional. The default value is true. */
         enabled?: boolean;
+        /** The path to the side panel HTML file to use. This must be a local resource within the extension package. */
         path?: string;
+        /**
+         * If specified, the side panel options will only apply to the tab with this id.
+         * If omitted, these options set the default behavior (used for any tab that doesn't have specific settings).
+         * Note: if the same path is set for this tabId and the default tabId, then the panel for this tabId will be a different instance than the panel for the default tabId.
+         */
         tabId?: number;
     }
 
     export interface SidePanel {
+        /** Developer specified path for side panel display. */
         default_path: string;
     }
 
+    /**
+     * Returns the active panel configuration.
+     * Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility.
+     * You cannot use both on the same function call.
+     * The promise resolves with the same type that is passed to the callback.
+     */
+    export function getOptions(
+        /** Specifies the context to return the configuration for. */
+        options: GetPanelOptions,
+        callback: (options: PanelOptions) => void,
+    ): void;
+
     export function getOptions(
+        /** Specifies the context to return the configuration for. */
         options: GetPanelOptions,
-        callback?: (options: PanelOptions) => void,
     ): Promise<PanelOptions>;
 
-    export function getPanelBehavior(callback?: (behavior: PanelBehavior) => void): Promise<PanelBehavior>;
+    /**
+     * Returns the extension's current side panel behavior.
+     * Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility.
+     * You cannot use both on the same function call.
+     * The promise resolves with the same type that is passed to the callback.
+     */
+    export function getPanelBehavior(
+        callback: (behavior: PanelBehavior) => void,
+    ): void;
+
+    export function getPanelBehavior(): Promise<PanelBehavior>;
+
+    /**
+     * @since Chrome 116
+     * Opens the side panel for the extension. This may only be called in response to a user action.
+     * Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility.
+     * You cannot use both on the same function call.
+     * The promise resolves with the same type that is passed to the callback.
+     */
+    export function open(
+        /** Specifies the context in which to open the side panel. */
+        options: OpenOptions,
+        callback: () => void,
+    ): void;
+
+    export function open(
+        /** Specifies the context in which to open the side panel. */
+        options: OpenOptions,
+    ): Promise<void>;
 
-    export function setOptions(options: PanelOptions, callback?: () => void): Promise<void>;
+    /**
+     * Configures the side panel.
+     * Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility.
+     * You cannot use both on the same function call.
+     * The promise resolves with the same type that is passed to the callback.
+     */
+    export function setOptions(
+        /** The configuration options to apply to the panel. */
+        options: PanelOptions,
+        callback: () => void,
+    ): void;
+
+    export function setOptions(
+        /** The configuration options to apply to the panel. */
+        options: PanelOptions,
+    ): Promise<void>;
+
+    /**
+     * Configures the extension's side panel behavior. This is an upsert operation.
+     * Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility.
+     * You cannot use both on the same function call.
+     * The promise resolves with the same type that is passed to the callback.
+     */
+    export function setPanelBehavior(
+        /** The new behavior to be set. */
+        behavior: PanelBehavior,
+        callback: () => void,
+    ): void;
 
-    export function setPanelBehavior(behavior: PanelBehavior, callback?: () => void): Promise<void>;
+    export function setPanelBehavior(
+        /** The new behavior to be set. */
+        behavior: PanelBehavior,
+    ): Promise<void>;
 }

chrome/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/chrome",
-    "version": "0.0.249",
+    "version": "0.0.251",
     "description": "TypeScript definitions for chrome",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome",
     "license": "MIT",
@@ -93,6 +93,6 @@
         "@types/filesystem": "*",
         "@types/har-format": "*"
     },
-    "typesPublisherContentHash": "959c4fddc2ba530d4e6fb5827335ea056d9a7ca9143041ebf421f18168571d16",
+    "typesPublisherContentHash": "c573dbaafc6ec5b81d1e2706b1c732aaeb55cf9541939c5ff4ea29c521af1abb",
     "typeScriptVersion": "4.5"
 }