feat(clerk-js,shared,nextjs,react-router,clerk-react,remix): Introduce EmailLinkErrorCodeStatus

[alexcarpenter]

Description

• Mark EmailLinkErrorCode as deprecated
• Introduce EmailLinkErrorCodeStatus

import { EmailLinkErrorCodeStatus } from '@clerk/nextjs/errors'

type EmailLinkError = typeof EmailLinkErrorCodeStatus[keyof typeof EmailLinkErrorCodeStatus];

const getStatus = (err: EmailLinkError): EmailLinkError => {
  if (err === EmailLinkErrorCodeStatus.Expired) {
    return 'expired'
  }

  if (err === EmailLinkErrorCodeStatus.ClientMismatch) {
    return 'client_mismatch'
  }

  return 'failed'
}

Resolves SDK-2055

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:

[changeset-bot]

🦋 Changeset detected

Latest commit: afe8949

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

This PR includes changesets to release 20 packages

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

[vercel]

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

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	⬜️ Skipped (Inspect)			Feb 13, 2025 2:44pm

[dstaley]

lgtm but this is technically a breaking change in the most technical sense given that we're narrowing EmailLinkErrorCode from Record<string, string> to a more restrictive type. I think this is probably fine, but there's technically user code that could break as a result of this change.

[panteliselef]

We need to re-export it from src/errors.ts

[panteliselef]

We need to re-export EmailLinkErrorCodeStatus from src/errors.ts

[panteliselef]

Nice work