docs(database): document signUp and changePassword - #208
Conversation
|
Warning Review limit reached
Next review available in: 59 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughDocumentation now covers database connection sign-up and change-password workflows for Auth and Server clients, including endpoint behavior, examples, response handling, validation, errors, client ID usage, and resolver behavior. ChangesDatabase connection documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
# Conflicts: # packages/auth0-auth-js/README.md
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/auth0-auth-js/EXAMPLES.md`:
- Line 1582: Update the changePassword documentation to describe the full input
contract: packages/auth0-auth-js/EXAMPLES.md lines 1582-1582 must state that
connection plus either email or username is accepted and show the username
alternative; packages/auth0-auth-js/README.md lines 336-340 and
packages/auth0-server-js/README.md lines 283-287 must also mention or link to
the username-based variant. No implementation changes are needed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: dc348d36-f914-4559-b048-cc174bddc4e8
📒 Files selected for processing (3)
packages/auth0-auth-js/EXAMPLES.mdpackages/auth0-auth-js/README.mdpackages/auth0-server-js/README.md
- Restore passkey sub-entries (Signup/Login Challenge, Exchanging a Credential) under "Using Passkeys" and move "Using Database Connections" after Custom Token Exchange to match the document body order, with correct sub-entries - Add an endpoints table to the Database Connections section and normalize the "Learn more:" link label - Clarify in auth0-server-js README that domain resolution is independent of session state (constructor domain in static mode; per-call resolver with storeOptions in resolver mode) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
changePassword accepts connection plus either email or username; the docs previously showed only the email path and incorrectly stated email is required. Correct the requirement to "email or username" and show the username-based alternative in EXAMPLES.md, auth0-auth-js README, and auth0-server-js README. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
LGTM, reviewed async with @tusharpandey13 |
2 participants
Summary
Documents the database-connection operations across both packages:
signUp(SignUpResulttable),changePassword, error-handling table (code+ sanitizedcause).ServerClient.signUp/changePasswordpure-passthrough (no session write) + resolver-mode note.Test plan
Depends on
Documents the API from #206 (
feat(database)). Merge after #206.Summary by CodeRabbit