@types/chrome 0.0.306 → 0.0.307

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: Fri, 21 Feb 2025 18:03:10 GMT
+ * Last updated: Fri, 28 Feb 2025 08:36:18 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

@@ -5576,7 +5576,6 @@ declare namespace chrome {
      * Permissions: "identity"
      */
     export namespace identity {
-        /** @since Chrome 32 */
         export interface AccountInfo {
             /** A unique identifier for the account. This ID will not change for the lifetime of the account. */
             id: string;
@@ -5584,78 +5583,81 @@ declare namespace chrome {
 
         /** @since Chrome 84 */
         export enum AccountStatus {
+            /** Specifies that Sync is enabled for the primary account. */
             SYNC = "SYNC",
+            /** Specifies the existence of a primary account, if any. */
             ANY = "ANY",
         }
 
+        /** @since Chrome 84 */
         export interface ProfileDetails {
-            /**
-             * Optional.
-             * A status of the primary account signed into a profile whose ProfileUserInfo should be returned. Defaults to SYNC account status.
-             */
-            accountStatus?: AccountStatus | undefined;
+            /** A status of the primary account signed into a profile whose `ProfileUserInfo` should be returned. Defaults to `SYNC` account status. */
+            accountStatus?: `${AccountStatus}`;
         }
 
         export interface TokenDetails {
+            /** Fetching a token may require the user to sign-in to Chrome, or approve the application's requested scopes. If the interactive flag is `true`, `getAuthToken` will prompt the user as necessary. When the flag is `false` or omitted, `getAuthToken` will return failure any time a prompt would be required. */
+            interactive?: boolean;
+            /** The account ID whose token should be returned. If not specified, the function will use an account from the Chrome profile: the Sync account if there is one, or otherwise the first Google web account. */
+            account?: AccountInfo;
             /**
-             * Optional.
-             * Fetching a token may require the user to sign-in to Chrome, or approve the application's requested scopes. If the interactive flag is true, getAuthToken will prompt the user as necessary. When the flag is false or omitted, getAuthToken will return failure any time a prompt would be required.
-             */
-            interactive?: boolean | undefined;
-            /**
-             * Optional.
-             * The account ID whose token should be returned. If not specified, the primary account for the profile will be used.
-             * account is only supported when the "enable-new-profile-management" flag is set.
-             * @since Chrome 37
+             * The `enableGranularPermissions` flag allows extensions to opt-in early to the granular permissions consent screen, in which requested permissions are granted or denied individually.
+             * @since Chrome 87
              */
-            account?: AccountInfo | undefined;
+            enableGranularPermissions?: boolean;
             /**
-             * Optional.
              * A list of OAuth2 scopes to request.
-             * When the scopes field is present, it overrides the list of scopes specified in manifest.json.
-             * @since Chrome 37
+             *
+             * When the `scopes` field is present, it overrides the list of scopes specified in manifest.json.
              */
-            scopes?: string[] | undefined;
+            scopes?: string[];
         }
 
-        export interface UserInfo {
-            /** An email address for the user account signed into the current profile. Empty if the user is not signed in or the identity.email manifest permission is not specified. */
+        export interface ProfileUserInfo {
+            /** An email address for the user account signed into the current profile. Empty if the user is not signed in or the `identity.email` manifest permission is not specified. */
             email: string;
-            /** A unique identifier for the account. This ID will not change for the lifetime of the account. Empty if the user is not signed in or (in M41+) the identity.email manifest permission is not specified. */
+            /** A unique identifier for the account. This ID will not change for the lifetime of the account. Empty if the user is not signed in or (in M41+) the `identity.email` manifest permission is not specified. */
             id: string;
         }
 
-        export interface TokenInformation {
+        export interface InvalidTokenDetails {
             /** The specific token that should be removed from the cache. */
             token: string;
         }
 
-        export interface WebAuthFlowOptions {
+        export interface WebAuthFlowDetails {
             /** The URL that initiates the auth flow. */
             url: string;
+
             /**
-             * Optional.
              * Whether to launch auth flow in interactive mode.
-             * Since some auth flows may immediately redirect to a result URL, launchWebAuthFlow hides its web view until the first navigation either redirects to the final URL, or finishes loading a page meant to be displayed.
-             * If the interactive flag is true, the window will be displayed when a page load completes. If the flag is false or omitted, launchWebAuthFlow will return with an error if the initial navigation does not complete the flow.
+             *
+             * Since some auth flows may immediately redirect to a result URL, `launchWebAuthFlow` hides its web view until the first navigation either redirects to the final URL, or finishes loading a page meant to be displayed.
+             *
+             * If the `interactive` flag is `true`, the window will be displayed when a page load completes. If the flag is `false` or omitted, `launchWebAuthFlow` will return with an error if the initial navigation does not complete the flow.
+             *
+             * For flows that use JavaScript for redirection, `abortOnLoadForNonInteractive` can be set to `false` in combination with setting `timeoutMsForNonInteractive` to give the page a chance to perform any redirects.
              */
-            interactive?: boolean | undefined;
-        }
-
-        export interface SignInChangeEvent
-            extends chrome.events.Event<(account: AccountInfo, signedIn: boolean) => void>
-        {}
-
-        export interface GetAuthTokenResult {
+            interactive?: boolean;
             /**
-             * Optional.
-             * A list of OAuth2 scopes granted to the extension.
+             * Whether to terminate `launchWebAuthFlow` for non-interactive requests after the page loads. This parameter does not affect interactive flows.
+             *
+             * When set to `true` (default) the flow will terminate immediately after the page loads. When set to `false`, the flow will only terminate after the `timeoutMsForNonInteractive` passes. This is useful for identity providers that use JavaScript to perform redirections after the page loads.
+             * @since Chrome 113
              */
-            grantedScopes?: string[];
+            abortOnLoadForNonInteractive?: boolean;
             /**
-             * Optional.
-             * The specific token associated with the request.
+             * The maximum amount of time, in milliseconds, `launchWebAuthFlow` is allowed to run in non-interactive mode in total. Only has an effect if `interactive` is `false`.
+             * @since Chrome 113
              */
+            timeoutMsForNonInteractive?: number;
+        }
+
+        /** @since Chrome 105 */
+        export interface GetAuthTokenResult {
+            /** A list of OAuth2 scopes granted to the extension. */
+            grantedScopes?: string[];
+            /** The specific token associated with the request. */
             token?: string;
         }
 
@@ -5665,81 +5667,86 @@ declare namespace chrome {
          *  * Removes all OAuth2 access tokens from the token cache
          *  * Removes user's account preferences
          *  * De-authorizes the user from all auth flows
-         * If `callback` is not provided, the function returns a Promise when the state has been cleared.
+         *
+         * Can return its result via Promise since Chrome 106.
          * @since Chrome 87
-         * @param callback Called when the state has been cleared.
          */
         export function clearAllCachedAuthTokens(): Promise<void>;
         export function clearAllCachedAuthTokens(callback: () => void): void;
 
         /**
          * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
+         *
          * getAccounts is only supported on dev channel.
-         * Dev channel only.
          */
         export function getAccounts(): Promise<AccountInfo[]>;
         export function getAccounts(callback: (accounts: AccountInfo[]) => void): void;
 
         /**
          * Gets an OAuth2 access token using the client ID and scopes specified in the oauth2 section of manifest.json.
+         *
          * The Identity API caches access tokens in memory, so it's ok to call getAuthToken non-interactively any time a token is required. The token cache automatically handles expiration.
+         *
          * For a good user experience it is important interactive token requests 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, or Chrome sign in screens if they are not signed in, with with no context. In particular, do not use getAuthToken interactively when your app is first launched.
-         * If `callback` is not provided, the function returns a Promise that resolves with the token.
          * @param details Token options.
-         * @param callback Called with an OAuth2 access token as specified by the manifest, or undefined if there was an error.
+         *
+         * Can return its result via Promise since Chrome 105.
          */
-        export function getAuthToken(details: TokenDetails): Promise<GetAuthTokenResult>;
-        export function getAuthToken(
-            details: TokenDetails,
-            callback: (token?: string, grantedScopes?: string[]) => void,
-        ): void;
+        export function getAuthToken(details?: TokenDetails): Promise<GetAuthTokenResult>;
+        export function getAuthToken(details: TokenDetails, callback: (result: GetAuthTokenResult) => void): void;
+        export function getAuthToken(callback: (result: GetAuthTokenResult) => void): void;
 
         /**
          * Retrieves email address and obfuscated gaia id of the user signed into a profile.
+         *
+         * Requires the `identity.email` manifest permission. Otherwise, returns an empty result.
+         *
          * 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.
-         * @since Chrome 37
+         * @param details Profile options.
+         *
+         * Can return its result via Promise since Chrome 105.
          */
-        export function getProfileUserInfo(callback: (userInfo: UserInfo) => void): void;
-
-        /** @since Chrome 84 */
-        export function getProfileUserInfo(details: ProfileDetails, callback: (userInfo: UserInfo) => void): void;
-
-        /** @since Chrome 84 */
-        export function getProfileUserInfo(details?: ProfileDetails): Promise<UserInfo>;
+        export function getProfileUserInfo(details?: ProfileDetails): Promise<ProfileUserInfo>;
+        export function getProfileUserInfo(
+            details: ProfileDetails,
+            callback: (userInfo: ProfileUserInfo) => void,
+        ): void;
+        export function getProfileUserInfo(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.
-         * If `callback` is not provided, the function returns a Promise when the state has been removed from the 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`.
          * @param details Token information.
-         * @param callback Called when the token has been removed from the cache.
+         *
+         * Can return its result via Promise since Chrome 105.
          */
-        export function removeCachedAuthToken(details: TokenInformation): Promise<void>;
-        export function removeCachedAuthToken(details: TokenInformation, callback: () => void): void;
+        export function removeCachedAuthToken(details: InvalidTokenDetails): Promise<void>;
+        export function removeCachedAuthToken(details: InvalidTokenDetails, 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.
+         *
+         * 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.
          * @param details WebAuth flow options.
-         * @param callback Optional. Called with the URL redirected back to your application.
+         *
+         * Can return its result via Promise since Chrome 106
          */
-        export function launchWebAuthFlow(details: WebAuthFlowOptions, callback: (responseUrl?: string) => void): void;
-        export function launchWebAuthFlow(details: WebAuthFlowOptions): Promise<string | undefined>;
+        export function launchWebAuthFlow(details: WebAuthFlowDetails): Promise<string | undefined>;
+        export function launchWebAuthFlow(details: WebAuthFlowDetails, callback: (responseUrl?: string) => void): void;
 
         /**
-         * Generates a redirect URL to be used in launchWebAuthFlow.
-         * The generated URLs match the pattern https://<app-id>.chromiumapp.org/*.
-         * @since Chrome 33
-         * @param path Optional. The path appended to the end of the generated URL.
+         * Generates a redirect URL to be used in `launchWebAuthFlow`.
+         *
+         * The generated URLs match the pattern `https://<app-id>.chromiumapp.org/*`.
+         * @param path The path appended to the end of the generated URL.
          */
         export function getRedirectURL(path?: string): string;
 
-        /**
-         * Fired when signin state changes for an account on the user's profile.
-         * @since Chrome 33
-         */
-        export var onSignInChanged: SignInChangeEvent;
+        /** Fired when signin state changes for an account on the user's profile. */
+        export const onSignInChanged: chrome.events.Event<(account: AccountInfo, signedIn: boolean) => void>;
     }
 
     ////////////////////

chrome/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/chrome",
-    "version": "0.0.306",
+    "version": "0.0.307",
     "description": "TypeScript definitions for chrome",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome",
     "license": "MIT",
@@ -94,6 +94,6 @@
         "@types/har-format": "*"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "bb923720eea25072715f0b54926923ab06f4c7923229e632c45fda4919b4f4ab",
+    "typesPublisherContentHash": "1b2cd14db3a39318621debc8f99f89670de83d3669b282a376524e7b4fad1362",
     "typeScriptVersion": "5.0"
 }