Release v2.24.0

[pmathew92]

Added

• feat: Add granular passkey APIs (getSignupChallenge, getLoginChallenge, getTokenWithPasskey) #1678 (pmathew92)

Summary by CodeRabbit

• New Features

  • Added documented granular passkey operations for login challenges, signup challenges, and token retrieval.
  • Added guidance for using online access, including Early Access status and Ephemeral Sessions limitations.

• Documentation

  • Updated CDN installation examples to reference version 2.24.
  • Expanded and refreshed API reference content, navigation, search, and source links.
  • Added documentation for new passkey challenge and token options.

• Release

  • Released version 2.24.0.

[coderabbitai]

📝 Walkthrough

Walkthrough

Version 2.24.0 updates package metadata, CDN examples, Online Access guidance, generated API documentation, search/navigation assets, and Passkey API documentation.

Changes

Release documentation and metadata

Layer / File(s)	Summary
Version and installation references .version, package.json, src/version.ts, FAQ.md, README.md, docs/index.html	Version references and CDN examples now use 2.24.0/2.24.
Generated documentation docs/classes/*, docs/interfaces/*, docs/types/*, docs/enums/*, docs/functions/*, docs/variables/*	Generated pages were refreshed with updated source links, markup, indexes, and selected documentation corrections.
Passkey documentation docs/classes/PasskeyApiClient.html, docs/types/Passkey*.html, docs/modules.html	Granular Passkey methods and their related challenge/token types are documented and indexed.
Documentation assets docs/assets/navigation.js, docs/assets/search.js	Embedded navigation and browser search payloads were regenerated.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

• auth0/auth0-spa-js#1650: Related Online Access documentation and createAuth0Client overload updates.
• auth0/auth0-spa-js#1678: Related granular Passkey API and type documentation.

Suggested reviewers: nandanprabhu

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title matches the release/version bump theme of the PR, though it does not mention the new passkey APIs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch release/v2.24.0

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 7

🤖 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 `@docs/interfaces/ClientConfiguration.html`:
- Line 3: Remove the duplicate ClientConfiguration.html#domain link from the
Properties index, leaving exactly one domain navigation entry and preserving all
other index entries.

In `@docs/interfaces/ConnectResponse.html`:
- Around line 2-4: Regenerate the ConnectResponse documentation page to remove
the duplicate Properties index entries for connect_params, connect_uri, and
expires_in, ensuring each property appears exactly once while preserving the
remaining index content.

In `@docs/interfaces/EmailEnrollmentVerifyOptions.html`:
- Around line 1-5: Regenerate the TypeDoc output from a clean directory so
docs/interfaces/EmailEnrollmentVerifyOptions.html contains each index,
Properties section, sidebar entry, and anchor only once. Also regenerate
docs/interfaces/EnrollEmailParams.html with one interface/property block and
correct source links: factorType to mfa/types.ts:86, email to mfa/types.ts:88,
and inherited mfaToken to mfa/types.ts:50.

In `@docs/interfaces/EnrollVoiceParams.html`:
- Around line 2-8: Regenerate the TypeDoc output from a clean build, removing
duplicated page trees, signatures, anchors, index entries, and member sections.
In docs/interfaces/EnrollVoiceParams.html lines 2-8, ensure phoneNumber is
attributed to EnrollVoiceParams; apply the corresponding cleanup to
docs/interfaces/EnrollmentFactor.html lines 2-4, docs/interfaces/Factor.html
lines 1-3, docs/interfaces/GetTokenSilentlyOptions.html lines 1-1 and 16-25, and
docs/interfaces/GetTokenWithPopupOptions.html lines 1-8. Correct stale source
and inheritance links, including cacheMode being declared on
GetTokenWithPopupOptions at global.ts:605.

In `@docs/interfaces/LogoutOptions.html`:
- Around line 1-9: Regenerate the affected TypeDoc pages from a clean output
directory to eliminate duplicated roots, indexes, anchors, and member sections.
In docs/interfaces/LogoutOptions.html (lines 1-9 and 24-34), retain one
document/index output and one onRedirect/openUrl section with correct source
attribution; in docs/interfaces/LogoutUrlOptions.html (lines 1-7 and 22), retain
one document root, logoutParams index entry, and member section; in
docs/interfaces/MfaRequirements.html (lines 2-6), retain one interface with
challenge/enroll sections; and in docs/interfaces/OobEnrollmentResponse.html
(lines 2-16) and docs/interfaces/OtpEnrollmentResponse.html (lines 2-12), retain
one interface and one section per property.

In `@docs/interfaces/PhoneEnrollmentVerifyOptions.html`:
- Around line 1-5: Update the generated Index > Properties markup for
PhoneEnrollmentVerifyOptions so location, otp_code, and type each appear exactly
once alongside auth_session. Remove only the duplicate anchor entries while
preserving the four-property contract and corresponding property detail
sections.

In `@docs/interfaces/RedirectLoginOptions.html`:
- Around line 9-10: Correct the generated documentation block for
RedirectLoginOptions.fragment so its attribution identifies the declaration
directly on RedirectLoginOptions, not BaseLoginOptions.authorizationParams.
Remove the incorrect inherited label and global.ts#L157 source link, and retain
the direct RedirectLoginOptions.fragment declaration link.

🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 75aeaa6f-0452-4a45-a264-20b7e7433801

📥 Commits

Reviewing files that changed from the base of the PR and between 1a4dcaf and ff76564.

⛔ Files ignored due to path filters (2)

• CHANGELOG.md is excluded by !CHANGELOG.md
• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (142)

• .version
• FAQ.md
• README.md
• docs/assets/navigation.js
• docs/assets/search.js
• docs/classes/Auth0Client.html
• docs/classes/AuthenticationError.html
• docs/classes/CacheKey.html
• docs/classes/ConnectError.html
• docs/classes/Fetcher.html
• docs/classes/GenericError.html
• docs/classes/InMemoryCache.html
• docs/classes/InvalidConfigurationError.html
• docs/classes/LocalStorageCache.html
• docs/classes/MfaApiClient.html
• docs/classes/MfaChallengeError.html
• docs/classes/MfaEnrollmentError.html
• docs/classes/MfaEnrollmentFactorsError.html
• docs/classes/MfaError.html
• docs/classes/MfaListAuthenticatorsError.html
• docs/classes/MfaRequiredError.html
• docs/classes/MfaVerifyError.html
• docs/classes/MissingRefreshTokenError.html
• docs/classes/MissingScopesError.html
• docs/classes/MyAccountApiClient.html
• docs/classes/MyAccountApiError.html
• docs/classes/PasskeyApiClient.html
• docs/classes/PasskeyError.html
• docs/classes/PopupCancelledError.html
• docs/classes/PopupOpenError.html
• docs/classes/PopupTimeoutError.html
• docs/classes/TimeoutError.html
• docs/classes/UseDpopNonceError.html
• docs/classes/User.html
• docs/enums/ResponseType.html
• docs/functions/createAuth0Client.html
• docs/index.html
• docs/interfaces/ActClaim.html
• docs/interfaces/Auth0ClientOptions.html
• docs/interfaces/Authenticator.html
• docs/interfaces/AuthorizationParams.html
• docs/interfaces/ChallengeAuthenticatorParams.html
• docs/interfaces/ChallengeResponse.html
• docs/interfaces/ClientAuthorizationParams.html
• docs/interfaces/ClientConfiguration.html
• docs/interfaces/CompleteRequest.html
• docs/interfaces/CompleteResponse.html
• docs/interfaces/ConnectRequest.html
• docs/interfaces/ConnectResponse.html
• docs/interfaces/DecodedToken.html
• docs/interfaces/EmailAuthenticationMethod.html
• docs/interfaces/EmailEnrollmentChallengeOptions.html
• docs/interfaces/EmailEnrollmentChallengeResponse.html
• docs/interfaces/EmailEnrollmentVerifyOptions.html
• docs/interfaces/EnrollEmailParams.html
• docs/interfaces/EnrollOtpParams.html
• docs/interfaces/EnrollPushParams.html
• docs/interfaces/EnrollSmsParams.html
• docs/interfaces/EnrollVoiceParams.html
• docs/interfaces/EnrollmentFactor.html
• docs/interfaces/ErrorResponse.html
• docs/interfaces/Factor.html
• docs/interfaces/GetTokenSilentlyOptions.html
• docs/interfaces/GetTokenWithPopupOptions.html
• docs/interfaces/ICache.html
• docs/interfaces/IdToken.html
• docs/interfaces/LogoutOptions.html
• docs/interfaces/LogoutUrlOptions.html
• docs/interfaces/MfaRequirements.html
• docs/interfaces/OobEnrollmentResponse.html
• docs/interfaces/OtpEnrollmentResponse.html
• docs/interfaces/PasskeyAuthenticationMethod.html
• docs/interfaces/PasskeyEnrollmentChallengeOptions.html
• docs/interfaces/PasskeyEnrollmentChallengeResponse.html
• docs/interfaces/PasskeyEnrollmentVerifyOptions.html
• docs/interfaces/PasskeyErrorResponse.html
• docs/interfaces/PasswordAuthenticationMethod.html
• docs/interfaces/PasswordEnrollmentChallengeOptions.html
• docs/interfaces/PasswordEnrollmentChallengeResponse.html
• docs/interfaces/PasswordEnrollmentVerifyOptions.html
• docs/interfaces/PasswordPolicy.html
• docs/interfaces/PhoneAuthenticationMethod.html
• docs/interfaces/PhoneEnrollmentChallengeOptions.html
• docs/interfaces/PhoneEnrollmentChallengeResponse.html
• docs/interfaces/PhoneEnrollmentVerifyOptions.html
• docs/interfaces/PopupConfigOptions.html
• docs/interfaces/PopupLoginOptions.html
• docs/interfaces/PushNotificationAuthenticationMethod.html
• docs/interfaces/PushNotificationEnrollmentChallengeOptions.html
• docs/interfaces/PushNotificationEnrollmentChallengeResponse.html
• docs/interfaces/PushNotificationEnrollmentVerifyOptions.html
• docs/interfaces/RecoveryCodeAuthenticationMethod.html
• docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html
• docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html
• docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html
• docs/interfaces/RedirectConnectAccountOptions.html
• docs/interfaces/RedirectLoginOptions.html
• docs/interfaces/RedirectLoginResult.html
• docs/interfaces/RevokeRefreshTokenOptions.html
• docs/interfaces/TotpAuthenticationMethod.html
• docs/interfaces/TotpEnrollmentChallengeOptions.html
• docs/interfaces/TotpEnrollmentChallengeResponse.html
• docs/interfaces/TotpEnrollmentVerifyOptions.html
• docs/interfaces/UpdateAuthenticationMethodRequest.html
• docs/interfaces/VerifyParams.html
• docs/interfaces/WebAuthnPlatformAuthenticationMethod.html
• docs/interfaces/WebAuthnRoamingAuthenticationMethod.html
• docs/modules.html
• docs/types/AuthenticationMethod.html
• docs/types/AuthenticationMethodType.html
• docs/types/AuthenticatorType.html
• docs/types/CacheEntry.html
• docs/types/CacheKeyData.html
• docs/types/CacheLocation.html
• docs/types/Cacheable.html
• docs/types/ConnectAccountRedirectResult.html
• docs/types/CustomFetchMinimalOutput.html
• docs/types/CustomTokenExchangeOptions.html
• docs/types/EnrollParams.html
• docs/types/EnrollmentChallengeOptions.html
• docs/types/EnrollmentChallengeResponse.html
• docs/types/EnrollmentResponse.html
• docs/types/EnrollmentVerifyOptions.html
• docs/types/FetcherConfig.html
• docs/types/GetTokenSilentlyVerboseResponse.html
• docs/types/InteractiveErrorHandler.html
• docs/types/KeyManifestEntry.html
• docs/types/MaybePromise.html
• docs/types/MfaFactorType.html
• docs/types/MfaGrantType.html
• docs/types/OobChannel.html
• docs/types/PasskeyGetTokenOptions.html
• docs/types/PasskeyLoginChallenge.html
• docs/types/PasskeyLoginOptions.html
• docs/types/PasskeySignupChallenge.html
• docs/types/PasskeySignupOptions.html
• docs/types/RefreshTokenMode.html
• docs/types/TokenEndpointResponse.html
• docs/types/WrappedCacheEntry.html
• docs/variables/RefreshTokenMode-1.html
• package.json
• src/version.ts

[coderabbitai]

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove the duplicate domain entry from the Properties index.

The index currently renders two identical ClientConfiguration.html#domain links, causing duplicate navigation entries for the same property.

🤖 Prompt for 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.

In `@docs/interfaces/ClientConfiguration.html` at line 3, Remove the duplicate
ClientConfiguration.html#domain link from the Properties index, leaving exactly
one domain navigation entry and preserving all other index entries.

[coderabbitai]

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove duplicate Properties index entries.

The generated index lists connect_params, connect_uri, and expires_in twice. Regenerate this page so each property appears exactly once.

🤖 Prompt for 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.

In `@docs/interfaces/ConnectResponse.html` around lines 2 - 4, Regenerate the
ConnectResponse documentation page to remove the duplicate Properties index
entries for connect_params, connect_uri, and expires_in, ensuring each property
appears exactly once while preserving the remaining index content.

[coderabbitai]

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Regenerate the affected TypeDoc pages from a clean output.

Both pages contain duplicated rendered sections; EnrollEmailParams also contains inconsistent source-line links.

• docs/interfaces/EmailEnrollmentVerifyOptions.html#L1-L5: remove repeated index, Properties, and sidebar markup so each anchor and section appears once.
• docs/interfaces/EnrollEmailParams.html#L2-L8: emit one interface/property block and map factorType to mfa/types.ts:86, email to mfa/types.ts:88, and inherited mfaToken to mfa/types.ts:50.

📍 Affects 2 files

• docs/interfaces/EmailEnrollmentVerifyOptions.html#L1-L5 (this comment)
• docs/interfaces/EnrollEmailParams.html#L2-L8

🤖 Prompt for 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.

In `@docs/interfaces/EmailEnrollmentVerifyOptions.html` around lines 1 - 5,
Regenerate the TypeDoc output from a clean directory so
docs/interfaces/EmailEnrollmentVerifyOptions.html contains each index,
Properties section, sidebar entry, and anchor only once. Also regenerate
docs/interfaces/EnrollEmailParams.html with one interface/property block and
correct source links: factorType to mfa/types.ts:86, email to mfa/types.ts:88,
and inherited mfaToken to mfa/types.ts:50.

[coderabbitai]

🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Regenerate the affected TypeDoc pages from a clean output.

The supplied final HTML repeats generated fragments and carries stale provenance metadata, producing duplicate anchors, redundant index entries, and incorrect source/inheritance links.

• docs/interfaces/EnrollVoiceParams.html#L2-L8: keep one page tree; attribute phoneNumber to EnrollVoiceParams, not EnrollBaseParams.mfaToken.
• docs/interfaces/EnrollmentFactor.html#L2-L4: keep one EnrollmentFactor signature, index, and type section.
• docs/interfaces/Factor.html#L1-L3: keep one usage? index row and one member section.
• docs/interfaces/GetTokenSilentlyOptions.html#L1-L1,16-25: keep one property block per member and correct the source-line links.
• docs/interfaces/GetTokenWithPopupOptions.html#L1-L8: keep one page tree; document cacheMode as declared on GetTokenWithPopupOptions at global.ts:605.

📍 Affects 5 files

• docs/interfaces/EnrollVoiceParams.html#L2-L8 (this comment)
• docs/interfaces/EnrollmentFactor.html#L2-L4
• docs/interfaces/Factor.html#L1-L3
• docs/interfaces/GetTokenSilentlyOptions.html#L1-L1
• docs/interfaces/GetTokenWithPopupOptions.html#L1-L8

🤖 Prompt for 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.

In `@docs/interfaces/EnrollVoiceParams.html` around lines 2 - 8, Regenerate the
TypeDoc output from a clean build, removing duplicated page trees, signatures,
anchors, index entries, and member sections. In
docs/interfaces/EnrollVoiceParams.html lines 2-8, ensure phoneNumber is
attributed to EnrollVoiceParams; apply the corresponding cleanup to
docs/interfaces/EnrollmentFactor.html lines 2-4, docs/interfaces/Factor.html
lines 1-3, docs/interfaces/GetTokenSilentlyOptions.html lines 1-1 and 16-25, and
docs/interfaces/GetTokenWithPopupOptions.html lines 1-8. Correct stale source
and inheritance links, including cacheMode being declared on
GetTokenWithPopupOptions at global.ts:605.

[coderabbitai]

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Regenerate the affected documentation pages from a clean output directory.

The same duplicated HTML-generation defect appears across these pages, producing repeated document/member sections, duplicate anchors, and ambiguous navigation.

• docs/interfaces/LogoutOptions.html#L1-L9: remove repeated document/index output and regenerate the member metadata.
• docs/interfaces/LogoutOptions.html#L24-L34: retain one onRedirect/openUrl section with correct source attribution.
• docs/interfaces/LogoutUrlOptions.html#L1-L7: retain one document root and one logoutParams index entry.
• docs/interfaces/LogoutUrlOptions.html#L22-L22: retain one logoutParams member section.
• docs/interfaces/MfaRequirements.html#L2-L6: retain one interface and one challenge/enroll section.
• docs/interfaces/OobEnrollmentResponse.html#L2-L16: retain one interface and one section per property.
• docs/interfaces/OtpEnrollmentResponse.html#L2-L12: retain one interface and one section per property.

📍 Affects 5 files

• docs/interfaces/LogoutOptions.html#L1-L9 (this comment)
• docs/interfaces/LogoutOptions.html#L24-L34
• docs/interfaces/LogoutUrlOptions.html#L1-L7
• docs/interfaces/LogoutUrlOptions.html#L22-L22
• docs/interfaces/MfaRequirements.html#L2-L6
• docs/interfaces/OobEnrollmentResponse.html#L2-L16
• docs/interfaces/OtpEnrollmentResponse.html#L2-L12

🤖 Prompt for 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.

In `@docs/interfaces/LogoutOptions.html` around lines 1 - 9, Regenerate the
affected TypeDoc pages from a clean output directory to eliminate duplicated
roots, indexes, anchors, and member sections. In
docs/interfaces/LogoutOptions.html (lines 1-9 and 24-34), retain one
document/index output and one onRedirect/openUrl section with correct source
attribution; in docs/interfaces/LogoutUrlOptions.html (lines 1-7 and 22), retain
one document root, logoutParams index entry, and member section; in
docs/interfaces/MfaRequirements.html (lines 2-6), retain one interface with
challenge/enroll sections; and in docs/interfaces/OobEnrollmentResponse.html
(lines 2-16) and docs/interfaces/OtpEnrollmentResponse.html (lines 2-12), retain
one interface and one section per property.

[coderabbitai]

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Remove duplicate property index entries.

The Index > Properties markup repeats location, otp_code, and type. Each property should appear exactly once, matching the four-property PhoneEnrollmentVerifyOptions contract.

🤖 Prompt for 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.

In `@docs/interfaces/PhoneEnrollmentVerifyOptions.html` around lines 1 - 5, Update
the generated Index > Properties markup for PhoneEnrollmentVerifyOptions so
location, otp_code, and type each appear exactly once alongside auth_session.
Remove only the duplicate anchor entries while preserving the four-property
contract and corresponding property detail sections.

[coderabbitai]

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Correct the fragment inheritance attribution.

The generated page labels fragment as inherited from BaseLoginOptions.authorizationParams, but fragment is declared directly on RedirectLoginOptions in src/global.ts. Regenerate or correct this block so it links to the RedirectLoginOptions.fragment declaration instead of global.ts#L157.

🤖 Prompt for 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.

In `@docs/interfaces/RedirectLoginOptions.html` around lines 9 - 10, Correct the
generated documentation block for RedirectLoginOptions.fragment so its
attribution identifies the declaration directly on RedirectLoginOptions, not
BaseLoginOptions.authorizationParams. Remove the incorrect inherited label and
global.ts#L157 source link, and retain the direct RedirectLoginOptions.fragment
declaration link.