Skip to content

chore(clerk-js,shared): Remove experimental tags from API keys#8059

Open
wobsoriano wants to merge 17 commits intomainfrom
rob/api-keys-stable
Open

chore(clerk-js,shared): Remove experimental tags from API keys#8059
wobsoriano wants to merge 17 commits intomainfrom
rob/api-keys-stable

Conversation

@wobsoriano
Copy link
Copy Markdown
Member

@wobsoriano wobsoriano commented Mar 12, 2026

Description

As part of making API keys stable, we're removing experimental tags from components and methods related

Resolves USER-4954

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

  • Documentation

    • API Keys docs cleaned up: removed experimental labels, clarified mount/unmount wording, and added usage examples including an API Keys component and pagination.
  • Bug Fixes

    • Removed an early-access/production warning that previously appeared when mounting API Keys.
  • Public API

    • The useAPIKeys hook is now a stable public export (experimental alias removed).

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 12, 2026

🦋 Changeset detected

Latest commit: 096545b

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

This PR includes changesets to release 21 packages
Name Type
@clerk/shared Minor
@clerk/react Minor
@clerk/clerk-js Minor
@clerk/ui Minor
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/chrome-extension 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/tanstack-react-start 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

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 12, 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 Apr 3, 2026 2:31pm

Request Review

@wobsoriano wobsoriano changed the title chore(clerk-js, ui): Remove experimental and early access tags from API keys chore(clerk-js, ui): Remove experimental tags from API keys Mar 12, 2026
@wobsoriano wobsoriano marked this pull request as ready for review March 13, 2026 15:36
@wobsoriano wobsoriano changed the title chore(clerk-js, ui): Remove experimental tags from API keys chore(clerk-js, shared): Remove experimental tags from API keys Mar 13, 2026
@wobsoriano wobsoriano changed the title chore(clerk-js, shared): Remove experimental tags from API keys chore(clerk-js,shared): Remove experimental tags from API keys Mar 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 13, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Pro

Run ID: ad969857-915b-4f63-8732-c36746029cbd

📥 Commits

Reviewing files that changed from the base of the PR and between 7d0310f and 096545b.

⛔ Files ignored due to path filters (2)
  • packages/react-router/src/__tests__/__snapshots__/exports.test.ts.snap is excluded by !**/*.snap
  • packages/tanstack-react-start/src/__tests__/__snapshots__/exports.test.ts.snap is excluded by !**/*.snap
📒 Files selected for processing (2)
  • packages/shared/src/react/hooks/index.ts
  • packages/ui/src/components/APIKeys/APIKeys.tsx

📝 Walkthrough

Walkthrough

Removed the logger.warnOnce call from mountAPIKeys and deleted @experimental/early-access JSDoc for API Keys methods. Introduced a private static #pathRoot = '/api_keys', converted getBaseFapiProxyOptions to a private field-style #getBaseFapiProxyOptions, and added credentials: 'same-origin' to FAPI proxy options while updating the Authorization header comment. Replaced experimental __experimental_useAPIKeys re-exports with a stable useAPIKeys export and updated consuming imports. Added a changeset documenting the stable API Keys surface. No public type or signature changes.

🚥 Pre-merge checks | ✅ 3
✅ 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 'chore(clerk-js,shared): Remove experimental tags from API keys' accurately and clearly describes the main objective of the changeset: removing @experimental annotations from API keys-related code to make the API keys feature stable.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 Mar 13, 2026

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 096545b

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants