Prerelease updates for release-3 (#42)

* Updated readme, changelog, faq.md for release-3 * Updated package version for release 3
auth0 · Feb 21, 2025 · 686ee03 · 686ee03
1 parent ad2fe49
commit 686ee03
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -122,21 +122,48 @@ Get up and running quickly with our boilerplate starter template: [Link](https:/
 ##  API reference
 ### Screens
 
-1. [login-id](https://auth0.github.io/universal-login/classes/Classes.LoginId.html)
-2. [login-Password](https://auth0.github.io/universal-login/classes/Classes.LoginPassword.html)
-3. [signup-id](https://auth0.github.io/universal-login/classes/Classes.SignupId.html)
-4. [signup-password](https://auth0.github.io/universal-login/classes/Classes.SignupPassword.html)
+| No. | Screen Name       | Documentation Link                                                                                      |
+|--------|-------------------|-------------------------------------------------------------------------------------------|
+| 1      | login             | [Link](https://auth0.github.io/universal-login/classes/Classes.Login.html)                 |
+| 2      | login-id          | [Link](https://auth0.github.io/universal-login/classes/Classes.LoginId.html)              |
+| 3      | login-Password    | [Link](https://auth0.github.io/universal-login/classes/Classes.LoginPassword.html)         |
+| 4      | signup-id         | [Link](https://auth0.github.io/universal-login/classes/Classes.SignupId.html)              |
+| 5      | signup-password   | [Link](https://auth0.github.io/universal-login/classes/Classes.SignupPassword.html)        |
+
 <details>
   <summary>Explore more screens...</summary>
 
-  5. [login-passwordless-email-code](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessEmailCode.html)
-  6. [login-passwordless-sms-otp](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessSmsOtp.html)
-  7. [passkey-enrollment](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollment.html)
-  8. [passkey-enrollment-local](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollmentLocal.html)
-  9. [phone-identifier-enrollment](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierEnrollment.html)
-  10. [phone-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierChallenge.html)
-  11. [email-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.EmailIdentifierChallenge.html)
-  12. [interstitial-captcha](https://auth0.github.io/universal-login/classes/Classes.InterstitialCaptcha.html)
+| No. | Screen Name                                      | Documentation Link                                                                                                                        |
+|--------|-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| 6      | login-passwordless-email-code            | [Link](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessEmailCode.html)                             |
+| 7      | login-passwordless-sms-otp                | [Link](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessSmsOtp.html)                                 |
+| 8      | passkey-enrollment                        | [Link](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollment.html)                                       |
+| 9      | passkey-enrollment-local                  | [Link](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollmentLocal.html)                                 |
+| 10     | phone-identifier-enrollment               | [Link](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierEnrollment.html)                               |
+| 11     | phone-identifier-challenge                | [Link](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierChallenge.html)                               |
+| 12     | email-identifier-challenge                | [Link](https://auth0.github.io/universal-login/classes/Classes.EmailIdentifierChallenge.html)                               |
+| 13     | interstitial-captcha                      | [Link](https://auth0.github.io/universal-login/classes/Classes.InterstitialCaptcha.html)                                     |
+| 14     | reset-password-email                      | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordEmail.html)                                     |
+| 15     | reset-password-request                    | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordRequest.html)                                   |
+| 16     | reset-password                            | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPassword.html)                                         |
+| 17     | reset-password-error                      | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordError.html)                                     |
+| 18     | reset-password-success                    | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordSuccess.html)                                   |
+| 19     | signup                                    | [Link](https://auth0.github.io/universal-login/classes/Classes.Signup.html)                                               |
+| 30     | mfa-detect-browser-capabilities          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaDetectBrowserCapabilities.html)   |
+| 33     | mfa-enroll-result          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEnrollResult.html)   |
+| 25     | mfa-begin-enroll-options                  | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaBeginEnrollOptions.html)                                 |
+| 33     | mfa-login-options          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaLoginOptions.html)   |
+| 21     | mfa-push-enrollment-qr                    | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushEnrollmentQr.html)                                  |
+| 23     | mfa-push-welcome                          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushWelcome.html)                                        |
+| 33     | mfa-push-challenge-push          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushChallengePush.html)   |
+| 22     | mfa-push-list                             | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushList.html)                                           |
+| 27     | mfa-country-codes                         | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaCountryCodes.html)                                       |
+| 26     | mfa-sms-challenge                  |   [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsChallenge.html)                                 |
+| 24     | mfa-sms-enrollment                        | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsEnrollment.html)                                        |
+| 26     | mfa-sms-list                  |   [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsList.html)                                 |
+| 31     | mfa-email-challenge          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEmailChallenge.html)   |
+| 32     | mfa-email-list          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEmailList.html)   |
+
 </details>
 
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/auth0-acul-js/CHANGELOG.md b/packages/auth0-acul-js/CHANGELOG.md
@@ -1,11 +1,33 @@
 
-## [auth0-acul-js@0.1.0-beta.1](https://github.com/auth0/auth0-react/tree/v0.1.0) (2024-02-06)
+## [auth0-acul-js@0.1.0-beta.2](https://github.com/auth0/universal-login/tree/auth0-acul-js%400.1.0-beta.2) (2024-12-09)
 
 **Added**
 
 Support for the following screens:
 
-1. [login](https://auth0.github.io/universal-login/classes/Classes.Login.html)
+1. [mfa-detect-browser-capabilities](https://auth0.github.io/universal-login/classes/Classes.MfaDetectBrowserCapabilities.html)
+2. [mfa-enroll-result](https://auth0.github.io/universal-login/classes/Classes.MfaEnrollResult.html)
+3. [mfa-begin-enroll-options](https://auth0.github.io/universal-login/classes/Classes.MfaBeginEnrollOptions.html)
+4. [mfa-login-options](https://auth0.github.io/universal-login/classes/Classes.MfaLoginOptions.html)
+5. [mfa-push-enrollment-qr](https://auth0.github.io/universal-login/classes/Classes.MfaPushEnrollmentQr.html)
+6. [mfa-push-welcome](https://auth0.github.io/universal-login/classes/Classes.MfaPushWelcome.html)
+7. [mfa-push-challenge-push](https://auth0.github.io/universal-login/classes/Classes.MfaPushChallengePush.html)
+8. [mfa-push-list](https://auth0.github.io/universal-login/classes/Classes.MfaPushList.html)
+9. [mfa-country-codes](https://auth0.github.io/universal-login/classes/Classes.MfaCountryCodes.html)
+10. [mfa-sms-challenge](https://auth0.github.io/universal-login/classes/Classes.MfaSmsChallenge.html)
+11. [mfa-sms-enrollment](https://auth0.github.io/universal-login/classes/Classes.MfaSmsEnrollment.html)
+12. [mfa-sms-list](https://auth0.github.io/universal-login/classes/Classes.MfaSmsList.html)
+13. [mfa-email-challenge](https://auth0.github.io/universal-login/classes/Classes.MfaEmailChallenge.html)
+14. [mfa-email-list](https://auth0.github.io/universal-login/classes/Classes.MfaEmailList.html)
+
+
+## [auth0-acul-js@0.1.0-beta.1](https://github.com/auth0/universal-login/tree/auth0-acul-js%400.1.0-beta.1) (2024-02-06)
+
+**Added**
+
+Support for the following screens:
+
+1. [login](https://auth0.github.io/universal-login/classes/Classes.Login.html
 2. [signup](https://auth0.github.io/universal-login/classes/Classes.Signup.html)
 3. [reset-password-email](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordEmail.html)
 4. [reset-password-request](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordRequest.html)
@@ -29,7 +51,7 @@ Support for the following screens:
   // New property
   loginIdInstance.transaction.errors;
 
-## [auth0-acul-js@0.0.1-beta.1](https://github.com/auth0/auth0-react/tree/v0.1.0) (2024-12-09)
+## [auth0-acul-js@0.0.1-beta.1](https://github.com/auth0/universal-login/tree/auth0-acul-js%400.0.1-beta.1) (2024-12-09)
 
 **Added**
 

diff --git a/packages/auth0-acul-js/FAQ.md b/packages/auth0-acul-js/FAQ.md
@@ -12,6 +12,11 @@ import  LoginIdScreen  from '@auth0/auth0-acul-js/login-id';
 import  LoginPasswordScreen  from '@auth0/auth0-acul-js/login-password';
 import  SignupScreen  from '@auth0/auth0-acul-js/signup-id';
 import  SignupPasswordScreen  from '@auth0/auth0-acul-js/signup-password';
+```
+<details>
+  <summary>Import of all other screens</summary>
+
+```javascript
 import  LoginPasswordlessEmailCodeScreen  from '@auth0/auth0-acul-js/login-passwordless-email-code';
 import  LoginPasswordlessEmailSMSOTP  from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
 import  PasskeyEnrolmentScreen  from '@auth0/auth0-acul-js/passkey-enrollment';
@@ -28,7 +33,23 @@ import  ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email';
 import  ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success';
 import  ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error';
 
+// MFA related screens
+import  MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities';
+import  MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result';
+import  MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
+import  MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';
+import  MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
+import  MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';
+import  MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
+import  MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';
+import  MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';
+import  MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';
+import  MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';
+import  MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';
+import  MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
+import  MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';
 ```
+</details> 
 
 ## Where can i see errors related to my screen
 
@@ -60,3 +81,6 @@ Once installed, you can import and use it in your JavaScript or TypeScript or Re
 Yes, this SDK can be easily integrated into a ReactJS application.
 
 Although the SDK is written in Vanilla JavaScript, it is fully compatible with all JavaScript-based frameworks, including React, Angular, Vue, and others. You can seamlessly use the SDK within your React components or hooks.
+
+
+# feedback
diff --git a/packages/auth0-acul-js/README.md b/packages/auth0-acul-js/README.md
@@ -22,18 +22,6 @@ It simplifies integrating authentication screens (login, signup, passwordless, p
 - [Examples](https://github.com/auth0/universal-login/tree/master/packages/auth0-acul-js/examples) - code snippets for different customization use cases.
 - [FAQs](FAQ.md) - Find answers to frequently asked questions about the Auth0 ACUL JS SDK.
 
-### Architecture Overview
-
-- SDK features a modular architecture for integrating various authentication screens.
-- The **Login ID screen** is used as an example to explain the architecture.
-- This structure can be applied to other screens across the project, such as **signup**, **passwordless login**, and **passkey enrollment**.
-- Each screen can be treated as an independent module that can be **easily integrated** into the project.
-
-![ACUL SDK](https://cdn.auth0.com/website/sdks/assets/auth0-acul-sdk-architecture.png)
-
-
-
-
 ##  Getting started
 
 ### Prerequisites
@@ -151,22 +139,20 @@ Get up and running quickly with our boilerplate starter template: [Link](https:/
 | 17     | reset-password-error                      | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordError.html)                                     |
 | 18     | reset-password-success                    | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordSuccess.html)                                   |
 | 19     | signup                                    | [Link](https://auth0.github.io/universal-login/classes/Classes.Signup.html)                                               |
-| 20     | reset-password-mfa-push-challenge-push    | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordMfaPushChallengePush.html)                     |
+| 30     | mfa-detect-browser-capabilities          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaDetectBrowserCapabilities.html)   |
+| 33     | mfa-enroll-result          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEnrollResult.html)   |
+| 25     | mfa-begin-enroll-options                  | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaBeginEnrollOptions.html)                                 |
+| 33     | mfa-login-options          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaLoginOptions.html)   |
 | 21     | mfa-push-enrollment-qr                    | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushEnrollmentQr.html)                                  |
-| 22     | mfa-push-list                             | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushList.html)                                           |
 | 23     | mfa-push-welcome                          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushWelcome.html)                                        |
+| 33     | mfa-push-challenge-push          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushChallengePush.html)   |
+| 22     | mfa-push-list                             | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushList.html)                                           |
+| 27     | mfa-country-codes                         | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaCountryCodes.html)                                       |
+| 26     | mfa-sms-challenge                  |   [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsChallenge.html)                                 |
 | 24     | mfa-sms-enrollment                        | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsEnrollment.html)                                        |
-| 25     | mfa-begin-enroll-options                  | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaBeginEnrollOptions.html)                                 |
 | 26     | mfa-sms-list                  |   [Link](https://auth0.github.io/universal-login/classes/Classes.MfaSmsList.html)                                 |
-| 27     | mfa-country-codes                         | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaCountryCodes.html)                                       |
-| 28     | reset-password-mfa-email-challenge                         | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordMfaEmailChallenge.html)                                       
-| 29     | reset-password-mfa-sms-challenge          | [Link](https://auth0.github.io/universal-login/classes/Classes.ResetPasswordMfaSmsChallenge.html)  | 
-| 30     | mfa-detect-browser-capabilities          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaDetectBrowserCapabilities.html)   |
 | 31     | mfa-email-challenge          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEmailChallenge.html)   |
 | 32     | mfa-email-list          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEmailList.html)   |
-| 33     | mfa-enroll-result          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaEnrollResult.html)   |
-| 33     | mfa-login-options          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaLoginOptions.html)   |
-| 33     | mfa-push-challenge-push          | [Link](https://auth0.github.io/universal-login/classes/Classes.MfaPushChallengePush.html)   |
 
 </details>
 

diff --git a/packages/auth0-acul-js/package.json b/packages/auth0-acul-js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@auth0/auth0-acul-js",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "type": "module",
   "module": "dist/index.js",
   "exports": {