@azure/msal-browser 4.24.0 → 4.25.0

package/src/custom_auth/sign_in/auth_flow/state/SignInPasswordRequiredState.ts

@@ -3,17 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
 import { SignInSubmitPasswordParams } from "../../interaction_client/parameter/SignInParams.js";
 import { SignInSubmitPasswordResult } from "../result/SignInSubmitPasswordResult.js";
-import { SignInCompletedState } from "./SignInCompletedState.js";
 import { SignInState } from "./SignInState.js";
 import { SignInPasswordRequiredStateParameters } from "./SignInStateParameters.js";
-import {
-    SIGN_IN_COMPLETED_RESULT_TYPE,
-    SIGN_IN_JIT_REQUIRED_RESULT_TYPE,
-} from "../../interaction_client/result/SignInActionResult.js";
-import { AuthMethodRegistrationRequiredState } from "../../../core/auth_flow/jit/state/AuthMethodRegistrationState.js";
 
 /*
  * Sign-in password required state.
@@ -57,51 +50,21 @@ export class SignInPasswordRequiredState extends SignInState<SignInPasswordRequi
                 this.stateParameters.correlationId
             );
 
-            if (submitPasswordResult.type === SIGN_IN_COMPLETED_RESULT_TYPE) {
-                const accountInfo = new CustomAuthAccountData(
-                    submitPasswordResult.authenticationResult.account,
-                    this.stateParameters.config,
-                    this.stateParameters.cacheClient,
-                    this.stateParameters.logger,
-                    this.stateParameters.correlationId
-                );
-
-                return new SignInSubmitPasswordResult(
-                    new SignInCompletedState(),
-                    accountInfo
-                );
-            } else if (
-                submitPasswordResult.type === SIGN_IN_JIT_REQUIRED_RESULT_TYPE
-            ) {
-                // JIT is required - return AuthMethodRegistrationRequiredState
-                this.stateParameters.logger.verbose(
-                    "Authentication method registration required after password submission.",
-                    this.stateParameters.correlationId
-                );
+            const nextState = this.handleSignInResult(
+                submitPasswordResult,
+                this.stateParameters.scopes
+            );
 
-                return new SignInSubmitPasswordResult(
-                    new AuthMethodRegistrationRequiredState({
-                        correlationId: this.stateParameters.correlationId,
-                        continuationToken:
-                            submitPasswordResult.continuationToken,
-                        logger: this.stateParameters.logger,
-                        config: this.stateParameters.config,
-                        jitClient: this.stateParameters.jitClient,
-                        cacheClient: this.stateParameters.cacheClient,
-                        authMethods: submitPasswordResult.authMethods,
-                        username: this.stateParameters.username,
-                        scopes: this.stateParameters.scopes ?? [],
-                        claims: this.stateParameters.claims,
-                    })
-                );
-            } else {
-                // Unexpected result type
-                const result = submitPasswordResult as { type: string };
-                const error = new Error(
-                    `Unexpected result type: ${result.type}`
+            if (nextState.error) {
+                return SignInSubmitPasswordResult.createWithError(
+                    nextState.error
                 );
-                return SignInSubmitPasswordResult.createWithError(error);
             }
+
+            return new SignInSubmitPasswordResult(
+                nextState.state,
+                nextState.accountInfo
+            );
         } catch (error) {
             this.stateParameters.logger.errorPii(
                 `Failed to sign in after submitting password. Error: ${error}.`,

package/src/custom_auth/sign_in/auth_flow/state/SignInState.ts

@@ -4,7 +4,20 @@
  */
 
 import { AuthFlowActionRequiredStateBase } from "../../../core/auth_flow/AuthFlowState.js";
+import { AuthMethodRegistrationRequiredState } from "../../../core/auth_flow/jit/state/AuthMethodRegistrationState.js";
+import { MfaAwaitingState } from "../../../core/auth_flow/mfa/state/MfaState.js";
 import { ensureArgumentIsNotEmptyString } from "../../../core/utils/ArgumentValidator.js";
+import { CustomAuthAccountData } from "../../../get_account/auth_flow/CustomAuthAccountData.js";
+import {
+    SIGN_IN_COMPLETED_RESULT_TYPE,
+    SIGN_IN_JIT_REQUIRED_RESULT_TYPE,
+    SIGN_IN_MFA_REQUIRED_RESULT_TYPE,
+    SignInCompletedResult,
+    SignInJitRequiredResult,
+    SignInMfaRequiredResult,
+} from "../../interaction_client/result/SignInActionResult.js";
+import { SignInCompletedState } from "./SignInCompletedState.js";
+import { SignInFailedState } from "./SignInFailedState.js";
 import { SignInStateParameters } from "./SignInStateParameters.js";
 
 /*
@@ -31,4 +44,99 @@ export abstract class SignInState<
             stateParameters.correlationId
         );
     }
+
+    /**
+     * Handles the result of a sign-in attempt.
+     * @param result - The result of the sign-in attempt.
+     * @param scopes - The scopes requested for the sign-in.
+     * @returns An object containing the next state and account information, if applicable.
+     */
+    protected handleSignInResult(
+        result:
+            | SignInCompletedResult
+            | SignInJitRequiredResult
+            | SignInMfaRequiredResult,
+        scopes?: string[]
+    ): {
+        state:
+            | SignInCompletedState
+            | AuthMethodRegistrationRequiredState
+            | MfaAwaitingState;
+        accountInfo?: CustomAuthAccountData;
+        error?: Error;
+    } {
+        const correlationId =
+            result.correlationId || this.stateParameters.correlationId;
+
+        if (result.type === SIGN_IN_COMPLETED_RESULT_TYPE) {
+            // Sign-in completed - return SignInCompletedState
+            this.stateParameters.logger.verbose(
+                "Sign-in completed successfully.",
+                correlationId
+            );
+
+            const accountInfo = new CustomAuthAccountData(
+                result.authenticationResult.account,
+                this.stateParameters.config,
+                this.stateParameters.cacheClient,
+                this.stateParameters.logger,
+                correlationId
+            );
+
+            return {
+                state: new SignInCompletedState(),
+                accountInfo: accountInfo,
+            };
+        } else if (result.type === SIGN_IN_JIT_REQUIRED_RESULT_TYPE) {
+            // JIT is required - return AuthMethodRegistrationRequiredState
+            this.stateParameters.logger.verbose(
+                "Authentication method registration is required during sign-in.",
+                correlationId
+            );
+
+            return {
+                state: new AuthMethodRegistrationRequiredState({
+                    correlationId: correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    jitClient: this.stateParameters.jitClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    authMethods: result.authMethods,
+                    username: this.stateParameters.username,
+                    scopes: scopes ?? [],
+                    claims: this.stateParameters.claims,
+                }),
+            };
+        } else if (result.type === SIGN_IN_MFA_REQUIRED_RESULT_TYPE) {
+            // MFA is required - return MfaAwaitingState
+            this.stateParameters.logger.verbose(
+                "MFA is required during the sign-in.",
+                correlationId
+            );
+
+            return {
+                state: new MfaAwaitingState({
+                    correlationId: correlationId,
+                    continuationToken: result.continuationToken,
+                    logger: this.stateParameters.logger,
+                    config: this.stateParameters.config,
+                    mfaClient: this.stateParameters.mfaClient,
+                    cacheClient: this.stateParameters.cacheClient,
+                    scopes: scopes ?? [],
+                    authMethods: result.authMethods ?? [],
+                }),
+            };
+        } else {
+            // Unexpected result type
+            const unexpectedResult = result as { type: string };
+            const error = new Error(
+                `Unexpected result type: ${unexpectedResult.type}`
+            );
+            return {
+                state: new SignInFailedState(),
+                error: error,
+            };
+        }
+    }
 }

package/src/custom_auth/sign_in/auth_flow/state/SignInStateParameters.ts

@@ -8,6 +8,7 @@ import { CustomAuthSilentCacheClient } from "../../../get_account/interaction_cl
 import { SignInClient } from "../../interaction_client/SignInClient.js";
 import { SignInScenarioType } from "../SignInScenario.js";
 import { JitClient } from "../../../core/interaction_client/jit/JitClient.js";
+import { MfaClient } from "../../../core/interaction_client/mfa/MfaClient.js";
 
 export interface SignInStateParameters
     extends AuthFlowActionRequiredStateParameters {
@@ -16,6 +17,7 @@ export interface SignInStateParameters
     cacheClient: CustomAuthSilentCacheClient;
     claims?: string;
     jitClient: JitClient;
+    mfaClient: MfaClient;
 }
 
 export interface SignInPasswordRequiredStateParameters

package/src/custom_auth/sign_up/auth_flow/state/SignUpAttributesRequiredState.ts

@@ -84,6 +84,7 @@ export class SignUpAttributesRequiredState extends SignUpState<SignUpAttributesR
                         signInClient: this.stateParameters.signInClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                         signInScenario: SignInScenario.SignInAfterSignUp,
                     })

package/src/custom_auth/sign_up/auth_flow/state/SignUpCodeRequiredState.ts

@@ -68,6 +68,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
                         signUpClient: this.stateParameters.signUpClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                     })
                 );
@@ -90,6 +91,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
                         signUpClient: this.stateParameters.signUpClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                         requiredAttributes: result.requiredAttributes,
                     })
@@ -110,6 +112,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
                         signInClient: this.stateParameters.signInClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                         signInScenario: SignInScenario.SignInAfterSignUp,
                     })
@@ -167,6 +170,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
                     signUpClient: this.stateParameters.signUpClient,
                     cacheClient: this.stateParameters.cacheClient,
                     jitClient: this.stateParameters.jitClient,
+                    mfaClient: this.stateParameters.mfaClient,
                     username: this.stateParameters.username,
                     codeLength: result.codeLength,
                     codeResendInterval: result.interval,

package/src/custom_auth/sign_up/auth_flow/state/SignUpPasswordRequiredState.ts

@@ -70,6 +70,7 @@ export class SignUpPasswordRequiredState extends SignUpState<SignUpPasswordRequi
                         signUpClient: this.stateParameters.signUpClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                         requiredAttributes: result.requiredAttributes,
                     })
@@ -90,6 +91,7 @@ export class SignUpPasswordRequiredState extends SignUpState<SignUpPasswordRequi
                         signInClient: this.stateParameters.signInClient,
                         cacheClient: this.stateParameters.cacheClient,
                         jitClient: this.stateParameters.jitClient,
+                        mfaClient: this.stateParameters.mfaClient,
                         username: this.stateParameters.username,
                         signInScenario: SignInScenario.SignInAfterSignUp,
                     })

package/src/custom_auth/sign_up/auth_flow/state/SignUpStateParameters.ts

@@ -9,6 +9,7 @@ import { CustomAuthSilentCacheClient } from "../../../get_account/interaction_cl
 import { AuthFlowActionRequiredStateParameters } from "../../../core/auth_flow/AuthFlowState.js";
 import { UserAttribute } from "../../../core/network_client/custom_auth_api/types/ApiErrorResponseTypes.js";
 import { JitClient } from "../../../core/interaction_client/jit/JitClient.js";
+import { MfaClient } from "../../../core/interaction_client/mfa/MfaClient.js";
 
 export interface SignUpStateParameters
     extends AuthFlowActionRequiredStateParameters {
@@ -17,6 +18,7 @@ export interface SignUpStateParameters
     signInClient: SignInClient;
     cacheClient: CustomAuthSilentCacheClient;
     jitClient: JitClient;
+    mfaClient: MfaClient;
 }
 
 export type SignUpPasswordRequiredStateParameters = SignUpStateParameters;

package/src/error/NativeAuthError.ts

@@ -67,6 +67,7 @@ export function isFatalNativeAuthError(error: NativeAuthError): boolean {
 
     switch (error.errorCode) {
         case NativeAuthErrorCodes.contentError:
+        case NativeAuthErrorCodes.pageException:
             return true;
         default:
             return false;

package/src/error/NativeAuthErrorCodes.ts

@@ -4,4 +4,5 @@
  */
 
 export const contentError = "ContentError";
+export const pageException = "PageException";
 export const userSwitch = "user_switch";

package/src/interaction_client/PlatformAuthInteractionClient.ts

@@ -1026,6 +1026,7 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
             case PromptValue.NONE:
             case PromptValue.CONSENT:
             case PromptValue.LOGIN:
+            case PromptValue.SELECT_ACCOUNT:
                 this.logger.trace(
                     "initializeNativeRequest: prompt is compatible with native flow"
                 );

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-browser";
-export const version = "4.24.0";
+export const version = "4.25.0";