chore(shared): Update signature of useReverification for error handling configuration

[panteliselef]

Description

Given this server action

export const deletePatientAction = async (
  prevState: { success: boolean },
  name: string
) => {
  const { orgId, has } = await auth();

  if (!has({ reverification: "strict" })) {
    return reverificationError("strict");
  }

  await waitFor();
  removePatient(name, orgId!);

  return { success: true };
};

// ^^ its return type :
Promise<{
    clerk_error: {
        type: "forbidden";
        reason: "reverification-mismatch";
        metadata: {
            reverification: "strict" | undefined;
        };
    };
} | {
    success: boolean;
}

when it is used as

const [deletePatient] = useReverification(deletePatientAction);
      // ^^ (prevState: {success: boolean;}, name: string) => Promise<{ success: boolean} | null>

but if you use it like with throwOnCancel: true then null will not never be returned since we throw.

const [deletePatient] = useReverification(deletePatientAction, {throwOnCancel: true});
        // ^^ (prevState: {success: boolean;}, name: string) => Promise<{ success: boolean}>

Checklist

• npm test runs as expected.
• npm run build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

[changeset-bot]

🦋 Changeset detected

Latest commit: 43ee306

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages

Name	Type
@clerk/shared	Minor
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/clerk-expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch
@clerk/tanstack-start	Patch
@clerk/testing	Patch
@clerk/ui	Patch
@clerk/vue	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[panteliselef]

For reviewers, do you think this is acceptable ?

const [createEmailAddress] = useReverification(() => user?.createEmailAddress({ email: emailField.value }));

...

const onSubmit = async () => {
 await createEmailAddress()
}

or we should force this ?

const [updatePasswordWithReverification] = useReverification(
    (user: UserResource, opts: Parameters<UserResource['updatePassword']>) => user.updatePassword(...opts),
  );
  
...
  
   
const onSubmit = async () => {
  try {
    const opts = {
      newPassword: passwordField.value,
      signOutOfOtherSessions: sessionsField.checked,
      currentPassword: user.passwordEnabled ? currentPasswordField.value : undefined,
    } satisfies Parameters<typeof user.updatePassword>[0];

    await updatePasswordWithReverification(user, [opts]);
    onSuccess();
  } catch (e) {
    handleError(e);
  }
};

[panteliselef]

Adding the references in here, will not cause the useMemo to re-render explicitly, but if something else causes the Component that the hook is mounted on, this will use the new references if they changed

[panteliselef]

I've added undefined here, in order to support the following

const {user} = useUser()
const [update] = useReverification(()=>user?.update({userName})

[panteliselef]

Accept the value itself, e.g. undefined instead of Promise<undefined>