docs(shared): use @hidden over @internal for internal Clerk/Client members#8701
Merged
alexisintech merged 1 commit intoMay 29, 2026
Conversation
…mbers These 18 __internal_* members on Clerk and ClientResource were tagged @internal to keep them out of the generated /objects docs, but snapi reads @internal as a TSDoc release tag and drops them from the API snapshot, so the API Changes check reports them as removed (18 false breaking changes). There is no stripInternal in the build, so the members are still emitted in the .d.ts and at runtime and remain part of the contract. Swap @internal to @hidden on just those members: typedoc still excludes them from the docs (@hidden is a removal tag), but snapi keeps tracking them since @hidden is not a release tag. The 14 pre-existing @internal tags are left as-is.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
wobsoriano
approved these changes
May 29, 2026
Member
|
ahhh you're a genius thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Targets the #8276 branch.
Those 18
__internal_*members onClerkandClientResourcegot@internaltags so they'd stay out of the generated/objectsdocs. The problem is snapi reads@internalas a TSDoc release tag and drops them from the API snapshot, so the API Changes check sees them disappear and reports 18 "removed" breaking changes. But there's nostripInternalin the build, so these members are still emitted in the.d.tsand at runtime. They're genuinely still part of the contract and shouldn't leave snapi's radar.Swapping
@internalto@hiddenon just those members keeps typedoc excluding them from the docs (@hiddenis a removal tag), while snapi keeps tracking them since@hiddenisn't a release tag. The 14 pre-existing@internaltags are left alone. I ran the typedoc generation locally to confirm none of the 18 leak into the output and the build is clean.One heads up: the API Changes check won't run on this PR, that workflow only triggers on PRs into
main/release/*, so it'll re-validate on #8276 once these commits land on the branch.