Merge pull request #125 from HassanBahati/ft-add-useDeleteUserMutation

feat: add useDeleteUserMutation hook

Author: Ehesp

packages/react/src/auth/index.ts

@@ -31,6 +31,7 @@ export { useSignInWithCredentialMutation } from "./useSignInWithCredentialMutati
 // useValidatePasswordMutation
 // useVerifyPasswordResetCodeMutation
 // useDeleteUserMutation
+export { useDeleteUserMutation } from "./useDeleteUserMutation";
 // useLinkWithCredentialMutation
 // useLinkWithPhoneNumberMutation
 // useLinkWithPopupMutation

packages/react/src/auth/useDeleteUserMutation.test.tsx

@@ -0,0 +1,101 @@
+import React from "react";
+import { describe, expect, test, beforeEach, afterEach, vi } from "vitest";
+import { renderHook, act, waitFor } from "@testing-library/react";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { auth, wipeAuth } from "~/testing-utils";
+import { createUserWithEmailAndPassword, type User } from "firebase/auth";
+import { useDeleteUserMutation } from "./useDeleteUserMutation";
+
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: { retry: false },
+    mutations: { retry: false },
+  },
+});
+
+const wrapper = ({ children }: { children: React.ReactNode }) => (
+  <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+);
+
+describe("useVerifyPasswordResetCodeMutation", () => {
+  const email = "[email protected]";
+  const password = "TanstackQueryFirebase#123";
+  let user: User;
+
+  beforeEach(async () => {
+    queryClient.clear();
+    await wipeAuth();
+    const userCredential = await createUserWithEmailAndPassword(
+      auth,
+      email,
+      password
+    );
+    user = userCredential.user;
+  });
+
+  afterEach(async () => {
+    vi.clearAllMocks();
+    await auth.signOut();
+  });
+
+  test("successfully verifies the reset code", async () => {
+    const { result } = renderHook(() => useDeleteUserMutation(auth), {
+      wrapper,
+    });
+
+    await act(async () => {
+      result.current.mutate(user);
+    });
+
+    await waitFor(() => expect(result.current.isSuccess).toBe(true));
+
+    expect(result.current.data).toBeUndefined();
+  });
+
+  test("resets mutation state correctly", async () => {
+    const { result } = renderHook(() => useDeleteUserMutation(auth), {
+      wrapper,
+    });
+
+    act(() => {
+      result.current.mutate(user);
+    });
+
+    await waitFor(() => {
+      expect(result.current.isSuccess).toBe(true);
+    });
+
+    act(() => {
+      result.current.reset();
+    });
+
+    await waitFor(() => {
+      expect(result.current.isIdle).toBe(true);
+      expect(result.current.data).toBeUndefined();
+      expect(result.current.error).toBeNull();
+    });
+  });
+
+  test("should call onSuccess when the user is successfully deleted", async () => {
+    const onSuccess = vi.fn();
+
+    const { result } = renderHook(
+      () =>
+        useDeleteUserMutation(auth, {
+          onSuccess,
+        }),
+      {
+        wrapper,
+      }
+    );
+
+    act(() => {
+      result.current.mutate(user);
+    });
+
+    await waitFor(() => expect(result.current.isSuccess).toBe(true));
+
+    expect(onSuccess).toHaveBeenCalledTimes(1);
+    expect(result.current.data).toBeUndefined();
+  });
+});

packages/react/src/auth/useDeleteUserMutation.ts

@@ -0,0 +1,18 @@
+import { useMutation, type UseMutationOptions } from "@tanstack/react-query";
+import { Auth, type AuthError, deleteUser, type User } from "firebase/auth";
+
+type AuthUMutationOptions<
+  TData = unknown,
+  TError = Error,
+  TVariables = void
+> = Omit<UseMutationOptions<TData, TError, TVariables>, "mutationFn">;
+
+export function useDeleteUserMutation(
+  auth: Auth,
+  options?: AuthUMutationOptions<void, AuthError, User>
+) {
+  return useMutation<void, AuthError, User>({
+    ...options,
+    mutationFn: (user: User) => deleteUser(user),
+  });
+}