@azure/msal-browser 4.20.0 → 4.21.1

package/src/custom_auth/core/network_client/custom_auth_api/BaseApiClient.ts

@@ -128,7 +128,10 @@ export abstract class BaseApiClient {
                 typeof responseData === "object" &&
                 responseData.challenge_type === ChallengeType.REDIRECT
             ) {
-                throw new RedirectError(correlationId);
+                throw new RedirectError(
+                    correlationId,
+                    responseData.redirect_reason
+                );
             }
 
             return {

package/src/custom_auth/core/network_client/custom_auth_api/CustomAuthApiClient.ts

@@ -17,22 +17,26 @@ export class CustomAuthApiClient implements ICustomAuthApiClient {
     constructor(
         customAuthApiBaseUrl: string,
         clientId: string,
-        httpClient: IHttpClient
+        httpClient: IHttpClient,
+        capabilities?: string
     ) {
         this.signInApi = new SignInApiClient(
             customAuthApiBaseUrl,
             clientId,
-            httpClient
+            httpClient,
+            capabilities
         );
         this.signUpApi = new SignupApiClient(
             customAuthApiBaseUrl,
             clientId,
-            httpClient
+            httpClient,
+            capabilities
         );
         this.resetPasswordApi = new ResetPasswordApiClient(
             customAuthApiBaseUrl,
             clientId,
-            httpClient
+            httpClient,
+            capabilities
         );
     }
 }

package/src/custom_auth/core/network_client/custom_auth_api/ResetPasswordApiClient.ts

@@ -9,6 +9,7 @@ import {
 } from "../../../CustomAuthConstants.js";
 import { CustomAuthApiError } from "../../error/CustomAuthApiError.js";
 import { BaseApiClient } from "./BaseApiClient.js";
+import { IHttpClient } from "../http_client/IHttpClient.js";
 import * as CustomAuthApiEndpoint from "./CustomAuthApiEndpoint.js";
 import * as CustomAuthApiErrorCode from "./types/ApiErrorCodes.js";
 import {
@@ -27,6 +28,18 @@ import {
 } from "./types/ApiResponseTypes.js";
 
 export class ResetPasswordApiClient extends BaseApiClient {
+    private readonly capabilities?: string;
+
+    constructor(
+        customAuthApiBaseUrl: string,
+        clientId: string,
+        httpClient: IHttpClient,
+        capabilities?: string
+    ) {
+        super(customAuthApiBaseUrl, clientId, httpClient);
+        this.capabilities = capabilities;
+    }
+
     /**
      * Start the password reset flow
      */
@@ -38,6 +51,9 @@ export class ResetPasswordApiClient extends BaseApiClient {
             {
                 challenge_type: params.challenge_type,
                 username: params.username,
+                ...(this.capabilities && {
+                    capabilities: this.capabilities,
+                }),
             },
             params.telemetryManager,
             params.correlationId

package/src/custom_auth/core/network_client/custom_auth_api/SignInApiClient.ts

@@ -7,6 +7,7 @@ import { ServerTelemetryManager } from "@azure/msal-common/browser";
 import { GrantType } from "../../../CustomAuthConstants.js";
 import { CustomAuthApiError } from "../../error/CustomAuthApiError.js";
 import { BaseApiClient } from "./BaseApiClient.js";
+import { IHttpClient } from "../http_client/IHttpClient.js";
 import * as CustomAuthApiEndpoint from "./CustomAuthApiEndpoint.js";
 import * as CustomAuthApiErrorCode from "./types/ApiErrorCodes.js";
 import {
@@ -23,6 +24,18 @@ import {
 } from "./types/ApiResponseTypes.js";
 
 export class SignInApiClient extends BaseApiClient {
+    private readonly capabilities?: string;
+
+    constructor(
+        customAuthApiBaseUrl: string,
+        clientId: string,
+        httpClient: IHttpClient,
+        capabilities?: string
+    ) {
+        super(customAuthApiBaseUrl, clientId, httpClient);
+        this.capabilities = capabilities;
+    }
+
     /**
      * Initiates the sign-in flow
      * @param username User's email
@@ -36,6 +49,9 @@ export class SignInApiClient extends BaseApiClient {
             {
                 username: params.username,
                 challenge_type: params.challenge_type,
+                ...(this.capabilities && {
+                    capabilities: this.capabilities,
+                }),
             },
             params.telemetryManager,
             params.correlationId

package/src/custom_auth/core/network_client/custom_auth_api/SignupApiClient.ts

@@ -5,6 +5,7 @@
 
 import { GrantType } from "../../../CustomAuthConstants.js";
 import { BaseApiClient } from "./BaseApiClient.js";
+import { IHttpClient } from "../http_client/IHttpClient.js";
 import * as CustomAuthApiEndpoint from "./CustomAuthApiEndpoint.js";
 import {
     SignUpChallengeRequest,
@@ -20,6 +21,18 @@ import {
 } from "./types/ApiResponseTypes.js";
 
 export class SignupApiClient extends BaseApiClient {
+    private readonly capabilities?: string;
+
+    constructor(
+        customAuthApiBaseUrl: string,
+        clientId: string,
+        httpClient: IHttpClient,
+        capabilities?: string
+    ) {
+        super(customAuthApiBaseUrl, clientId, httpClient);
+        this.capabilities = capabilities;
+    }
+
     /**
      * Start the sign-up flow
      */
@@ -33,6 +46,9 @@ export class SignupApiClient extends BaseApiClient {
                     attributes: JSON.stringify(params.attributes),
                 }),
                 challenge_type: params.challenge_type,
+                ...(this.capabilities && {
+                    capabilities: this.capabilities,
+                }),
             },
             params.telemetryManager,
             params.correlationId

package/src/custom_auth/reset_password/auth_flow/error_type/ResetPasswordError.ts

@@ -31,14 +31,6 @@ export class ResetPasswordError extends AuthActionErrorBase {
     isUnsupportedChallengeType(): boolean {
         return this.isUnsupportedChallengeTypeError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if client app doesn't support the challenge type configured in Entra, "loginPopup" function is required to continue the operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
 export class ResetPasswordSubmitPasswordError extends AuthActionErrorBase {
@@ -75,22 +67,6 @@ export class ResetPasswordSubmitCodeError extends AuthActionErrorBase {
     isInvalidCode(): boolean {
         return this.isInvalidCodeError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if client app doesn't support the challenge type configured in Entra, "loginPopup" function is required to continue the operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
-export class ResetPasswordResendCodeError extends AuthActionErrorBase {
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if client app doesn't support the challenge type configured in Entra, "loginPopup" function is required to continue the operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
-}
+export class ResetPasswordResendCodeError extends AuthActionErrorBase {}

package/src/custom_auth/sign_in/auth_flow/error_type/SignInError.ts

@@ -46,14 +46,6 @@ export class SignInError extends AuthActionErrorBase {
     isUnsupportedChallengeType(): boolean {
         return this.isUnsupportedChallengeTypeError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
 export class SignInSubmitPasswordError extends AuthActionErrorBase {
@@ -76,12 +68,4 @@ export class SignInSubmitCodeError extends AuthActionErrorBase {
     }
 }
 
-export class SignInResendCodeError extends AuthActionErrorBase {
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
-}
+export class SignInResendCodeError extends AuthActionErrorBase {}

package/src/custom_auth/sign_up/auth_flow/error_type/SignUpError.ts

@@ -53,14 +53,6 @@ export class SignUpError extends AuthActionErrorBase {
     isUnsupportedChallengeType(): boolean {
         return this.isUnsupportedChallengeTypeError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
 export class SignUpSubmitPasswordError extends AuthActionErrorBase {
@@ -73,14 +65,6 @@ export class SignUpSubmitPasswordError extends AuthActionErrorBase {
             this.isPasswordIncorrectError() || this.isInvalidNewPasswordError()
         );
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
 export class SignUpSubmitCodeError extends AuthActionErrorBase {
@@ -91,14 +75,6 @@ export class SignUpSubmitCodeError extends AuthActionErrorBase {
     isInvalidCode(): boolean {
         return this.isInvalidCodeError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
 export class SignUpSubmitAttributesError extends AuthActionErrorBase {
@@ -117,22 +93,6 @@ export class SignUpSubmitAttributesError extends AuthActionErrorBase {
     isAttributesValidationFailed(): boolean {
         return this.isAttributeValidationFailedError();
     }
-
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
 }
 
-export class SignUpResendCodeError extends AuthActionErrorBase {
-    /**
-     * Check if client app supports the challenge type configured in Entra.
-     * @returns {boolean} True if "loginPopup" function is required to continue sthe operation.
-     */
-    isRedirectRequired(): boolean {
-        return this.isRedirectError();
-    }
-}
+export class SignUpResendCodeError extends AuthActionErrorBase {}

package/src/error/NativeAuthError.ts

@@ -52,8 +52,7 @@ export function isFatalNativeAuthError(error: NativeAuthError): boolean {
     if (
         error.ext &&
         error.ext.status &&
-        (error.ext.status === NativeStatusCodes.PERSISTENT_ERROR ||
-            error.ext.status === NativeStatusCodes.DISABLED)
+        error.ext.status === NativeStatusCodes.DISABLED
     ) {
         return true;
     }

package/src/interaction_client/PlatformAuthInteractionClient.ts

@@ -155,14 +155,14 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
     ): Promise<AuthenticationResult> {
         this.performanceClient.addQueueMeasurement(
             PerformanceEvents.NativeInteractionClientAcquireToken,
-            request.correlationId
+            this.correlationId
         );
         this.logger.trace("NativeInteractionClient - acquireToken called.");
 
         // start the perf measurement
         const nativeATMeasurement = this.performanceClient.startMeasurement(
             PerformanceEvents.NativeInteractionClientAcquireToken,
-            request.correlationId
+            this.correlationId
         );
         const reqTimestamp = TimeUtils.nowSeconds();
 
@@ -191,6 +191,10 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
                     this.logger.info(
                         "MSAL internal Cache does not contain tokens, return error as per cache policy"
                     );
+                    nativeATMeasurement.end({
+                        success: false,
+                        brokerErrorCode: "cache_request_failed",
+                    });
                     throw e;
                 }
                 // continue with a native call for any and all errors
@@ -221,7 +225,6 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
                         success: false,
                         errorCode: error.errorCode,
                         subErrorCode: error.subError,
-                        isNativeBroker: true,
                     });
                     throw error;
                 });
@@ -229,6 +232,9 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
             if (e instanceof NativeAuthError) {
                 serverTelemetryManager.setNativeBrokerErrorCode(e.errorCode);
             }
+            nativeATMeasurement.end({
+                success: false,
+            });
             throw e;
         }
     }
@@ -423,6 +429,12 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
             const serverTelemetryManager =
                 this.initializeServerTelemetryManager(this.apiId);
             serverTelemetryManager.clearNativeBrokerErrorCode();
+            if (performanceClient && this.correlationId) {
+                this.performanceClient.addFields(
+                    { isNativeBroker: true },
+                    this.correlationId
+                );
+            }
             return authResult;
         } catch (e) {
             throw e;
@@ -948,7 +960,7 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
                     PerformanceEvents.PopTokenGenerateCnf,
                     this.logger,
                     this.performanceClient,
-                    request.correlationId
+                    this.correlationId
                 )(shrParameters, this.logger);
                 reqCnfData = generatedReqCnfData.reqCnfString;
                 validatedRequest.keyId = generatedReqCnfData.kid;
@@ -1073,7 +1085,7 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
                 embeddedClientId: child_client_id,
                 embeddedRedirectUri: child_redirect_uri,
             },
-            request.correlationId
+            this.correlationId
         );
     }
 }

package/src/interaction_client/RedirectClient.ts

@@ -391,8 +391,8 @@ export class RedirectClient extends StandardInteractionClient {
                     true
                 ) || Constants.EMPTY_STRING;
             const loginRequestUrlNormalized =
-                UrlString.removeHashFromUrl(loginRequestUrl);
-            const currentUrlNormalized = UrlString.removeHashFromUrl(
+                UrlUtils.normalizeUrlForComparison(loginRequestUrl);
+            const currentUrlNormalized = UrlUtils.normalizeUrlForComparison(
                 window.location.href
             );
 

package/src/packageMetadata.ts

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

package/src/protocol/Authorize.ts

@@ -84,6 +84,14 @@ async function getStandardParameters(
         // signal ests that this is a WAM call
         RequestParameterBuilder.addNativeBroker(parameters);
 
+        // instrument JS-platform bridge specific fields
+        performanceClient.addFields(
+            {
+                isPlatformAuthorizeRequest: true,
+            },
+            request.correlationId
+        );
+
         // pass the req_cnf for POP
         if (request.authenticationScheme === AuthenticationScheme.POP) {
             const cryptoOps = new CryptoOps(logger, performanceClient);