Skip to content

fix(backend): point lockUser() JSDoc to the Sign-in security page - #10745

Open
brunol95 wants to merge 2 commits into
mainfrom
bruno/lockuser-brute-force-link
Open

brunol95 wants to merge 2 commits into
mainfrom
bruno/lockuser-brute-force-link

Conversation

@brunol95

@brunol95 brunol95 commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Description

The Clerk Dashboard is moving the user lockout settings from the Protections page under Protect to a new Sign-in security page under User & authentication, at /~/user-authentication/sign-in-security (clerk/dashboard#10728). This updates the lockUser() JSDoc to link to the new page. An earlier version of this PR linked to a planned /~/protect/brute-force page, which never shipped.

The lockUser() reference page in the docs is generated from this JSDoc. The related clerk/clerk#3815 updates the handwritten guides; the generated reference page will receive this link through the TypeDoc sync.

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

Do not merge until this Dashboard stack is deployed to production, in order:

  1. clerk/dashboard#10722 — split Protections into Basic and Advanced tabs.
  2. clerk/dashboard#10725 — add action and flow tags to protection rows.
  3. clerk/dashboard#10727 — move the blocklist into Protections as "Block account identifiers".
  4. clerk/dashboard#10728 — move Device Trust, lockout and enumeration to Sign-in security under User & authentication.

Before this stack reaches production, the new link points to a page that does not 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 ran (lint-staged); Prettier passes.
  • (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 17, 2026 12:01am UTC
swingset Ready Ready Preview Nov 17, 2026 12:01am UTC

Request Review

@changeset-bot

changeset-bot Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: c9b7f1f

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() documentation link now points to the Sign-in security page under User & authentication. A patch changeset records the update. The method implementation is unchanged.

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

Possibly related PRs

  • clerk/javascript#10395: Updates the lockUser() documentation link and related user-lockout documentation links.

Suggested reviewers: mwickett

Merge Risk: Minimal · up to c9b7f

This is a documentation-comment link update with no runtime effect. Merge only after the Dashboard deployments land, as the PR already states, so the link resolves.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the change: the lockUser() JSDoc now links to the Sign-in security page. It matches the single change in UserApi.ts and the changeset. The 'fix(backend)' prefix describes a comment-onl…
Description check Passed The description states that the lockUser() JSDoc now links to the new Sign-in security page, which matches the changeset. It also explains the rollout dependency on Dashboard PRs, the docs sync, and t…
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: Title check

Explanation

The title names the change: the lockUser() JSDoc now links to the Sign-in security page. It matches the single change in UserApi.ts and the changeset. The 'fix(backend)' prefix describes a comment-only edit, which is a minor mismatch but does not make the title misleading.

Full details: Description check

Explanation

The description states that the lockUser() JSDoc now links to the new Sign-in security page, which matches the changeset. It also explains the rollout dependency on Dashboard PRs, the docs sync, and the testing status. It is directly related to the change.

  • 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: e804e939-b8f9-412d-b1d6-f3881fefee52
Commits

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

Files selected for processing: 2

  • .changeset/lockuser-sign-in-security-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. 6 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: c9b7f1f

@github-actions

github-actions Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-11-17T00:04:42.587Z

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 c9b7f1f.

@SarahSoutoul SarahSoutoul 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.

LGTM! But yeah only merge when things are ready Dashboard wise. Once this is merged, you'll need to trigger a Typedoc sync for the changes to appear in the docs.

The Dashboard moved the lockout settings to Sign-in security under
User & authentication (/user-authentication/sign-in-security) instead of
the planned /protect/brute-force page, which never shipped.

Part of PROT-1263

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@brunol95 brunol95 changed the title fix(backend): point lockUser() JSDoc to the Brute force protection page fix(backend): point lockUser() JSDoc to the Sign-in security page Nov 16, 2026

This branch was successfully deployed

2 active deployments
Preview – swingset — c9b7f1f2 Deployed Nov 17, 2026 by vercel[bot]
Preview – clerk-js-sandbox — c9b7f1f2 Deployed Nov 17, 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.

2 participants