[SDK] Add account deletion support when unlinking profiles (#7211)

Author: joaquim-verges

.changeset/account-deletion-unlink.md

@@ -0,0 +1,35 @@
+---
+"thirdweb": patch
+---
+
+**Add account deletion support when unlinking profiles**
+
+Added optional `allowAccountDeletion` parameter to `useUnlinkProfile` hook and `unlinkProfile` function. When set to `true`, this allows deleting the entire account when unlinking the last profile associated with it.
+
+**React Hook Example:**
+
+```tsx
+import { useUnlinkProfile } from "thirdweb/react";
+
+const { mutate: unlinkProfile } = useUnlinkProfile();
+
+const handleUnlink = () => {
+  unlinkProfile({
+    client,
+    profileToUnlink: connectedProfiles[0],
+    allowAccountDeletion: true, // Delete account if last profile
+  });
+};
+```
+
+**Direct Function Example:**
+
+```ts
+import { unlinkProfile } from "thirdweb/wallets/in-app";
+
+const updatedProfiles = await unlinkProfile({
+  client,
+  profileToUnlink: profiles[0],
+  allowAccountDeletion: true, // Delete account if last profile
+});
+```

packages/thirdweb/src/react/native/hooks/wallets/useUnlinkProfile.test.tsx

@@ -40,6 +40,32 @@ describe("useUnlinkProfile", () => {
       client: TEST_CLIENT,
       ecosystem: undefined,
       profileToUnlink: mockProfile,
+      allowAccountDeletion: false,
+    });
+    expect(queryClient.invalidateQueries).toHaveBeenCalledWith({
+      queryKey: ["profiles"],
+    });
+  });
+
+  it("should call unlinkProfile with allowAccountDeletion if true", async () => {
+    const { result } = renderHook(() => useUnlinkProfile(), {
+      wrapper,
+    });
+    const mutationFn = result.current.mutateAsync;
+
+    await act(async () => {
+      await mutationFn({
+        client: TEST_CLIENT,
+        profileToUnlink: mockProfile,
+        allowAccountDeletion: true,
+      });
+    });
+
+    expect(unlinkProfile).toHaveBeenCalledWith({
+      client: TEST_CLIENT,
+      ecosystem: undefined,
+      profileToUnlink: mockProfile,
+      allowAccountDeletion: true,
     });
     expect(queryClient.invalidateQueries).toHaveBeenCalledWith({
       queryKey: ["profiles"],
@@ -70,6 +96,7 @@ describe("useUnlinkProfile", () => {
           ?.partnerId,
       },
       profileToUnlink: mockProfile,
+      allowAccountDeletion: false,
     });
   });
 });

packages/thirdweb/src/react/native/hooks/wallets/useUnlinkProfile.ts

@@ -31,6 +31,23 @@ import { useConnectedWallets } from "../../../core/hooks/wallets/useConnectedWal
  * };
  * ```
  *
+ * ### Unlinking an email account with account deletion
+ *
+ * ```jsx
+ * import { useUnlinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: unlinkProfile } = useUnlinkProfile();
+ *
+ * const onClick = () => {
+ *   unlinkProfile({
+ *     client,
+ *      // Select the profile you want to unlink
+ *     profileToUnlink: connectedProfiles[0],
+ *     allowAccountDeletion: true, // This will delete the account if it's the last profile linked to the account
+ *   });
+ * };
+ * ```
+ *
  * @wallet
  */
 export function useUnlinkProfile() {
@@ -40,7 +57,12 @@ export function useUnlinkProfile() {
     mutationFn: async ({
       client,
       profileToUnlink,
-    }: { client: ThirdwebClient; profileToUnlink: Profile }) => {
+      allowAccountDeletion = false,
+    }: {
+      client: ThirdwebClient;
+      profileToUnlink: Profile;
+      allowAccountDeletion?: boolean;
+    }) => {
       const ecosystemWallet = wallets.find((w) => isEcosystemWallet(w));
       const ecosystem: Ecosystem | undefined = ecosystemWallet
         ? {
@@ -53,6 +75,7 @@ export function useUnlinkProfile() {
         client,
         ecosystem,
         profileToUnlink,
+        allowAccountDeletion,
       });
     },
     onSuccess: () => {

packages/thirdweb/src/react/web/hooks/wallets/useUnlinkProfile.test.tsx

@@ -40,6 +40,7 @@ describe("useUnlinkProfile", () => {
       client: TEST_CLIENT,
       ecosystem: undefined,
       profileToUnlink: mockProfile,
+      allowAccountDeletion: false,
     });
     expect(queryClient.invalidateQueries).toHaveBeenCalledWith({
       queryKey: ["profiles"],
@@ -70,6 +71,7 @@ describe("useUnlinkProfile", () => {
           ?.partnerId,
       },
       profileToUnlink: mockProfile,
+      allowAccountDeletion: false,
     });
   });
 });

packages/thirdweb/src/react/web/hooks/wallets/useUnlinkProfile.ts

@@ -31,6 +31,23 @@ import { useConnectedWallets } from "../../../core/hooks/wallets/useConnectedWal
  * };
  * ```
  *
+ * ### Unlinking an email account with account deletion
+ *
+ * ```jsx
+ * import { useUnlinkProfile } from "thirdweb/react";
+ *
+ * const { mutate: unlinkProfile } = useUnlinkProfile();
+ *
+ * const onClick = () => {
+ *   unlinkProfile({
+ *     client,
+ *      // Select the profile you want to unlink
+ *     profileToUnlink: connectedProfiles[0],
+ *     allowAccountDeletion: true, // This will delete the account if it's the last profile linked to the account
+ *   });
+ * };
+ * ```
+ *
  * @wallet
  */
 export function useUnlinkProfile() {
@@ -40,7 +57,12 @@ export function useUnlinkProfile() {
     mutationFn: async ({
       client,
       profileToUnlink,
-    }: { client: ThirdwebClient; profileToUnlink: Profile }) => {
+      allowAccountDeletion = false,
+    }: {
+      client: ThirdwebClient;
+      profileToUnlink: Profile;
+      allowAccountDeletion?: boolean;
+    }) => {
       const ecosystemWallet = wallets.find((w) => isEcosystemWallet(w));
       const ecosystem: Ecosystem | undefined = ecosystemWallet
         ? {
@@ -53,6 +75,7 @@ export function useUnlinkProfile() {
         client,
         ecosystem,
         profileToUnlink,
+        allowAccountDeletion,
       });
     },
     onSuccess: () => {

packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.test.ts

@@ -90,7 +90,37 @@ describe("Account linking functions", () => {
             Authorization: "Bearer iaw-auth-token:mock-token",
             "Content-Type": "application/json",
           },
-          body: JSON.stringify(profileToUnlink),
+          body: JSON.stringify({
+            type: profileToUnlink.type,
+            details: profileToUnlink.details,
+            allowAccountDeletion: false,
+          }),
+        },
+      );
+      expect(result).toEqual(mockLinkedAccounts);
+    });
+
+    it("should successfully unlink an account with allowAccountDeletion", async () => {
+      const result = await unlinkAccount({
+        client: mockClient,
+        profileToUnlink,
+        storage: mockStorage,
+        allowAccountDeletion: true,
+      });
+
+      expect(mockFetch).toHaveBeenCalledWith(
+        "https://embedded-wallet.thirdweb.com/api/2024-05-05/account/disconnect",
+        {
+          method: "POST",
+          headers: {
+            Authorization: "Bearer iaw-auth-token:mock-token",
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify({
+            type: profileToUnlink.type,
+            details: profileToUnlink.details,
+            allowAccountDeletion: true,
+          }),
         },
       );
       expect(result).toEqual(mockLinkedAccounts);

packages/thirdweb/src/wallets/in-app/core/authentication/linkAccount.ts

@@ -66,11 +66,13 @@ export async function unlinkAccount({
   client,
   ecosystem,
   profileToUnlink,
+  allowAccountDeletion = false,
   storage,
 }: {
   client: ThirdwebClient;
   ecosystem?: Ecosystem;
   profileToUnlink: Profile;
+  allowAccountDeletion?: boolean;
   storage: ClientScopedStorage;
 }): Promise<Profile[]> {
   const clientFetch = getClientFetch(client, ecosystem);
@@ -90,7 +92,11 @@ export async function unlinkAccount({
     {
       method: "POST",
       headers,
-      body: stringify(profileToUnlink),
+      body: stringify({
+        type: profileToUnlink.type,
+        details: profileToUnlink.details,
+        allowAccountDeletion,
+      }),
     },
   );
 

packages/thirdweb/src/wallets/in-app/core/authentication/types.ts

@@ -259,4 +259,5 @@ export type UnlinkParams = {
   client: ThirdwebClient;
   ecosystem?: Ecosystem;
   profileToUnlink: Profile;
+  allowAccountDeletion?: boolean;
 };

packages/thirdweb/src/wallets/in-app/core/interfaces/connector.ts

@@ -37,7 +37,10 @@ export interface InAppConnector {
   ): Promise<AuthLoginReturnType>;
   logout(): Promise<LogoutReturnType>;
   linkProfile(args: AuthArgsType): Promise<Profile[]>;
-  unlinkProfile(args: Profile): Promise<Profile[]>;
+  unlinkProfile(
+    args: Profile,
+    allowAccountDeletion?: boolean,
+  ): Promise<Profile[]>;
   getProfiles(): Promise<Profile[]>;
   storage: ClientScopedStorage;
 }

packages/thirdweb/src/wallets/in-app/native/auth/index.ts

@@ -203,7 +203,10 @@ export async function linkProfile(args: AuthArgsType) {
  */
 export async function unlinkProfile(args: UnlinkParams) {
   const connector = await getInAppWalletConnector(args.client, args.ecosystem);
-  return await connector.unlinkProfile(args.profileToUnlink);
+  return await connector.unlinkProfile(
+    args.profileToUnlink,
+    args.allowAccountDeletion,
+  );
 }
 
 /**