feat: extend authentication to support id token change event (#710)

* adds type definitions
capawesome-team · Nov 4, 2024 · 383aef8 · 383aef8
1 parent 7af2032
commit 383aef8
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/authentication/src/definitions.ts b/packages/authentication/src/definitions.ts
@@ -483,6 +483,17 @@ export interface FirebaseAuthenticationPlugin {
     eventName: 'authStateChange',
     listenerFunc: AuthStateChangeListener,
   ): Promise<PluginListenerHandle>;
+  /**
+   * Listen for changes to the signed-in user's ID token changes.
+   *
+   * **Attention:** This listener will not be triggered automatically upon ID token expiration.
+   *
+   * @since TODO: Add since for idTokenChange
+   */
+  addListener(
+    eventName: 'idTokenChange',
+    listenerFunc: AuthStateChangeListener,
+  ): Promise<PluginListenerHandle>;
   /**
    * Listen for a completed phone verification.
    *