Skip to content

chore(clerk-js,ui): Make OAuthConsent component public#8381

Merged
wobsoriano merged 19 commits intomainfrom
rob/oauth-consent-ga
May 1, 2026
Merged

chore(clerk-js,ui): Make OAuthConsent component public#8381
wobsoriano merged 19 commits intomainfrom
rob/oauth-consent-ga

Conversation

@wobsoriano
Copy link
Copy Markdown
Member

@wobsoriano wobsoriano commented Apr 22, 2026

Description

This PR makes OAuthConsent publicly available across SDKs and keeps the legacy __internal_*OAuthConsent runtime methods in place for compatibility.

Older published SDKs still call:

  • clerk.__internal_mountOAuthConsent
  • clerk.__internal_unmountOAuthConsent

When clerk-js is loaded from the CDN, users can end up with:

  • older framework SDK versions
  • newer clerk-js runtime assets

If we remove the legacy runtime methods now, those mixed-version deployments break at runtime with ... is not a function.

To avoid that, this PR:

  • keeps mountOAuthConsent / unmountOAuthConsent as the canonical API
  • preserves __internal_mountOAuthConsent / __internal_unmountOAuthConsent as deprecated aliases
  • updates SDKs as needed while maintaining backward compatibility

Follow-up plan

  • SDKs can continue migrating to mountOAuthConsent / unmountOAuthConsent
  • __internal_*OAuthConsent can be removed in a later major once we intentionally drop compatibility with older published wrappers

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:

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 22, 2026

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

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
clerk-js-sandbox Skipped Skipped May 1, 2026 2:29am

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 22, 2026

🦋 Changeset detected

Latest commit: fe96c4a

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

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

- Rename __internal_OAuthConsentProps to OAuthConsentProps in @clerk/shared
- Rename __internal_mountOAuthConsent / __internal_unmountOAuthConsent to
  mountOAuthConsent / unmountOAuthConsent on the Clerk interface and clerk-js
- Add OAuthConsent and useOAuthConsent to the public exports of @clerk/react,
  @clerk/nextjs, @clerk/vue, @clerk/nuxt, and @clerk/astro
- Add @deprecated JSDoc to the existing /internal re-exports in @clerk/react
  and @clerk/nextjs pointing consumers to the public paths
- Update @clerk/ui type references to the renamed public types
@wobsoriano wobsoriano force-pushed the rob/oauth-consent-ga branch from b7eb222 to 2c33684 Compare April 22, 2026 18:06
@wobsoriano wobsoriano changed the title chore(clerk-js,ui): Move OAuthConsent component to public export chore(clerk-js,ui): Make OAuthConsent component public Apr 22, 2026
@wobsoriano wobsoriano marked this pull request as ready for review April 29, 2026 16:09
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 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
📝 Walkthrough

Walkthrough

Adds a new OAuthConsent UI component and useOAuthConsent hook as public APIs across multiple SDKs (Astro, React, Next.js, Nuxt, Vue, React Router, TanStack React Start). Introduces framework-specific wrapper components, updates export barrels and re-exports, expands InternalUIComponentId/type unions to include 'oauth-consent', and promotes internal mount/unmount methods to public mountOAuthConsent/unmountOAuthConsent while retaining deprecated internal wrappers.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: making the OAuthConsent component public across SDKs, which is the primary objective of the PR.
Description check ✅ Passed The description is clearly related to the changeset, detailing the rationale for maintaining backward compatibility with legacy runtime methods while exposing OAuthConsent as a public API.
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 Apr 29, 2026

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: fe96c4a

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
packages/clerk-js/src/core/clerk.ts (1)

1352-1392: ⚠️ Potential issue | 🟠 Major

Add explicit return type annotations for the new OAuthConsent public API methods.

Lines 1352, 1376, 1383, and 1390 define public methods without explicit return types. Public APIs in this repository must include explicit return type annotations (: void in this case).

Suggested fix
-  public mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
+  public mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps): void => {
@@
-  public unmountOAuthConsent = (node: HTMLDivElement) => {
+  public unmountOAuthConsent = (node: HTMLDivElement): void => {
@@
-  public __internal_mountOAuthConsent = (node: HTMLDivElement, props?: __internal_OAuthConsentProps) => {
+  public __internal_mountOAuthConsent = (
+    node: HTMLDivElement,
+    props?: __internal_OAuthConsentProps,
+  ): void => {
@@
-  public __internal_unmountOAuthConsent = (node: HTMLDivElement) => {
+  public __internal_unmountOAuthConsent = (node: HTMLDivElement): void => {
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/clerk-js/src/core/clerk.ts` around lines 1352 - 1392, The four
public methods mountOAuthConsent, unmountOAuthConsent,
__internal_mountOAuthConsent, and __internal_unmountOAuthConsent lack explicit
return type annotations; update their function signatures to include an explicit
": void" return type (e.g., change "public mountOAuthConsent = (node:
HTMLDivElement, props?: OAuthConsentProps)" to "public mountOAuthConsent =
(node: HTMLDivElement, props?: OAuthConsentProps): void"), and do the same for
unmountOAuthConsent, __internal_mountOAuthConsent, and
__internal_unmountOAuthConsent so the public API has explicit void return types.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@packages/clerk-js/src/core/clerk.ts`:
- Around line 1352-1392: The four public methods mountOAuthConsent,
unmountOAuthConsent, __internal_mountOAuthConsent, and
__internal_unmountOAuthConsent lack explicit return type annotations; update
their function signatures to include an explicit ": void" return type (e.g.,
change "public mountOAuthConsent = (node: HTMLDivElement, props?:
OAuthConsentProps)" to "public mountOAuthConsent = (node: HTMLDivElement,
props?: OAuthConsentProps): void"), and do the same for unmountOAuthConsent,
__internal_mountOAuthConsent, and __internal_unmountOAuthConsent so the public
API has explicit void return types.

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro

Run ID: 7fec644c-ae08-448a-a0e5-df62849dd863

📥 Commits

Reviewing files that changed from the base of the PR and between 5adabce and 0f340a8.

📒 Files selected for processing (6)
  • packages/astro/src/astro-components/interactive/OAuthConsent.astro
  • packages/astro/src/internal/mount-clerk-astro-js-components.ts
  • packages/astro/src/react/uiComponents.tsx
  • packages/clerk-js/src/core/clerk.ts
  • packages/shared/src/types/clerk.ts
  • packages/vue/src/components/ui-components/OAuthConsent.vue
✅ Files skipped from review due to trivial changes (2)
  • packages/astro/src/astro-components/interactive/OAuthConsent.astro
  • packages/vue/src/components/ui-components/OAuthConsent.vue
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/astro/src/internal/mount-clerk-astro-js-components.ts
  • packages/astro/src/react/uiComponents.tsx
  • packages/shared/src/types/clerk.ts

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

maybe it's safe just to remove this /internal export that was added just for OAuthConsent. Never used in any of our repos

Comment thread packages/react-router/src/internal.ts Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Comment on lines +12 to +13
:mount="clerk?.__internal_mountOAuthConsent"
:unmount="clerk?.__internal_unmountOAuthConsent"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any of these new components should likely be using the mountOAuthConsent or unmountOAuthConsent vs deprecated __internal methods right?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Oh, good catch 😄

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated!

@wobsoriano wobsoriano enabled auto-merge (squash) May 1, 2026 02:42
@wobsoriano wobsoriano merged commit 244920d into main May 1, 2026
73 of 74 checks passed
@wobsoriano wobsoriano deleted the rob/oauth-consent-ga branch May 1, 2026 02:45
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.

3 participants