@azure/msal-browser 4.24.1 → 5.0.0-alpha.0

package/src/custom_auth/sign_in/interaction_client/SignInClient.ts

@@ -6,14 +6,10 @@
 import {
     ChallengeType,
     DefaultCustomAuthApiCodeLength,
-    GrantType,
 } from "../../CustomAuthConstants.js";
 import { CustomAuthApiError } from "../../core/error/CustomAuthApiError.js";
 import * as CustomAuthApiErrorCode from "../../core/network_client/custom_auth_api/types/ApiErrorCodes.js";
-import {
-    MFA_REQUIRED,
-    REGISTRATION_REQUIRED,
-} from "../../core/network_client/custom_auth_api/types/ApiSuberrors.js";
+import { REGISTRATION_REQUIRED } from "../../core/network_client/custom_auth_api/types/ApiSuberrors.js";
 
 import { CustomAuthInteractionClientBase } from "../../core/interaction_client/CustomAuthInteractionClientBase.js";
 import {
@@ -33,8 +29,6 @@ import {
     SignInCompletedResult,
     SignInPasswordRequiredResult,
     SignInJitRequiredResult,
-    SignInMfaRequiredResult,
-    createSignInMfaRequiredResult,
 } from "./result/SignInActionResult.js";
 import * as PublicApiId from "../../core/telemetry/PublicApiId.js";
 import {
@@ -44,7 +38,6 @@ import {
     SignInOobTokenRequest,
     SignInPasswordTokenRequest,
     RegisterIntrospectRequest,
-    SignInIntrospectRequest,
 } from "../../core/network_client/custom_auth_api/types/ApiRequestTypes.js";
 import { SignInTokenResponse } from "../../core/network_client/custom_auth_api/types/ApiResponseTypes.js";
 import {
@@ -54,6 +47,7 @@ import {
 import { UnexpectedError } from "../../core/error/UnexpectedError.js";
 import { ensureArgumentIsNotEmptyString } from "../../core/utils/ArgumentValidator.js";
 import { ServerTelemetryManager } from "@azure/msal-common/browser";
+import { initializeServerTelemetryManager } from "../../../interaction_client/BaseInteractionClient.js";
 
 export class SignInClient extends CustomAuthInteractionClientBase {
     /**
@@ -67,7 +61,13 @@ export class SignInClient extends CustomAuthInteractionClientBase {
         const apiId = !parameters.password
             ? PublicApiId.SIGN_IN_WITH_CODE_START
             : PublicApiId.SIGN_IN_WITH_PASSWORD_START;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         this.logger.verbose(
             "Calling initiate endpoint for sign in.",
@@ -108,7 +108,13 @@ export class SignInClient extends CustomAuthInteractionClientBase {
         parameters: SignInResendCodeParams
     ): Promise<SignInCodeSendResult> {
         const apiId = PublicApiId.SIGN_IN_RESEND_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const challengeReq: SignInChallengeRequest = {
             challenge_type: this.getChallengeTypes(parameters.challengeType),
@@ -142,11 +148,7 @@ export class SignInClient extends CustomAuthInteractionClientBase {
      */
     async submitCode(
         parameters: SignInSubmitCodeParams
-    ): Promise<
-        | SignInCompletedResult
-        | SignInJitRequiredResult
-        | SignInMfaRequiredResult
-    > {
+    ): Promise<SignInCompletedResult> {
         ensureArgumentIsNotEmptyString(
             "parameters.code",
             parameters.code,
@@ -154,13 +156,18 @@ export class SignInClient extends CustomAuthInteractionClientBase {
         );
 
         const apiId = PublicApiId.SIGN_IN_SUBMIT_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
         const scopes = this.getScopes(parameters.scopes);
 
         const request: SignInOobTokenRequest = {
             continuation_token: parameters.continuationToken,
             oob: parameters.code,
-            grant_type: GrantType.OOB,
             scope: scopes.join(" "),
             correlationId: parameters.correlationId,
             telemetryManager: telemetryManager,
@@ -169,15 +176,18 @@ export class SignInClient extends CustomAuthInteractionClientBase {
             }),
         };
 
-        return this.performTokenRequest(
+        const result = this.performTokenRequest(
             () =>
                 this.customAuthApiClient.signInApi.requestTokensWithOob(
                     request
                 ),
             scopes,
             parameters.correlationId,
-            telemetryManager
+            telemetryManager,
+            false // Don't handle JIT for code submission
         );
+
+        return result as Promise<SignInCompletedResult>;
     }
 
     /**
@@ -187,11 +197,7 @@ export class SignInClient extends CustomAuthInteractionClientBase {
      */
     async submitPassword(
         parameters: SignInSubmitPasswordParams
-    ): Promise<
-        | SignInCompletedResult
-        | SignInJitRequiredResult
-        | SignInMfaRequiredResult
-    > {
+    ): Promise<SignInCompletedResult | SignInJitRequiredResult> {
         ensureArgumentIsNotEmptyString(
             "parameters.password",
             parameters.password,
@@ -199,7 +205,13 @@ export class SignInClient extends CustomAuthInteractionClientBase {
         );
 
         const apiId = PublicApiId.SIGN_IN_SUBMIT_PASSWORD;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
         const scopes = this.getScopes(parameters.scopes);
 
         const request: SignInPasswordTokenRequest = {
@@ -220,7 +232,8 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 ),
             scopes,
             parameters.correlationId,
-            telemetryManager
+            telemetryManager,
+            true // Handle JIT for password submission
         );
     }
 
@@ -231,16 +244,18 @@ export class SignInClient extends CustomAuthInteractionClientBase {
      */
     async signInWithContinuationToken(
         parameters: SignInContinuationTokenParams
-    ): Promise<
-        | SignInCompletedResult
-        | SignInJitRequiredResult
-        | SignInMfaRequiredResult
-    > {
+    ): Promise<SignInCompletedResult | SignInJitRequiredResult> {
         const apiId = this.getPublicApiIdBySignInScenario(
             parameters.signInScenario,
             parameters.correlationId
         );
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
         const scopes = this.getScopes(parameters.scopes);
 
         // Create token request.
@@ -263,8 +278,9 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 ),
             scopes,
             parameters.correlationId,
-            telemetryManager
-        );
+            telemetryManager,
+            true // Handle JIT for continuation token sign-in (e.g., after sign-up or SSPR)
+        ) as Promise<SignInCompletedResult | SignInJitRequiredResult>;
     }
 
     /**
@@ -272,19 +288,16 @@ export class SignInClient extends CustomAuthInteractionClientBase {
      * @param tokenEndpointCaller Function that calls the specific token endpoint
      * @param scopes Scopes for the token request
      * @param correlationId Correlation ID for logging and result
-     * @param telemetryManager Telemetry manager for telemetry logging
-     * @returns SignInCompletedResult | SignInJitRequiredResult | SignInMfaRequiredResult with authentication result
+     * @param handleJit Whether to handle JIT required errors or throw them
+     * @returns SignInCompletedResult with authentication result
      */
     private async performTokenRequest(
         tokenEndpointCaller: () => Promise<SignInTokenResponse>,
         scopes: string[],
         correlationId: string,
-        telemetryManager: ServerTelemetryManager
-    ): Promise<
-        | SignInCompletedResult
-        | SignInJitRequiredResult
-        | SignInMfaRequiredResult
-    > {
+        telemetryManager: ServerTelemetryManager,
+        handleJit: boolean
+    ): Promise<SignInCompletedResult | SignInJitRequiredResult> {
         this.logger.verbose(
             "Calling token endpoint for sign in.",
             correlationId
@@ -310,23 +323,34 @@ export class SignInClient extends CustomAuthInteractionClientBase {
             });
         } catch (error) {
             if (
+                handleJit &&
                 error instanceof CustomAuthApiError &&
                 error.subError === REGISTRATION_REQUIRED
             ) {
-                return this.handleJitRequiredError(
-                    error,
-                    telemetryManager,
+                this.logger.verbose(
+                    "Auth method registration required for sign in.",
                     correlationId
                 );
-            } else if (
-                error instanceof CustomAuthApiError &&
-                error.subError === MFA_REQUIRED
-            ) {
-                return this.handleMfaRequiredError(
-                    error,
+
+                // Call register introspect endpoint to get available authentication methods
+                const introspectRequest: RegisterIntrospectRequest = {
+                    continuation_token: error.continuationToken ?? "",
+                    correlationId: error.correlationId ?? correlationId,
                     telemetryManager,
-                    correlationId
-                );
+                };
+
+                const introspectResponse =
+                    await this.customAuthApiClient.registerApi.introspect(
+                        introspectRequest
+                    );
+
+                return createSignInJitRequiredResult({
+                    correlationId:
+                        introspectResponse.correlation_id ?? correlationId,
+                    continuationToken:
+                        introspectResponse.continuation_token ?? "",
+                    authMethods: introspectResponse.methods,
+                });
             }
 
             // Re-throw any other errors or JIT errors when handleJit is false
@@ -411,79 +435,4 @@ export class SignInClient extends CustomAuthInteractionClientBase {
                 );
         }
     }
-
-    private async handleJitRequiredError(
-        error: CustomAuthApiError,
-        telemetryManager: ServerTelemetryManager,
-        correlationId: string
-    ): Promise<SignInJitRequiredResult> {
-        this.logger.verbose(
-            "Auth method registration required for sign in.",
-            correlationId
-        );
-
-        // Call register introspect endpoint to get available authentication methods
-        const introspectRequest: RegisterIntrospectRequest = {
-            continuation_token: error.continuationToken ?? "",
-            correlationId: error.correlationId ?? correlationId,
-            telemetryManager,
-        };
-
-        this.logger.verbose(
-            "Calling introspect endpoint for getting auth methods.",
-            correlationId
-        );
-
-        const introspectResponse =
-            await this.customAuthApiClient.registerApi.introspect(
-                introspectRequest
-            );
-
-        this.logger.verbose(
-            "Introspect endpoint called for getting auth methods.",
-            introspectResponse.correlation_id ?? correlationId
-        );
-
-        return createSignInJitRequiredResult({
-            correlationId: introspectResponse.correlation_id ?? correlationId,
-            continuationToken: introspectResponse.continuation_token ?? "",
-            authMethods: introspectResponse.methods,
-        });
-    }
-
-    private async handleMfaRequiredError(
-        error: CustomAuthApiError,
-        telemetryManager: ServerTelemetryManager,
-        correlationId: string
-    ): Promise<SignInMfaRequiredResult> {
-        this.logger.verbose("MFA required for sign in.", correlationId);
-
-        // Call sign-in introspect endpoint to get available MFA methods
-        const introspectRequest: SignInIntrospectRequest = {
-            continuation_token: error.continuationToken ?? "",
-            correlationId: error.correlationId ?? correlationId,
-            telemetryManager,
-        };
-
-        this.logger.verbose(
-            "Calling introspect endpoint for MFA auth methods.",
-            correlationId
-        );
-
-        const introspectResponse =
-            await this.customAuthApiClient.signInApi.requestAuthMethods(
-                introspectRequest
-            );
-
-        this.logger.verbose(
-            "Introspect endpoint called for MFA auth methods.",
-            introspectResponse.correlation_id ?? correlationId
-        );
-
-        return createSignInMfaRequiredResult({
-            correlationId: introspectResponse.correlation_id ?? correlationId,
-            continuationToken: introspectResponse.continuation_token ?? "",
-            authMethods: introspectResponse.methods,
-        });
-    }
 }

package/src/custom_auth/sign_in/interaction_client/result/SignInActionResult.ts

@@ -38,17 +38,11 @@ export interface SignInJitRequiredResult extends SignInContinuationTokenResult {
     authMethods: AuthenticationMethod[];
 }
 
-export interface SignInMfaRequiredResult extends SignInContinuationTokenResult {
-    type: typeof SIGN_IN_MFA_REQUIRED_RESULT_TYPE;
-    authMethods: AuthenticationMethod[];
-}
-
 export const SIGN_IN_CODE_SEND_RESULT_TYPE = "SignInCodeSendResult";
 export const SIGN_IN_PASSWORD_REQUIRED_RESULT_TYPE =
     "SignInPasswordRequiredResult";
 export const SIGN_IN_COMPLETED_RESULT_TYPE = "SignInCompletedResult";
 export const SIGN_IN_JIT_REQUIRED_RESULT_TYPE = "SignInJitRequiredResult";
-export const SIGN_IN_MFA_REQUIRED_RESULT_TYPE = "SignInMfaRequiredResult";
 
 export function createSignInCompleteResult(
     input: Omit<SignInCompletedResult, "type">
@@ -85,12 +79,3 @@ export function createSignInJitRequiredResult(
         ...input,
     };
 }
-
-export function createSignInMfaRequiredResult(
-    input: Omit<SignInMfaRequiredResult, "type">
-): SignInMfaRequiredResult {
-    return {
-        type: SIGN_IN_MFA_REQUIRED_RESULT_TYPE,
-        ...input,
-    };
-}

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

@@ -98,7 +98,7 @@ export class SignUpAttributesRequiredState extends SignUpState<SignUpAttributesR
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit attributes for sign up. Error: ${error}.`,
+                `Failed to submit attributes for sign up. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

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

@@ -124,7 +124,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit code for sign up. Error: ${error}.`,
+                `Failed to submit code for sign up. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 
@@ -174,7 +174,7 @@ export class SignUpCodeRequiredState extends SignUpState<SignUpCodeRequiredState
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to resend code for sign up. Error: ${error}.`,
+                `Failed to resend code for sign up. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

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

@@ -104,7 +104,7 @@ export class SignUpPasswordRequiredState extends SignUpState<SignUpPasswordRequi
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit password for sign up. Error: ${error}.`,
+                `Failed to submit password for sign up. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

package/src/custom_auth/sign_up/interaction_client/SignUpClient.ts

@@ -43,6 +43,7 @@ import {
 } from "../../core/network_client/custom_auth_api/types/ApiRequestTypes.js";
 import { SignUpContinueResponse } from "../../core/network_client/custom_auth_api/types/ApiResponseTypes.js";
 import { ServerTelemetryManager } from "@azure/msal-common/browser";
+import { initializeServerTelemetryManager } from "../../../interaction_client/BaseInteractionClient.js";
 
 export class SignUpClient extends CustomAuthInteractionClientBase {
     /**
@@ -56,7 +57,13 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         const apiId = !parameters.password
             ? PublicApiId.SIGN_UP_START
             : PublicApiId.SIGN_UP_WITH_PASSWORD_START;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const startRequest: SignUpStartRequest = {
             username: parameters.username,
@@ -104,7 +111,13 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         | SignUpAttributesRequiredResult
     > {
         const apiId = PublicApiId.SIGN_UP_SUBMIT_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const requestSubmitCode: SignUpContinueWithOobRequest = {
             continuation_token: parameters.continuationToken,
@@ -148,7 +161,13 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         | SignUpAttributesRequiredResult
     > {
         const apiId = PublicApiId.SIGN_UP_SUBMIT_PASSWORD;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const requestSubmitPwd: SignUpContinueWithPasswordRequest = {
             continuation_token: parameter.continuationToken,
@@ -192,7 +211,13 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         | SignUpCodeRequiredResult
     > {
         const apiId = PublicApiId.SIGN_UP_SUBMIT_ATTRIBUTES;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
         const reqWithAttr: SignUpContinueWithAttributesRequest = {
             continuation_token: parameter.continuationToken,
             attributes: parameter.attributes,
@@ -235,7 +260,13 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         parameters: SignUpResendCodeParams
     ): Promise<SignUpCodeRequiredResult> {
         const apiId = PublicApiId.SIGN_UP_RESEND_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const challengeRequest: SignUpChallengeRequest = {
             continuation_token: parameters.continuationToken ?? "",
@@ -334,7 +365,7 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
         | SignUpAttributesRequiredResult
     > {
         this.logger.verbose(
-            `${callerName} is calling continue endpoint for sign up.`,
+            `'${callerName}' is calling continue endpoint for sign up.`,
             requestCorrelationId
         );
 
@@ -342,7 +373,7 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
             const response = await responseGetter();
 
             this.logger.verbose(
-                `Continue endpoint called by ${callerName} for sign up.`,
+                `Continue endpoint called by '${callerName}' for sign up.`,
                 requestCorrelationId
             );
 
@@ -360,7 +391,7 @@ export class SignUpClient extends CustomAuthInteractionClientBase {
                 );
             } else {
                 this.logger.errorPii(
-                    `${callerName} is failed to call continue endpoint for sign up. Error: ${error}`,
+                    `'${callerName}' is failed to call continue endpoint for sign up. Error: '${error}'`,
                     requestCorrelationId
                 );