🤖 Merge PR DefinitelyTyped#73667 [chrome] update loginState namespace by @erwanjugand

Author: erwanjugand

types/chrome/index.d.ts

@@ -6900,22 +6900,38 @@ declare namespace chrome {
      * @since Chrome 78
      */
     export namespace loginState {
-        export interface SessionStateChangedEvent extends chrome.events.Event<(sessionState: SessionState) => void> {}
-
-        /** Possible profile types. */
-        export type ProfileType = "SIGNIN_PROFILE" | "USER_PROFILE";
+        export enum ProfileType {
+            SIGNIN_PROFILE = "SIGNIN_PROFILE",
+            USER_PROFILE = "USER_PROFILE",
+        }
 
-        /** Possible session states. */
-        export type SessionState = "UNKNOWN" | "IN_OOBE_SCREEN" | "IN_LOGIN_SCREEN" | "IN_SESSION" | "IN_LOCK_SCREEN";
+        export enum SessionState {
+            UNKNOWN = "UNKNOWN",
+            IN_OOBE_SCREEN = "IN_OOBE_SCREEN",
+            IN_LOGIN_SCREEN = "IN_LOGIN_SCREEN",
+            IN_SESSION = "IN_SESSION",
+            IN_LOCK_SCREEN = "IN_LOCK_SCREEN",
+            IN_RMA_SCREEN = "IN_RMA_SCREEN",
+        }
 
-        /** Gets the type of the profile the extension is in. */
-        export function getProfileType(callback: (profileType: ProfileType) => void): void;
+        /**
+         * Gets the type of the profile the extension is in.
+         *
+         * Can return its result via Promise in Manifest V3 or later since Chrome 96.
+         */
+        export function getProfileType(): Promise<`${ProfileType}`>;
+        export function getProfileType(callback: (result: `${ProfileType}`) => void): void;
 
-        /** Gets the current session state. */
-        export function getSessionState(callback: (sessionState: SessionState) => void): void;
+        /**
+         * Gets the current session state.
+         *
+         * Can return its result via Promise in Manifest V3 or later since Chrome 96.
+         */
+        export function getSessionState(): Promise<`${SessionState}`>;
+        export function getSessionState(callback: (sessionState: `${SessionState}`) => void): void;
 
-        /** Dispatched when the session state changes. sessionState is the new session state.*/
-        export const onSessionStateChanged: SessionStateChangedEvent;
+        /** Dispatched when the session state changes. `sessionState` is the new session state.*/
+        export const onSessionStateChanged: events.Event<(sessionState: `${SessionState}`) => void>;
     }
 
     ////////////////////

types/chrome/test/index.ts

@@ -6048,6 +6048,37 @@ function testInstanceID() {
     checkChromeEvent(chrome.instanceID.onTokenRefresh, () => void 0);
 }
 
+// https://developer.chrome.com/docs/extensions/reference/api/loginState
+function testLoginState() {
+    chrome.loginState.ProfileType.SIGNIN_PROFILE === "SIGNIN_PROFILE";
+    chrome.loginState.ProfileType.USER_PROFILE === "USER_PROFILE";
+
+    chrome.loginState.SessionState.IN_LOCK_SCREEN === "IN_LOCK_SCREEN";
+    chrome.loginState.SessionState.IN_LOGIN_SCREEN === "IN_LOGIN_SCREEN";
+    chrome.loginState.SessionState.IN_OOBE_SCREEN === "IN_OOBE_SCREEN";
+    chrome.loginState.SessionState.IN_RMA_SCREEN === "IN_RMA_SCREEN";
+    chrome.loginState.SessionState.IN_SESSION === "IN_SESSION";
+    chrome.loginState.SessionState.UNKNOWN === "UNKNOWN";
+
+    chrome.loginState.getProfileType(); // $ExpectType Promise<"SIGNIN_PROFILE" | "USER_PROFILE">
+    chrome.loginState.getProfileType((result) => { // $ExpectType void
+        result; // $ExpectType "SIGNIN_PROFILE" | "USER_PROFILE"
+    });
+    // @ts-expect-error
+    chrome.loginState.getProfileType(() => {}).then(() => {});
+
+    chrome.loginState.getSessionState(); // $ExpectType Promise<"IN_LOCK_SCREEN" | "IN_LOGIN_SCREEN" | "IN_OOBE_SCREEN" | "IN_RMA_SCREEN" | "IN_SESSION" | "UNKNOWN">
+    chrome.loginState.getSessionState((result) => { // $ExpectType void
+        result; // $ExpectType "IN_LOCK_SCREEN" | "IN_LOGIN_SCREEN" | "IN_OOBE_SCREEN" | "IN_RMA_SCREEN" | "IN_SESSION" | "UNKNOWN"
+    });
+    // @ts-expect-error
+    chrome.loginState.getSessionState(() => {}).then(() => {});
+
+    checkChromeEvent(chrome.loginState.onSessionStateChanged, (sessionState) => {
+        sessionState; // $ExpectType "IN_LOCK_SCREEN" | "IN_LOGIN_SCREEN" | "IN_OOBE_SCREEN" | "IN_RMA_SCREEN" | "IN_SESSION" | "UNKNOWN"
+    });
+}
+
 function testUserScripts() {
     const worldProperties: chrome.userScripts.WorldProperties = {
         csp: "script-src 'self'",