Skip to content

chore(shared): Remove internal tag from publicly re-exported error helpers#8598

Open
wobsoriano wants to merge 2 commits into
mainfrom
rob/remove-deprecated-tag-from-error-helpers
Open

chore(shared): Remove internal tag from publicly re-exported error helpers#8598
wobsoriano wants to merge 2 commits into
mainfrom
rob/remove-deprecated-tag-from-error-helpers

Conversation

@wobsoriano
Copy link
Copy Markdown
Member

Description

  • Removes the @internal JSDoc tag from error helpers in @clerk/shared that are explicitly re-exported for public use by SDK packages (isKnownError, isReverificationCancelledError, isMetamaskError, isUserLockedError, isEmailLinkError)
  • Helpers that are genuinely internal and not re-exported retain the @internal tag

The @internal tag was originally applied because these helpers live in @clerk/shared, which users shouldn't import from directly. However, since they are explicitly re-exported from the SDK packages, the tag was misleading.

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
Copy link
Copy Markdown

changeset-bot Bot commented May 20, 2026

🦋 Changeset detected

Latest commit: b6100be

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

This PR includes changesets to release 20 packages
Name Type
@clerk/shared Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/expo-passkeys Patch
@clerk/expo Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/react Patch
@clerk/tanstack-react-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
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 20, 2026 12:21am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 08cc451a-2063-4cb6-957e-70059c88c075

📥 Commits

Reviewing files that changed from the base of the PR and between c2fff36 and b6100be.

📒 Files selected for processing (2)
  • .changeset/orange-pandas-burn.md
  • packages/shared/src/errors/helpers.ts
💤 Files with no reviewable changes (1)
  • packages/shared/src/errors/helpers.ts

📝 Walkthrough

Walkthrough

This PR removes the @internal JSDoc annotations from four error helper functions in the shared error utilities module: isKnownError, isReverificationCancelledError, isMetamaskError, and isEmailLinkError. The function implementations and signatures remain unchanged. A Changeset entry documents this modification as a patch-level version bump for the @clerk/shared package, transitioning these helpers from internal-only to public API.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing the @internal tag from publicly re-exported error helpers in the shared package.
Description check ✅ Passed The description clearly explains the rationale for removing the @internal tags and lists the specific error helpers affected by this change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 20, 2026

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8598

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8598

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8598

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8598

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8598

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8598

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8598

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8598

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8598

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8598

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8598

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8598

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8598

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8598

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8598

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8598

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8598

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8598

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8598

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8598

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8598

commit: b6100be

Copy link
Copy Markdown
Member

@jacekradko jacekradko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense for these not to be internal

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants