feat(authentication): add reload method (#285)

* docs * docs: add changeset * feat(android): implement reload * feat(ios): implement reload
capawesome-team · Dec 17, 2022 · 8b27765 · 8b27765
1 parent 6842fac
commit 8b27765
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 0 deletions.
diff --git a/.changeset/big-llamas-kiss.md b/.changeset/big-llamas-kiss.md
@@ -0,0 +1,5 @@
+---
+"@capacitor-firebase/authentication": minor
+---
+
+feat: add `reload` method
diff --git a/packages/authentication/README.md b/packages/authentication/README.md
@@ -376,6 +376,7 @@ const useEmulator = async () => {
 * [`linkWithPlayGames(...)`](#linkwithplaygames)
 * [`linkWithTwitter(...)`](#linkwithtwitter)
 * [`linkWithYahoo(...)`](#linkwithyahoo)
+* [`reload()`](#reload)
 * [`sendEmailVerification()`](#sendemailverification)
 * [`sendPasswordResetEmail(...)`](#sendpasswordresetemail)
 * [`sendSignInLinkToEmail(...)`](#sendsigninlinktoemail)
@@ -839,6 +840,19 @@ The `skipNativeAuth` configuration option has no effect here.
 --------------------
 
 
+### reload()
+
+```typescript
+reload() => Promise<void>
+```
+
+Reloads user account data, if signed in.
+
+**Since:** 1.3.0
+
+--------------------
+
+
 ### sendEmailVerification()
 
 ```typescript

diff --git a/...ava/io/capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthentication.java b/...ava/io/capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthentication.java
@@ -275,6 +275,16 @@ public void linkWithYahoo(final PluginCall call) {
         oAuthProviderHandler.link(call, ProviderId.YAHOO);
     }
 
+    public void reload(FirebaseUser user, @NonNull Runnable callback) {
+        user
+            .reload()
+            .addOnCompleteListener(
+                task -> {
+                    callback.run();
+                }
+            );
+    }
+
     public void sendEmailVerification(FirebaseUser user, @NonNull Runnable callback) {
         user
             .sendEmailVerification()

diff --git a/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationPlugin.java b/.../capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthenticationPlugin.java
@@ -293,6 +293,20 @@ public void linkWithYahoo(PluginCall call) {
         }
     }
 
+    @PluginMethod
+    public void reload(PluginCall call) {
+        try {
+            FirebaseUser user = implementation.getCurrentUser();
+            if (user == null) {
+                call.reject(ERROR_NO_USER_SIGNED_IN);
+                return;
+            }
+            implementation.reload(user, () -> call.resolve());
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
     @PluginMethod
     public void sendEmailVerification(PluginCall call) {
         try {

diff --git a/packages/authentication/ios/Plugin/FirebaseAuthentication.swift b/packages/authentication/ios/Plugin/FirebaseAuthentication.swift
@@ -211,6 +211,12 @@ public typealias AuthStateChangedObserver = () -> Void
         self.oAuthProviderHandler?.link(call: call, providerId: ProviderId.yahoo)
     }
 
+    @objc func reload(user: User, completion: @escaping (Error?) -> Void) {
+        user.reload { error in
+            completion(error)
+        }
+    }
+
     @objc func sendEmailVerification(user: User, completion: @escaping (Error?) -> Void) {
         user.sendEmailVerification(completion: { error in
             completion(error)

diff --git a/packages/authentication/ios/Plugin/FirebaseAuthenticationPlugin.m b/packages/authentication/ios/Plugin/FirebaseAuthenticationPlugin.m
@@ -25,6 +25,7 @@
            CAP_PLUGIN_METHOD(linkWithPlayGames, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(linkWithTwitter, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(linkWithYahoo, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(reload, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(sendEmailVerification, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(sendPasswordResetEmail, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(sendSignInLinkToEmail, CAPPluginReturnPromise);

diff --git a/packages/authentication/ios/Plugin/FirebaseAuthenticationPlugin.swift b/packages/authentication/ios/Plugin/FirebaseAuthenticationPlugin.swift
@@ -198,6 +198,21 @@ public class FirebaseAuthenticationPlugin: CAPPlugin {
         implementation?.linkWithYahoo(call)
     }
 
+    @objc func reload(_ call: CAPPluginCall) {
+        guard let user = implementation?.getCurrentUser() else {
+            call.reject(errorNoUserSignedIn)
+            return
+        }
+
+        implementation?.reload(user: user, completion: { error in
+            if let error = error {
+                call.reject(error.localizedDescription)
+                return
+            }
+            call.resolve()
+        })
+    }
+
     @objc func sendEmailVerification(_ call: CAPPluginCall) {
         guard let user = implementation?.getCurrentUser() else {
             call.reject(errorNoUserSignedIn)

diff --git a/packages/authentication/src/definitions.ts b/packages/authentication/src/definitions.ts
@@ -219,6 +219,12 @@ export interface FirebaseAuthenticationPlugin {
    * @since 1.1.0
    */
   linkWithYahoo(options?: LinkWithOAuthOptions): Promise<LinkResult>;
+  /**
+   * Reloads user account data, if signed in.
+   *
+   * @since 1.3.0
+   */
+  reload(): Promise<void>;
   /**
    * Sends a verification email to the currently signed in user.
    *

diff --git a/packages/authentication/src/web.ts b/packages/authentication/src/web.ts
@@ -26,6 +26,7 @@ import {
   linkWithCredential,
   linkWithPopup,
   linkWithRedirect,
+  reload,
   sendEmailVerification,
   sendPasswordResetEmail,
   sendSignInLinkToEmail,
@@ -309,6 +310,15 @@ export class FirebaseAuthenticationWeb
     return this.createSignInResult(userCredential, authCredential);
   }
 
+  public async reload(): Promise<void> {
+    const auth = getAuth();
+    const currentUser = auth.currentUser;
+    if (!currentUser) {
+      throw new Error(FirebaseAuthenticationWeb.ERROR_NO_USER_SIGNED_IN);
+    }
+    return reload(currentUser);
+  }
+
   public async sendEmailVerification(): Promise<void> {
     const auth = getAuth();
     const currentUser = auth.currentUser;