chore(rwa): convert AuthChallengeNames enum to string union (#2544)

Author: calebpollman

.changeset/gentle-ads-hang.md

@@ -0,0 +1,8 @@
+---
+"@aws-amplify/ui-react": patch
+"@aws-amplify/ui": patch
+"@aws-amplify/ui-vue": patch
+"@aws-amplify/ui-angular": patch
+---
+
+chore(rwa): convert AuthChallengeNames enum to string union

packages/angular/projects/ui-angular/src/lib/components/authenticator/components/confirm-sign-in/confirm-sign-in.component.ts

@@ -1,7 +1,6 @@
 import { Component, HostBinding, OnInit } from '@angular/core';
 import { Logger } from 'aws-amplify';
 import {
-  AuthChallengeNames,
   FormFieldsArray,
   getActorContext,
   getFormDataFromEvent,
@@ -40,10 +39,10 @@ export class ConfirmSignInComponent implements OnInit {
     const actorContext = getActorContext(state) as SignInContext;
     const { challengeName } = actorContext;
     switch (challengeName) {
-      case AuthChallengeNames.SOFTWARE_TOKEN_MFA:
+      case 'SOFTWARE_TOKEN_MFA':
         this.headerText = translate('Confirm TOTP Code');
         break;
-      case AuthChallengeNames.SMS_MFA:
+      case 'SMS_MFA':
         this.headerText = translate('Confirm SMS Code');
         break;
       default:

packages/react/src/components/Authenticator/ConfirmSignIn/ConfirmSignIn.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { AuthChallengeNames, getActorState, translate } from '@aws-amplify/ui';
+import { getActorState, translate } from '@aws-amplify/ui';
 
 import { Flex } from '../../../primitives/Flex';
 import { Heading } from '../../../primitives/Heading';
@@ -61,10 +61,10 @@ function Header() {
   let headerText: string;
 
   switch (challengeName) {
-    case AuthChallengeNames.SMS_MFA:
+    case 'SMS_MFA':
       headerText = translate('Confirm SMS Code');
       break;
-    case AuthChallengeNames.SOFTWARE_TOKEN_MFA:
+    case 'SOFTWARE_TOKEN_MFA':
       headerText = translate('Confirm TOTP Code');
       break;
     default:

packages/ui/src/machines/authenticator/actors/signIn.ts

@@ -2,7 +2,12 @@ import { Auth } from 'aws-amplify';
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
 import { createMachine, sendUpdate } from 'xstate';
-import { AuthChallengeNames, AuthEvent, SignInContext } from '../../../types';
+import {
+  AuthChallengeName,
+  AuthEvent,
+  CognitoUserAmplify,
+  SignInContext,
+} from '../../../types';
 import { runValidators } from '../../../validators';
 import {
   clearAttributeToVerify,
@@ -34,6 +39,22 @@ export type SignInMachineOptions = {
   services?: Partial<typeof defaultServices>;
 };
 
+const MFA_CHALLENGE_NAMES: AuthChallengeName[] = [
+  'SMS_MFA',
+  'SOFTWARE_TOKEN_MFA',
+];
+
+const getChallengeName = (event: AuthEvent): AuthChallengeName =>
+  get(event, 'data.challengeName');
+
+const isExpectedChallengeName = (
+  challengeName: AuthChallengeName,
+  expectedChallengeName: AuthChallengeName
+) => challengeName === expectedChallengeName;
+
+const isMfaChallengeName = (challengeName: AuthChallengeName) =>
+  MFA_CHALLENGE_NAMES.includes(challengeName);
+
 export function signInActor({ services }: SignInMachineOptions) {
   return createMachine<SignInContext, AuthEvent>(
     {
@@ -461,13 +482,7 @@ export function signInActor({ services }: SignInMachineOptions) {
       },
       guards: {
         shouldConfirmSignIn: (_, event): boolean => {
-          const challengeName = get(event, 'data.challengeName');
-          const validChallengeNames = [
-            AuthChallengeNames.SMS_MFA,
-            AuthChallengeNames.SOFTWARE_TOKEN_MFA,
-          ];
-
-          return validChallengeNames.includes(challengeName);
+          return isMfaChallengeName(getChallengeName(event));
         },
         shouldAutoSignIn: (context) => {
           return context?.intent === 'autoSignIn';
@@ -479,14 +494,13 @@ export function signInActor({ services }: SignInMachineOptions) {
           return event.data.code === 'PasswordResetRequiredException';
         },
         shouldSetupTOTP: (_, event): boolean => {
-          const challengeName = get(event, 'data.challengeName');
-
-          return challengeName === AuthChallengeNames.MFA_SETUP;
+          return isExpectedChallengeName(getChallengeName(event), 'MFA_SETUP');
         },
         shouldForceChangePassword: (_, event): boolean => {
-          const challengeName = get(event, 'data.challengeName');
-
-          return challengeName === AuthChallengeNames.NEW_PASSWORD_REQUIRED;
+          return isExpectedChallengeName(
+            getChallengeName(event),
+            'NEW_PASSWORD_REQUIRED'
+          );
         },
         shouldRequestVerification: (_, event): boolean => {
           const { unverified, verified } = event.data;
@@ -511,22 +525,18 @@ export function signInActor({ services }: SignInMachineOptions) {
             password,
           });
         },
-        async confirmSignIn(context, event) {
+        async confirmSignIn(context) {
           const { challengeName, user } = context;
           const { confirmation_code: code } = context.formValues;
 
-          let mfaType;
-          if (
-            challengeName === AuthChallengeNames.SMS_MFA ||
-            challengeName === AuthChallengeNames.SOFTWARE_TOKEN_MFA
-          ) {
-            mfaType = challengeName;
-          }
+          const mfaType = isMfaChallengeName(challengeName)
+            ? challengeName
+            : undefined;
 
           await services.handleConfirmSignIn({ user, code, mfaType });
           return await Auth.currentAuthenticatedUser();
         },
-        async forceNewPassword(context, event) {
+        async forceNewPassword(context) {
           const { user, formValues } = context;
           let {
             password,
@@ -545,7 +555,7 @@ export function signInActor({ services }: SignInMachineOptions) {
 
           try {
             // complete forceNewPassword flow and get updated CognitoUser
-            const newUser = await Auth.completeNewPassword(
+            const newUser: CognitoUserAmplify = await Auth.completeNewPassword(
               user,
               password,
               rest
@@ -569,9 +579,9 @@ export function signInActor({ services }: SignInMachineOptions) {
             return Promise.reject(err);
           }
         },
-        async verifyTotpToken(context, event) {
-          const { user } = context;
-          const { confirmation_code } = context.formValues;
+        async verifyTotpToken(context) {
+          const { formValues, user } = context;
+          const { confirmation_code } = formValues;
 
           return Auth.verifyTotpToken(user, confirmation_code);
         },
@@ -580,21 +590,21 @@ export function signInActor({ services }: SignInMachineOptions) {
 
           return await Auth.federatedSignIn({ provider });
         },
-        async checkVerifiedContact(context, event) {
+        async checkVerifiedContact(context) {
           const { user } = context;
           const result = await Auth.verifiedContact(user);
 
           return result;
         },
-        async verifyUser(context, event) {
+        async verifyUser(context) {
           const { unverifiedAttr } = context.formValues;
           const result = await Auth.verifyCurrentUserAttribute(unverifiedAttr);
 
           context.attributeToVerify = unverifiedAttr;
 
           return result;
         },
-        async confirmVerifyUser(context, event) {
+        async confirmVerifyUser(context) {
           const { attributeToVerify } = context;
           const { confirmation_code } = context.formValues;
 
@@ -603,7 +613,7 @@ export function signInActor({ services }: SignInMachineOptions) {
             confirmation_code
           );
         },
-        async validateFields(context, event) {
+        async validateFields(context) {
           return runValidators(
             context.formValues,
             context.touched,

packages/ui/src/machines/authenticator/defaultServices.ts

@@ -2,7 +2,7 @@ import { Amplify, Auth } from 'aws-amplify';
 import { hasSpecialChars } from '../../helpers';
 
 import {
-  AuthChallengeNames,
+  AuthChallengeName,
   PasswordSettings,
   SignInResult,
   ValidatorResult,
@@ -36,9 +36,14 @@ export const defaultServices = {
   }: {
     user: any;
     code: string;
-    mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+    mfaType: AuthChallengeName;
   }): Promise<any> {
-    return Auth.confirmSignIn(user, code, mfaType);
+    return Auth.confirmSignIn(
+      user,
+      code,
+      // cast due to restrictive typing of Auth.confirmSignIn
+      mfaType as 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA'
+    );
   },
   async handleConfirmSignUp({
     username,

packages/ui/src/types/authenticator/stateMachine/context.ts

@@ -1,6 +1,6 @@
 import { ValidationError } from '../validator';
 import { AuthFormData, AuthFormFields } from '../form';
-import { AuthChallengeNames, CognitoUserAmplify } from '../user';
+import { AuthChallengeName, CognitoUserAmplify } from '../user';
 import { CodeDeliveryDetails as CognitoCodeDeliveryDetails } from 'amazon-cognito-identity-js';
 import { LoginMechanism, SignUpAttribute, SocialProvider } from '../attributes';
 import { defaultServices } from '../../../machines/authenticator/defaultServices';
@@ -37,7 +37,7 @@ export interface AuthContext {
   username?: string;
   password?: string;
   code?: string;
-  mfaType?: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA;
+  mfaType?: 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA';
   actorDoneData?: Omit<ActorDoneData, 'user'>; // data returned from actors when they finish and reach their final state
   hasSetup?: boolean;
 }
@@ -51,7 +51,7 @@ interface BaseFormContext {
   /** Any user attributes set that needs to persist between states */
   authAttributes?: Record<string, any>;
   /** Current challengeName issued by Cognnito */
-  challengeName?: AuthChallengeNames;
+  challengeName?: AuthChallengeName;
   /** Required attributes for form submission */
   requiredAttributes?: Array<string>;
   /** Maps each input name to tis value */
@@ -98,7 +98,7 @@ export interface ResetPasswordContext extends BaseFormContext {
 
 export interface SignOutContext {
   authAttributes?: Record<string, any>;
-  challengeName?: AuthChallengeNames;
+  challengeName?: AuthChallengeName;
   unverifiedAttributes?: Record<string, string>;
   user?: CognitoUserAmplify;
   formFields?: AuthFormFields;

packages/ui/src/types/authenticator/user.ts

@@ -1,13 +1,7 @@
-import { CognitoUser } from 'amazon-cognito-identity-js';
+import { ChallengeName, CognitoUser } from 'amazon-cognito-identity-js';
 
-/** Enum of known challenge names */
-export enum AuthChallengeNames {
-  SMS_MFA = 'SMS_MFA',
-  SOFTWARE_TOKEN_MFA = 'SOFTWARE_TOKEN_MFA',
-  NEW_PASSWORD_REQUIRED = 'NEW_PASSWORD_REQUIRED',
-  RESET_REQUIRED = 'RESET_REQUIRED',
-  MFA_SETUP = 'MFA_SETUP',
-}
+/** Known challenge names */
+export type AuthChallengeName = ChallengeName;
 
 /** Contact destinations that we can send user confirmation code to */
 export type ContactMethod = 'Email' | 'Phone Number';

packages/ui/src/types/authenticator/validator.ts

@@ -1,6 +1,5 @@
 import { PasswordSettings } from '.';
 import { AuthFormData } from './form';
-import { AuthChallengeNames } from './user';
 
 /**
  * Maps each input to its validation error, if any
@@ -22,9 +21,3 @@ export type Validator = (
   touchData?: AuthFormData,
   passwordSettings?: PasswordSettings
 ) => ValidatorResult | Promise<ValidatorResult>;
-
-export type SignInTypes = (
-  user: string,
-  code: string,
-  mfaType: AuthChallengeNames.SMS_MFA | AuthChallengeNames.SOFTWARE_TOKEN_MFA
-) => SignInResult | Promise<SignInResult>;

packages/vue/src/components/confirm-sign-in.vue

@@ -1,6 +1,5 @@
 <script setup lang="ts">
 import {
-  AuthChallengeNames,
   getActorState,
   getFormDataFromEvent,
   SignInState,
@@ -27,7 +26,7 @@ const challengeName = actorState.value.context.challengeName;
 
 let mfaType = 'SMS';
 
-if (challengeName === AuthChallengeNames.SOFTWARE_TOKEN_MFA) {
+if (challengeName === 'SOFTWARE_TOKEN_MFA') {
   mfaType = 'TOTP';
 }
 const confirmSignInHeading = `Confirm ${mfaType} Code`;