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

package/src/custom_auth/core/interaction_client/jit/result/JitActionResult.ts

@@ -4,15 +4,25 @@
  */
 
 import { AuthenticationResult } from "../../../../../response/AuthenticationResult.js";
+import { AuthenticationMethod } from "../../../network_client/custom_auth_api/types/ApiResponseTypes.js";
 
 interface JitActionResult {
     type: string;
     correlationId: string;
 }
 
-export interface JitVerificationRequiredResult extends JitActionResult {
-    type: typeof JIT_VERIFICATION_REQUIRED_RESULT_TYPE;
+interface JitContinuationTokenResult extends JitActionResult {
     continuationToken: string;
+}
+
+export interface JitGetAuthMethodsResult extends JitContinuationTokenResult {
+    type: typeof JIT_GET_AUTH_METHODS_RESULT_TYPE;
+    authMethods: AuthenticationMethod[];
+}
+
+export interface JitVerificationRequiredResult
+    extends JitContinuationTokenResult {
+    type: typeof JIT_VERIFICATION_REQUIRED_RESULT_TYPE;
     challengeChannel: string;
     challengeTargetLabel: string;
     codeLength: number;
@@ -24,10 +34,20 @@ export interface JitCompletedResult extends JitActionResult {
 }
 
 // Result type constants
+export const JIT_GET_AUTH_METHODS_RESULT_TYPE = "JitGetAuthMethodsResult";
 export const JIT_VERIFICATION_REQUIRED_RESULT_TYPE =
     "JitVerificationRequiredResult";
 export const JIT_COMPLETED_RESULT_TYPE = "JitCompletedResult";
 
+export function createJitGetAuthMethodsResult(
+    input: Omit<JitGetAuthMethodsResult, "type">
+): JitGetAuthMethodsResult {
+    return {
+        type: JIT_GET_AUTH_METHODS_RESULT_TYPE,
+        ...input,
+    };
+}
+
 export function createJitVerificationRequiredResult(
     input: Omit<JitVerificationRequiredResult, "type">
 ): JitVerificationRequiredResult {

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

@@ -6,7 +6,6 @@
 export const SIGNIN_INITIATE = "/oauth2/v2.0/initiate";
 export const SIGNIN_CHALLENGE = "/oauth2/v2.0/challenge";
 export const SIGNIN_TOKEN = "/oauth2/v2.0/token";
-export const SIGNIN_INTROSPECT = "/oauth2/v2.0/introspect";
 
 export const SIGNUP_START = "/signup/v1.0/start";
 export const SIGNUP_CHALLENGE = "/signup/v1.0/challenge";

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

@@ -14,14 +14,12 @@ import {
     SignInChallengeRequest,
     SignInContinuationTokenRequest,
     SignInInitiateRequest,
-    SignInIntrospectRequest,
     SignInOobTokenRequest,
     SignInPasswordTokenRequest,
 } from "./types/ApiRequestTypes.js";
 import {
     SignInChallengeResponse,
     SignInInitiateResponse,
-    SignInIntrospectResponse,
     SignInTokenResponse,
 } from "./types/ApiResponseTypes.js";
 
@@ -130,7 +128,7 @@ export class SignInApiClient extends BaseApiClient {
                 continuation_token: params.continuation_token,
                 scope: params.scope,
                 oob: params.oob,
-                grant_type: params.grant_type,
+                grant_type: GrantType.OOB,
                 ...(params.claims && { claims: params.claims }),
             },
             params.telemetryManager,
@@ -155,30 +153,6 @@ export class SignInApiClient extends BaseApiClient {
         );
     }
 
-    /**
-     * Requests available authentication methods for MFA
-     * @param continuationToken Token from previous response
-     */
-    async requestAuthMethods(
-        params: SignInIntrospectRequest
-    ): Promise<SignInIntrospectResponse> {
-        const result = await this.request<SignInIntrospectResponse>(
-            CustomAuthApiEndpoint.SIGNIN_INTROSPECT,
-            {
-                continuation_token: params.continuation_token,
-            },
-            params.telemetryManager,
-            params.correlationId
-        );
-
-        this.ensureContinuationTokenIsValid(
-            result.continuation_token,
-            params.correlationId
-        );
-
-        return result;
-    }
-
     private async requestTokens(
         requestData: Record<string, string | boolean>,
         telemetryManager: ServerTelemetryManager,

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiRequestTypes.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import { GrantType } from "../../../../CustomAuthConstants.js";
 import { ApiRequestBase } from "./ApiTypesBase.js";
 
 /* Sign-in API request types */
@@ -30,17 +29,12 @@ export interface SignInPasswordTokenRequest extends SignInTokenRequestBase {
 
 export interface SignInOobTokenRequest extends SignInTokenRequestBase {
     oob: string;
-    grant_type: typeof GrantType.OOB | typeof GrantType.MFA_OOB;
 }
 
 export interface SignInContinuationTokenRequest extends SignInTokenRequestBase {
     username?: string;
 }
 
-export interface SignInIntrospectRequest extends ApiRequestBase {
-    continuation_token: string;
-}
-
 /* Sign-up API request types */
 export interface SignUpStartRequest extends ApiRequestBase {
     username: string;

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiResponseTypes.ts

@@ -42,12 +42,7 @@ export interface AuthenticationMethod {
     id: string;
     challenge_type: string;
     challenge_channel: string;
-    login_hint?: string;
-}
-
-export interface SignInIntrospectResponse extends ApiResponseBase {
-    continuation_token: string;
-    methods: AuthenticationMethod[];
+    login_hint: string;
 }
 
 /* Sign-up API response types */

package/src/custom_auth/core/network_client/custom_auth_api/types/ApiSuberrors.ts

@@ -13,4 +13,3 @@ export const INVALID_OOB_VALUE = "invalid_oob_value";
 export const ATTRIBUTE_VALIATION_FAILED = "attribute_validation_failed";
 export const NATIVEAUTHAPI_DISABLED = "nativeauthapi_disabled";
 export const REGISTRATION_REQUIRED = "registration_required";
-export const MFA_REQUIRED = "mfa_required";

package/src/custom_auth/core/network_client/http_client/FetchHttpClient.ts

@@ -23,26 +23,29 @@ export class FetchHttpClient implements IHttpClient {
     ): Promise<Response> {
         const headers = options.headers as Record<string, string>;
         const correlationId =
-            headers?.[AADServerParamKeys.CLIENT_REQUEST_ID] || undefined;
+            headers?.[AADServerParamKeys.CLIENT_REQUEST_ID] || "";
 
         try {
-            this.logger.verbosePii(`Sending request to ${url}`, correlationId);
+            this.logger.verbosePii(
+                `Sending request to '${url}'`,
+                correlationId
+            );
 
             const startTime = performance.now();
             const response = await fetch(url, options);
             const endTime = performance.now();
 
             this.logger.verbosePii(
-                `Request to '${url}' completed in ${
+                `Request to '${url}' completed in '${
                     endTime - startTime
-                }ms with status code ${response.status}`,
+                }'ms with status code '${response.status}'`,
                 correlationId
             );
 
             return response;
         } catch (e) {
             this.logger.errorPii(
-                `Failed to send request to ${url}: ${e}`,
+                `Failed to send request to '${url}': '${e}'`,
                 correlationId
             );
 

package/src/custom_auth/core/telemetry/PublicApiId.ts

@@ -37,9 +37,6 @@ export const ACCOUNT_SIGN_OUT = 100062;
 export const ACCOUNT_GET_ACCESS_TOKEN = 100063;
 
 // JIT (Just-In-Time) Auth Method Registration
-export const JIT_CHALLENGE_AUTH_METHOD = 100081;
-export const JIT_SUBMIT_CHALLENGE = 100082;
-
-// MFA
-export const MFA_REQUEST_CHALLENGE = 100101;
-export const MFA_SUBMIT_CHALLENGE = 100102;
+export const JIT_GET_AUTH_METHODS = 100081;
+export const JIT_CHALLENGE_AUTH_METHOD = 100082;
+export const JIT_SUBMIT_CHALLENGE = 100083;

package/src/custom_auth/get_account/auth_flow/CustomAuthAccountData.ts

@@ -12,8 +12,8 @@ import { DefaultScopes } from "../../CustomAuthConstants.js";
 import { AccessTokenRetrievalInputs } from "../../CustomAuthActionInputs.js";
 import {
     AccountInfo,
-    AuthenticationScheme,
     CommonSilentFlowRequest,
+    Constants,
     Logger,
     TokenClaims,
 } from "@azure/msal-common/browser";
@@ -70,7 +70,7 @@ export class CustomAuthAccountData {
             return new SignOutResult();
         } catch (error) {
             this.logger.errorPii(
-                `An error occurred during sign out: ${error}`,
+                `An error occurred during sign out: '${error}'`,
                 this.correlationId
             );
 
@@ -190,7 +190,7 @@ export class CustomAuthAccountData {
 
         return {
             ...silentRequest,
-            authenticationScheme: AuthenticationScheme.BEARER,
+            authenticationScheme: Constants.AuthenticationScheme.BEARER,
         } as CommonSilentFlowRequest;
     }
 }

package/src/custom_auth/get_account/interaction_client/CustomAuthSilentCacheClient.ts

@@ -22,6 +22,10 @@ import { AuthenticationResult } from "../../../response/AuthenticationResult.js"
 import { ClearCacheRequest } from "../../../request/ClearCacheRequest.js";
 import { ApiId } from "../../../utils/BrowserConstants.js";
 import { getCurrentUri } from "../../../utils/BrowserUtils.js";
+import {
+    clearCacheOnLogout,
+    initializeServerTelemetryManager,
+} from "../../../interaction_client/BaseInteractionClient.js";
 
 export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase {
     /**
@@ -37,8 +41,13 @@ export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase
     override async acquireToken(
         silentRequest: CommonSilentFlowRequest
     ): Promise<AuthenticationResult> {
-        const telemetryManager = this.initializeServerTelemetryManager(
-            PublicApiId.ACCOUNT_GET_ACCESS_TOKEN
+        const telemetryManager = initializeServerTelemetryManager(
+            PublicApiId.ACCOUNT_GET_ACCESS_TOKEN,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger,
+            silentRequest.forceRefresh
         );
         const clientConfig = this.getCustomAuthClientConfiguration(
             telemetryManager,
@@ -106,15 +115,15 @@ export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase
         const validLogoutRequest = this.initializeLogoutRequest(logoutRequest);
 
         // Clear the cache
-        this.logger.verbose(
-            "Start to clear the cache",
-            logoutRequest?.correlationId
-        );
-        await this.clearCacheOnLogout(
-            validLogoutRequest.correlationId,
+        this.logger.verbose("Start to clear the cache", this.correlationId);
+        await clearCacheOnLogout(
+            this.browserStorage,
+            this.browserCrypto,
+            this.logger,
+            this.correlationId,
             validLogoutRequest?.account
         );
-        this.logger.verbose("Cache cleared", logoutRequest?.correlationId);
+        this.logger.verbose("Cache cleared", this.correlationId);
 
         const postLogoutRedirectUri = this.config.auth.postLogoutRedirectUri;
 
@@ -126,7 +135,7 @@ export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase
 
             this.logger.verbose(
                 "Post logout redirect uri is set, redirecting to uri",
-                logoutRequest?.correlationId
+                this.correlationId
             );
 
             // Redirect to post logout redirect uri
@@ -195,10 +204,6 @@ export class CustomAuthSilentCacheClient extends CustomAuthInteractionClientBase
                 logLevel: logger.logLevel,
                 correlationId: this.correlationId,
             },
-            cacheOptions: {
-                claimsBasedCachingEnabled:
-                    this.config.cache.claimsBasedCachingEnabled,
-            },
             cryptoInterface: this.browserCrypto,
             networkInterface: this.networkClient,
             storageInterface: this.browserStorage,

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordCodeRequiredState.ts

@@ -61,7 +61,7 @@ export class ResetPasswordCodeRequiredState extends ResetPasswordState<ResetPass
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit code for password reset. Error: ${error}.`,
+                `Failed to submit code for password reset. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 
@@ -114,7 +114,7 @@ export class ResetPasswordCodeRequiredState extends ResetPasswordState<ResetPass
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to resend code for password reset. Error: ${error}.`,
+                `Failed to resend code for password reset. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

package/src/custom_auth/reset_password/auth_flow/state/ResetPasswordPasswordRequiredState.ts

@@ -64,7 +64,7 @@ export class ResetPasswordPasswordRequiredState extends ResetPasswordState<Reset
             );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit password for password reset. Error: ${error}.`,
+                `Failed to submit password for password reset. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

package/src/custom_auth/reset_password/interaction_client/ResetPasswordClient.ts

@@ -33,6 +33,7 @@ import {
     ResetPasswordPasswordRequiredResult,
 } from "./result/ResetPasswordActionResult.js";
 import { ensureArgumentIsNotEmptyString } from "../../core/utils/ArgumentValidator.js";
+import { initializeServerTelemetryManager } from "../../../interaction_client/BaseInteractionClient.js";
 
 export class ResetPasswordClient extends CustomAuthInteractionClientBase {
     /**
@@ -45,7 +46,13 @@ export class ResetPasswordClient extends CustomAuthInteractionClientBase {
     ): Promise<ResetPasswordCodeRequiredResult> {
         const correlationId = parameters.correlationId;
         const apiId = PublicApiId.PASSWORD_RESET_START;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const startRequest: ResetPasswordStartRequest = {
             challenge_type: this.getChallengeTypes(parameters.challengeType),
@@ -93,7 +100,13 @@ export class ResetPasswordClient extends CustomAuthInteractionClientBase {
         );
 
         const apiId = PublicApiId.PASSWORD_RESET_SUBMIT_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const continueRequest: ResetPasswordContinueRequest = {
             continuation_token: parameters.continuationToken,
@@ -132,7 +145,13 @@ export class ResetPasswordClient extends CustomAuthInteractionClientBase {
         parameters: ResetPasswordResendCodeParams
     ): Promise<ResetPasswordCodeRequiredResult> {
         const apiId = PublicApiId.PASSWORD_RESET_RESEND_CODE;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const challengeRequest: ResetPasswordChallengeRequest = {
             continuation_token: parameters.continuationToken,
@@ -161,7 +180,13 @@ export class ResetPasswordClient extends CustomAuthInteractionClientBase {
         );
 
         const apiId = PublicApiId.PASSWORD_RESET_SUBMIT_PASSWORD;
-        const telemetryManager = this.initializeServerTelemetryManager(apiId);
+        const telemetryManager = initializeServerTelemetryManager(
+            apiId,
+            this.config.auth.clientId,
+            this.correlationId,
+            this.browserStorage,
+            this.logger
+        );
 
         const submitRequest: ResetPasswordSubmitRequest = {
             continuation_token: parameters.continuationToken,
@@ -289,7 +314,7 @@ export class ResetPasswordClient extends CustomAuthInteractionClientBase {
             }
 
             this.logger.verbose(
-                `Poll completion endpoint for password reset is not started or in progress, waiting ${pollInterval} seconds for next check.`,
+                `Poll completion endpoint for password reset is not started or in progress, waiting '${pollInterval}' seconds for next check.`,
                 correlationId
             );
 

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

@@ -13,7 +13,6 @@ import { SignInSubmitCodeResult } from "../result/SignInSubmitCodeResult.js";
 import { SignInCodeRequiredStateParameters } from "./SignInStateParameters.js";
 import { SignInState } from "./SignInState.js";
 import { SignInCompletedState } from "./SignInCompletedState.js";
-import { SIGN_IN_COMPLETED_RESULT_TYPE } from "../../interaction_client/result/SignInActionResult.js";
 
 /*
  * Sign-in code required state.
@@ -46,7 +45,7 @@ export class SignInCodeRequiredState extends SignInState<SignInCodeRequiredState
                 this.stateParameters.correlationId
             );
 
-            const submitCodeResult =
+            const completedResult =
                 await this.stateParameters.signInClient.submitCode(
                     submitCodeParams
                 );
@@ -56,30 +55,21 @@ export class SignInCodeRequiredState extends SignInState<SignInCodeRequiredState
                 this.stateParameters.correlationId
             );
 
-            if (submitCodeResult.type === SIGN_IN_COMPLETED_RESULT_TYPE) {
-                const accountInfo = new CustomAuthAccountData(
-                    submitCodeResult.authenticationResult.account,
-                    this.stateParameters.config,
-                    this.stateParameters.cacheClient,
-                    this.stateParameters.logger,
-                    this.stateParameters.correlationId
-                );
+            const accountInfo = new CustomAuthAccountData(
+                completedResult.authenticationResult.account,
+                this.stateParameters.config,
+                this.stateParameters.cacheClient,
+                this.stateParameters.logger,
+                this.stateParameters.correlationId
+            );
 
-                return new SignInSubmitCodeResult(
-                    new SignInCompletedState(),
-                    accountInfo
-                );
-            } else {
-                // Unexpected result type
-                const result = submitCodeResult as { type: string };
-                const error = new Error(
-                    `Unexpected result type: ${result.type}`
-                );
-                return SignInSubmitCodeResult.createWithError(error);
-            }
+            return new SignInSubmitCodeResult(
+                new SignInCompletedState(),
+                accountInfo
+            );
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to submit code for sign-in. Error: ${error}.`,
+                `Failed to submit code for sign-in. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

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

@@ -112,7 +112,7 @@ export class SignInContinuationState extends SignInState<SignInContinuationState
             }
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to sign in with continuation token. Error: ${error}.`,
+                `Failed to sign in with continuation token. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );
 

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

@@ -104,7 +104,7 @@ export class SignInPasswordRequiredState extends SignInState<SignInPasswordRequi
             }
         } catch (error) {
             this.stateParameters.logger.errorPii(
-                `Failed to sign in after submitting password. Error: ${error}.`,
+                `Failed to sign in after submitting password. Error: '${error}'.`,
                 this.stateParameters.correlationId
             );