[auth] Make all functions return a success indicator

Author: chrisbianca

Diff for: auth/README.md

@@ -2,7 +2,7 @@ import { Auth, AuthError } from 'firebase/auth';
 import { useCallback, useState } from 'react';
 
 export type DeleteUserHook = [
-  () => Promise<void>,
+  () => Promise<boolean>,
   boolean,
   AuthError | Error | undefined
 ];
@@ -17,11 +17,13 @@ export default (auth: Auth): DeleteUserHook => {
     try {
       if (auth.currentUser) {
         await auth.currentUser.delete();
+        return true;
       } else {
-        setError(new Error('No user is logged in') as AuthError);
+        throw new Error('No user is logged in');
       }
     } catch (err) {
       setError(err as AuthError);
+      return false;
     } finally {
       setLoading(false);
     }

Diff for: auth/useDeleteUser.ts

@@ -6,7 +6,7 @@ import {
 import { useCallback, useState } from 'react';
 
 export type SendEmailVerificationHook = [
-  () => Promise<void>,
+  () => Promise<boolean>,
   boolean,
   AuthError | Error | undefined
 ];
@@ -21,11 +21,13 @@ export default (auth: Auth): SendEmailVerificationHook => {
     try {
       if (auth.currentUser) {
         await fbSendEmailVerification(auth.currentUser);
+        return true;
       } else {
-        setError(new Error('No user is logged in') as AuthError);
+        throw new Error('No user is logged in');
       }
     } catch (err) {
       setError(err as AuthError);
+      return false;
     } finally {
       setLoading(false);
     }

Diff for: auth/useSendEmailVerification.ts

@@ -7,7 +7,7 @@ import {
 import { useCallback, useState } from 'react';
 
 export type SendPasswordResetEmailHook = [
-  (email: string, actionCodeSettings?: ActionCodeSettings) => Promise<void>,
+  (email: string, actionCodeSettings?: ActionCodeSettings) => Promise<boolean>,
   boolean,
   AuthError | Error | undefined
 ];
@@ -22,8 +22,10 @@ export default (auth: Auth): SendPasswordResetEmailHook => {
       setError(undefined);
       try {
         await fbSendPasswordResetEmail(auth, email, actionCodeSettings);
+        return true;
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }

Diff for: auth/useSendPasswordResetEmail.ts

@@ -7,7 +7,7 @@ import {
 import { useCallback, useState } from 'react';
 
 export type SendSignInLinkToEmailHook = [
-  (email: string, actionCodeSettings: ActionCodeSettings) => Promise<void>,
+  (email: string, actionCodeSettings: ActionCodeSettings) => Promise<boolean>,
   boolean,
   AuthError | Error | undefined
 ];
@@ -22,8 +22,10 @@ export default (auth: Auth): SendSignInLinkToEmailHook => {
       setError(undefined);
       try {
         await fbSendSignInLinkToEmail(auth, email, actionCodeSettings);
+        return true;
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }

Diff for: auth/useSendSignInLinkToEmail.ts

@@ -2,7 +2,7 @@ import { Auth, AuthError } from 'firebase/auth';
 import { useCallback, useState } from 'react';
 
 export type SignOutHook = [
-  () => Promise<void>,
+  () => Promise<boolean>,
   boolean,
   AuthError | Error | undefined
 ];
@@ -16,8 +16,10 @@ export default (auth: Auth): SignOutHook => {
     setError(undefined);
     try {
       await auth.signOut();
+      return true;
     } catch (err) {
       setError(err as AuthError);
+      return false;
     } finally {
       setLoading(false);
     }

Diff for: auth/useSignOut.ts

@@ -16,18 +16,20 @@ type Profile = {
 
 export type UpdateUserHook<M> = [M, boolean, AuthError | Error | undefined];
 
-export type UpdateEmailHook = UpdateUserHook<(email: string) => Promise<void>>;
+export type UpdateEmailHook = UpdateUserHook<
+  (email: string) => Promise<boolean>
+>;
 export type UpdatePasswordHook = UpdateUserHook<
-  (password: string) => Promise<void>
+  (password: string) => Promise<boolean>
 >;
 export type UpdateProfileHook = UpdateUserHook<
-  (profile: Profile) => Promise<void>
+  (profile: Profile) => Promise<boolean>
 >;
 export type VerifyBeforeUpdateEmailHook = UpdateUserHook<
   (
     email: string,
     actionCodeSettings: ActionCodeSettings | null
-  ) => Promise<void>
+  ) => Promise<boolean>
 >;
 
 export const useUpdateEmail = (auth: Auth): UpdateEmailHook => {
@@ -41,11 +43,13 @@ export const useUpdateEmail = (auth: Auth): UpdateEmailHook => {
       try {
         if (auth.currentUser) {
           await fbUpdateEmail(auth.currentUser, email);
+          return true;
         } else {
-          setError(new Error('No user is logged in') as AuthError);
+          throw new Error('No user is logged in');
         }
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }
@@ -67,11 +71,13 @@ export const useUpdatePassword = (auth: Auth): UpdatePasswordHook => {
       try {
         if (auth.currentUser) {
           await fbUpdatePassword(auth.currentUser, password);
+          return true;
         } else {
-          setError(new Error('No user is logged in') as AuthError);
+          throw new Error('No user is logged in');
         }
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }
@@ -93,11 +99,13 @@ export const useUpdateProfile = (auth: Auth): UpdateProfileHook => {
       try {
         if (auth.currentUser) {
           await fbUpdateProfile(auth.currentUser, profile);
+          return true;
         } else {
-          setError(new Error('No user is logged in') as AuthError);
+          throw new Error('No user is logged in');
         }
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }
@@ -125,11 +133,13 @@ export const useVerifyBeforeUpdateEmail = (
             email,
             actionCodeSettings
           );
+          return true;
         } else {
-          setError(new Error('No user is logged in') as AuthError);
+          throw new Error('No user is logged in');
         }
       } catch (err) {
         setError(err as AuthError);
+        return false;
       } finally {
         setLoading(false);
       }