feat(authentication): add getIdTokenResult method

.changeset/popular-cobras-camp.md

@@ -0,0 +1,5 @@
+---
+'@capacitor-firebase/authentication': major
+---
+
+feat: add getIdTokenResult method

packages/authentication/src/definitions.ts

@@ -106,6 +106,12 @@ export interface FirebaseAuthenticationPlugin {
    * @since 0.1.0
    */
   getIdToken(options?: GetIdTokenOptions): Promise<GetIdTokenResult>;
+  /**
+   * Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.
+   * 
+   * @since 6.4.0
+   */
+  getIdTokenResult(options?: GetIdTokenResultOptions): Promise<GetIdTokenResultResult>;
   /**
    * Returns the `SignInResult` from the redirect-based sign-in flow.
    *
@@ -655,6 +661,18 @@ export interface GetIdTokenOptions {
   forceRefresh: boolean;
 }
 
+/**
+ * @since 6.4.0
+ */
+export interface GetIdTokenResultOptions {
+  /**
+   * Force refresh regardless of token expiration.
+   *
+   * @since 6.4.0
+   */
+  forceRefresh: boolean;
+}
+
 /**
  * @since 0.1.0
  */
@@ -667,6 +685,38 @@ export interface GetIdTokenResult {
   token: string;
 }
 
+export interface GetIdTokenResultResult {
+  /**
+   * The authentication time formatted as a UTC string.
+   *
+   * @remarks
+   * This is the time the user authenticated (signed in) and not the time the token was refreshed.
+   */
+  authTime: string;
+  /** The ID token expiration time formatted as a UTC string. */
+  expirationTime: string;
+  /** The ID token issuance time formatted as a UTC string. */
+  issuedAtTime: string;
+  /**
+   * The sign-in provider through which the ID token was obtained (anonymous, custom, phone,
+   * password, etc).
+   *
+   * @remarks
+   * Note, this does not map to provider IDs.
+   */
+  signInProvider: string | null;
+  /**
+   * The type of second factor associated with this session, provided the user was multi-factor
+   * authenticated (eg. phone, etc).
+   */
+  signInSecondFactor: string | null;
+  /**
+   * The entire payload claims of the ID token including the standard reserved claims as well as
+   * the custom claims.
+   */
+  claims: Record<string, unknown>;
+}
+
 /**
  * @since 1.1.0
  */

packages/authentication/src/web.ts

@@ -68,6 +68,7 @@ import type {
   FetchSignInMethodsForEmailResult,
   FirebaseAuthenticationPlugin,
   GetCurrentUserResult,
+  GetIdTokenResultResult,
   GetIdTokenOptions,
   GetIdTokenResult,
   GetTenantIdResult,
@@ -109,8 +110,7 @@ import { Persistence, ProviderId } from './definitions';
 
 export class FirebaseAuthenticationWeb
   extends WebPlugin
-  implements FirebaseAuthenticationPlugin
-{
+  implements FirebaseAuthenticationPlugin {
   public static readonly AUTH_STATE_CHANGE_EVENT = 'authStateChange';
   public static readonly ID_TOKEN_CHANGE_EVENT = 'idTokenChange';
   public static readonly PHONE_CODE_SENT_EVENT = 'phoneCodeSent';
@@ -217,6 +217,17 @@ export class FirebaseAuthenticationWeb
     return result;
   }
 
+  public async getIdTokenResult(
+    options?: GetIdTokenOptions,
+  ) {
+    const auth = getAuth();
+    if (!auth.currentUser) {
+      throw new Error(FirebaseAuthenticationWeb.ERROR_NO_USER_SIGNED_IN);
+    }
+    const result: GetIdTokenResultResult = await auth.currentUser.getIdTokenResult(options?.forceRefresh);
+    return result;
+  }
+
   public async getRedirectResult(): Promise<SignInResult> {
     const auth = getAuth();
     const userCredential = await getRedirectResult(auth);
@@ -981,4 +992,4 @@ export class FirebaseAuthenticationWeb
   private throwNotAvailableError(): never {
     throw new Error('Not available on web.');
   }
-}
+}