chore: change the name of the sign in step to make it more broad for passwordless

khatruong2009 · khatruong2009 · commit 3055a3a668cf · 2024-10-24T13:57:40.000-07:00
diff --git a/packages/amplify_core/doc/lib/auth.dart b/packages/amplify_core/doc/lib/auth.dart
@@ -146,7 +146,7 @@ Future<void> _handleSignInResult(SignInResult result) async {
       _handleCodeDelivery(codeDeliveryDetails);
     // #enddocregion handle-confirm-signin-sms
     // #docregion handle-confirm-signin-email
-    case AuthSignInStep.confirmSignInWithEmailMfaCode:
+    case AuthSignInStep.confirmSignInWithOtpCode:
       final codeDeliveryDetails = result.nextStep.codeDeliveryDetails!;
       _handleCodeDelivery(codeDeliveryDetails);
     // #enddocregion handle-confirm-signin-email
diff --git a/packages/amplify_core/lib/src/types/auth/sign_in/auth_next_sign_in_step.g.dart b/packages/amplify_core/lib/src/types/auth/sign_in/auth_next_sign_in_step.g.dart
diff --git a/packages/amplify_core/lib/src/types/auth/sign_in/auth_sign_in_step.dart b/packages/amplify_core/lib/src/types/auth/sign_in/auth_sign_in_step.dart
@@ -29,7 +29,7 @@ enum AuthSignInStep {
   confirmSignInWithTotpMfaCode,
 
   /// The sign-in is not complete and must be confirmed with an email code.
-  confirmSignInWithEmailMfaCode,
+  confirmSignInWithOtpCode,
 
   /// The sign-in is not complete and must be confirmed with the user's new
   /// password.
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_optional_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_optional_test.dart
@@ -60,7 +60,7 @@ void main() {
             password: password,
           );
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_required_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_required_test.dart
@@ -37,7 +37,7 @@ void main() {
           password: password,
         );
         check(signInRes.nextStep.signInStep)
-            .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+            .equals(AuthSignInStep.confirmSignInWithOtpCode);
 
         final confirmRes = await Amplify.Auth.confirmSignIn(
           confirmationValue: await otpResult.code,
@@ -63,7 +63,7 @@ void main() {
             password: password,
           );
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_optional_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_optional_test.dart
@@ -230,7 +230,7 @@ void main() {
             password: password,
           );
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -353,7 +353,7 @@ void main() {
           confirmationValue: 'EMAIL',
         );
         check(selectRes.nextStep.signInStep)
-            .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+            .equals(AuthSignInStep.confirmSignInWithOtpCode);
         check(selectRes.nextStep.codeDeliveryDetails)
             .isNotNull()
             .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -392,7 +392,7 @@ void main() {
             password: password,
           );
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_required_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_required_test.dart
@@ -37,7 +37,7 @@ void main() {
           signInRes.nextStep.signInStep,
           because:
               'When an email is registered and the userpool has email MFA enabled, Cognito will automatically enable email MFA as the preferred MFA method.',
-        ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+        ).equals(AuthSignInStep.confirmSignInWithOtpCode);
 
         final setupRes = await Amplify.Auth.confirmSignIn(
           confirmationValue: await otpResult.code,
@@ -60,7 +60,7 @@ void main() {
           password: password,
         );
         check(resignInRes.nextStep.signInStep)
-            .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+            .equals(AuthSignInStep.confirmSignInWithOtpCode);
         check(resignInRes.nextStep.codeDeliveryDetails)
             .isNotNull()
             .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -98,7 +98,7 @@ void main() {
             signInRes.nextStep.signInStep,
             because:
                 'MFA is required so Cognito automatically enables EMAIL MFA',
-          ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+          ).equals(AuthSignInStep.confirmSignInWithOtpCode);
 
           final confirmRes = await Amplify.Auth.confirmSignIn(
             confirmationValue: await otpResult.code,
@@ -224,7 +224,7 @@ void main() {
           check(
             signInRes.nextStep.signInStep,
             because: 'Preference is EMAIL MFA now',
-          ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+          ).equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_optional_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_optional_test.dart
@@ -64,7 +64,7 @@ void main() {
             signInRes.nextStep.signInStep,
             because: 'Once Email MFA is preferred, it is performed '
                 'on every sign-in attempt.',
-          ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+          ).equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -155,7 +155,7 @@ void main() {
             password: password,
           );
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -386,7 +386,7 @@ void main() {
           );
 
           check(signInRes.nextStep.signInStep)
-              .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+              .equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_required_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_required_test.dart
@@ -41,7 +41,7 @@ void main() {
           signInRes.nextStep.signInStep,
           because: 'MFA is required, and EMAIL is chosen when '
               'no phone number is registered',
-        ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+        ).equals(AuthSignInStep.confirmSignInWithOtpCode);
 
         final setupRes = await Amplify.Auth.confirmSignIn(
           confirmationValue: await otpResult.code,
@@ -68,7 +68,7 @@ void main() {
           password: password,
         );
         check(resignInRes.nextStep.signInStep)
-            .equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+            .equals(AuthSignInStep.confirmSignInWithOtpCode);
         check(resignInRes.nextStep.codeDeliveryDetails)
             .isNotNull()
             .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -147,7 +147,7 @@ void main() {
           check(
             resignInRes.nextStep.signInStep,
             because: 'Preference is EMAIL MFA now',
-          ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+          ).equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(resignInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -300,7 +300,7 @@ void main() {
           check(
             signInRes.nextStep.signInStep,
             because: 'Preference is EMAIL MFA now',
-          ).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
+          ).equals(AuthSignInStep.confirmSignInWithOtpCode);
           check(signInRes.nextStep.codeDeliveryDetails)
               .isNotNull()
               .has((d) => d.deliveryMedium, 'deliveryMedium')
diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/flows/constants.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/flows/constants.dart
@@ -61,7 +61,7 @@ abstract class CognitoConstants {
   static const challengeParamSmsMfaCode = 'SMS_MFA_CODE';
 
   /// The `EMAIL_OTP_CODE` parameter.
-  static const challengeParamEmailMfaCode = 'EMAIL_OTP_CODE';
+  static const challengeParamEmailOtpCode = 'EMAIL_OTP_CODE';
 
   /// The `SOFTWARE_TOKEN_MFA_CODE` parameter.
   static const challengeParamSoftwareTokenMfaCode = 'SOFTWARE_TOKEN_MFA_CODE';
diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/sdk/sdk_bridge.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/sdk/sdk_bridge.dart
@@ -33,7 +33,7 @@ extension ChallengeNameTypeBridge on ChallengeNameType {
         ChallengeNameType.softwareTokenMfa =>
           AuthSignInStep.confirmSignInWithTotpMfaCode,
         ChallengeNameType.emailOtp =>
-          AuthSignInStep.confirmSignInWithEmailMfaCode,
+          AuthSignInStep.confirmSignInWithOtpCode,
         ChallengeNameType.adminNoSrpAuth ||
         ChallengeNameType.passwordVerifier ||
         ChallengeNameType.devicePasswordVerifier ||
diff --git a/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_test.dart b/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_test.dart
@@ -36,10 +36,10 @@ void main() {
           tester.bloc.stream,
           emitsInOrder([
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             emitsDone,
           ]),
@@ -62,7 +62,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the email MFA code page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // And I type a valid EMAIL OTP code
         await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -94,7 +94,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the EMAIL OTP code page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // When I type a valid EMAIL OTP code
         await confirmSignInPage.enterVerificationCode(await otpResult2.code);
@@ -129,7 +129,7 @@ void main() {
           tester.bloc.stream,
           emitsInOrder([
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             emitsDone,
           ]),
         );
@@ -147,7 +147,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the EMAIL OTP code page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // And I type an invalid confirmation code
         await confirmSignInPage.enterVerificationCode('123456');
diff --git a/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_totp_test.dart b/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_totp_test.dart
@@ -36,7 +36,7 @@ void main() {
           tester.bloc.stream,
           emitsInOrder([
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             UnauthenticatedState.signIn,
             isA<ContinueSignInWithMfaSelection>(),
@@ -61,7 +61,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the confirm email mfa page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // When I type a valid confirmation code
         await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -138,11 +138,11 @@ void main() {
           tester.bloc.stream,
           emitsInOrder([
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             UnauthenticatedState.signIn,
             isA<ContinueSignInWithMfaSelection>(),
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             emitsDone,
           ]),
@@ -163,7 +163,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the confirm email mfa page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // When I type a valid confirmation code
         await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -205,7 +205,7 @@ void main() {
         await confirmSignInPage.submitConfirmSignInMfaSelection();
 
         // Then I will be redirected to the confirm EMAIL mfa page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // When I type a valid confirmation code
         await confirmSignInPage.enterVerificationCode(await otpResult2.code);
diff --git a/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_sms_email_test.dart b/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_sms_email_test.dart
@@ -46,7 +46,7 @@ void main() {
             UnauthenticatedState.confirmSignInMfa,
             isA<AuthenticatedState>(),
             UnauthenticatedState.signIn,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             emitsDone,
           ]),
@@ -101,7 +101,7 @@ void main() {
         await signInPage.submitSignIn();
 
         // Then I will be redirected to the EMAIL MFA code page
-        await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
+        await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
 
         // When I type a valid EMAIL MFA code
         await confirmSignInPage.enterVerificationCode(await code_2.code);
diff --git a/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_username_login_test.dart b/packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_username_login_test.dart
@@ -37,7 +37,7 @@ void main() {
             UnauthenticatedState.signIn,
             isA<ContinueSignInWithMfaSetupSelection>(),
             UnauthenticatedState.continueSignInWithEmailMfaSetup,
-            UnauthenticatedState.confirmSignInWithEmailMfaCode,
+            UnauthenticatedState.confirmSignInWithOtpCode,
             isA<AuthenticatedState>(),
             emitsDone,
           ]),
diff --git a/packages/authenticator/amplify_authenticator/lib/amplify_authenticator.dart b/packages/authenticator/amplify_authenticator/lib/amplify_authenticator.dart
@@ -719,7 +719,7 @@ class _AuthenticatorState extends State<Authenticator> {
                 continueSignInWithEmailMfaSetupForm:
                     ContinueSignInWithEmailMfaSetupForm(),
                 confirmSignInWithTotpMfaCodeForm: ConfirmSignInMFAForm(),
-                confirmSignInWithEmailMfaCodeForm: ConfirmSignInMFAForm(),
+                confirmSignInWithOtpCodeForm: ConfirmSignInMFAForm(),
                 verifyUserForm: VerifyUserForm(),
                 confirmVerifyUserForm: ConfirmVerifyUserForm(),
                 child: widget.child,
diff --git a/packages/authenticator/amplify_authenticator/lib/src/blocs/auth/auth_bloc.dart b/packages/authenticator/amplify_authenticator/lib/src/blocs/auth/auth_bloc.dart
@@ -227,8 +227,8 @@ class StateMachineBloc
           yield UnauthenticatedState.confirmSignInNewPassword;
         case AuthSignInStep.confirmSignInWithTotpMfaCode:
           yield UnauthenticatedState.confirmSignInWithTotpMfaCode;
-        case AuthSignInStep.confirmSignInWithEmailMfaCode:
-          yield UnauthenticatedState.confirmSignInWithEmailMfaCode;
+        case AuthSignInStep.confirmSignInWithOtpCode:
+          yield UnauthenticatedState.confirmSignInWithOtpCode;
         case AuthSignInStep.continueSignInWithMfaSelection:
           yield ContinueSignInWithMfaSelection(
             allowedMfaTypes: result.nextStep.allowedMfaTypes,
@@ -345,9 +345,9 @@ class StateMachineBloc
         _emit(UnauthenticatedState.continueSignInWithEmailMfaSetup);
       case AuthSignInStep.confirmSignInWithTotpMfaCode:
         _emit(UnauthenticatedState.confirmSignInWithTotpMfaCode);
-      case AuthSignInStep.confirmSignInWithEmailMfaCode:
+      case AuthSignInStep.confirmSignInWithOtpCode:
         _notifyCodeSent(result.nextStep.codeDeliveryDetails?.destination);
-        _emit(UnauthenticatedState.confirmSignInWithEmailMfaCode);
+        _emit(UnauthenticatedState.confirmSignInWithOtpCode);
       case AuthSignInStep.resetPassword:
         _emit(UnauthenticatedState.confirmResetPassword);
       case AuthSignInStep.confirmSignUp:
diff --git a/packages/authenticator/amplify_authenticator/lib/src/enums/authenticator_step.dart b/packages/authenticator/amplify_authenticator/lib/src/enums/authenticator_step.dart
@@ -82,7 +82,7 @@ enum AuthenticatorStep {
   confirmSignInWithTotpMfaCode,
 
   /// The sign-in is not complete and must be confirmed with an email code.
-  confirmSignInWithEmailMfaCode,
+  confirmSignInWithOtpCode,
 
   /// The user is on the Reset Password step.
   resetPassword,
diff --git a/packages/authenticator/amplify_authenticator/lib/src/l10n/generated/title_localizations.dart b/packages/authenticator/amplify_authenticator/lib/src/l10n/generated/title_localizations.dart
@@ -145,7 +145,7 @@ abstract class AuthenticatorTitleLocalizations {
   ///
   /// In en, this message translates to:
   /// **'Enter your one-time passcode'**
-  String get confirmSignInWithEmailMfaCode;
+  String get confirmSignInWithOtpCode;
 
   /// Title of the Continue Sign In with Email MFA Setup step and form
   ///
diff --git a/packages/authenticator/amplify_authenticator/lib/src/l10n/generated/title_localizations_en.dart b/packages/authenticator/amplify_authenticator/lib/src/l10n/generated/title_localizations_en.dart
@@ -31,7 +31,7 @@ class AuthenticatorTitleLocalizationsEn
   String get confirmSignInWithTotpMfaCode => 'Enter your one-time passcode';
 
   @override
-  String get confirmSignInWithEmailMfaCode => 'Enter your one-time passcode';
+  String get confirmSignInWithOtpCode => 'Enter your one-time passcode';
 
   @override
   String get continueSignInWithEmailMfaSetup =>
diff --git a/packages/authenticator/amplify_authenticator/lib/src/l10n/title_resolver.dart b/packages/authenticator/amplify_authenticator/lib/src/l10n/title_resolver.dart
diff --git a/packages/authenticator/amplify_authenticator/lib/src/screens/authenticator_screen.dart b/packages/authenticator/amplify_authenticator/lib/src/screens/authenticator_screen.dart
diff --git a/packages/authenticator/amplify_authenticator/lib/src/state/auth_state.dart b/packages/authenticator/amplify_authenticator/lib/src/state/auth_state.dart
diff --git a/packages/authenticator/amplify_authenticator/lib/src/state/inherited_forms.dart b/packages/authenticator/amplify_authenticator/lib/src/state/inherited_forms.dart
diff --git a/packages/authenticator/amplify_authenticator/lib/src/widgets/form_field.dart b/packages/authenticator/amplify_authenticator/lib/src/widgets/form_field.dart
diff --git a/packages/authenticator/amplify_authenticator_test/lib/src/pages/confirm_sign_in_page.dart b/packages/authenticator/amplify_authenticator_test/lib/src/pages/confirm_sign_in_page.dart
