Skip to content

feat/ update ACUL SDK references to v1.7.0 - #1819

Open
BcnCarlos wants to merge 5 commits into
mainfrom
feat/acul-js-sdk-1.7.0-docs
Open

feat/ update ACUL SDK references to v1.7.0#1819
BcnCarlos wants to merge 5 commits into
mainfrom
feat/acul-js-sdk-1.7.0-docs

Conversation

@BcnCarlos

@BcnCarlos BcnCarlos commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the @auth0/auth0-acul-js and @auth0/auth0-acul-react reference docs for [v1.7.0]

Every change was verified directly against the SDK source.

  • login() (Login, LoginId) gains identifier (new preferred field), identifierType, and phoneCountryCode; username is now documented as the accepted legacy spelling. screen.data.activeIdentifierType documented on both screens.
  • signup() (Signup, SignupId) gains phoneCountryCode.
  • LoginPassword.switchToOtp() — new method (the changelog attributed this to the identifier-challenge screens; it's actually on LoginPassword). screen.data.showSwitchToOtpButton documented alongside it.
  • PasskeyRead.rpId — new PasskeyRead interface page (didn't exist before); fixes LoginId's publicKey property, which was linked to the wrong interface.
  • Theme identifiers & country codes ("theme identifiers and country code support" in the changelog is two unrelated additions):
    • BrandingThemes.default.identifiers (ThemeIdentifiers — login display, OTP autocomplete, phone display formatting/masking).
    • countryCodes was added to the SDK's shared BaseMembers base type, so it's present on every screen. Added to all 80 screen class docs' Properties sections for consistency with how every other base property (organization, tenant, etc.) is already fully documented per class.

New reference pages: CountryCodesMembers, AvailableCountryCode, ThemeIdentifiers, PasskeyRead.

No navigation changes needed — confirmed Screens/interfaces/*.mdx pages aren't listed in config/navigation/sdk-libraries.json (only Screens/classes/* pages are).

Test plan

  • Spot-check rendering of the 5 screens with new methods/params (Login, LoginId, Signup, SignupId, LoginPassword) in preview
  • Spot-check the 4 new interface pages render correctly and their links resolve
  • Confirm countryCodes property renders correctly on a sample of the 80 updated class docs

🤖 Generated with Claude Code

Documents new identifier/phoneCountryCode fields on login and signup,
the new LoginPassword.switchToOtp method, PasskeyRead.rpId, theme
identifiers, and the countryCodes property added to every screen class.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@BcnCarlos
BcnCarlos requested a review from a team as a code owner September 2, 2026 13:41
@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0 🟢 Ready View Preview Sep 10, 2026, 4:49 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0-docs-dev 🟢 Ready View Preview Sep 10, 2026, 4:50 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0-docs-staging 🟢 Ready View Preview Sep 10, 2026, 4:49 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Status Count
🔍 Total 1169
🔗 Unique 222
✅ Successful 1167
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 0
❓ Unknown 0
🚫 Errors 2
⛔ Unsupported 0

Errors per input

Errors in main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushChallengePush.mdx

  • [ERROR] </docs/libraries/acul/js-sdk/Screens/type-aliases/MfaPollingOptions#oncompleted> (at 144:209) | Cannot find fragment

Errors in main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx

  • [ERROR] </docs/libraries/acul/js-sdk/Screens/type-aliases/MfaPollingOptions#oncompleted> (at 144:211) | Cannot find fragment

Full Github Actions output

Run on commit 53b82f8.

@BcnCarlos BcnCarlos changed the title docs(acul-js-sdk): update JS SDK reference for v1.7.0 feat/ update ACUL SDK references to v1.7.0 Sep 9, 2026
@BcnCarlos BcnCarlos added the documentation Improvements or additions to documentation label Sep 9, 2026
Comment thread main/docs/libraries/acul/js-sdk/Screens/interfaces/PasskeyRead.mdx Outdated
- PasskeyRead: challenge is typed as the unexported Base64URLString
  alias in the source; the code example now shows string, matching
  what the prop table already documented and what's actually
  importable from the package. Addresses Nick's review comment.
- Add missing googleOneTapConfig property to ScreenMembersOnLogin,
  ScreenMembersOnLoginId, ScreenMembersOnSignup, and
  ScreenMembersOnSignupId, which have carried it since v1.6.0. The
  class docs already reference screen.googleOneTapConfig in prose,
  but the property was undocumented on the interface reference pages.
- Add GoogleOneTapConfig.mdx, which didn't exist despite sibling
  common interfaces (CustomOptions, WebAuthnErrorDetails) having pages.
…nLoginId.data

The parsed screen.data only carries activeIdentifierType (renamed from
active_identifier_type by getScreenData()); passkey info is already
exposed separately via the publicKey property. The passkey field was
copied over from the raw ExtendedScreenContext.data shape, which is
not what consumers see on screen.data. Confirmed against
screen-override.ts and the published TypeDoc reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants