Skip to content

Commit 6cd3a62

Browse files
khatruong2009khatruong2009
authored
chore: API Name Change Amendment (#5602)
1 parent e63b865 commit 6cd3a62

32 files changed

+71
-72
lines changed

‎packages/amplify_core/doc/lib/auth.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Future<void> _handleSignInResult(SignInResult result) async {
146146
_handleCodeDelivery(codeDeliveryDetails);
147147
// #enddocregion handle-confirm-signin-sms
148148
// #docregion handle-confirm-signin-email
149-
case AuthSignInStep.confirmSignInWithEmailMfaCode:
149+
case AuthSignInStep.confirmSignInWithOtpCode:
150150
final codeDeliveryDetails = result.nextStep.codeDeliveryDetails!;
151151
_handleCodeDelivery(codeDeliveryDetails);
152152
// #enddocregion handle-confirm-signin-email

‎packages/amplify_core/lib/src/types/auth/sign_in/auth_next_sign_in_step.g.dart

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/amplify_core/lib/src/types/auth/sign_in/auth_sign_in_step.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ enum AuthSignInStep {
2929
confirmSignInWithTotpMfaCode,
3030

3131
/// The sign-in is not complete and must be confirmed with an email code.
32-
confirmSignInWithEmailMfaCode,
32+
confirmSignInWithOtpCode,
3333

3434
/// The sign-in is not complete and must be confirmed with the user's new
3535
/// password.

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_optional_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ void main() {
6060
password: password,
6161
);
6262
check(signInRes.nextStep.signInStep)
63-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
63+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
6464
check(signInRes.nextStep.codeDeliveryDetails)
6565
.isNotNull()
6666
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_required_test.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ void main() {
3737
password: password,
3838
);
3939
check(signInRes.nextStep.signInStep)
40-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
40+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
4141

4242
final confirmRes = await Amplify.Auth.confirmSignIn(
4343
confirmationValue: await otpResult.code,
@@ -63,7 +63,7 @@ void main() {
6363
password: password,
6464
);
6565
check(signInRes.nextStep.signInStep)
66-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
66+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
6767
check(signInRes.nextStep.codeDeliveryDetails)
6868
.isNotNull()
6969
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_optional_test.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ void main() {
230230
password: password,
231231
);
232232
check(signInRes.nextStep.signInStep)
233-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
233+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
234234
check(signInRes.nextStep.codeDeliveryDetails)
235235
.isNotNull()
236236
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -353,7 +353,7 @@ void main() {
353353
confirmationValue: 'EMAIL',
354354
);
355355
check(selectRes.nextStep.signInStep)
356-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
356+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
357357
check(selectRes.nextStep.codeDeliveryDetails)
358358
.isNotNull()
359359
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -392,7 +392,7 @@ void main() {
392392
password: password,
393393
);
394394
check(signInRes.nextStep.signInStep)
395-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
395+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
396396
check(signInRes.nextStep.codeDeliveryDetails)
397397
.isNotNull()
398398
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_email_totp_required_test.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ void main() {
3737
signInRes.nextStep.signInStep,
3838
because:
3939
'When an email is registered and the userpool has email MFA enabled, Cognito will automatically enable email MFA as the preferred MFA method.',
40-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
40+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
4141

4242
final setupRes = await Amplify.Auth.confirmSignIn(
4343
confirmationValue: await otpResult.code,
@@ -60,7 +60,7 @@ void main() {
6060
password: password,
6161
);
6262
check(resignInRes.nextStep.signInStep)
63-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
63+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
6464
check(resignInRes.nextStep.codeDeliveryDetails)
6565
.isNotNull()
6666
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -98,7 +98,7 @@ void main() {
9898
signInRes.nextStep.signInStep,
9999
because:
100100
'MFA is required so Cognito automatically enables EMAIL MFA',
101-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
101+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
102102

103103
final confirmRes = await Amplify.Auth.confirmSignIn(
104104
confirmationValue: await otpResult.code,
@@ -224,7 +224,7 @@ void main() {
224224
check(
225225
signInRes.nextStep.signInStep,
226226
because: 'Preference is EMAIL MFA now',
227-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
227+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
228228
check(signInRes.nextStep.codeDeliveryDetails)
229229
.isNotNull()
230230
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_optional_test.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ void main() {
6464
signInRes.nextStep.signInStep,
6565
because: 'Once Email MFA is preferred, it is performed '
6666
'on every sign-in attempt.',
67-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
67+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
6868
check(signInRes.nextStep.codeDeliveryDetails)
6969
.isNotNull()
7070
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -155,7 +155,7 @@ void main() {
155155
password: password,
156156
);
157157
check(signInRes.nextStep.signInStep)
158-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
158+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
159159
check(signInRes.nextStep.codeDeliveryDetails)
160160
.isNotNull()
161161
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -386,7 +386,7 @@ void main() {
386386
);
387387

388388
check(signInRes.nextStep.signInStep)
389-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
389+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
390390
check(signInRes.nextStep.codeDeliveryDetails)
391391
.isNotNull()
392392
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_sms_email_required_test.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ void main() {
4141
signInRes.nextStep.signInStep,
4242
because: 'MFA is required, and EMAIL is chosen when '
4343
'no phone number is registered',
44-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
44+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
4545

4646
final setupRes = await Amplify.Auth.confirmSignIn(
4747
confirmationValue: await otpResult.code,
@@ -68,7 +68,7 @@ void main() {
6868
password: password,
6969
);
7070
check(resignInRes.nextStep.signInStep)
71-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
71+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
7272
check(resignInRes.nextStep.codeDeliveryDetails)
7373
.isNotNull()
7474
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -147,7 +147,7 @@ void main() {
147147
check(
148148
resignInRes.nextStep.signInStep,
149149
because: 'Preference is EMAIL MFA now',
150-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
150+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
151151
check(resignInRes.nextStep.codeDeliveryDetails)
152152
.isNotNull()
153153
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -300,7 +300,7 @@ void main() {
300300
check(
301301
signInRes.nextStep.signInStep,
302302
because: 'Preference is EMAIL MFA now',
303-
).equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
303+
).equals(AuthSignInStep.confirmSignInWithOtpCode);
304304
check(signInRes.nextStep.codeDeliveryDetails)
305305
.isNotNull()
306306
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito/example/integration_test/mfa_username_login_required_test.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ void main() {
7272
password: password,
7373
);
7474
check(resignInRes.nextStep.signInStep)
75-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
75+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
7676
check(resignInRes.nextStep.codeDeliveryDetails)
7777
.isNotNull()
7878
.has((d) => d.deliveryMedium, 'deliveryMedium')
@@ -199,7 +199,7 @@ void main() {
199199
);
200200

201201
check(resignInRes.nextStep.signInStep)
202-
.equals(AuthSignInStep.confirmSignInWithEmailMfaCode);
202+
.equals(AuthSignInStep.confirmSignInWithOtpCode);
203203
check(resignInRes.nextStep.codeDeliveryDetails)
204204
.isNotNull()
205205
.has((d) => d.deliveryMedium, 'deliveryMedium')

‎packages/auth/amplify_auth_cognito_dart/lib/src/flows/constants.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ abstract class CognitoConstants {
6161
static const challengeParamSmsMfaCode = 'SMS_MFA_CODE';
6262

6363
/// The `EMAIL_OTP_CODE` parameter.
64-
static const challengeParamEmailMfaCode = 'EMAIL_OTP_CODE';
64+
static const challengeParamEmailOtpCode = 'EMAIL_OTP_CODE';
6565

6666
/// The `SOFTWARE_TOKEN_MFA_CODE` parameter.
6767
static const challengeParamSoftwareTokenMfaCode = 'SOFTWARE_TOKEN_MFA_CODE';

‎packages/auth/amplify_auth_cognito_dart/lib/src/sdk/sdk_bridge.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ extension ChallengeNameTypeBridge on ChallengeNameType {
3232
AuthSignInStep.continueSignInWithMfaSetupSelection,
3333
ChallengeNameType.softwareTokenMfa =>
3434
AuthSignInStep.confirmSignInWithTotpMfaCode,
35-
ChallengeNameType.emailOtp =>
36-
AuthSignInStep.confirmSignInWithEmailMfaCode,
35+
ChallengeNameType.emailOtp => AuthSignInStep.confirmSignInWithOtpCode,
3736
ChallengeNameType.adminNoSrpAuth ||
3837
ChallengeNameType.passwordVerifier ||
3938
ChallengeNameType.devicePasswordVerifier ||

‎packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/sign_in_state_machine.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ final class SignInStateMachine
327327
ChallengeNameType.softwareTokenMfa when hasUserResponse =>
328328
createSoftwareTokenMfaRequest(event),
329329
ChallengeNameType.emailOtp when hasUserResponse =>
330-
createEmailMfaRequest(event),
330+
createEmailOtpRequest(event),
331331
ChallengeNameType.selectMfaType when hasUserResponse =>
332332
createSelectMfaRequest(event),
333333
ChallengeNameType.mfaSetup when hasUserResponse =>
@@ -454,7 +454,7 @@ final class SignInStateMachine
454454

455455
/// Creates the response object for an Email MFA challenge.
456456
@protected
457-
Future<RespondToAuthChallengeRequest> createEmailMfaRequest(
457+
Future<RespondToAuthChallengeRequest> createEmailOtpRequest(
458458
SignInRespondToChallenge event,
459459
) async {
460460
_enableMfaType = MfaType.email;
@@ -464,7 +464,7 @@ final class SignInStateMachine
464464
..challengeName = _challengeName
465465
..challengeResponses.addAll({
466466
CognitoConstants.challengeParamUsername: cognitoUsername,
467-
CognitoConstants.challengeParamEmailMfaCode: event.answer,
467+
CognitoConstants.challengeParamEmailOtpCode: event.answer,
468468
})
469469
..clientMetadata.addAll(event.clientMetadata);
470470
});
@@ -702,13 +702,13 @@ final class SignInStateMachine
702702

703703
// User has provided the verification code
704704
return _enableMfaType == MfaType.totp
705-
? createMfaSetupRequest(event)
705+
? createTotpMfaSetupRequest(event)
706706
: createEmailMfaSetupRequest(event);
707707
}
708708

709709
/// Completes set up of a TOTP MFA.
710710
@protected
711-
Future<RespondToAuthChallengeRequest> createMfaSetupRequest(
711+
Future<RespondToAuthChallengeRequest> createTotpMfaSetupRequest(
712712
SignInRespondToChallenge event,
713713
) async {
714714
await verifySoftwareToken(

‎packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_test.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ void main() {
3636
tester.bloc.stream,
3737
emitsInOrder([
3838
UnauthenticatedState.signIn,
39-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
39+
UnauthenticatedState.confirmSignInWithOtpCode,
4040
isA<AuthenticatedState>(),
4141
UnauthenticatedState.signIn,
42-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
42+
UnauthenticatedState.confirmSignInWithOtpCode,
4343
isA<AuthenticatedState>(),
4444
emitsDone,
4545
]),
@@ -62,7 +62,7 @@ void main() {
6262
await signInPage.submitSignIn();
6363

6464
// Then I will be redirected to the email MFA code page
65-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
65+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
6666

6767
// And I type a valid EMAIL OTP code
6868
await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -94,7 +94,7 @@ void main() {
9494
await signInPage.submitSignIn();
9595

9696
// Then I will be redirected to the EMAIL OTP code page
97-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
97+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
9898

9999
// When I type a valid EMAIL OTP code
100100
await confirmSignInPage.enterVerificationCode(await otpResult2.code);
@@ -129,7 +129,7 @@ void main() {
129129
tester.bloc.stream,
130130
emitsInOrder([
131131
UnauthenticatedState.signIn,
132-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
132+
UnauthenticatedState.confirmSignInWithOtpCode,
133133
emitsDone,
134134
]),
135135
);
@@ -147,7 +147,7 @@ void main() {
147147
await signInPage.submitSignIn();
148148

149149
// Then I will be redirected to the EMAIL OTP code page
150-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
150+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
151151

152152
// And I type an invalid confirmation code
153153
await confirmSignInPage.enterVerificationCode('123456');

‎packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_email_totp_test.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ void main() {
3636
tester.bloc.stream,
3737
emitsInOrder([
3838
UnauthenticatedState.signIn,
39-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
39+
UnauthenticatedState.confirmSignInWithOtpCode,
4040
isA<AuthenticatedState>(),
4141
UnauthenticatedState.signIn,
4242
isA<ContinueSignInWithMfaSelection>(),
@@ -61,7 +61,7 @@ void main() {
6161
await signInPage.submitSignIn();
6262

6363
// Then I will be redirected to the confirm email mfa page
64-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
64+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
6565

6666
// When I type a valid confirmation code
6767
await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -138,11 +138,11 @@ void main() {
138138
tester.bloc.stream,
139139
emitsInOrder([
140140
UnauthenticatedState.signIn,
141-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
141+
UnauthenticatedState.confirmSignInWithOtpCode,
142142
isA<AuthenticatedState>(),
143143
UnauthenticatedState.signIn,
144144
isA<ContinueSignInWithMfaSelection>(),
145-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
145+
UnauthenticatedState.confirmSignInWithOtpCode,
146146
isA<AuthenticatedState>(),
147147
emitsDone,
148148
]),
@@ -163,7 +163,7 @@ void main() {
163163
await signInPage.submitSignIn();
164164

165165
// Then I will be redirected to the confirm email mfa page
166-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
166+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
167167

168168
// When I type a valid confirmation code
169169
await confirmSignInPage.enterVerificationCode(await otpResult.code);
@@ -205,7 +205,7 @@ void main() {
205205
await confirmSignInPage.submitConfirmSignInMfaSelection();
206206

207207
// Then I will be redirected to the confirm EMAIL mfa page
208-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
208+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
209209

210210
// When I type a valid confirmation code
211211
await confirmSignInPage.enterVerificationCode(await otpResult2.code);

‎packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_sms_email_test.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ void main() {
4646
UnauthenticatedState.confirmSignInMfa,
4747
isA<AuthenticatedState>(),
4848
UnauthenticatedState.signIn,
49-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
49+
UnauthenticatedState.confirmSignInWithOtpCode,
5050
isA<AuthenticatedState>(),
5151
emitsDone,
5252
]),
@@ -101,7 +101,7 @@ void main() {
101101
await signInPage.submitSignIn();
102102

103103
// Then I will be redirected to the EMAIL MFA code page
104-
await confirmSignInPage.expectConfirmSignInWithEmailMfaCodeIsPresent();
104+
await confirmSignInPage.expectConfirmSignInWithOtpCodeIsPresent();
105105

106106
// When I type a valid EMAIL MFA code
107107
await confirmSignInPage.enterVerificationCode(await code_2.code);

‎packages/authenticator/amplify_authenticator/example/integration_test/sign_in_mfa_username_login_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ void main() {
3737
UnauthenticatedState.signIn,
3838
isA<ContinueSignInWithMfaSetupSelection>(),
3939
UnauthenticatedState.continueSignInWithEmailMfaSetup,
40-
UnauthenticatedState.confirmSignInWithEmailMfaCode,
40+
UnauthenticatedState.confirmSignInWithOtpCode,
4141
isA<AuthenticatedState>(),
4242
emitsDone,
4343
]),

‎packages/authenticator/amplify_authenticator/lib/amplify_authenticator.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,7 @@ class _AuthenticatorState extends State<Authenticator> {
719719
continueSignInWithEmailMfaSetupForm:
720720
ContinueSignInWithEmailMfaSetupForm(),
721721
confirmSignInWithTotpMfaCodeForm: ConfirmSignInMFAForm(),
722-
confirmSignInWithEmailMfaCodeForm: ConfirmSignInMFAForm(),
722+
confirmSignInWithOtpCodeForm: ConfirmSignInMFAForm(),
723723
verifyUserForm: VerifyUserForm(),
724724
confirmVerifyUserForm: ConfirmVerifyUserForm(),
725725
child: widget.child,

0 commit comments

Comments
 (0)