fix(shared): Hide billing types not needed in Typedoc

[SarahSoutoul]

Description

This PR went out a few days ago, and resulted in an autogenerated Typedoc PR in clerk-docs here. However, after talking with @panteliselef, seems like a lot of these types should be internal, and shouldn't be outputted in Typedoc in our docs.

This PR makes those internal, so they don't get outputted.

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:

Summary by CodeRabbit

• Chores
  • Updated internal documentation annotations across multiple React hook type declarations to mark them as internal scope.
  • Added a release metadata entry noting these doc changes.
  • No functional changes or user-facing impact; behavior and public APIs remain unchanged.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

🦋 Changeset detected

Latest commit: 5fe543c

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/shared	Minor
@clerk/agent-toolkit	Patch
@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/react-router	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/themes	Patch
@clerk/types	Patch
@clerk/vue	Patch
@clerk/localizations	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 GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Nov 25, 2025 11:05pm

[coderabbitai]

Walkthrough

This PR updates JSDoc annotations across five hook-related TypeScript files, replacing @interface tags with @internal tags on exported type definitions. No type signatures, runtime behavior, or logic are altered—only documentation metadata is changed. A changeset entry was added describing the documentation visibility change.

Changes

Cohort / File(s)	Summary
Hook type documentation updates packages/shared/src/react/hooks/useAPIKeys.rq.tsx, packages/shared/src/react/hooks/useAPIKeys.swr.tsx, packages/shared/src/react/hooks/usePaymentAttemptQuery.types.ts, packages/shared/src/react/hooks/usePlanDetailsQuery.types.ts, packages/shared/src/react/hooks/useStatementQuery.types.ts	Replaced JSDoc @interface tags with @internal on exported type declarations (e.g., UseAPIKeysParams, UseAPIKeysReturn, UsePaymentAttemptQueryParams, PaymentAttemptQueryResult, UsePlanDetailsQueryParams, PlanDetailsQueryResult, UseStatementQueryParams, StatementQueryResult). Added/adjusted @internal markers in module/hook doc blocks. No type or runtime changes.
Changeset metadata .changeset/gold-wasps-dress.md	Added changeset entry noting the visibility change ("Hide billing types through @internal tag") for release metadata. No code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Homogeneous documentation-only edits across a small set of files.
• No logic, type signatures, or runtime behavior to validate.

Poem

🐰 From interface to internal deep,
The docs now secrets safely keep,
A marking shift, both small and bright,
Tags tucked away, out of sight ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix(shared): Hide billing types not needed in Typedoc' accurately describes the main change—marking billing types as @internal to hide them from Typedoc output.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ss/hide-billing-types

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 895b011 and 5fe543c.

📒 Files selected for processing (1)

• .changeset/gold-wasps-dress.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .changeset/gold-wasps-dress.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Build Packages
• GitHub Check: Formatting | Dedupe | Changeset
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: semgrep-cloud-platform/scan

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7315

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7315

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7315

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7315

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7315

@clerk/upgrade

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

@clerk/vue

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

commit: 5fe543c

[alexisintech]

makes sense!