chrome-types 0.1.127 → 0.1.130

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Mon Jul 18 2022 22:29:33 GMT+0000 (Coordinated Universal Time)
-// Built at 5a3f9deda7d79e7e5ecaa8a66730a87348a3e854
+// Generated on Fri Jul 22 2022 22:29:32 GMT+0000 (Coordinated Universal Time)
+// Built at 685e5a75f8909c7e95143e95755e307331578249
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -3544,7 +3544,7 @@ declare namespace chrome {
       transport?: Transport;
 
       /**
-       * The remaining battery of the device. TODO(https://crbug.com/973237): This field is only used by Chrome OS and it is different from others because it is not filled by the platform. In the future, when there is a unified Mojo service, this field will be moved to BluetoothDeviceInfo.
+       * The remaining battery of the device.
        *
        * @since Chrome 77
        */
@@ -11759,6 +11759,17 @@ declare namespace chrome {
       size?: 16 | 32;
     }
 
+    /**
+     * @since Pending
+     */
+    export interface UiOptions {
+
+      /**
+       * Enable or disable the download UI.
+       */
+      enabled: boolean;
+    }
+
     /**
      * This event fires with the {@link DownloadItem} object when a download begins.
      */
@@ -12038,6 +12049,31 @@ declare namespace chrome {
 
       enabled: boolean,
     ): void;
+
+    /**
+     * Change the download UI of every window associated with the current browser profile. As long as at least one extension has set {@link UiOptions.enabled} to false, the download UI will be hidden. Setting {@link UiOptions.enabled} to true while at least one other extension has disabled it will return an error through {@link runtime.lastError}. Requires the `"downloads.ui"` permission in addition to the `"downloads"` permission.
+     *
+     * @param options Encapsulate a change to the download UI.
+     * @since Pending
+     */
+    export function setUiOptions(
+
+      options: UiOptions,
+    ): Promise<void>;
+
+    /**
+     * Change the download UI of every window associated with the current browser profile. As long as at least one extension has set {@link UiOptions.enabled} to false, the download UI will be hidden. Setting {@link UiOptions.enabled} to true while at least one other extension has disabled it will return an error through {@link runtime.lastError}. Requires the `"downloads.ui"` permission in addition to the `"downloads"` permission.
+     *
+     * @param options Encapsulate a change to the download UI.
+     * @param callback Called when the UI update is completed.
+     * @since Pending
+     */
+    export function setUiOptions(
+
+      options: UiOptions,
+
+      callback?: () => void,
+    ): void;
   }
 
   /**
@@ -16314,6 +16350,15 @@ declare namespace chrome {
       signedIn: boolean,
     ) => void>;
 
+    /**
+     * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
+     *
+     * `getAccounts` is only supported on dev channel.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getAccounts(): Promise<AccountInfo[]>;
+
     /**
      * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
      *
@@ -16321,7 +16366,7 @@ declare namespace chrome {
      */
     export function getAccounts(
 
-      callback: (
+      callback?: (
         accounts: AccountInfo[],
       ) => void,
     ): void;
@@ -16374,20 +16419,16 @@ declare namespace chrome {
      *
      * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
      *
+     * @chrome-returns-extra since Pending
      * @param details Profile options.
-     * @param callback Called with the `ProfileUserInfo` of the primary Chrome account, of an empty `ProfileUserInfo` if the account with given `details` doesn't exist.
      */
     export function getProfileUserInfo(
 
       /**
        * @since Chrome 84
        */
-      details: ProfileDetails,
-
-      callback: (
-        userInfo: ProfileUserInfo,
-      ) => void,
-    ): void;
+      details?: ProfileDetails,
+    ): Promise<ProfileUserInfo>;
 
     /**
      * Retrieves email address and obfuscated gaia id of the user signed into a profile.
@@ -16396,15 +16437,34 @@ declare namespace chrome {
      *
      * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
      *
+     * @param details Profile options.
      * @param callback Called with the `ProfileUserInfo` of the primary Chrome account, of an empty `ProfileUserInfo` if the account with given `details` doesn't exist.
      */
     export function getProfileUserInfo(
 
-      callback: (
+      /**
+       * @since Chrome 84
+       */
+      details?: ProfileDetails,
+
+      callback?: (
         userInfo: ProfileUserInfo,
       ) => void,
     ): void;
 
+    /**
+     * Removes an OAuth2 access token from the Identity API's token cache.
+     *
+     * If an access token is discovered to be invalid, it should be passed to removeCachedAuthToken to remove it from the cache. The app may then retrieve a fresh token with `getAuthToken`.
+     *
+     * @chrome-returns-extra since Pending
+     * @param details Token information.
+     */
+    export function removeCachedAuthToken(
+
+      details: InvalidTokenDetails,
+    ): Promise<void>;
+
     /**
      * Removes an OAuth2 access token from the Identity API's token cache.
      *
@@ -16420,6 +16480,18 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Resets the state of the Identity API:
+     *
+     * *   Removes all OAuth2 access tokens from the token cache
+     * *   Removes user's account preferences
+     * *   De-authorizes the user from all auth flows
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 87
+     */
+    export function clearAllCachedAuthTokens(): Promise<void>;
+
     /**
      * Resets the state of the Identity API:
      *
@@ -16432,9 +16504,24 @@ declare namespace chrome {
      */
     export function clearAllCachedAuthTokens(
 
-      callback: () => void,
+      callback?: () => void,
     ): void;
 
+    /**
+     * Starts an auth flow at the specified URL.
+     *
+     * This method enables auth flows with non-Google identity providers by launching a web view and navigating it to the first URL in the provider's auth flow. When the provider redirects to a URL matching the pattern `https://<app-id>.chromiumapp.org/*`, the window will close, and the final redirect URL will be passed to the `callback` function.
+     *
+     * For a good user experience it is important interactive auth flows are initiated by UI in your app explaining what the authorization is for. Failing to do this will cause your users to get authorization requests with no context. In particular, do not launch an interactive auth flow when your app is first launched.
+     *
+     * @chrome-returns-extra since Pending
+     * @param details WebAuth flow options.
+     */
+    export function launchWebAuthFlow(
+
+      details: WebAuthFlowDetails,
+    ): Promise<string | undefined>;
+
     /**
      * Starts an auth flow at the specified URL.
      *
@@ -16449,7 +16536,7 @@ declare namespace chrome {
 
       details: WebAuthFlowDetails,
 
-      callback: (
+      callback?: (
         responseUrl?: string,
       ) => void,
     ): void;

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Mon Jul 18 2022 22:29:28 GMT+0000 (Coordinated Universal Time)
-// Built at 5a3f9deda7d79e7e5ecaa8a66730a87348a3e854
+// Generated on Fri Jul 22 2022 22:29:27 GMT+0000 (Coordinated Universal Time)
+// Built at 685e5a75f8909c7e95143e95755e307331578249
 
 // Includes MV3+ APIs only.
 
@@ -7965,6 +7965,17 @@ declare namespace chrome {
       size?: 16 | 32;
     }
 
+    /**
+     * @since Pending
+     */
+    export interface UiOptions {
+
+      /**
+       * Enable or disable the download UI.
+       */
+      enabled: boolean;
+    }
+
     /**
      * This event fires with the {@link DownloadItem} object when a download begins.
      */
@@ -8244,6 +8255,31 @@ declare namespace chrome {
 
       enabled: boolean,
     ): void;
+
+    /**
+     * Change the download UI of every window associated with the current browser profile. As long as at least one extension has set {@link UiOptions.enabled} to false, the download UI will be hidden. Setting {@link UiOptions.enabled} to true while at least one other extension has disabled it will return an error through {@link runtime.lastError}. Requires the `"downloads.ui"` permission in addition to the `"downloads"` permission.
+     *
+     * @param options Encapsulate a change to the download UI.
+     * @since Pending
+     */
+    export function setUiOptions(
+
+      options: UiOptions,
+    ): Promise<void>;
+
+    /**
+     * Change the download UI of every window associated with the current browser profile. As long as at least one extension has set {@link UiOptions.enabled} to false, the download UI will be hidden. Setting {@link UiOptions.enabled} to true while at least one other extension has disabled it will return an error through {@link runtime.lastError}. Requires the `"downloads.ui"` permission in addition to the `"downloads"` permission.
+     *
+     * @param options Encapsulate a change to the download UI.
+     * @param callback Called when the UI update is completed.
+     * @since Pending
+     */
+    export function setUiOptions(
+
+      options: UiOptions,
+
+      callback?: () => void,
+    ): void;
   }
 
   /**
@@ -11850,6 +11886,15 @@ declare namespace chrome {
       signedIn: boolean,
     ) => void>;
 
+    /**
+     * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
+     *
+     * `getAccounts` is only supported on dev channel.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getAccounts(): Promise<AccountInfo[]>;
+
     /**
      * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
      *
@@ -11857,7 +11902,7 @@ declare namespace chrome {
      */
     export function getAccounts(
 
-      callback: (
+      callback?: (
         accounts: AccountInfo[],
       ) => void,
     ): void;
@@ -11910,20 +11955,16 @@ declare namespace chrome {
      *
      * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
      *
+     * @chrome-returns-extra since Pending
      * @param details Profile options.
-     * @param callback Called with the `ProfileUserInfo` of the primary Chrome account, of an empty `ProfileUserInfo` if the account with given `details` doesn't exist.
      */
     export function getProfileUserInfo(
 
       /**
        * @since Chrome 84
        */
-      details: ProfileDetails,
-
-      callback: (
-        userInfo: ProfileUserInfo,
-      ) => void,
-    ): void;
+      details?: ProfileDetails,
+    ): Promise<ProfileUserInfo>;
 
     /**
      * Retrieves email address and obfuscated gaia id of the user signed into a profile.
@@ -11932,15 +11973,34 @@ declare namespace chrome {
      *
      * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
      *
+     * @param details Profile options.
      * @param callback Called with the `ProfileUserInfo` of the primary Chrome account, of an empty `ProfileUserInfo` if the account with given `details` doesn't exist.
      */
     export function getProfileUserInfo(
 
-      callback: (
+      /**
+       * @since Chrome 84
+       */
+      details?: ProfileDetails,
+
+      callback?: (
         userInfo: ProfileUserInfo,
       ) => void,
     ): void;
 
+    /**
+     * Removes an OAuth2 access token from the Identity API's token cache.
+     *
+     * If an access token is discovered to be invalid, it should be passed to removeCachedAuthToken to remove it from the cache. The app may then retrieve a fresh token with `getAuthToken`.
+     *
+     * @chrome-returns-extra since Pending
+     * @param details Token information.
+     */
+    export function removeCachedAuthToken(
+
+      details: InvalidTokenDetails,
+    ): Promise<void>;
+
     /**
      * Removes an OAuth2 access token from the Identity API's token cache.
      *
@@ -11956,6 +12016,18 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Resets the state of the Identity API:
+     *
+     * *   Removes all OAuth2 access tokens from the token cache
+     * *   Removes user's account preferences
+     * *   De-authorizes the user from all auth flows
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 87
+     */
+    export function clearAllCachedAuthTokens(): Promise<void>;
+
     /**
      * Resets the state of the Identity API:
      *
@@ -11968,9 +12040,24 @@ declare namespace chrome {
      */
     export function clearAllCachedAuthTokens(
 
-      callback: () => void,
+      callback?: () => void,
     ): void;
 
+    /**
+     * Starts an auth flow at the specified URL.
+     *
+     * This method enables auth flows with non-Google identity providers by launching a web view and navigating it to the first URL in the provider's auth flow. When the provider redirects to a URL matching the pattern `https://<app-id>.chromiumapp.org/*`, the window will close, and the final redirect URL will be passed to the `callback` function.
+     *
+     * For a good user experience it is important interactive auth flows are initiated by UI in your app explaining what the authorization is for. Failing to do this will cause your users to get authorization requests with no context. In particular, do not launch an interactive auth flow when your app is first launched.
+     *
+     * @chrome-returns-extra since Pending
+     * @param details WebAuth flow options.
+     */
+    export function launchWebAuthFlow(
+
+      details: WebAuthFlowDetails,
+    ): Promise<string | undefined>;
+
     /**
      * Starts an auth flow at the specified URL.
      *
@@ -11985,7 +12072,7 @@ declare namespace chrome {
 
       details: WebAuthFlowDetails,
 
-      callback: (
+      callback?: (
         responseUrl?: string,
       ) => void,
     ): void;

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "283635a1aec31c5e"
+    "build-hash": "2e32c6686bea76c3"
   },
   "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.127"
+  "version": "0.1.130"
 }