Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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" + '
docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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('^' + ".*" + ' docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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('^' + ".*" + ' docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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" + ' docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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('^' + ".*" + ' docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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('^' + ".*" + ' docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, '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); } })(); })(); docs(backend): Correct Dashboard labels in instance restrictions by manovotny · Pull Request #9253 · clerk/javascript · GitHub
Skip to content

docs(backend): Correct Dashboard labels in instance restrictions - #9253

Merged
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label
Jul 27, 2026
Merged

docs(backend): Correct Dashboard labels in instance restrictions#9253
manovotny merged 2 commits into
mainfrom
manovotny/fix-disposable-email-toggle-label

Conversation

@manovotny

@manovotnymanovotny commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

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:

…mailDomains
The bolded label read "Block sign-ups that use disposable email domains",
but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable
email addresses". Property names are unchanged.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercelBot commented Jul 27, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 27, 2026 3:58pm
swingsetReadyReadyPreview, CommentJul 27, 2026 3:58pm

Request Review

@changeset-bot

changeset-botBot commented Jul 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1bf6b4a

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

This PR includes changesets to release 10 packages
NameType
@clerk/backendPatch
@clerk/astroPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch

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

@pkg-pr-new

pkg-pr-newBot commented Jul 27, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1bf6b4a

No "Ignore dots for Gmail addresses" toggle exists in the Clerk Dashboard —
the setting appears only in the generated DAPI spec, and the backend strips
Gmail dots unconditionally. Bold marks a Dashboard label, so this drops it
and matches the wording already used on UpdateRestrictionsParams.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@manovotny
manovotny marked this pull request as ready for review July 27, 2026 16:04
@manovotnymanovotny changed the title docs(backend): Correct the Dashboard toggle name for blockDisposableEmailDomainsdocs(backend): Correct Dashboard labels in instance restrictionsJul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

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 1bf6b4a.

@coderabbitai

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)
  • .changeset/fix-disposable-email-toggle-label.md
  • packages/backend/src/api/endpoints/InstanceApi.ts
  • packages/backend/src/api/resources/InstanceRestrictions.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go(manual)
  • clerk/dashboard(manual)
  • clerk/accounts(manual)
  • clerk/backoffice(manual)
  • clerk/clerk(manual) → reviewed against open PR #3034bsid/yahoo-subaddressing instead of the default branch
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
  • clerk/cli(auto-detected)

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers:alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly describes the documentation label corrections in backend instance restrictions.
Description check✅ PassedThe description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
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.

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

@manovotny
manovotny merged commit 6f5fde9 into mainJul 27, 2026
87 of 90 checks passed
@manovotny
manovotny deleted the manovotny/fix-disposable-email-toggle-label branch July 27, 2026 17:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter