@auth0/auth0-acul-react 1.0.0-alpha.1 → 1.0.0-alpha.3

package/README.md

@@ -1,5 +1,7 @@
 # Auth0 ACUL React SDK
 
+![ACUL React SDK](https://cdn.auth0.com/website/sdks/banners/auth0-acul-react-banner.png)
+
 <div align="center">
 
 [![NPM Version](https://img.shields.io/npm/v/@auth0/auth0-acul-react)](https://www.npmjs.com/package/@auth0/auth0-acul-react)
@@ -11,7 +13,7 @@
 
 <div align='center'>
 
-📚 [Documentation](#-documentation) | 🚀 [Getting Started](#-getting-started) | 💻 [API Reference](#-api-reference) | 💬 [Feedback](#-feedback)
+📚 [Documentation](#documentation) | 🚀 [Getting Started](#getting-started) | 💻 [API Reference](#api-reference) | 🪝 [Hooks](#hooks) | [Examples](#examples) | 💬 [Feedback](#feedback)
 
 </div>
 
@@ -23,7 +25,24 @@ Developers using Auth0’s Universal Login can use this React SDK to customize s
 >
 > This feature is still in **Early Access**.
 
-## Installation
+<a id="documentation"></a>
+## 📚 Documentation
+
+- [Quickstart](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/sdk-quickstart) - our guide for setting up the SDK on your app.
+- [Guides](https://auth0.com/docs/customize/login-pages/advanced-customizations/screens) - more guides for common use cases
+- [Examples](https://github.com/auth0/universal-login/tree/master/packages/auth0-acul-react/examples) - code snippets for different customization use cases.
+
+<a id="getting-started"></a>
+## 🚀 Getting started
+
+### Prerequisites
+Before starting, ensure that you have the following setup:
+
+1. **Custom Domain**: Ensure that a custom domain is configured for your Auth0 tenant.
+2. **Screen Configuration**: Set up the required authentication screens within your Auth0 flow.  
+   For detailed steps, refer to the [Configure ACUL Screens](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens).
+
+### Installation
 
 ```bash
 npm install @auth0/auth0-acul-react
@@ -33,11 +52,13 @@ Peer dependency:
 ```bash
 npm install react
 ```
----
-## Importing the SDK
-The SDK supports `partial imports` for each screen, allowing you to include only the code you need for your specific use case. This helps keep your bundle size small and improves performance.
-Also, you can use a `root import` to load all screens from a single bundle if your app requires it.
-### Partial Imports
+
+### Importing the SDK
+The SDK supports `partial imports` for each screen, allowing you to include only the code you need for your specific use case. This helps keep your bundle size small and improves performance. 
+
+Also, you can use a `root import` to load all screens from a single bundle if your app requires it. 
+
+#### Partial Imports
 Each screen has its own set of hooks and methods. You can import only what you need for the screen you're building.
 
 The following example shows how to import and use SDK to build `login-id` screen.
@@ -71,7 +92,7 @@ import {
 
 ---
 
-### Root Imports
+#### Root Imports
 
 The SDK also supports a root import, which lets you load all screens from a single bundle.
 This is useful if your app dynamically renders different screens at runtime based on the current Auth0 flow, for example, when you want one unified build that can handle all possible screens.
@@ -94,7 +115,7 @@ import {
 ```
 ---
 
-### Types / Interfaces
+#### Types / Interfaces
 Typescript types and interfaces can be imported from `@auth0/auth0-acul-react/types` for type safety and better DX.
 ```tsx
 import type {
@@ -106,14 +127,196 @@ import type {
   // ...other types
 } from '@auth0/auth0-acul-react/types';
 ```
-Refer to our [API Reference](#-api-reference) for the full list of available types and interfaces.
+Refer to our [API Reference](#api-reference) for the full list of available types and interfaces.
 
 ---
 
+<a id="api-reference"></a>
+## 💻 API Reference
+### Screens
+
+| No.    | Prompt             | Screen Name       | Documentation Link                                                                                    |
+|--------|--------------------|-------------------|--------------------------------------------------------------------------------------------|
+| 1      | login              | login             | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login)                 |
+| 2      | login-id            | login-id          | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login-Id)               |
+| 3      | login-password     | login-password    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login-Password)         |
+| 4      | signup-id          | signup-id         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Signup-Id)              |
+| 5      | signup-password    | signup-password   | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Signup-Password)        |
+
+<details>
+  <summary>Explore more screens...</summary>
+
+| No.    | Prompt                         | Screen Name                                      | Documentation Link                                                                                                                        |
+|--------|--------------------------------|-------------------------------------------|-------------------------------------------------------------------------------------------------------|
+| 6      | login-passwordless             | login-passwordless-email-code             | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login-Passwordless-Email-Code)   |
+| 7      | login-passwordless             | login-passwordless-sms-otp                | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login-Passwordless-Sms-Otp)      |
+| 8      | passkeys                       | passkey-enrollment                        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Passkey-Enrollment)                |
+| 9      | passkeys                       | passkey-enrollment-local                  | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Passkey-Enrollment-Local)           |
+| 10     | phone-identifier-enrollment    | phone-identifier-enrollment               | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Phone-Identifier-Enrollment)    |
+| 11     | phone-identifier-challenge     | phone-identifier-challenge                | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Phone-Identifier-Challenge)         |
+| 12     | email-identifier-challenge     | email-identifier-challenge                | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Email-Identifier-Challenge)     |
+| 13     | captcha                        | interstitial-captcha                      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Interstitial-Captcha)      |
+| 14     | reset-password                 | reset-password-email                      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Email)       |
+| 15     | reset-password                 | reset-password-request                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Request)        |
+| 16     | reset-password                 | reset-password                            | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password)                |
+| 17     | reset-password                 | reset-password-error                      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Error)            |
+| 18     | reset-password                 | reset-password-success                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Success)         |
+| 19     | signup                         | signup                                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Signup)                        |
+| 20     | mfa                            | mfa-detect-browser-capabilities           | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Detect-Browser-Capabilities)   |
+| 21     | mfa                            | mfa-enroll-result                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Enroll-Result)   |
+| 22     | mfa                            | mfa-begin-enroll-options                  | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Begin-Enroll-Options)       |
+| 23     | mfa                            | mfa-login-options                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Login-Options)   |
+| 24     | mfa-push                       | mfa-push-enrollment-qr                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Push-Enrollment-Qr)            |
+| 25     | mfa-push                       | mfa-push-welcome                          | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Push-Welcome)            |
+| 26     | mfa-push                       | mfa-push-challenge-push                   | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Push-Challenge-Push)   |
+| 27     | mfa-push                       | mfa-push-list                             | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Push-List)                   |
+| 28     | mfa-sms                        | mfa-country-codes                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Country-Codes)              |
+| 29     | mfa-sms                        | mfa-sms-challenge                         |   [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Sms-Challenge)                 |
+| 30     | mfa-sms                        | mfa-sms-enrollment                        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Sms-Enrollment)           |
+| 31     | mfa-sms                        | mfa-sms-list                              |  [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Sms-List)                  |
+| 32     | mfa-email                      | mfa-email-challenge                       | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Email-Challenge)   |
+| 33     | mfa-email                      | mfa-email-list                            | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Email-List)   |
+| 34     | invitatino                     | accept-invitation                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Accept-Invitation)   |
+| 35     | organizations                  | organization-picker                       | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Organization-Picker)        |
+| 36     | organizations                  | organization-selection                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Organization-Selection)        |
+| 37     | reset-password                 | mfa-otp-challenge                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Otp-Challenge)   |
+| 38     | mfa-otp                        | mfa-otp-enrollment-code                   | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Otp-Enrollment-Code)   |
+| 39     | mfa-otp                        | mfa-otp-enrollment-qr                     | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Otp-Enrollment-Qr)   |
+| 40     | reset-password                 | reset-password-mfa-email-challenge        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Email-Challenge)  |
+| 41     | reset-password                 | reset-password-mfa-push-challenge-push    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Push-Challenge-Push)|
+| 42     | reset-password                 | mfa-sms-challenge                         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Sms-Challenge)   |
+| 43     | reset-password                 | reset-password-mfa-otp-challenge          | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Organization-Selection)   |
+| 44     | mfa-phone                      | mfa-phone-enrollment                      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Phone-Enrollment)   |
+| 45     | mfa-voice                      | mfa-voice-enrollment                      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Voice-Enrollment)   |
+| 46     | mfa-recovery-code              | mfa-recovery-code-challenge               | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Recovery-Code-Challenge)   |
+| 47     | device-flow                    | device-code-activation-allowed            | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Device-Code-Activation-Allowed)   |
+| 48     | device-flow                    | device-code-activation-denied             | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Device-Code-Activation-Denied)   |
+| 49     | device-flow                    | device-code-activation                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Device-Code-Activation)   |
+| 50     | reset-password             | reset-password-mfa-recovery-code-challenge | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Recovery-Code-Challenge) |
+| 51     | reset-password                 | reset-password-mfa-voice                  | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Voice-Challenge)   |
+| 52     | common                         | redeem-ticket                             | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Redeem-Ticket)   |
+| 53     | device-flow                    | device-code-confirmation                  | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Device-Code-Confirmation)   |
+| 54     | mfa-phone                      | mfa-phone-challenge                       | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Phone-Challenge) |
+| 55     | mfa-voice                      | mfa-voice-challenge                       | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Voice-Challenge)   |
+| 56     | mfa-recovery-code              | mfa-recovery-code-enrollment              | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Recovery-Code-Enrollment)   |
+| 57     | reset-password                 | reset-password-mfa-phone-challenge        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-Phone-Challenge)   |
+| 58     | mfa-recovery-code              | mfa-recovery-code-challenge-new-code      | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-Recovery-Code-Challenge-New-Code) |
+| 59     | logout                         | logout                                    | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Logout) |
+| 60     | logout                         | logout-aborted                            | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Logout-Aborted) |
+| 61     | logout                         | logout-complete                           | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Logout-Complete) |
+| 62     | email-verification             | email-verification-result                 | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Email-Verification-Result) |
+| 63     | login-email-verification       | login-email-verification                  | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Login-Email-Verification) |
+| 64     |mfa-webauthn                    | mfa-webauthn-platform-enrollment        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Platform-Enrollment)                        |
+| 65     |mfa-webauthn                    | mfa-webauthn-error        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Error)                        |
+| 66     |mfa-webauthn                    | mfa-webauthn-roaming-enrollment         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Roaming-Enrollment)   |
+| 67     |mfa-webauthn                    | mfa-webauthn-roaming-challenge          | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Roaming-Challenge)    |
+| 68     |mfa-webauthn                    | mfa-webauthn-platform-challenge         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Platform-Challenge)   |
+| 69     |mfa-webauthn                    | mfa-webauthn-enrollment-success         | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Enrollment-Success)   |
+| 70     |mfa-webauthn                    | mfa-webauthn-change-key-nickname        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Change-Key-Nickname)   |
+| 71     |mfa-webauthn                    | mfa-webauthn-not-available-error        | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Mfa-WebAuthn-Not-Available-Error)   |
+| 72     |reset-password                    | reset-password-mfa-webauthn-platform-challenge | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-WebAuthn-Platform-Challenge)                |
+| 73     |reset-password                    | reset-password-mfa-webauthn-roaming-challenge | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Reset-Password-Mfa-WebAuthn-Roaming-Challenge)   |
+| 74     |consent                   | consent | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.consent)   |
+| 75     |customized-consent        | customized-consent | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Customized-Consent)   |
+| 76     |email-otp-challenge                   | email-otp-challenge | [Link](https://auth0.github.io/universal-login/auth0-acul-react/modules/Screens.Email-OTP-Challenge)   |
+</details>
+
+---
+
+## Hooks
+### Context Hooks (Available in all screens)
+- `useUser()` - Current user information
+- `useTenant()` - Tenant configuration
+- `useClient()` - Application client information
+- `useScreen()` - Current screen data and configuration
+- `useTransaction()` - Transaction state and methods
+- `useBranding()` - Tenant branding and theme
+- `useOrganization()` - Organization context (if applicable)
+- `usePrompt()` - Current authentication prompt
+- `useUntrustedData()` - Untrusted data from the authentication flow
+ 
+### Utility Hooks
+Specialized hooks for form validation, polling, and identifier management:
+
+#### Identifier Management
+- `useLoginIdentifiers()` - Get available login identifier types (email, phone, username)
+- `useSignupIdentifiers()` - Get available signup identifier types, each with its `required` status
+
+#### Form Validation
+- `usePasswordValidation(password, rules)` - Real-time password strength validation
+- `useUsernameValidation(username)` - Username format and availability validation
+
+#### MFA & Polling
+- `useMfaPolling(options)` - Manage MFA push notification polling lifecycle
+- `useResend(options)` - Handle resend operations with cooldown timers
+
+### Common Hooks
+General-purpose hooks available across all screens:
+
+#### Screen Management
+- `useCurrentScreen()` - Get complete current screen context data
+- `useAuth0Themes()` - Access tenant branding and theme configuration
+
+#### Error Handling
+- `useErrors(options)` - Comprehensive error management with categorization
+  - Filter by error kind: `'validation'`, `'auth0'`, `'configuration'`
+  - Filter by field name for form-specific errors
+  - Dismiss individual or all errors
+
+### Screen-Specific Action Methods
+Each screen module exports methods for screen actions:
+
+```tsx
+// Login ID Screen
+import {
+  loginMethod,
+  continueWithFederatedLogin
+} from '@auth0/auth0-acul-react/login-id';
+
+// Password Screen
+import {
+  loginMethod,
+  forgotPasswordMethod
+} from '@auth0/auth0-acul-react/login-password';
+
+// MFA Push Challenge
+import {
+  continueMethod,
+  resendPushNotification,
+  useMfaPolling
+} from '@auth0/auth0-acul-react/mfa-push-challenge-push';
+```
+
 ## Examples
-Check out the [`examples/`](https://github.com/auth0/universal-login/tree/main/packages/auth0-acul-react/examples) directory for complete, working examples of how to use this SDK to build custom Universal Login screens.
+- [React Examples](https://github.com/auth0/universal-login/tree/master/packages/auth0-acul-react/examples) - Complete React component examples
+- [React Boilerplate](https://github.com/auth0/auth0-acul-react-boilerplate) - Full React application template
 
 ---
+
+<a id="feedback"></a>
+## 💬 Feedback
+
+### Contributing
+
+We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+
+- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
+- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
+
+### Raise an issue
+
+To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/universal-login/issues).
+
+### Vulnerability Reporting
+
+Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
+
+### Legal
+
+**Early Access.** This SDK and its associated product are made available only in Early Access ("EA") format and are governed by the Free Trial terms of the [Okta Master Subscription Agreement](https://www.okta.com/agreements/#mastersubscriptionagreement). If Okta elects to make a version of this SDK and its associated product Generally Available ("GA"), such GA version may have different pricing, product and feature configurations, and use of the GA product and SDK will be subject to the standard terms of the Agreement (or other such titled written or electronic agreement addressing the same subject matter) between Okta and Customer."
+
+---
+
 <p align="center">
   <picture>
     <source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png"   width="150">

package/dist/export/getting-started.d.ts

@@ -208,7 +208,7 @@
  *
  * #### Error Handling
  * - `useErrors(options)` - Comprehensive error management with categorization
- *   - Filter by error kind: `'client'`, `'server'`, `'dev'`
+ *   - Filter by error type: `'validation'`, `'auth0'`, `'configuration'`
  *   - Filter by field name for form-specific errors
  *   - Dismiss individual or all errors
  *

package/dist/export/hooks.d.ts

@@ -1 +1 @@
-export { usePasswordValidation, useUsernameValidation, useResend, useMfaPolling, useErrors, useAuth0Themes, useCurrentScreen, useLoginIdentifiers, useSignupIdentifiers, } from '../hooks';
+export { usePasswordValidation, useUsernameValidation, useResend, useMfaPolling, useErrors, useAuth0Themes, useCurrentScreen, useLoginIdentifiers, useSignupIdentifiers, usePasskeyAutofill, } from '../hooks';

package/dist/hooks/common/errors.d.ts

@@ -1,10 +1,10 @@
-import { type ErrorItem, type ErrorKind } from '../../state/error-store';
+import { type ErrorItem, type ErrorType } from '../../state/error-store';
 export interface ErrorsResult extends ReadonlyArray<ErrorItem> {
-    byKind(kind: ErrorKind, opts?: {
+    byType(type: ErrorType, opts?: {
         field?: string;
     }): ReadonlyArray<ErrorItem>;
     byField(field: string, opts?: {
-        kind?: ErrorKind;
+        type?: ErrorType;
     }): ReadonlyArray<ErrorItem>;
 }
 export interface UseErrorOptions {
@@ -18,21 +18,21 @@ export interface UseErrorsResult {
 }
 /**
  * React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login).
- * With all validation and server-side errors. It groups errors into three kinds:
- * - `server` — errors returned by Auth0 or your own backend.
- * - `client` — errors from client-side validation (e.g., invalid form input).
- * - `developer` — errors caused by incorrect integration or SDK misuse.
+ * With all validation and server-side errors. It groups errors into three types:
+ * - `auth0` — errors returned by Auth0 or your own backend.
+ * - `validation` — errors from client-side validation (e.g., invalid form input).
+ * - `configuration` — errors caused by incorrect integration or SDK misuse.
  *
  * @supportedScreens
  * - The `useErrors` hook is available on every ACUL screen.
  *
- * @param options.includeDevErrors - When `true`, developer errors are included in
+ * @param options.includeDevErrors - When `true`, configuration errors are included in
  *   the returned list. Defaults to `false`.
  *
  * @returns An object of type {@link UseErrorsResult}, containing:
  * - `errors` — the full error list of type {@link ErrorsResult}, with helpers:
- *   - `errors.byKind(kind, filter?)` — filter by error kind and optionally by field.
- *   - `errors.byField(field, filter?)` — filter by field and optionally by kind.
+ *   - `errors.byType(type, filter?)` — filter by error type and optionally by field.
+ *   - `errors.byField(field, filter?)` — filter by field and optionally by type.
  * - `hasError` — `true` if any error is currently present.
  * - `dismiss(id)` — remove a specific error by its ID.
  * - `dismissAll()` — clear all tracked errors.
@@ -51,7 +51,7 @@ export interface UseErrorsResult {
  *     <div>
  *       {hasError && (
  *         <div className="mb-4">
- *           {errors.byKind("server").map(err => (
+ *           {errors.byType("auth0").map(err => (
  *             <div key={err.id} className="text-red-600">
  *               {err.message}
  *               <button onClick={() => dismiss(err.id)}>Dismiss</button>
@@ -66,12 +66,12 @@ export interface UseErrorsResult {
  * }
  * ```
  *
- * In addition to rendering messages, you can filter by field or kind:
+ * In addition to rendering messages, you can filter by field or type:
  * ```ts
- * console.log(errors.byKind('client')); // all client errors
- * console.log(errors.byKind('client', { field: 'username' })); // client errors for field 'username'
+ * console.log(errors.byType('validation')); // all validation errors
+ * console.log(errors.byType('validation', { field: 'username' })); // validation errors for field 'username'
  * console.log(errors.byField('username')); // all errors for field 'username'
- * console.log(errors.byField('username', { kind: 'server' })); // server errors for field 'username'
+ * console.log(errors.byField('username', { type: 'auth0' })); // auth0 errors for field 'username'
  * ```
  */
 export declare function useErrors(options?: UseErrorOptions): UseErrorsResult;
@@ -83,11 +83,11 @@ declare function withError<T>(actionOrPromise: (() => T | Promise<T>) | Promise<
  */
 export declare const errorManager: {
     withError: typeof withError;
-    replaceClientErrors(list: Array<Omit<ErrorItem, "id">>, opts?: {
+    replaceValidationErrors(list: Array<Omit<ErrorItem, "id">>, opts?: {
         byField?: string;
     }): void;
-    clearClientErrors(): void;
-    pushClientErrors(list: Omit<ErrorItem, "id"> | Array<Omit<ErrorItem, "id">>): void;
+    clearValidationErrors(): void;
+    pushValidationErrors(list: Omit<ErrorItem, "id"> | Array<Omit<ErrorItem, "id">>): void;
     replaceDeveloperErrors(list: Array<Omit<ErrorItem, "id">>, opts?: {
         byField?: string;
     }): void;
@@ -100,4 +100,4 @@ export declare const errorManager: {
     pushServerErrors(list: Omit<ErrorItem, "id"> | Array<Omit<ErrorItem, "id">>): void;
     syncServerErrors(): void;
 };
-export { ErrorItem, ErrorKind };
+export { ErrorItem, ErrorType };

package/dist/hooks/common/errors.js

@@ -1,2 +1,2 @@
-import{getErrors as e,UserInputError as r,SDKUsageError as t,Auth0ServerError as n}from"@auth0/auth0-acul-js";import{useSyncExternalStore as c,useRef as o,useEffect as l,useMemo as s,useCallback as i}from"react";import{errorStore as a,ERROR_KINDS as p}from"../../state/error-store.js";function d(e,r){return r?e.filter(e=>e.field===r):e}const u=new WeakMap,v=new WeakMap,f=new WeakMap,h=(e,r)=>{const t="server"===e?u:"client"===e?v:f,n=t.get(r);if(n)return n;const c=Object.freeze(r.map(r=>Object.freeze({...r,kind:e})));return t.set(r,c),c};function b(r={}){const{includeDevErrors:t=!1}=r,n=c(e=>a.subscribe(e),()=>a.snapshot()),u=o(!1);l(()=>{if(u.current)return;u.current=!0;const r=e?.()??[];a.replace("server",r)},[]);const v=s(()=>h("server",n.server),[n.server]),f=s(()=>h("client",n.client),[n.client]),b=s(()=>h("developer",n.developer),[n.developer]),E=s(()=>Object.freeze([...t?b:[],...f,...v]),[t,b,f,v]),y=s(()=>{const e=Object.assign([...E],{byKind(e,r){const t="client"===e?f:"developer"===e?b:v;return r?.field?Object.freeze(d(t,r.field)):t},byField:(r,t)=>t?.kind?e.byKind(t.kind,{field:r}):Object.freeze(d(E,r))});return Object.freeze(e)},[E,f,b,v]),m=E.length>0,k=i(e=>{a.remove(p,e)},[]),w=i(()=>{a.clear(p)},[]);return s(()=>({errors:y,hasError:m,dismiss:k,dismissAll:w}),[y,m,k,w])}const E={withError:function(e){const c=e=>{const c=function(e){return e instanceof r?"client":e instanceof t?"developer":e instanceof n?"server":null}(e),o=function(e){return{code:e?.code??(e instanceof Error?e.name:void 0)??"unknown_error",message:e?.message??"Unknown error",field:e?.field}}(e);switch(c){case"client":E.replaceClientErrors([o]);break;case"developer":E.replaceDeveloperErrors([o]);break;case"server":E.replaceServerErrors([o]);break;default:throw console.error("[auth0-acul-react] Unhandled error:",e),e}};if("function"==typeof e)try{const r=e();return"object"==typeof(o=r)&&null!==o&&"then"in o&&"function"==typeof o.then?r.catch(e=>{throw c(e),e}):r}catch(e){throw c(e),e}var o;return e.catch(e=>{throw c(e),e})},replaceClientErrors(e,r){r?.byField?a.replacePartial("client",e,r.byField):a.replace("client",e)},clearClientErrors(){a.clear(["client"])},pushClientErrors(e){a.push("client",e)},replaceDeveloperErrors(e,r){r?.byField?a.replacePartial("developer",e,r.byField):a.replace("developer",e)},clearDeveloperErrors(){a.clear(["developer"])},pushDeveloperErrors(e){a.push("developer",e)},replaceServerErrors(e,r){r?.byField?a.replacePartial("server",e,r.byField):a.replace("server",e)},clearServerErrors(){a.clear(["server"])},pushServerErrors(e){a.push("server",e)},syncServerErrors(){const r=e?.()??[];a.replace("server",r)}};export{E as errorManager,b as useErrors};
+import{getErrors as r,ValidationError as e,ConfigurationError as t,Auth0Error as a}from"@auth0/auth0-acul-js";import{useSyncExternalStore as o,useRef as n,useEffect as i,useMemo as c,useCallback as l}from"react";import{errorStore as s,ERROR_TYPES as u}from"../../state/error-store.js";function f(r,e){return e?r.filter(r=>r.field===e):r}const p=new WeakMap,d=new WeakMap,h=new WeakMap,v=(r,e)=>{const t="auth0"===r?p:"validation"===r?d:h,a=t.get(e);if(a)return a;const o=Object.freeze(e.map(e=>Object.freeze({...e,type:r})));return t.set(e,o),o};function b(e={}){const{includeDevErrors:t=!1}=e,a=o(r=>s.subscribe(r),()=>s.snapshot()),p=n(!1);i(()=>{if(p.current)return;p.current=!0;const e=r?.()??[];s.replace("auth0",e)},[]);const d=c(()=>v("auth0",a.auth0),[a.auth0]),h=c(()=>v("validation",a.validation),[a.validation]),b=c(()=>v("configuration",a.configuration),[a.configuration]),y=c(()=>Object.freeze([...t?b:[],...h,...d]),[t,b,h,d]),E=c(()=>{const r=Object.assign([...y],{byType(r,e){let t;return t="validation"===r?h:"configuration"===r?b:d,e?.field?Object.freeze(f(t,e.field)):t},byField:(e,t)=>t?.type?r.byType(t.type,{field:e}):Object.freeze(f(y,e))});return Object.freeze(r)},[y,h,b,d]),g=y.length>0,m=l(r=>{s.remove(u,r)},[]),w=l(()=>{s.clear(u)},[]);return c(()=>({errors:E,hasError:g,dismiss:m,dismissAll:w}),[E,g,m,w])}const y={withError:function(r){const o=r=>{const o=function(r){return r instanceof e?"validation":r instanceof t?"configuration":r instanceof a?"auth0":null}(r),n=function(r){return{code:r?.code??(r instanceof Error?r.name:void 0)??"unknown_error",message:r?.message??"Unknown error",field:r?.field}}(r);switch(o){case"validation":y.replaceValidationErrors([n]);break;case"configuration":y.replaceDeveloperErrors([n]);break;case"auth0":y.replaceServerErrors([n]);break;default:throw console.error("[auth0-acul-react] Unhandled error:",r),r}};if("function"==typeof r)try{const e=r();return"object"==typeof(n=e)&&null!==n&&"then"in n&&"function"==typeof n.then?e.catch(r=>{throw o(r),r}):e}catch(r){throw o(r),r}var n;return r.catch(r=>{throw o(r),r})},replaceValidationErrors(r,e){e?.byField?s.replacePartial("validation",r,e.byField):s.replace("validation",r)},clearValidationErrors(){s.clear(["validation"])},pushValidationErrors(r){s.push("validation",r)},replaceDeveloperErrors(r,e){e?.byField?s.replacePartial("configuration",r,e.byField):s.replace("configuration",r)},clearDeveloperErrors(){s.clear(["configuration"])},pushDeveloperErrors(r){s.push("configuration",r)},replaceServerErrors(r,e){e?.byField?s.replacePartial("auth0",r,e.byField):s.replace("auth0",r)},clearServerErrors(){s.clear(["auth0"])},pushServerErrors(r){s.push("auth0",r)},syncServerErrors(){const e=r?.()??[];s.replace("auth0",e)}};export{y as errorManager,b as useErrors};
 //# sourceMappingURL=errors.js.map

package/dist/hooks/common/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sources":["../../../src/hooks/common/errors.ts"],"sourcesContent":["import {\n  SDKUsageError,\n  UserInputError,\n  Auth0ServerError,\n  getErrors as getServerErrors,\n  type Error as Auth0Error,\n} from '@auth0/auth0-acul-js';\nimport { useEffect, useMemo, useRef, useSyncExternalStore, useCallback } from 'react';\n\nimport { errorStore, ERROR_KINDS, type ErrorItem, type ErrorKind } from '../../state/error-store';\n\nexport interface ErrorsResult extends ReadonlyArray<ErrorItem> {\n  byKind(kind: ErrorKind, opts?: { field?: string }): ReadonlyArray<ErrorItem>;\n  byField(field: string, opts?: { kind?: ErrorKind }): ReadonlyArray<ErrorItem>;\n}\n\nexport interface UseErrorOptions {\n  includeDevErrors?: boolean;\n}\n\nexport interface UseErrorsResult {\n  errors: ErrorsResult;\n  hasError: boolean;\n  dismiss: (id: string) => void;\n  dismissAll: () => void;\n}\n\nfunction classifyKind(e: unknown): ErrorKind | null {\n  if (e instanceof UserInputError) {\n    return 'client';\n  }\n  if (e instanceof SDKUsageError) {\n    return 'developer';\n  }\n  if (e instanceof Auth0ServerError) {\n    return 'server';\n  }\n  return null;\n}\n\nfunction toErrorObject(e: unknown): Omit<ErrorItem, 'id'> {\n  return {\n    code: (e as Auth0Error)?.code ?? (e instanceof Error ? e.name : undefined) ?? 'unknown_error',\n    message: (e as Auth0Error)?.message ?? 'Unknown error',\n    field: (e as Auth0Error)?.field,\n  };\n}\n\nfunction filterByField<T extends { field?: string }>(\n  list: ReadonlyArray<T>,\n  field?: string\n): ReadonlyArray<T> {\n  if (!field) {\n    return list;\n  }\n  return list.filter((e) => e.field === field);\n}\n\n// caches for tagging\nconst cacheServer = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\nconst cacheClient = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\nconst cacheDev = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\n\nconst tag = (kind: ErrorKind, arr: ReadonlyArray<ErrorItem>): ReadonlyArray<ErrorItem> => {\n  const cache = kind === 'server' ? cacheServer : kind === 'client' ? cacheClient : cacheDev;\n  const hit = cache.get(arr);\n  if (hit) {\n    return hit;\n  }\n  const out = Object.freeze(arr.map((e) => Object.freeze({ ...e, kind })));\n  cache.set(arr, out);\n  return out;\n};\n\n/**\n * React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login).\n * With all validation and server-side errors. It groups errors into three kinds:\n * - `server` — errors returned by Auth0 or your own backend.\n * - `client` — errors from client-side validation (e.g., invalid form input).\n * - `developer` — errors caused by incorrect integration or SDK misuse.\n *\n * @supportedScreens\n * - The `useErrors` hook is available on every ACUL screen.\n *\n * @param options.includeDevErrors - When `true`, developer errors are included in\n *   the returned list. Defaults to `false`.\n *\n * @returns An object of type {@link UseErrorsResult}, containing:\n * - `errors` — the full error list of type {@link ErrorsResult}, with helpers:\n *   - `errors.byKind(kind, filter?)` — filter by error kind and optionally by field.\n *   - `errors.byField(field, filter?)` — filter by field and optionally by kind.\n * - `hasError` — `true` if any error is currently present.\n * - `dismiss(id)` — remove a specific error by its ID.\n * - `dismissAll()` — clear all tracked errors.\n *\n * Typical usage is inside a form or screen component where you need to\n * reactively display errors and provide ways to dismiss them:\n *\n * @example\n * ```tsx\n * import { useErrors } from \"@auth0/auth0-acul-react\";\n *\n * export function SignupForm() {\n *   const { errors, hasError, dismiss, dismissAll } = useErrors();\n *\n *   return (\n *     <div>\n *       {hasError && (\n *         <div className=\"mb-4\">\n *           {errors.byKind(\"server\").map(err => (\n *             <div key={err.id} className=\"text-red-600\">\n *               {err.message}\n *               <button onClick={() => dismiss(err.id)}>Dismiss</button>\n *             </div>\n *           ))}\n *         </div>\n *       )}\n *\n *       <button onClick={dismissAll}>Clear All Errors</button>\n *     </div>\n *   );\n * }\n * ```\n *\n * In addition to rendering messages, you can filter by field or kind:\n * ```ts\n * console.log(errors.byKind('client')); // all client errors\n * console.log(errors.byKind('client', { field: 'username' })); // client errors for field 'username'\n * console.log(errors.byField('username')); // all errors for field 'username'\n * console.log(errors.byField('username', { kind: 'server' })); // server errors for field 'username'\n * ```\n */\n\nexport function useErrors(options: UseErrorOptions = {}): UseErrorsResult {\n  const { includeDevErrors = false } = options;\n\n  const snap = useSyncExternalStore(\n    (cb) => errorStore.subscribe(cb),\n    () => errorStore.snapshot()\n  );\n\n  const didInit = useRef(false);\n  useEffect(() => {\n    if (didInit.current) {\n      return;\n    }\n    didInit.current = true;\n\n    // Get server errors directly from TS SDK on first render.\n    const server = (getServerErrors?.() ?? []) as Array<Omit<ErrorItem, 'id'>>;\n    errorStore.replace('server', server);\n  }, []);\n\n  const serverTagged = useMemo(() => tag('server', snap.server), [snap.server]);\n  const clientTagged = useMemo(() => tag('client', snap.client), [snap.client]);\n  const devTagged = useMemo(() => tag('developer', snap.developer), [snap.developer]);\n\n  const all = useMemo<ReadonlyArray<ErrorItem>>(\n    () => Object.freeze([...(includeDevErrors ? devTagged : []), ...clientTagged, ...serverTagged]),\n    [includeDevErrors, devTagged, clientTagged, serverTagged]\n  );\n\n  const errors: ErrorsResult = useMemo(() => {\n    const arr = Object.assign([...all], {\n      byKind(kind: ErrorKind, opts?: { field?: string }): ReadonlyArray<ErrorItem> {\n        const base =\n          kind === 'client' ? clientTagged : kind === 'developer' ? devTagged : serverTagged;\n        return opts?.field ? Object.freeze(filterByField(base, opts.field)) : base;\n      },\n      byField(field: string, opts?: { kind?: ErrorKind }): ReadonlyArray<ErrorItem> {\n        if (opts?.kind) {\n          return arr.byKind(opts.kind, { field });\n        }\n        return Object.freeze(filterByField(all, field));\n      },\n    });\n    return Object.freeze(arr);\n  }, [all, clientTagged, devTagged, serverTagged]);\n\n  const hasError = all.length > 0;\n\n  const dismiss = useCallback((id: string) => {\n    errorStore.remove(ERROR_KINDS, id);\n  }, []);\n\n  const dismissAll = useCallback(() => {\n    errorStore.clear(ERROR_KINDS);\n  }, []);\n\n  return useMemo(\n    () => ({ errors, hasError, dismiss, dismissAll }),\n    [errors, hasError, dismiss, dismissAll]\n  );\n}\n\n// ---------------- INTERNAL (SDK-only) ----------------\nconst isPromise = (v: unknown): v is Promise<unknown> =>\n  typeof v === 'object' &&\n  v !== null &&\n  'then' in v &&\n  typeof (v as { then: unknown }).then === 'function';\n\nfunction withError<T>(actionOrPromise: (() => T | Promise<T>) | Promise<T>): T | Promise<T> {\n  const handle = (e: unknown) => {\n    const kind = classifyKind(e);\n    const normalized = toErrorObject(e);\n    switch (kind) {\n      case 'client':\n        errorManager.replaceClientErrors([normalized]);\n        break;\n      case 'developer':\n        errorManager.replaceDeveloperErrors([normalized]);\n        break;\n      case 'server':\n        errorManager.replaceServerErrors([normalized]);\n        break;\n      default: {\n        console.error('[auth0-acul-react] Unhandled error:', e);\n        throw e;\n      }\n    }\n  };\n\n  if (typeof actionOrPromise === 'function') {\n    try {\n      const result = (actionOrPromise as () => T | Promise<T>)();\n      return isPromise(result)\n        ? result.catch((e) => {\n            handle(e);\n            throw e;\n          })\n        : result;\n    } catch (e) {\n      handle(e);\n      throw e;\n    }\n  }\n\n  return actionOrPromise.catch((e) => {\n    handle(e);\n    throw e;\n  });\n}\n\n/**\n * @hidden\n * Internal error manager for use by SDK methods.\n * Use the `useErrors` hook in React components instead.\n */\nexport const errorManager = {\n  withError,\n\n  replaceClientErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('client', list, opts.byField);\n    } else {\n      errorStore.replace('client', list);\n    }\n  },\n  clearClientErrors() {\n    errorStore.clear(['client']);\n  },\n  pushClientErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('client', list);\n  },\n\n  replaceDeveloperErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('developer', list, opts.byField);\n    } else {\n      errorStore.replace('developer', list);\n    }\n  },\n  clearDeveloperErrors() {\n    errorStore.clear(['developer']);\n  },\n  pushDeveloperErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('developer', list);\n  },\n\n  replaceServerErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('server', list, opts.byField);\n    } else {\n      errorStore.replace('server', list);\n    }\n  },\n  clearServerErrors() {\n    errorStore.clear(['server']);\n  },\n  pushServerErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('server', list);\n  },\n\n  syncServerErrors() {\n    const server = (getServerErrors?.() ?? []) as Array<Omit<ErrorItem, 'id'>>;\n    errorStore.replace('server', server);\n  },\n};\n\nexport { ErrorItem, ErrorKind };\n"],"names":["filterByField","list","field","filter","e","cacheServer","WeakMap","cacheClient","cacheDev","tag","kind","arr","cache","hit","get","out","Object","freeze","map","set","useErrors","options","includeDevErrors","snap","useSyncExternalStore","cb","errorStore","subscribe","snapshot","didInit","useRef","useEffect","current","server","getServerErrors","replace","serverTagged","useMemo","clientTagged","client","devTagged","developer","all","errors","assign","byKind","opts","base","byField","hasError","length","dismiss","useCallback","id","remove","ERROR_KINDS","dismissAll","clear","errorManager","withError","actionOrPromise","handle","UserInputError","SDKUsageError","Auth0ServerError","classifyKind","normalized","code","Error","name","undefined","message","toErrorObject","replaceClientErrors","replaceDeveloperErrors","replaceServerErrors","console","error","result","v","then","catch","replacePartial","clearClientErrors","pushClientErrors","push","clearDeveloperErrors","pushDeveloperErrors","clearServerErrors","pushServerErrors","syncServerErrors"],"mappings":"6RAgDA,SAASA,EACPC,EACAC,GAEA,OAAKA,EAGED,EAAKE,OAAQC,GAAMA,EAAEF,QAAUA,GAF7BD,CAGX,CAGA,MAAMI,EAAc,IAAIC,QAClBC,EAAc,IAAID,QAClBE,EAAW,IAAIF,QAEfG,EAAM,CAACC,EAAiBC,KAC5B,MAAMC,EAAiB,WAATF,EAAoBL,EAAuB,WAATK,EAAoBH,EAAcC,EAC5EK,EAAMD,EAAME,IAAIH,GACtB,GAAIE,EACF,OAAOA,EAET,MAAME,EAAMC,OAAOC,OAAON,EAAIO,IAAKd,GAAMY,OAAOC,OAAO,IAAKb,EAAGM,WAE/D,OADAE,EAAMO,IAAIR,EAAKI,GACRA,GA8DH,SAAUK,EAAUC,EAA2B,IACnD,MAAMC,iBAAEA,GAAmB,GAAUD,EAE/BE,EAAOC,EACVC,GAAOC,EAAWC,UAAUF,GAC7B,IAAMC,EAAWE,YAGbC,EAAUC,GAAO,GACvBC,EAAU,KACR,GAAIF,EAAQG,QACV,OAEFH,EAAQG,SAAU,EAGlB,MAAMC,EAAUC,OAAuB,GACvCR,EAAWS,QAAQ,SAAUF,IAC5B,IAEH,MAAMG,EAAeC,EAAQ,IAAM5B,EAAI,SAAUc,EAAKU,QAAS,CAACV,EAAKU,SAC/DK,EAAeD,EAAQ,IAAM5B,EAAI,SAAUc,EAAKgB,QAAS,CAAChB,EAAKgB,SAC/DC,EAAYH,EAAQ,IAAM5B,EAAI,YAAac,EAAKkB,WAAY,CAAClB,EAAKkB,YAElEC,EAAML,EACV,IAAMrB,OAAOC,OAAO,IAAKK,EAAmBkB,EAAY,MAAQF,KAAiBF,IACjF,CAACd,EAAkBkB,EAAWF,EAAcF,IAGxCO,EAAuBN,EAAQ,KACnC,MAAM1B,EAAMK,OAAO4B,OAAO,IAAIF,GAAM,CAClC,MAAAG,CAAOnC,EAAiBoC,GACtB,MAAMC,EACK,WAATrC,EAAoB4B,EAAwB,cAAT5B,EAAuB8B,EAAYJ,EACxE,OAAOU,GAAM5C,MAAQc,OAAOC,OAAOjB,EAAc+C,EAAMD,EAAK5C,QAAU6C,CACxE,EACAC,QAAO,CAAC9C,EAAe4C,IACjBA,GAAMpC,KACDC,EAAIkC,OAAOC,EAAKpC,KAAM,CAAER,UAE1Bc,OAAOC,OAAOjB,EAAc0C,EAAKxC,MAG5C,OAAOc,OAAOC,OAAON,IACpB,CAAC+B,EAAKJ,EAAcE,EAAWJ,IAE5Ba,EAAWP,EAAIQ,OAAS,EAExBC,EAAUC,EAAaC,IAC3B3B,EAAW4B,OAAOC,EAAaF,IAC9B,IAEGG,EAAaJ,EAAY,KAC7B1B,EAAW+B,MAAMF,IAChB,IAEH,OAAOlB,EACL,KAAA,CAASM,SAAQM,WAAUE,UAASK,eACpC,CAACb,EAAQM,EAAUE,EAASK,GAEhC,CAwDO,MAAME,EAAe,CAC1BC,UAhDF,SAAsBC,GACpB,MAAMC,EAAUzD,IACd,MAAMM,EAjLV,SAAsBN,GACpB,OAAIA,aAAa0D,EACR,SAEL1D,aAAa2D,EACR,YAEL3D,aAAa4D,EACR,SAEF,IACT,CAsKiBC,CAAa7D,GACpB8D,EArKV,SAAuB9D,GACrB,MAAO,CACL+D,KAAO/D,GAAkB+D,OAAS/D,aAAagE,MAAQhE,EAAEiE,UAAOC,IAAc,gBAC9EC,QAAUnE,GAAkBmE,SAAW,gBACvCrE,MAAQE,GAAkBF,MAE9B,CA+JuBsE,CAAcpE,GACjC,OAAQM,GACN,IAAK,SACHgD,EAAae,oBAAoB,CAACP,IAClC,MACF,IAAK,YACHR,EAAagB,uBAAuB,CAACR,IACrC,MACF,IAAK,SACHR,EAAaiB,oBAAoB,CAACT,IAClC,MACF,QAEE,MADAU,QAAQC,MAAM,sCAAuCzE,GAC/CA,IAKZ,GAA+B,mBAApBwD,EACT,IACE,MAAMkB,EAAUlB,IAChB,MA7BS,iBADImB,EA8BID,IA5Bf,OAANC,GACA,SAAUA,GAC+B,mBAAjCA,EAAwBC,KA2BxBF,EAAOG,MAAO7E,IAEZ,MADAyD,EAAOzD,GACDA,IAER0E,CACN,CAAE,MAAO1E,GAEP,MADAyD,EAAOzD,GACDA,CACR,CAvCc,IAAC2E,EA0CjB,OAAOnB,EAAgBqB,MAAO7E,IAE5B,MADAyD,EAAOzD,GACDA,GAEV,EAUE,mBAAAqE,CAAoBxE,EAAoC6C,GAClDA,GAAME,QACRtB,EAAWwD,eAAe,SAAUjF,EAAM6C,EAAKE,SAE/CtB,EAAWS,QAAQ,SAAUlC,EAEjC,EACA,iBAAAkF,GACEzD,EAAW+B,MAAM,CAAC,UACpB,EACA,gBAAA2B,CAAiBnF,GACfyB,EAAW2D,KAAK,SAAUpF,EAC5B,EAEA,sBAAAyE,CAAuBzE,EAAoC6C,GACrDA,GAAME,QACRtB,EAAWwD,eAAe,YAAajF,EAAM6C,EAAKE,SAElDtB,EAAWS,QAAQ,YAAalC,EAEpC,EACA,oBAAAqF,GACE5D,EAAW+B,MAAM,CAAC,aACpB,EACA,mBAAA8B,CAAoBtF,GAClByB,EAAW2D,KAAK,YAAapF,EAC/B,EAEA,mBAAA0E,CAAoB1E,EAAoC6C,GAClDA,GAAME,QACRtB,EAAWwD,eAAe,SAAUjF,EAAM6C,EAAKE,SAE/CtB,EAAWS,QAAQ,SAAUlC,EAEjC,EACA,iBAAAuF,GACE9D,EAAW+B,MAAM,CAAC,UACpB,EACA,gBAAAgC,CAAiBxF,GACfyB,EAAW2D,KAAK,SAAUpF,EAC5B,EAEA,gBAAAyF,GACE,MAAMzD,EAAUC,OAAuB,GACvCR,EAAWS,QAAQ,SAAUF,EAC/B"}
+{"version":3,"file":"errors.js","sources":["../../../src/hooks/common/errors.ts"],"sourcesContent":["import {\n  ConfigurationError,\n  ValidationError,\n  Auth0Error as Auth0ServerError,\n  getErrors as getServerErrors,\n  type Error as Auth0Error,\n} from '@auth0/auth0-acul-js';\nimport { useEffect, useMemo, useRef, useSyncExternalStore, useCallback } from 'react';\n\nimport { errorStore, ERROR_TYPES, type ErrorItem, type ErrorType } from '../../state/error-store';\n\nexport interface ErrorsResult extends ReadonlyArray<ErrorItem> {\n  byType(type: ErrorType, opts?: { field?: string }): ReadonlyArray<ErrorItem>;\n  byField(field: string, opts?: { type?: ErrorType }): ReadonlyArray<ErrorItem>;\n}\n\nexport interface UseErrorOptions {\n  includeDevErrors?: boolean;\n}\n\nexport interface UseErrorsResult {\n  errors: ErrorsResult;\n  hasError: boolean;\n  dismiss: (id: string) => void;\n  dismissAll: () => void;\n}\n\nfunction classifyType(e: unknown): ErrorType | null {\n  if (e instanceof ValidationError) {\n    return 'validation';\n  }\n  if (e instanceof ConfigurationError) {\n    return 'configuration';\n  }\n  if (e instanceof Auth0ServerError) {\n    return 'auth0';\n  }\n  return null;\n}\n\nfunction toErrorObject(e: unknown): Omit<ErrorItem, 'id'> {\n  return {\n    code: (e as Auth0Error)?.code ?? (e instanceof Error ? e.name : undefined) ?? 'unknown_error',\n    message: (e as Auth0Error)?.message ?? 'Unknown error',\n    field: (e as Auth0Error)?.field,\n  };\n}\n\nfunction filterByField<T extends { field?: string }>(\n  list: ReadonlyArray<T>,\n  field?: string\n): ReadonlyArray<T> {\n  if (!field) {\n    return list;\n  }\n  return list.filter((e) => e.field === field);\n}\n\n// caches for tagging\nconst cacheServer = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\nconst cacheValidation = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\nconst cacheDev = new WeakMap<ReadonlyArray<ErrorItem>, ReadonlyArray<ErrorItem>>();\n\nconst tag = (type: ErrorType, arr: ReadonlyArray<ErrorItem>): ReadonlyArray<ErrorItem> => {\n  const cache = type === 'auth0' ? cacheServer : type === 'validation' ? cacheValidation : cacheDev;\n  const hit = cache.get(arr);\n  if (hit) {\n    return hit;\n  }\n  const out = Object.freeze(arr.map((e) => Object.freeze({ ...e, type })));\n  cache.set(arr, out);\n  return out;\n};\n\n/**\n * React hook for reading and managing errors in ACUL (Advanced Customization of Universal Login).\n * With all validation and server-side errors. It groups errors into three types:\n * - `auth0` — errors returned by Auth0 or your own backend.\n * - `validation` — errors from client-side validation (e.g., invalid form input).\n * - `configuration` — errors caused by incorrect integration or SDK misuse.\n *\n * @supportedScreens\n * - The `useErrors` hook is available on every ACUL screen.\n *\n * @param options.includeDevErrors - When `true`, configuration errors are included in\n *   the returned list. Defaults to `false`.\n *\n * @returns An object of type {@link UseErrorsResult}, containing:\n * - `errors` — the full error list of type {@link ErrorsResult}, with helpers:\n *   - `errors.byType(type, filter?)` — filter by error type and optionally by field.\n *   - `errors.byField(field, filter?)` — filter by field and optionally by type.\n * - `hasError` — `true` if any error is currently present.\n * - `dismiss(id)` — remove a specific error by its ID.\n * - `dismissAll()` — clear all tracked errors.\n *\n * Typical usage is inside a form or screen component where you need to\n * reactively display errors and provide ways to dismiss them:\n *\n * @example\n * ```tsx\n * import { useErrors } from \"@auth0/auth0-acul-react\";\n *\n * export function SignupForm() {\n *   const { errors, hasError, dismiss, dismissAll } = useErrors();\n *\n *   return (\n *     <div>\n *       {hasError && (\n *         <div className=\"mb-4\">\n *           {errors.byType(\"auth0\").map(err => (\n *             <div key={err.id} className=\"text-red-600\">\n *               {err.message}\n *               <button onClick={() => dismiss(err.id)}>Dismiss</button>\n *             </div>\n *           ))}\n *         </div>\n *       )}\n *\n *       <button onClick={dismissAll}>Clear All Errors</button>\n *     </div>\n *   );\n * }\n * ```\n *\n * In addition to rendering messages, you can filter by field or type:\n * ```ts\n * console.log(errors.byType('validation')); // all validation errors\n * console.log(errors.byType('validation', { field: 'username' })); // validation errors for field 'username'\n * console.log(errors.byField('username')); // all errors for field 'username'\n * console.log(errors.byField('username', { type: 'auth0' })); // auth0 errors for field 'username'\n * ```\n */\n\nexport function useErrors(options: UseErrorOptions = {}): UseErrorsResult {\n  const { includeDevErrors = false } = options;\n\n  const snap = useSyncExternalStore(\n    (cb) => errorStore.subscribe(cb),\n    () => errorStore.snapshot()\n  );\n\n  const didInit = useRef(false);\n  useEffect(() => {\n    if (didInit.current) {\n      return;\n    }\n    didInit.current = true;\n\n    // Get server errors directly from TS SDK on first render.\n    const server = (getServerErrors?.() ?? []) as Array<Omit<ErrorItem, 'id'>>;\n    errorStore.replace('auth0', server);\n  }, []);\n\n  const serverTagged = useMemo(() => tag('auth0', snap.auth0), [snap.auth0]);\n  const clientTagged = useMemo(() => tag('validation', snap.validation), [snap.validation]);\n  const devTagged = useMemo(() => tag('configuration', snap.configuration), [snap.configuration]);\n\n  const all = useMemo<ReadonlyArray<ErrorItem>>(\n    () => Object.freeze([...(includeDevErrors ? devTagged : []), ...clientTagged, ...serverTagged]),\n    [includeDevErrors, devTagged, clientTagged, serverTagged]\n  );\n\n  const errors: ErrorsResult = useMemo(() => {\n    const arr = Object.assign([...all], {\n      byType(type: ErrorType, opts?: { field?: string }): ReadonlyArray<ErrorItem> {\n        let base: ReadonlyArray<ErrorItem>;\n        if (type === 'validation') {\n          base = clientTagged;\n        } else if (type === 'configuration') {\n          base = devTagged;\n        } else {\n          base = serverTagged;\n        }\n        if (opts?.field) {\n          return Object.freeze(filterByField(base, opts.field));\n        }\n        return base;\n      },\n      byField(field: string, opts?: { type?: ErrorType }): ReadonlyArray<ErrorItem> {\n        if (opts?.type) {\n          return arr.byType(opts.type, { field });\n        }\n        return Object.freeze(filterByField(all, field));\n      },\n    });\n    return Object.freeze(arr);\n  }, [all, clientTagged, devTagged, serverTagged]);\n\n  const hasError = all.length > 0;\n\n  const dismiss = useCallback((id: string) => {\n    errorStore.remove(ERROR_TYPES, id);\n  }, []);\n\n  const dismissAll = useCallback(() => {\n    errorStore.clear(ERROR_TYPES);\n  }, []);\n\n  return useMemo(\n    () => ({ errors, hasError, dismiss, dismissAll }),\n    [errors, hasError, dismiss, dismissAll]\n  );\n}\n\n// ---------------- INTERNAL (SDK-only) ----------------\nconst isPromise = (v: unknown): v is Promise<unknown> =>\n  typeof v === 'object' &&\n  v !== null &&\n  'then' in v &&\n  typeof (v as { then: unknown }).then === 'function';\n\nfunction withError<T>(actionOrPromise: (() => T | Promise<T>) | Promise<T>): T | Promise<T> {\n  const handle = (e: unknown) => {\n    const type = classifyType(e);\n    const normalized = toErrorObject(e);\n    switch (type) {\n      case 'validation':\n        errorManager.replaceValidationErrors([normalized]);\n        break;\n      case 'configuration':\n        errorManager.replaceDeveloperErrors([normalized]);\n        break;\n      case 'auth0':\n        errorManager.replaceServerErrors([normalized]);\n        break;\n      default: {\n        console.error('[auth0-acul-react] Unhandled error:', e);\n        throw e;\n      }\n    }\n  };\n\n  if (typeof actionOrPromise === 'function') {\n    try {\n      const result = (actionOrPromise as () => T | Promise<T>)();\n      return isPromise(result)\n        ? result.catch((e) => {\n            handle(e);\n            throw e;\n          })\n        : result;\n    } catch (e) {\n      handle(e);\n      throw e;\n    }\n  }\n\n  return actionOrPromise.catch((e) => {\n    handle(e);\n    throw e;\n  });\n}\n\n/**\n * @hidden\n * Internal error manager for use by SDK methods.\n * Use the `useErrors` hook in React components instead.\n */\nexport const errorManager = {\n  withError,\n\n  replaceValidationErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('validation', list, opts.byField);\n    } else {\n      errorStore.replace('validation', list);\n    }\n  },\n  clearValidationErrors() {\n    errorStore.clear(['validation']);\n  },\n  pushValidationErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('validation', list);\n  },\n\n  replaceDeveloperErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('configuration', list, opts.byField);\n    } else {\n      errorStore.replace('configuration', list);\n    }\n  },\n  clearDeveloperErrors() {\n    errorStore.clear(['configuration']);\n  },\n  pushDeveloperErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('configuration', list);\n  },\n\n  replaceServerErrors(list: Array<Omit<ErrorItem, 'id'>>, opts?: { byField?: string }) {\n    if (opts?.byField) {\n      errorStore.replacePartial('auth0', list, opts.byField);\n    } else {\n      errorStore.replace('auth0', list);\n    }\n  },\n  clearServerErrors() {\n    errorStore.clear(['auth0']);\n  },\n  pushServerErrors(list: Omit<ErrorItem, 'id'> | Array<Omit<ErrorItem, 'id'>>) {\n    errorStore.push('auth0', list);\n  },\n\n  syncServerErrors() {\n    const server = (getServerErrors?.() ?? []) as Array<Omit<ErrorItem, 'id'>>;\n    errorStore.replace('auth0', server);\n  },\n};\n\nexport { ErrorItem, ErrorType };\n"],"names":["filterByField","list","field","filter","e","cacheServer","WeakMap","cacheValidation","cacheDev","tag","type","arr","cache","hit","get","out","Object","freeze","map","set","useErrors","options","includeDevErrors","snap","useSyncExternalStore","cb","errorStore","subscribe","snapshot","didInit","useRef","useEffect","current","server","getServerErrors","replace","serverTagged","useMemo","auth0","clientTagged","validation","devTagged","configuration","all","errors","assign","byType","opts","base","byField","hasError","length","dismiss","useCallback","id","remove","ERROR_TYPES","dismissAll","clear","errorManager","withError","actionOrPromise","handle","ValidationError","ConfigurationError","Auth0ServerError","classifyType","normalized","code","Error","name","undefined","message","toErrorObject","replaceValidationErrors","replaceDeveloperErrors","replaceServerErrors","console","error","result","v","then","catch","replacePartial","clearValidationErrors","pushValidationErrors","push","clearDeveloperErrors","pushDeveloperErrors","clearServerErrors","pushServerErrors","syncServerErrors"],"mappings":"6RAgDA,SAASA,EACPC,EACAC,GAEA,OAAKA,EAGED,EAAKE,OAAQC,GAAMA,EAAEF,QAAUA,GAF7BD,CAGX,CAGA,MAAMI,EAAc,IAAIC,QAClBC,EAAkB,IAAID,QACtBE,EAAW,IAAIF,QAEfG,EAAM,CAACC,EAAiBC,KAC5B,MAAMC,EAAiB,UAATF,EAAmBL,EAAuB,eAATK,EAAwBH,EAAkBC,EACnFK,EAAMD,EAAME,IAAIH,GACtB,GAAIE,EACF,OAAOA,EAET,MAAME,EAAMC,OAAOC,OAAON,EAAIO,IAAKd,GAAMY,OAAOC,OAAO,IAAKb,EAAGM,WAE/D,OADAE,EAAMO,IAAIR,EAAKI,GACRA,GA8DH,SAAUK,EAAUC,EAA2B,IACnD,MAAMC,iBAAEA,GAAmB,GAAUD,EAE/BE,EAAOC,EACVC,GAAOC,EAAWC,UAAUF,GAC7B,IAAMC,EAAWE,YAGbC,EAAUC,GAAO,GACvBC,EAAU,KACR,GAAIF,EAAQG,QACV,OAEFH,EAAQG,SAAU,EAGlB,MAAMC,EAAUC,OAAuB,GACvCR,EAAWS,QAAQ,QAASF,IAC3B,IAEH,MAAMG,EAAeC,EAAQ,IAAM5B,EAAI,QAASc,EAAKe,OAAQ,CAACf,EAAKe,QAC7DC,EAAeF,EAAQ,IAAM5B,EAAI,aAAcc,EAAKiB,YAAa,CAACjB,EAAKiB,aACvEC,EAAYJ,EAAQ,IAAM5B,EAAI,gBAAiBc,EAAKmB,eAAgB,CAACnB,EAAKmB,gBAE1EC,EAAMN,EACV,IAAMrB,OAAOC,OAAO,IAAKK,EAAmBmB,EAAY,MAAQF,KAAiBH,IACjF,CAACd,EAAkBmB,EAAWF,EAAcH,IAGxCQ,EAAuBP,EAAQ,KACnC,MAAM1B,EAAMK,OAAO6B,OAAO,IAAIF,GAAM,CAClC,MAAAG,CAAOpC,EAAiBqC,GACtB,IAAIC,EAQJ,OANEA,EADW,eAATtC,EACK6B,EACW,kBAAT7B,EACF+B,EAEAL,EAELW,GAAM7C,MACDc,OAAOC,OAAOjB,EAAcgD,EAAMD,EAAK7C,QAEzC8C,CACT,EACAC,QAAO,CAAC/C,EAAe6C,IACjBA,GAAMrC,KACDC,EAAImC,OAAOC,EAAKrC,KAAM,CAAER,UAE1Bc,OAAOC,OAAOjB,EAAc2C,EAAKzC,MAG5C,OAAOc,OAAOC,OAAON,IACpB,CAACgC,EAAKJ,EAAcE,EAAWL,IAE5Bc,EAAWP,EAAIQ,OAAS,EAExBC,EAAUC,EAAaC,IAC3B5B,EAAW6B,OAAOC,EAAaF,IAC9B,IAEGG,EAAaJ,EAAY,KAC7B3B,EAAWgC,MAAMF,IAChB,IAEH,OAAOnB,EACL,KAAA,CAASO,SAAQM,WAAUE,UAASK,eACpC,CAACb,EAAQM,EAAUE,EAASK,GAEhC,CAwDO,MAAME,EAAe,CAC1BC,UAhDF,SAAsBC,GACpB,MAAMC,EAAU1D,IACd,MAAMM,EA1LV,SAAsBN,GACpB,OAAIA,aAAa2D,EACR,aAEL3D,aAAa4D,EACR,gBAEL5D,aAAa6D,EACR,QAEF,IACT,CA+KiBC,CAAa9D,GACpB+D,EA9KV,SAAuB/D,GACrB,MAAO,CACLgE,KAAOhE,GAAkBgE,OAAShE,aAAaiE,MAAQjE,EAAEkE,UAAOC,IAAc,gBAC9EC,QAAUpE,GAAkBoE,SAAW,gBACvCtE,MAAQE,GAAkBF,MAE9B,CAwKuBuE,CAAcrE,GACjC,OAAQM,GACN,IAAK,aACHiD,EAAae,wBAAwB,CAACP,IACtC,MACF,IAAK,gBACHR,EAAagB,uBAAuB,CAACR,IACrC,MACF,IAAK,QACHR,EAAaiB,oBAAoB,CAACT,IAClC,MACF,QAEE,MADAU,QAAQC,MAAM,sCAAuC1E,GAC/CA,IAKZ,GAA+B,mBAApByD,EACT,IACE,MAAMkB,EAAUlB,IAChB,MA7BS,iBADImB,EA8BID,IA5Bf,OAANC,GACA,SAAUA,GAC+B,mBAAjCA,EAAwBC,KA2BxBF,EAAOG,MAAO9E,IAEZ,MADA0D,EAAO1D,GACDA,IAER2E,CACN,CAAE,MAAO3E,GAEP,MADA0D,EAAO1D,GACDA,CACR,CAvCc,IAAC4E,EA0CjB,OAAOnB,EAAgBqB,MAAO9E,IAE5B,MADA0D,EAAO1D,GACDA,GAEV,EAUE,uBAAAsE,CAAwBzE,EAAoC8C,GACtDA,GAAME,QACRvB,EAAWyD,eAAe,aAAclF,EAAM8C,EAAKE,SAEnDvB,EAAWS,QAAQ,aAAclC,EAErC,EACA,qBAAAmF,GACE1D,EAAWgC,MAAM,CAAC,cACpB,EACA,oBAAA2B,CAAqBpF,GACnByB,EAAW4D,KAAK,aAAcrF,EAChC,EAEA,sBAAA0E,CAAuB1E,EAAoC8C,GACrDA,GAAME,QACRvB,EAAWyD,eAAe,gBAAiBlF,EAAM8C,EAAKE,SAEtDvB,EAAWS,QAAQ,gBAAiBlC,EAExC,EACA,oBAAAsF,GACE7D,EAAWgC,MAAM,CAAC,iBACpB,EACA,mBAAA8B,CAAoBvF,GAClByB,EAAW4D,KAAK,gBAAiBrF,EACnC,EAEA,mBAAA2E,CAAoB3E,EAAoC8C,GAClDA,GAAME,QACRvB,EAAWyD,eAAe,QAASlF,EAAM8C,EAAKE,SAE9CvB,EAAWS,QAAQ,QAASlC,EAEhC,EACA,iBAAAwF,GACE/D,EAAWgC,MAAM,CAAC,SACpB,EACA,gBAAAgC,CAAiBzF,GACfyB,EAAW4D,KAAK,QAASrF,EAC3B,EAEA,gBAAA0F,GACE,MAAM1D,EAAUC,OAAuB,GACvCR,EAAWS,QAAQ,QAASF,EAC9B"}

package/dist/hooks/index.d.ts

@@ -1,6 +1,6 @@
 export { useAuth0Themes } from './common/auth0-themes';
 export { useCurrentScreen } from './common/current-screen';
-export { errorManager, useErrors, type UseErrorOptions, type UseErrorsResult, type ErrorsResult, type ErrorKind, type ErrorItem, } from './common/errors';
+export { errorManager, useErrors, type UseErrorOptions, type UseErrorsResult, type ErrorsResult, type ErrorType, type ErrorItem, } from './common/errors';
 export { ContextHooks } from './context';
 export { useLoginIdentifiers } from './utility/login-identifiers';
 export { useSignupIdentifiers } from './utility/signup-identifiers';
@@ -8,3 +8,4 @@ export { useMfaPolling, type MfaPollingResult, type ULError } from './utility/po
 export { useResend, type UseResendReturn, type UseResendOptions } from './utility/resend-manager';
 export { usePasswordValidation, type PasswordValidationResult, type PasswordComplexityRule, } from './utility/validate-password';
 export { useUsernameValidation, type UsernameValidationResult, type UsernameValidationError, } from './utility/validate-username';
+export { usePasskeyAutofill, type UsePasskeyAutofillResult } from './utility/passkey-autofill';

package/dist/hooks/utility/passkey-autofill.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Result object returned by {@link usePasskeyAutofill}.
+ *
+ * Provides a ref that can be attached to the username `<input>` element
+ * to automatically enable browser Conditional UI (passkey autofill).
+ *
+ * @see {@link usePasskeyAutofill}
+ * @category Passkeys
+ * @public
+ */
+export interface UsePasskeyAutofillResult {
+    /**
+     * A React ref that can be bound to the username `<input>` element.
+     *
+     * When attached, the SDK ensures the input’s `autocomplete`
+     * attribute is correctly set to `"username webauthn"`.
+     *
+     * If the developer already declared this attribute in markup,
+     * the ref is optional, the hook will still register Conditional
+     * Mediation correctly even without it.
+     */
+    inputRef: React.RefObject<HTMLInputElement>;
+}
+/**
+ * React hook that enables browser **Conditional UI** (passkey autofill)
+ * for the login identifier field on the `login-id` screen.
+ *
+ * ---
+ * ### Behavior
+ * - The hook automatically initializes the browser’s Conditional Mediation
+ *   API (`navigator.credentials.get({ mediation: "conditional" })`),
+ *   allowing passkeys stored on the user’s device to appear directly in
+ *   the username field’s autocomplete dropdown.
+ * - It **fails silently** on unsupported browsers and **never blocks** user input.
+ * - The registration is performed once per page lifecycle.
+ *
+ * ---
+ * ### Using the returned `ref`
+ * The returned `inputRef` is **optional**.
+ * - If you bind it to your `<input>` element, the SDK will ensure the element’s
+ *   `autocomplete` attribute is correctly set to `"username webauthn"`.
+ * - If your input element **already has**
+ *   `autocomplete="username webauthn"` declared in markup,
+ *   you can skip binding the `ref` entirely, the hook will still register
+ *   Conditional Mediation correctly. See {@link UsePasskeyAutofillResult}
+ *
+ * ---
+ * ### Example
+ * ```tsx
+ * import { usePasskeyAutofill } from '@auth0/auth0-acul-react/login-id';
+ *
+ * export function LoginForm() {
+ *   // Option 1: bind the ref for automatic attribute handling
+ *   const { inputRef } = usePasskeyAutofill();
+ *
+ *   return (
+ *     <input
+ *       ref={inputRef}
+ *       id="username"
+ *       placeholder="Username"
+ *       autoComplete="username webauthn"
+ *     />
+ *   );
+ * }
+ *
+ * // Option 2: works equally well without using the ref
+ * export function LoginFormWithoutRef() {
+ *   usePasskeyAutofill(); // just call the hook once
+ *
+ *   return (
+ *     <input
+ *       id="username"
+ *       placeholder="Username"
+ *       autoComplete="username webauthn"
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * ---
+ * @supportedScreens
+ * - `login-id`
+ *
+ * @category Passkeys
+ */
+export declare function usePasskeyAutofill(): UsePasskeyAutofillResult;

package/dist/hooks/utility/passkey-autofill.js

@@ -0,0 +1,2 @@
+import{useRef as t,useLayoutEffect as e}from"react";import{getScreen as r}from"../../state/instance-store.js";const o="username webauthn";function n(){const n=r(),s=t(null),i=t(!1);return e(()=>{if(!i.current){i.current=!0;try{if(!n||"function"!=typeof n.registerPasskeyAutofill)return void console.warn("Passkey autofill unavailable: missing instance method");const t=s.current,e=t?.id;if(n.registerPasskeyAutofill(e),t){(t.getAttribute("autocomplete")??"").trim().toLowerCase()!==o&&t.setAttribute("autocomplete",o)}}catch(t){console.warn("usePasskeyAutofill failed:",t)}}},[n]),{inputRef:s}}export{n as usePasskeyAutofill};
+//# sourceMappingURL=passkey-autofill.js.map

package/dist/hooks/utility/passkey-autofill.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passkey-autofill.js","sources":["../../../src/hooks/utility/passkey-autofill.ts"],"sourcesContent":["import { useLayoutEffect, useRef } from 'react';\n\nimport { getScreen } from '../../state/instance-store';\n\nimport type { LoginIdMembers } from '@auth0/auth0-acul-js/login-id';\n\nconst REQUIRED_TOKENS = 'username webauthn';\n\n/**\n * Result object returned by {@link usePasskeyAutofill}.\n *\n * Provides a ref that can be attached to the username `<input>` element\n * to automatically enable browser Conditional UI (passkey autofill).\n *\n * @see {@link usePasskeyAutofill}\n * @category Passkeys\n * @public\n */\nexport interface UsePasskeyAutofillResult {\n  /**\n   * A React ref that can be bound to the username `<input>` element.\n   *\n   * When attached, the SDK ensures the input’s `autocomplete`\n   * attribute is correctly set to `\"username webauthn\"`.\n   *\n   * If the developer already declared this attribute in markup,\n   * the ref is optional, the hook will still register Conditional\n   * Mediation correctly even without it.\n   */\n  inputRef: React.RefObject<HTMLInputElement>;\n}\n\n/**\n * React hook that enables browser **Conditional UI** (passkey autofill)\n * for the login identifier field on the `login-id` screen.\n *\n * ---\n * ### Behavior\n * - The hook automatically initializes the browser’s Conditional Mediation\n *   API (`navigator.credentials.get({ mediation: \"conditional\" })`),\n *   allowing passkeys stored on the user’s device to appear directly in\n *   the username field’s autocomplete dropdown.\n * - It **fails silently** on unsupported browsers and **never blocks** user input.\n * - The registration is performed once per page lifecycle.\n *\n * ---\n * ### Using the returned `ref`\n * The returned `inputRef` is **optional**.\n * - If you bind it to your `<input>` element, the SDK will ensure the element’s\n *   `autocomplete` attribute is correctly set to `\"username webauthn\"`.\n * - If your input element **already has**\n *   `autocomplete=\"username webauthn\"` declared in markup,\n *   you can skip binding the `ref` entirely, the hook will still register\n *   Conditional Mediation correctly. See {@link UsePasskeyAutofillResult}\n *\n * ---\n * ### Example\n * ```tsx\n * import { usePasskeyAutofill } from '@auth0/auth0-acul-react/login-id';\n *\n * export function LoginForm() {\n *   // Option 1: bind the ref for automatic attribute handling\n *   const { inputRef } = usePasskeyAutofill();\n *\n *   return (\n *     <input\n *       ref={inputRef}\n *       id=\"username\"\n *       placeholder=\"Username\"\n *       autoComplete=\"username webauthn\"\n *     />\n *   );\n * }\n *\n * // Option 2: works equally well without using the ref\n * export function LoginFormWithoutRef() {\n *   usePasskeyAutofill(); // just call the hook once\n *\n *   return (\n *     <input\n *       id=\"username\"\n *       placeholder=\"Username\"\n *       autoComplete=\"username webauthn\"\n *     />\n *   );\n * }\n * ```\n *\n * ---\n * @supportedScreens\n * - `login-id`\n *\n * @category Passkeys\n */\nexport function usePasskeyAutofill(): UsePasskeyAutofillResult {\n  const instance = getScreen<LoginIdMembers>();\n  const inputRef = useRef<HTMLInputElement>(null);\n  const initializedRef = useRef(false);\n\n  useLayoutEffect(() => {\n    if (initializedRef.current) return;\n    initializedRef.current = true;\n\n    try {\n      if (!instance || typeof instance.registerPasskeyAutofill !== 'function') {\n        console.warn('Passkey autofill unavailable: missing instance method');\n        return;\n      }\n\n      const el = inputRef.current;\n      const inputId = el?.id;\n\n      // Fire-and-forget registration (fails silently)\n      void instance.registerPasskeyAutofill(inputId);\n\n      // Optionally correct the autocomplete attribute if the ref was used\n      if (el) {\n        const current = (el.getAttribute('autocomplete') ?? '').trim().toLowerCase();\n        if (current !== REQUIRED_TOKENS) {\n          el.setAttribute('autocomplete', REQUIRED_TOKENS);\n        }\n      }\n    } catch (err) {\n      console.warn('usePasskeyAutofill failed:', err);\n    }\n  }, [instance]);\n\n  return { inputRef };\n}\n"],"names":["REQUIRED_TOKENS","usePasskeyAutofill","instance","getScreen","inputRef","useRef","initializedRef","useLayoutEffect","current","registerPasskeyAutofill","console","warn","el","inputId","id","getAttribute","trim","toLowerCase","setAttribute","err"],"mappings":"8GAMA,MAAMA,EAAkB,6BAwFRC,IACd,MAAMC,EAAWC,IACXC,EAAWC,EAAyB,MACpCC,EAAiBD,GAAO,GA8B9B,OA5BAE,EAAgB,KACd,IAAID,EAAeE,QAAnB,CACAF,EAAeE,SAAU,EAEzB,IACE,IAAKN,GAAwD,mBAArCA,EAASO,wBAE/B,YADAC,QAAQC,KAAK,yDAIf,MAAMC,EAAKR,EAASI,QACdK,EAAUD,GAAIE,GAMpB,GAHKZ,EAASO,wBAAwBI,GAGlCD,EAAI,EACWA,EAAGG,aAAa,iBAAmB,IAAIC,OAAOC,gBAC/CjB,GACdY,EAAGM,aAAa,eAAgBlB,EAEpC,CACF,CAAE,MAAOmB,GACPT,QAAQC,KAAK,6BAA8BQ,EAC7C,CAxB4B,GAyB3B,CAACjB,IAEG,CAAEE,WACX"}