Skip to content

chore(shared): Add JSDocs coverage for domain verification ownership - #8956

Merged
LauraBeatris merged 6 commits into
mainfrom
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged

chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom
laura/add-jsdocs-domain-ownership

Conversation

@LauraBeatris

@LauraBeatrisLauraBeatris commented Jun 22, 2026•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.

@LauraBeatrisLauraBeatris self-assigned this Jun 22, 2026
@changeset-bot

changeset-botBot commented Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5ee45bf

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 Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm

Request Review

@coderabbitai

coderabbitaiBot commented Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44

📥 Commits

Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.

📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough

Walkthrough

JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.

Changes

Organization Verification Documentation

Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.

Suggested reviewers

  • alexisintech

Poem

🐇 I hopped through docs with a tidy little flop,
TXT trails and domain notes went straight to the top.
A link now rewrites with a cheerful new tune,
And a changeset dances by soft rabbit moon.
Hop-hop, the comments are neat as can be!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

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

@LauraBeatrisLauraBeatris changed the title chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris requested a review from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris marked this pull request as ready for review June 22, 2026 22:04
@pkg-pr-new

pkg-pr-newBot commented Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 5ee45bf

@github-actions

github-actionsBot commented Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-06-24T13:25:12.288Z

Summary

MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0

No API Changes Detected

All packages have stable APIs with no detected changes.

Report generated by Break Check

Last ran on 5ee45bf.

coderabbitai[bot]
coderabbitaiBot reviewed Jun 22, 2026
View reviewed changes

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro

Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34

📥 Commits

Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.

📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts

Comment threadpackages/shared/src/types/organizationDomain.ts Outdated
@LauraBeatris
LauraBeatrisforce-pushed the laura/add-jsdocs-domain-ownership branch from ee8f1fc to 976dc37CompareJune 22, 2026 22:13
@alexisintech

alexisintech commented Jun 22, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

I updated the changeset to be empty as updating comments doesn't require a patch version update!

@alexisintechalexisintech mentioned this pull request Jun 22, 2026
Closed
@LauraBeatris

LauraBeatris commented Jun 22, 2026

Copy link
Copy Markdown
ContributorAuthor

@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?

@SarahSoutoulSarahSoutoul mentioned this pull request Jun 22, 2026
Merged
@LauraBeatris
LauraBeatrisforce-pushed the laura/add-jsdocs-domain-ownership branch from 53f9993 to 5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris enabled auto-merge (squash) June 24, 2026 13:29
@LauraBeatris
LauraBeatris merged commit f23ac11 into mainJun 24, 2026
50 checks passed
@LauraBeatris
LauraBeatris deleted the laura/add-jsdocs-domain-ownership branch June 24, 2026 13:30
@coderabbitaicoderabbitaiBot mentioned this pull request Jun 29, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
+2 more reviewers
@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared): Add JSDocs coverage for domain verification ownership by LauraBeatris · Pull Request #8956 · clerk/javascript · GitHub
Skip to content
chore(shared): Add JSDocs coverage for domain verification ownership - #8956
Merged
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Jun 24, 2026
Merged
chore(shared): Add JSDocs coverage for domain verification ownership#8956
LauraBeatris merged 6 commits into
mainfrom 
laura/add-jsdocs-domain-ownership
Conversation
@LauraBeatris
@LauraBeatrisLauraBeatris
commented
Jun 22, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen

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

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This PR adds JSDocs coverage to the latest types updates for organization domain verification via TXT records ownership
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
Summary by CodeRabbit
  • Documentation
    • Expanded and clarified JSDoc for organization verified-domain types, including affiliation verification details and legacy verification field mapping.
    • Improved documentation for verified-domain ownership flows and bulk ownership verification, clarifying single-bad-domain behavior and how per-domain partial success populates results (data vs errors).
    • Updated typedoc link rewriting so the organization-domain-verification reference resolves to the correct reference page.
  • Chores
    • Added a Changeset entry for this documentation-only update.
@LauraBeatrisLauraBeatris
self-assigned this
Jun 22, 2026
@changeset-bot
changeset-botBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 5ee45bf
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
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 24, 2026 1:23pm
swingsetReadyReadyPreview, CommentJun 24, 2026 1:23pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: a43fd7df-5dd4-4dbe-aab8-279ac7a3bf44
📥 Commits
Reviewing files that changed from the base of the PR and between 53f9993 and 5ee45bf.
📒 Files selected for processing (4)
  • .changeset/bumpy-ways-brake.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organization.ts
  • packages/shared/src/types/organizationDomain.ts
💤 Files with no reviewable changes (1)
  • .changeset/bumpy-ways-brake.md
✅ Files skipped from review due to trivial changes (3)
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/organizationDomain.ts
  • packages/shared/src/types/organization.ts
📝 Walkthrough
Walkthrough
JSDoc comments for organization domain verification and ownership types are rewritten across shared type files, typedoc link rewriting is updated, and a new changeset entry is added.
Changes
Organization Verification Documentation
Layer / File(s)Summary
Domain verification type JSDoc
packages/shared/src/types/organizationDomain.ts		JSDoc for OrganizationDomainVerification, OrganizationDomainOwnershipVerification, OrganizationEnrollmentMode, OrganizationDomainBulkOwnershipVerificationError, and OrganizationDomainsBulkOwnershipVerificationResource is reworded to describe affiliation and ownership verification semantics, nullability, and partial-success behavior.
Resource method JSDoc
packages/shared/src/types/organizationDomain.ts, packages/shared/src/types/organization.ts		JSDoc for OrganizationDomainResource affiliation verification methods and OrganizationResource ownership verification methods is updated, along with parameter comments for affiliation verification params.
Typedoc link mapping and changeset
.typedoc/custom-plugin.mjs, .changeset/bumpy-ways-brake.md		LINK_REPLACEMENTS adds a mapping for organization-domain-verification, and a new changeset file records the documentation updates.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
  • clerk/javascript#8748: Both PRs modify packages/shared/src/types/organizationDomain.ts around organization domain verification and ownership documentation.
  • clerk/javascript#8825: Both PRs update JSDoc in packages/shared/src/types/organizationDomain.ts for organization domain and enrollment-mode references.
  • clerk/javascript#8957: Both PRs update .typedoc/custom-plugin.mjs link rewriting rules.
Suggested reviewers
  • alexisintech
Poem
🐇 I hopped through docs with a tidy little flop,

TXT trails and domain notes went straight to the top.

A link now rewrites with a cheerful new tune,

And a changeset dances by soft rabbit moon.

Hop-hop, the comments are neat as can be!
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: adding JSDoc coverage for shared domain verification ownership docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@LauraBeatrisLauraBeatris
changed the title
chore(shared): Add JSDocs for domain verification ownership methodschore(shared): Add JSDocs coverage for domain verification ownershipJun 22, 2026
@LauraBeatris
LauraBeatris
requested a review
from a teamJune 22, 2026 22:03
@LauraBeatris
LauraBeatris
marked this pull request as ready for review
June 22, 2026 22:04
@pkg-pr-new
pkg-pr-newBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@8956

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@8956

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@8956

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@8956

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 5ee45bf
@github-actions
github-actionsBot
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-24T13:25:12.288Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 5ee45bf.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jun 22, 2026
View reviewed changes
@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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Around line 67-83: The JSDoc comments for the `txtRecordName` and
`txtRecordValue` fields are making overly specific timing guarantees that the
`string | null` type signature does not enforce. Revise the JSDoc for both
fields to soften the wording and avoid implying that these values are guaranteed
to be present only immediately after calling `prepareOwnershipVerification`.
Instead, use language that acknowledges the values may or may not be populated
depending on the current state, without making specific promises about timing.
Replace phrases like "Only present immediately after" with more flexible
language that aligns with what the type signature actually guarantees.

🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
  •  Push a commit to this branch (recommended)
  •  Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 167d2d3c-f5b0-4c13-80ca-28885f60db34
📥 Commits
Reviewing files that changed from the base of the PR and between cb825c2 and ee8f1fc.
📒 Files selected for processing (2)
  • .changeset/bumpy-ways-brake.md
  • packages/shared/src/types/organizationDomain.ts
Comment threadpackages/shared/src/types/organizationDomain.ts
Outdated

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
ee8f1fc to
976dc37CompareJune 22, 2026 22:13
@alexisintech
alexisintech
commented
Jun 22, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
I updated the changeset to be empty as updating comments doesn't require a patch version update!
@alexisintechalexisintech
mentioned this pull request
Jun 22, 2026
 Closed

@LauraBeatris
LauraBeatris
commented
Jun 22, 2026

Copy link


Copy Markdown

ContributorAuthor
@alexisintech Once we release @clerk/shared as a package, wouldn't we need to build the new JSDocs so it can be referenced by the code?
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 22, 2026
 Merged

@LauraBeatris
LauraBeatrisforce-pushed
the
laura/add-jsdocs-domain-ownership
branch
from
53f9993 to
5ee45bfCompareJune 24, 2026 13:21
@LauraBeatris
LauraBeatris
enabled auto-merge (squash)
June 24, 2026 13:29
@LauraBeatris
LauraBeatris
merged commit f23ac11
into
mainJun 24, 2026

50 checks passed

@LauraBeatris
LauraBeatris
deleted the

laura/add-jsdocs-domain-ownership

branch
June 24, 2026 13:30
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jun 29, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

+2 more reviewers

@im2nguyenim2nguyenim2nguyen approved these changes
@alexisintechalexisintechalexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@LauraBeatrisLauraBeatris

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@LauraBeatris@alexisintech@im2nguyen