feat(clerk-js,shared): Refactor useReverification to support custom UIs

[octoper]

Description

This PR refactors useReverification to allow it to be used both for AIO and custom UI's.

This refactor will introduce breaking changes to useReverification as now it will not return an array but instead will return the fetcher, an also the throwOnCancel and onCancel options are dropped and all errors even canceling will be thrown.

import { useReverification } from '@clerk/clerk-react'
import { isReverificationCancelledError } from '@clerk/clerk-react/errors'

export function MyButton() {
  const enhancedFetcher = useReverification(() => fetch('/api/fetcher'))

  const handleClick = async () => {
    try {
      const myData = await enhancedFetcher()
    } catch (e) {
      // Handle if user cancels the reverification process
      if (isReverificationCancelledError(e)) {
        console.error('User cancelled reverification', e.code)
      }
    }
  }

  return <button onClick={handleClick}>Update user</button>
}

Checklist

• pnpm test runs as expected.
• pnpm 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:

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 21, 2025 0:24am

[changeset-bot]

🦋 Changeset detected

Latest commit: 1478856

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

This PR includes changesets to release 18 packages

Name	Type
@clerk/react-router	Patch
@clerk/clerk-js	Patch
@clerk/nextjs	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/shared	Minor
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/elements	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nuxt	Patch
@clerk/testing	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

[octoper]

!snapshot

[clerk-cookie]

Hey @octoper - the snapshot version command generated the following package versions:

Package	Version
@clerk/agent-toolkit	0.0.11-snapshot.v20250319140008
@clerk/astro	2.4.0-snapshot.v20250319140008
@clerk/backend	1.25.3-snapshot.v20250319140008
@clerk/chrome-extension	2.2.17-snapshot.v20250319140008
@clerk/clerk-js	5.57.0-snapshot.v20250319140008
@clerk/elements	0.23.3-snapshot.v20250319140008
@clerk/clerk-expo	2.9.0-snapshot.v20250319140008
@clerk/expo-passkeys	0.1.24-snapshot.v20250319140008
@clerk/express	1.3.54-snapshot.v20250319140008
@clerk/fastify	2.1.27-snapshot.v20250319140008
@clerk/localizations	3.13.0-snapshot.v20250319140008
@clerk/nextjs	6.12.6-snapshot.v20250319140008
@clerk/nuxt	1.4.1-snapshot.v20250319140008
@clerk/clerk-react	5.25.0-snapshot.v20250319140008
@clerk/react-router	1.1.6-snapshot.v20250319140008
@clerk/remix	4.5.6-snapshot.v20250319140008
@clerk/shared	3.1.0-snapshot.v20250319140008
@clerk/tanstack-start	0.11.5-snapshot.v20250319140008
@clerk/testing	1.4.28-snapshot.v20250319140008
@clerk/themes	2.2.22-snapshot.v20250319140008
@clerk/types	4.49.0-snapshot.v20250319140008
@clerk/vue	1.4.0-snapshot.v20250319140008

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/agent-toolkit

npm i @clerk/agent-toolkit@0.0.11-snapshot.v20250319140008 --save-exact

@clerk/astro

npm i @clerk/astro@2.4.0-snapshot.v20250319140008 --save-exact

@clerk/backend

npm i @clerk/backend@1.25.3-snapshot.v20250319140008 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.17-snapshot.v20250319140008 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.57.0-snapshot.v20250319140008 --save-exact

@clerk/elements

npm i @clerk/elements@0.23.3-snapshot.v20250319140008 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.9.0-snapshot.v20250319140008 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.24-snapshot.v20250319140008 --save-exact

@clerk/express

npm i @clerk/express@1.3.54-snapshot.v20250319140008 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.27-snapshot.v20250319140008 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.13.0-snapshot.v20250319140008 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.12.6-snapshot.v20250319140008 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.4.1-snapshot.v20250319140008 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.25.0-snapshot.v20250319140008 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.1.6-snapshot.v20250319140008 --save-exact

@clerk/remix

npm i @clerk/remix@4.5.6-snapshot.v20250319140008 --save-exact

@clerk/shared

npm i @clerk/shared@3.1.0-snapshot.v20250319140008 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.11.5-snapshot.v20250319140008 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.28-snapshot.v20250319140008 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.22-snapshot.v20250319140008 --save-exact

@clerk/types

npm i @clerk/types@4.49.0-snapshot.v20250319140008 --save-exact

@clerk/vue

npm i @clerk/vue@1.4.0-snapshot.v20250319140008 --save-exact

[octoper]

!snapshot

[clerk-cookie]

Hey @octoper - the snapshot version command generated the following package versions:

Package	Version
@clerk/agent-toolkit	0.0.12-snapshot.v20250320122807
@clerk/astro	2.4.1-snapshot.v20250320122807
@clerk/backend	1.25.4-snapshot.v20250320122807
@clerk/chrome-extension	2.2.18-snapshot.v20250320122807
@clerk/clerk-js	5.57.1-snapshot.v20250320122807
@clerk/elements	0.23.4-snapshot.v20250320122807
@clerk/clerk-expo	2.9.1-snapshot.v20250320122807
@clerk/expo-passkeys	0.1.25-snapshot.v20250320122807
@clerk/express	1.3.55-snapshot.v20250320122807
@clerk/fastify	2.1.28-snapshot.v20250320122807
@clerk/nextjs	6.12.7-snapshot.v20250320122807
@clerk/nuxt	1.4.2-snapshot.v20250320122807
@clerk/clerk-react	5.25.1-snapshot.v20250320122807
@clerk/react-router	1.1.7-snapshot.v20250320122807
@clerk/remix	4.5.7-snapshot.v20250320122807
@clerk/shared	3.1.0-snapshot.v20250320122807
@clerk/testing	1.4.29-snapshot.v20250320122807
@clerk/vue	1.4.1-snapshot.v20250320122807

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/agent-toolkit

npm i @clerk/agent-toolkit@0.0.12-snapshot.v20250320122807 --save-exact

@clerk/astro

npm i @clerk/astro@2.4.1-snapshot.v20250320122807 --save-exact

@clerk/backend

npm i @clerk/backend@1.25.4-snapshot.v20250320122807 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.18-snapshot.v20250320122807 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.57.1-snapshot.v20250320122807 --save-exact

@clerk/elements

npm i @clerk/elements@0.23.4-snapshot.v20250320122807 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.9.1-snapshot.v20250320122807 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.25-snapshot.v20250320122807 --save-exact

@clerk/express

npm i @clerk/express@1.3.55-snapshot.v20250320122807 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.28-snapshot.v20250320122807 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.12.7-snapshot.v20250320122807 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.4.2-snapshot.v20250320122807 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.25.1-snapshot.v20250320122807 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.1.7-snapshot.v20250320122807 --save-exact

@clerk/remix

npm i @clerk/remix@4.5.7-snapshot.v20250320122807 --save-exact

@clerk/shared

npm i @clerk/shared@3.1.0-snapshot.v20250320122807 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.29-snapshot.v20250320122807 --save-exact

@clerk/vue

npm i @clerk/vue@1.4.1-snapshot.v20250320122807 --save-exact

[octoper]

@panteliselef all comments are fixed!