Skip to content

Conversation

@alexisintech
Copy link
Member

@alexisintech alexisintech commented Oct 30, 2025

Description

Types were moved from @clerk/types to @clerk/shared/types (PR)
We need to export the typedoc output from the new shared/types folder

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 documentation configuration to include generated type definitions in the docs build.
    • Added a lightweight changeset file to record this update for release tracking.

@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2025

🦋 Changeset detected

Latest commit: ab8ea9d

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

vercel bot commented Oct 30, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Oct 31, 2025 9:59pm

@alexisintech alexisintech requested a review from NWylynko October 30, 2025 19:13
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2025

Walkthrough

Updated TypeDoc configuration to include generated type files from src/types and added a new changeset metadata file; no code logic or public API declarations were modified.

Changes

Cohort / File(s) Change Summary
TypeDoc configuration
packages/shared/typedoc.json
Added ./src/types/*.ts to the entryPoints array so generated types in src/types are included in TypeDoc input.
Changeset metadata
.changeset/tall-melons-switch.md
Added a new changeset file containing minimal placeholder content (---).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Check the glob pattern in packages/shared/typedoc.json matches the intended generated files and doesn't unintentionally include unrelated files.
  • Run TypeDoc generation locally to ensure no config errors and that the new files appear as expected.
  • Verify the new .changeset/*.md file follows repo conventions (format, required fields) if applicable.

Poem

A rabbit nibbles through the trees of code,
Finds src/types now in documentation's road.
A tiny changeset, simple and sweet,
Hops into history with tiny feet. 🐇✨

Pre-merge checks and finishing touches

❌ 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%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "fix(shared): Export new types folder for typedoc output" accurately reflects the main change in the pull request, which is updating the TypeDoc configuration in packages/shared/typedoc.json to include the new types folder by adding ./src/types/*.ts to the entryPoints array. The title is concise, uses proper conventional commit formatting with a scope, and clearly communicates the purpose of the change. A developer reviewing the commit history would immediately understand that this PR makes types available for TypeDoc documentation generation following the types migration from @clerk/types to @clerk/shared/types.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch aa/fix-typedoc

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

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

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 30, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: ab8ea9d

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

Actionable comments posted: 1

📜 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 ba46df6 and 54347c2.

📒 Files selected for processing (1)
  • .changeset/tall-melons-switch.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**

📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

  • .changeset/tall-melons-switch.md
🪛 LanguageTool
.changeset/tall-melons-switch.md

[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---

(QB_NEW_DE)

⏰ 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: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep-cloud-platform/scan

Comment on lines +1 to +2
---
---
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Incomplete changeset format—missing package metadata and description.

The changeset file is empty. According to the Changesets convention and the coding guidelines requiring automated releases to use Changesets, this file must include:

  1. Package name and version bump type (e.g., @clerk/shared: patch)
  2. A brief description of the change

Without this metadata, the release automation will not function correctly.

Based on the PR objectives (moving types and updating exports for TypeDoc), a typical changeset should look like:

 ---
----
+@clerk/shared: patch
+---
+
+Export new types folder for TypeDoc output

Please update the changeset with the appropriate package name, version bump type (patch/minor/major), and a description of the change.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
---
---
---
@clerk/shared: patch
---
Export new types folder for TypeDoc output
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---

(QB_NEW_DE)

🤖 Prompt for AI Agents
In .changeset/tall-melons-switch.md around lines 1 to 2, the changeset is empty
so release automation will fail; update the file to include the package
identifier and bump type (e.g., "@clerk/shared: patch" or the correct package(s)
and chosen bump level) on the first line and a short descriptive summary on the
following line(s) describing the change (for example: "Move types and update
exports for TypeDoc generation"). Ensure the package name(s), bump type(s), and
a concise description are present and saved.

@blacksmith-sh
Copy link

blacksmith-sh bot commented Oct 31, 2025

Found 57 test failures on Blacksmith runners:

Test View Logs
[chrome] › integration/tests/
components.test.ts:102:9 › component smoke tests @generic › long-running--next.appRoute
r.withEmailCodes › SignIn supports fallback
View Logs
[chrome] › integration/tests/
components.test.ts:102:9 › component smoke tests @generic › long-running--next.appRoute
r.withEmailCodes › Waitlist supports fallback
View Logs
[chrome] › integration/tests/
components.test.ts:102:9 › component smoke tests @generic › long-running--react.vite.wi
thEmailCodes › SignIn supports fallback
View Logs
[chrome] › integration/tests/
components.test.ts:102:9 › component smoke tests @generic › long-running--react.vite.wi
thEmailCodes › Waitlist supports fallback
View Logs
[chrome] › integration/tests/
custom-pages.test.ts:175:11 › user profile custom pages @generic › long-running--react.
vite.withEmailCodes › User Button with experimental asStandalone and asProvider › items
at the specified order
View Logs
[chrome] › integration/tests/
custom-pages.test.ts:299:11 › user profile custom pages @generic › long-running--react.
vite.withEmailCodes › User Button custom items › onClick custom item action
View Logs
[chrome] › integration/tests/
custom-pages.test.ts:65:13 › user profile custom pages @generic › long-running--react.v
ite.withEmailCodes › Custom pages coming from <UserButton/>
› user profile has all custom pages with icons in the side nav with specified order
View Logs
[chrome] › integration/tests/
custom-pages.test.ts:65:13 › user profile custom pages @generic › long-running--react.v
ite.withEmailCodes › Custom pages coming from <UserProfile/>
› user profile has all custom pages with icons in the side nav with specified order
View Logs
[chrome] › integration/tests/
dynamic-keys.test.ts:92:7 › dynamic keys @nextjs › calls clerkClient with dynamic key
s from middleware runtime
View Logs
[chrome] › integration/tests/elements/
next-sign-in.test.ts:100:7 › Next.js Sign-In Flow @elements › long-running--elements.ne
xt.appRouter › sign in only with phone number
View Logs
[chrome] › integration/tests/elements/
next-sign-in.test.ts:134:7 › Next.js Sign-In Flow @elements › long-running--elements.ne
xt.appRouter › can reset password
View Logs
[chrome] › integration/tests/elements/
next-sign-in.test.ts:33:7 › Next.js Sign-In Flow @elements › long-running--elements.nex
t.appRouter › sign in with email and password
View Logs
[chrome] › integration/tests/elements/
next-sign-up.test.ts:13:7 › Next.js Sign-Up Flow @elements › long-running--elements.nex
t.appRouter › sign up with email and password
View Logs
[chrome] › integration/tests/elements/
next-sign-up.test.ts:89:7 › Next.js Sign-Up Flow @elements › long-running--elements.nex
t.appRouter › can sign up with phone number
View Logs
[chrome] › integration/tests/elements/
otp.test.ts:196:9 › OTP @elements › long-running--elements.next.appRouter › Type: segme
nted-otp › should forward-delete char when pressing delete
View Logs
[chrome] › integration/tests/
oauth-flows.test.ts:38:7 › oauth flows @nextjs › long-running--next.appRouter.withEmail
Codes › sign up with custom oauth provider
View Logs
[chrome] › integration/tests/
oauth-flows.test.ts:38:7 › oauth flows @nextjs › long-running--next.appRouter.withEmail
Codes › sign up with custom oauth provider
View Logs
[chrome] › integration/tests/
oauth-flows.test.ts:38:7 › oauth flows @nextjs › long-running--next.appRouter.withEmail
Codes › sign up with custom oauth provider
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.astro.
node › when signed in flow › subscribes to a plan
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.next.a
ppRouter › when signed in flow › subscribes to a plan
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.vue.vi
te › when signed in flow › subscribes to a plan
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:221:7 › pricing table @billing › long-running--withBilling.next.a
ppRouter › user is prompted to add email before checkout
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:221:7 › pricing table @billing › long-running--withBilling.vue.vi
te › user is prompted to add email before checkout
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:250:7 › pricing table @billing › long-running--withBilling.next.a
ppRouter › starts free trial subscription for new user
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:26:9 › pricing table @billing › long-running--withBilling.vue.vit
e › when signed out › renders pricing table with plans
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:456:9 › pricing table @billing › long-running--withBilling.vue.vi
te › in UserProfile › renders pricing table, subscribes to a plan, revalidates payment
method on complete and then downgrades to free
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:588:9 › pricing table @billing › long-running--withBilling.next.a
ppRouter › in UserProfile › adds payment method via checkout and resets stripe setup in
tent after failed payment
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:625:9 › pricing table @billing › long-running--withBilling.next.a
ppRouter › in UserProfile › displays notice then plan cannot change
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:80:9 › pricing table @billing › long-running--withBilling.next.ap
pRouter › when signed in flow › when signed in, clicking get started button opens check
out drawer and shows free plan as active
View Logs
[chrome] › integration/tests/
pricing-table.test.ts:80:9 › pricing table @billing › long-running--withBilling.vue.vit
e › when signed in flow › when signed in, clicking get started button opens checkout dr
awer and shows free plan as active
View Logs
[chrome] › integration/tests/
redirects.test.ts:34:9 › redirect props @nextjs › long-running--next.appRouter.withEmai
lCodes › SignInButton › sign in button respects forceRedirectUrl
View Logs
[chrome] › integration/tests/
redirects.test.ts:34:9 › redirect props @nextjs › long-running--next.appRouter.withEmai
lCodes › SignInButton › sign in button respects forceRedirectUrl
View Logs
[chrome] › integration/tests/
redirects.test.ts:34:9 › redirect props @nextjs › long-running--next.appRouter.withEmai
lCodes › SignInButton › sign in button respects forceRedirectUrl
View Logs
[chrome] › integration/tests/
redirects.test.ts:70:9 › redirect props @nextjs › long-running--next.appRouter.withEmai
lCodes › SignUpButton › sign up button respects forceRedirectUrl
View Logs
[chrome] › integration/tests/
redirects.test.ts:70:9 › redirect props @nextjs › long-running--next.appRouter.withEmai
lCodes › SignUpButton › sign up button respects forceRedirectUrl
View Logs
[chrome] › integration/tests/
session-tasks-multi-session.test.ts:33:9 › session tasks multi-session flow @nextjs › l
ong-running--next.appRouter.withSessionTasks › when switching sessions, navigate to tas
k
View Logs
[chrome] › integration/tests/
session-tasks-multi-session.test.ts:33:9 › session tasks multi-session flow @nextjs › l
ong-running--next.appRouter.withSessionTasks › when switching sessions, navigate to tas
k
View Logs
[chrome] › integration/tests/
sign-in-flow.test.ts:26:7 › sign in flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign in with email and password
View Logs
[chrome] › integration/tests/
sign-in-flow.test.ts:26:7 › sign in flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign in with email and password
View Logs
[chrome] › integration/tests/
sign-in-flow.test.ts:26:7 › sign in flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign in with email and password
View Logs
[chrome] › integration/tests/
sign-in-flow.test.ts:74:7 › sign in flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign in only with phone number
View Logs
[chrome] › integration/tests/
sign-in-or-up-flow.test.ts:29:9 › sign-in-or-up flow @nextjs › long-running--next.appRo
uter.withSignInOrUpFlow › sign-in › flows are combined
View Logs
[chrome] › integration/tests/
sign-in-or-up-flow.test.ts:29:9 › sign-in-or-up flow @nextjs › long-running--next.appRo
uter.withSignInOrUpFlow › sign-in › flows are combined
View Logs
[chrome] › integration/tests/
sign-in-or-up-flow.test.ts:29:9 › sign-in-or-up flow @nextjs › long-running--next.appRo
uter.withSignInOrUpFlow › sign-in › flows are combined
View Logs
[chrome] › integration/tests/
sign-in-or-up-flow.test.ts:88:9 › sign-in-or-up flow @nextjs › long-running--next.appRo
uter.withSignInOrUpFlow › sign-in › sign in only with phone number
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:124:7 › sign up flow @generic @nextjs › long-running--next.appRout
er.withEmailCodes › sign up with first name, last name, email, phone and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:124:7 › sign up flow @generic @nextjs › long-running--next.appRout
er.withEmailCodes › sign up with first name, last name, email, phone and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:124:7 › sign up flow @generic @nextjs › long-running--next.appRout
er.withEmailCodes › sign up with first name, last name, email, phone and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:13:7 › sign up flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign up with email and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:13:7 › sign up flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign up with email and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:13:7 › sign up flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › sign up with email and password
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:163:7 › sign up flow @generic @nextjs › long-running--next.appRout
er.withEmailCodes › sign up, sign out and sign in again
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:65:7 › sign up flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › can sign up with phone number
View Logs
[chrome] › integration/tests/
sign-up-flow.test.ts:65:7 › sign up flow @generic @nextjs › long-running--next.appRoute
r.withEmailCodes › can sign up with phone number
View Logs
[chrome] › integration/tests/
unsafeMetadata.test.ts:13:7 › unsafeMetadata @nextjs › long-running--next.appRouter.wit
hEmailCodes › sign up persists unsafeMetadata
View Logs
[chrome] › integration/tests/
unsafeMetadata.test.ts:42:7 › unsafeMetadata @nextjs › long-running--next.appRouter.wit
hEmailCodes › combined sign up persists unsafeMetadata
View Logs
[setup] › integration/tests/
global.setup.ts:7:6 › start long running apps ─────────────────────
View Logs


Fix in Cursor

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.

4 participants