Skip to content

fix(backend): point lockUser() JSDoc to the Brute force protection page - #10745

Open
brunol95 wants to merge 1 commit into
mainfrom
bruno/lockuser-brute-force-link
Open

brunol95 wants to merge 1 commit into
mainfrom
bruno/lockuser-brute-force-link

Conversation

@brunol95

Copy link
Copy Markdown
Contributor

Description

The Clerk Dashboard is moving the user lockout settings from the Protections page to a new Brute force protection page at /~/protect/brute-force (clerk/dashboard#10728). This updates the lockUser() JSDoc to link to the new page.

The lockUser() reference page in the docs is generated from this JSDoc. clerk/clerk#3815 makes the same change to the generated copy. Without this PR, the next Typedoc refresh would revert it.

This changes only the comment; there is no runtime change.

Do not merge until the Dashboard stack (clerk/dashboard#10722 → #10725 → #10727 → #10728) is in production. Before then, the link points to a page that doesn't exist yet.

Checklist

  • pnpm test runs as expected. Not run: the change is to a doc comment only.
  • pnpm build runs as expected. Not run, for the same reason. The pre-commit hook couldn't start locally (pnpm 12 wasn't installable), so I ran its Prettier check by hand; it passed.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated: clerk/clerk#3815

Type of change

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

Part of PROT-1263

🤖 Generated with Claude Code

The Dashboard moves the lockout settings from Protections to a new
Brute force protection page (/~/protect/brute-force).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Nov 10, 2026 4:01pm UTC
swingset Ready Ready Preview Nov 10, 2026 4:01pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Nov 10, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: c07b3cf

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

This PR includes changesets to release 11 packages
Name Type
@clerk/backend Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/swingset Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The lockUser() JSDoc link now points to the Dashboard’s Brute force protection page. A patch changeset records the documentation update. The method implementation is unchanged.

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

Possibly related PRs

  • clerk/javascript#10395: Changed the lockUser() JSDoc link to the Protections Dashboard page; this PR updates it to the Brute force protection page.

Suggested reviewers: mwickett

Merge Risk: Minimal · up to c07b3

The link update has no runtime effect. Confirm the Dashboard page is deployed before merging, as planned.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title clearly identifies the lockUser() JSDoc link update to the Brute force protection page.
Description check Passed The description explains the JSDoc link change, its destination, and that it does not change runtime behavior.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (1 skipped: 1 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Linked repositories: Some configured repositories could not be included in this review. Cross-repository analysis may be incomplete. Please check linked-repository access and settings.

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: clerk/javascript
  • Branch: main
  • File: .coderabbit.yaml
  • Commit: 01aaab7
  • Layers: Repository YAML (base), Organization UI (inherited)
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: 34325c15-0d30-43a5-8793-5dfaec767f74
Commits

Reviewing files that changed from the base of the PR and between 01aaab7 and c07b3cf.

Files selected for processing: 2

  • .changeset/lockuser-brute-force-link.md
  • packages/backend/src/api/endpoints/UserApi.ts
Linked repositories identified

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

Included review availability: This review used your included allowance. 5 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.

@pkg-pr-new

pkg-pr-new Bot commented Nov 10, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-biometrics

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

@clerk/expo-google-signin

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

@clerk/expo-native-components

npm i https://pkg.pr.new/@clerk/expo-native-components@10745

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@10745

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: c07b3cf

@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-11-10T16:04:21.123Z

Summary

Metric Count
Packages analyzed 20
Packages with changes 0
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 0

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on c07b3cf.

This branch was successfully deployed

2 active deployments
Preview – swingset — c07b3cf6 Deployed Nov 10, 2026 by vercel[bot]
Preview – clerk-js-sandbox — c07b3cf6 Deployed Nov 10, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant