fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix(shared): Export new types folder for typedoc output - #7106

Merged
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc
Nov 5, 2025
Merged

fix(shared): Export new types folder for typedoc output#7106
alexisintech merged 5 commits into
mainfrom
aa/fix-typedoc

Conversation

@alexisintech

@alexisintechalexisintech commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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

changeset-botBot commented Oct 30, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3e25570

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

vercelBot commented Oct 30, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
clerk-js-sandboxReadyReadyPreviewCommentNov 4, 2025 7:44pm

@coderabbitai

coderabbitaiBot commented Oct 30, 2025

Copy link
Copy Markdown
Contributor

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe 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.

Comment threadpackages/shared/typedoc.json Outdated
@pkg-pr-new

pkg-pr-newBot commented Oct 30, 2025

Copy link
Copy Markdown

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: 3e25570

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

This comment has been minimized.

@alexisintech
alexisintech merged commit f97679a into mainNov 5, 2025
40 checks passed
@alexisintech
alexisintech deleted the aa/fix-typedoc branch November 5, 2025 05:05
Sign up for freeto 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.

3 participants

@alexisintech@SarahSoutoul@NWylynko