Merge pull request #264 from RobertSasak/master

Create hooks useDeleteUser and useSignOut

Author: chrisbianca

auth/README.md

@@ -25,6 +25,8 @@ List of Auth hooks:
 - [useUpdateProfile](#useupdateprofile)
 - [useSendPasswordResetEmail](#usesendpasswordresetemail)
 - [useSendEmailVerification](#usesendemailverification)
+- [useSignOut](#usesignout)
+- [useDeleteUser](#usedeleteuser)
 
 ### useAuthState
 
@@ -748,3 +750,105 @@ const SendEmailVerification = () => {
   );
 };
 ```
+
+### useSignOut
+
+```js
+const [signOut, loading, error] = useSignOut(auth);
+```
+
+Sign out current user. Wraps the underlying `auth.signOut` method and provides additional `loading` and `error` information.
+
+The `useSignOut` hook takes the following parameters:
+
+- `auth`: `Auth` instance for the app you would like to monitor
+
+Returns:
+
+- `signOut()`: A `() => Promise<void>` function you can call to sign out current user
+- `loading`: A `boolean` to indicate whether the user is being signed out
+- `error`: Any `Error` returned by Firebase when trying to sign out user, or `undefined` if there is no error
+
+#### Full Example
+
+```jsx
+import { useSignOut } from 'react-firebase-hooks/auth';
+
+const SignOut = () => {
+  const [signOut, loading, error] = useSignOut(auth);
+
+  if (error) {
+    return (
+      <div>
+        <p>Error: {error.message}</p>
+      </div>
+    );
+  }
+  if (loading) {
+    return <p>Loading...</p>;
+  }
+  return (
+    <div className="App">
+      <button
+        onClick={async () => {
+          await signOut();
+          alert('You are sign out');
+        }}
+      >
+        Sign out
+      </button>
+    </div>
+  );
+};
+```
+
+### useDeleteUser
+
+```js
+const [deleteUser, loading, error] = useDeleteUser(auth);
+```
+
+Delete current user. Wraps the underlying `auth.currrentUser.delete` method and provides additional `loading` and `error` information.
+
+The `useDeleteUser` hook takes the following parameters:
+
+- `auth`: `Auth` instance for the app you would like to monitor
+
+Returns:
+
+- `deleteUser()`: A `() => Promise<void>` function you can call to delete the current user
+- `loading`: A `boolean` to indicate whether the deletion is processing
+- `error`: Any `Error` returned by Firebase when trying to delete user, or `undefined` if there is no error
+
+#### Full Example
+
+```jsx
+import { useDeleteUser } from 'react-firebase-hooks/auth';
+
+const DeleteUser = () => {
+  const [deleteUser, loading, error] = useDeleteUser(auth);
+
+  if (error) {
+    return (
+      <div>
+        <p>Error: {error.message}</p>
+      </div>
+    );
+  }
+  if (loading) {
+    return <p>Loading...</p>;
+  }
+  return (
+    <div className="App">
+      <button
+        onClick={async () => {
+          await deleteUser();
+          alert('You have been deleted');
+        }}
+      >
+        Delete current user
+      </button>
+    </div>
+  );
+};
+```

auth/index.ts

@@ -8,6 +8,8 @@ export {
   default as useSendPasswordResetEmail,
   SendPasswordResetEmailHook,
 } from './useSendPasswordResetEmail';
+export { default as useSignOut, SignOutHook } from './useSignOut';
+export { default as useDeleteUser, DeleteUserHook } from './useDeleteUser';
 export { default as useSignInWithEmailAndPassword } from './useSignInWithEmailAndPassword';
 export {
   useSignInWithApple,

auth/useDeleteUser.ts

@@ -0,0 +1,32 @@
+import { Auth, AuthError } from 'firebase/auth';
+import { useMemo, useState } from 'react';
+
+export type DeleteUserHook = [
+  () => Promise<void>,
+  boolean,
+  AuthError | Error | undefined
+];
+
+export default (auth: Auth): DeleteUserHook => {
+  const [error, setError] = useState<AuthError>();
+  const [loading, setLoading] = useState<boolean>(false);
+
+  const deleteUser = async () => {
+    setLoading(true);
+    setError(undefined);
+    try {
+      if (auth.currentUser) {
+        await auth.currentUser.delete();
+      } else {
+        setError(new Error('No user is logged in') as AuthError);
+      }
+    } catch (err) {
+      setError(err as AuthError);
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  const resArray: DeleteUserHook = [deleteUser, loading, error];
+  return useMemo<DeleteUserHook>(() => resArray, resArray);
+};

auth/useSignOut.ts

@@ -0,0 +1,28 @@
+import { Auth, AuthError } from 'firebase/auth';
+import { useMemo, useState } from 'react';
+
+export type SignOutHook = [
+  () => Promise<void>,
+  boolean,
+  AuthError | Error | undefined
+];
+
+export default (auth: Auth): SignOutHook => {
+  const [error, setError] = useState<AuthError>();
+  const [loading, setLoading] = useState<boolean>(false);
+
+  const signOut = async () => {
+    setLoading(true);
+    setError(undefined);
+    try {
+      await auth.signOut();
+    } catch (err) {
+      setError(err as AuthError);
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  const resArray: SignOutHook = [signOut, loading, error];
+  return useMemo<SignOutHook>(() => resArray, resArray);
+};