[Native Auth] Remove preview warning and typo fix (#8147)

shenj · web-flow · commit 169194799418 · 2025-11-18T12:15:13.000Z
diff --git a/change/@azure-msal-browser-6db0123d-105f-4d42-8b63-09120ab0d737.json b/change/@azure-msal-browser-6db0123d-105f-4d42-8b63-09120ab0d737.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "[Native Auth] Remove preview warning and typo fix",
+  "packageName": "@azure/msal-browser",
+  "email": "shen.jian@live.com",
+  "dependentChangeType": "patch"
+}
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/jit/result/AuthMethodRegistrationChallengeMethodResult.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/jit/result/AuthMethodRegistrationChallengeMethodResult.ts
@@ -44,7 +44,6 @@ export class AuthMethodRegistrationChallengeMethodResult extends AuthFlowResultB
     /**
      * Checks if the result indicates that verification is required.
      * @returns true if verification is required, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isVerificationRequired(): this is AuthMethodRegistrationChallengeMethodResult & {
         state: AuthMethodVerificationRequiredState;
@@ -58,7 +57,6 @@ export class AuthMethodRegistrationChallengeMethodResult extends AuthFlowResultB
     /**
      * Checks if the result indicates that registration is completed (fast-pass scenario).
      * @returns true if registration is completed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isCompleted(): this is AuthMethodRegistrationChallengeMethodResult & {
         state: AuthMethodRegistrationCompletedState;
@@ -72,7 +70,6 @@ export class AuthMethodRegistrationChallengeMethodResult extends AuthFlowResultB
     /**
      * Checks if the result is in a failed state.
      * @returns true if the result is failed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isFailed(): this is AuthMethodRegistrationChallengeMethodResult & {
         state: AuthMethodRegistrationFailedState;
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/jit/result/AuthMethodRegistrationSubmitChallengeResult.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/jit/result/AuthMethodRegistrationSubmitChallengeResult.ts
@@ -41,7 +41,6 @@ export class AuthMethodRegistrationSubmitChallengeResult extends AuthFlowResultB
     /**
      * Checks if the result indicates that registration is completed.
      * @returns true if registration is completed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isCompleted(): this is AuthMethodRegistrationSubmitChallengeResult & {
         state: AuthMethodRegistrationCompletedState;
@@ -55,7 +54,6 @@ export class AuthMethodRegistrationSubmitChallengeResult extends AuthFlowResultB
     /**
      * Checks if the result is in a failed state.
      * @returns true if the result is failed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isFailed(): this is AuthMethodRegistrationSubmitChallengeResult & {
         state: AuthMethodRegistrationFailedState;
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/jit/state/AuthMethodRegistrationState.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/jit/state/AuthMethodRegistrationState.ts
@@ -123,8 +123,8 @@ abstract class AuthMethodRegistrationState<
                 );
             }
         } catch (error) {
-            this.stateParameters.logger.error(
-                "Failed to challenge authentication method for auth method registration.",
+            this.stateParameters.logger.errorPii(
+                `Failed to challenge authentication method for auth method registration. Error: ${error}.`,
                 this.stateParameters.correlationId
             );
             return AuthMethodRegistrationChallengeMethodResult.createWithError(
@@ -146,7 +146,6 @@ export class AuthMethodRegistrationRequiredState extends AuthMethodRegistrationS
     /**
      * Gets the available authentication methods for registration.
      * @returns Array of available authentication methods.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getAuthMethods(): AuthenticationMethod[] {
         return this.stateParameters.authMethods;
@@ -156,7 +155,6 @@ export class AuthMethodRegistrationRequiredState extends AuthMethodRegistrationS
      * Challenges an authentication method for registration.
      * @param authMethodDetails The authentication method details to challenge.
      * @returns Promise that resolves to AuthMethodRegistrationChallengeMethodResult.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     async challengeAuthMethod(
         authMethodDetails: AuthMethodDetails
@@ -177,7 +175,6 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
     /**
      * Gets the length of the expected verification code.
      * @returns The code length.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getCodeLength(): number {
         return this.stateParameters.codeLength;
@@ -186,7 +183,6 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
     /**
      * Gets the channel through which the challenge was sent.
      * @returns The challenge channel (e.g., "email").
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getChannel(): string {
         return this.stateParameters.challengeChannel;
@@ -195,7 +191,6 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
     /**
      * Gets the target label indicating where the challenge was sent.
      * @returns The challenge target label (e.g., masked email address).
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getSentTo(): string {
         return this.stateParameters.challengeTargetLabel;
@@ -205,7 +200,6 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
      * Submits the verification challenge to complete the authentication method registration.
      * @param code The verification code entered by the user.
      * @returns Promise that resolves to AuthMethodRegistrationSubmitChallengeResult.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     async submitChallenge(
         code: string
@@ -250,8 +244,8 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
                 accountInfo
             );
         } catch (error) {
-            this.stateParameters.logger.error(
-                "Failed to submit auth method challenge.",
+            this.stateParameters.logger.errorPii(
+                `Failed to submit auth method challenge. Error: ${error}.`,
                 this.stateParameters.correlationId
             );
             return AuthMethodRegistrationSubmitChallengeResult.createWithError(
@@ -264,7 +258,6 @@ export class AuthMethodVerificationRequiredState extends AuthMethodRegistrationS
      * Challenges a different authentication method for registration.
      * @param authMethodDetails The authentication method details to challenge.
      * @returns Promise that resolves to AuthMethodRegistrationChallengeMethodResult.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     async challengeAuthMethod(
         authMethodDetails: AuthMethodDetails
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/result/MfaRequestChallengeResult.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/result/MfaRequestChallengeResult.ts
@@ -36,7 +36,6 @@ export class MfaRequestChallengeResult extends AuthFlowResultBase<
     /**
      * Checks if the result indicates that verification is required.
      * @returns true if verification is required, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isVerificationRequired(): this is MfaRequestChallengeResult & {
         state: MfaVerificationRequiredState;
@@ -47,7 +46,6 @@ export class MfaRequestChallengeResult extends AuthFlowResultBase<
     /**
      * Checks if the result is in a failed state.
      * @returns true if the result is failed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isFailed(): this is MfaRequestChallengeResult & {
         state: MfaFailedState;
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/result/MfaSubmitChallengeResult.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/result/MfaSubmitChallengeResult.ts
@@ -37,7 +37,6 @@ export class MfaSubmitChallengeResult extends AuthFlowResultBase<
     /**
      * Checks if the MFA flow is completed successfully.
      * @returns true if completed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isCompleted(): this is MfaSubmitChallengeResult & {
         state: MfaCompletedState;
@@ -48,7 +47,6 @@ export class MfaSubmitChallengeResult extends AuthFlowResultBase<
     /**
      * Checks if the result is in a failed state.
      * @returns true if the result is failed, false otherwise.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isFailed(): this is MfaSubmitChallengeResult & {
         state: MfaFailedState;
diff --git a/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/state/MfaState.ts b/lib/msal-browser/src/custom_auth/core/auth_flow/mfa/state/MfaState.ts
@@ -31,7 +31,6 @@ abstract class MfaState<
      * Requests an MFA challenge for a specific authentication method.
      * @param authMethodId The authentication method ID to use for the challenge.
      * @returns Promise that resolves to MfaRequestChallengeResult.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     async requestChallenge(
         authMethodId: string
@@ -101,7 +100,6 @@ export class MfaAwaitingState extends MfaState<MfaAwaitingStateParameters> {
     /**
      * Gets the available authentication methods for MFA.
      * @returns Array of available authentication methods.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getAuthMethods(): AuthenticationMethod[] {
         return this.stateParameters.authMethods;
@@ -121,7 +119,6 @@ export class MfaVerificationRequiredState extends MfaState<MfaVerificationRequir
     /**
      * Gets the length of the code that the user needs to provide.
      * @returns The expected code length.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getCodeLength(): number {
         return this.stateParameters.codeLength;
@@ -130,7 +127,6 @@ export class MfaVerificationRequiredState extends MfaState<MfaVerificationRequir
     /**
      * Gets the channel through which the challenge was sent.
      * @returns The challenge channel (e.g., "email").
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getChannel(): string {
         return this.stateParameters.challengeChannel;
@@ -139,7 +135,6 @@ export class MfaVerificationRequiredState extends MfaState<MfaVerificationRequir
     /**
      * Gets the target label indicating where the challenge was sent.
      * @returns The challenge target label (e.g., masked email address).
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     getSentTo(): string {
         return this.stateParameters.challengeTargetLabel;
@@ -149,7 +144,6 @@ export class MfaVerificationRequiredState extends MfaState<MfaVerificationRequir
      * Submits the MFA challenge (e.g., OTP code) to complete the authentication.
      * @param challenge The challenge code (e.g., OTP code) entered by the user.
      * @returns Promise that resolves to MfaSubmitChallengeResult.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     async submitChallenge(
         challenge: string
diff --git a/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInResult.ts b/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInResult.ts
@@ -83,7 +83,6 @@ export class SignInResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires authentication method registration.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isAuthMethodRegistrationRequired(): this is SignInResult & {
         state: AuthMethodRegistrationRequiredState;
@@ -96,7 +95,6 @@ export class SignInResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires MFA.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isMfaRequired(): this is SignInResult & { state: MfaAwaitingState } {
         return this.state.stateType === MFA_AWAITING_STATE_TYPE;
diff --git a/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInSubmitCodeResult.ts b/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInSubmitCodeResult.ts
@@ -57,7 +57,6 @@ export class SignInSubmitCodeResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires authentication method registration.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isAuthMethodRegistrationRequired(): this is SignInSubmitCodeResult & {
         state: AuthMethodRegistrationRequiredState;
@@ -70,7 +69,6 @@ export class SignInSubmitCodeResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires MFA.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isMfaRequired(): this is SignInSubmitCodeResult & {
         state: MfaAwaitingState;
diff --git a/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInSubmitPasswordResult.ts b/lib/msal-browser/src/custom_auth/sign_in/auth_flow/result/SignInSubmitPasswordResult.ts
@@ -54,7 +54,6 @@ export class SignInSubmitPasswordResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires authentication method registration.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isAuthMethodRegistrationRequired(): this is SignInSubmitPasswordResult & {
         state: AuthMethodRegistrationRequiredState;
@@ -67,7 +66,6 @@ export class SignInSubmitPasswordResult extends AuthFlowResultBase<
 
     /**
      * Checks if the result requires MFA.
-     * @warning This API is experimental. It may be changed in the future without notice. Do not use in production applications.
      */
     isMfaRequired(): this is SignInSubmitPasswordResult & {
         state: MfaAwaitingState;
diff --git a/lib/msal-browser/test/custom_auth/core/auth_flow/jit/state/AuthMethodRegistrationState.spec.ts b/lib/msal-browser/test/custom_auth/core/auth_flow/jit/state/AuthMethodRegistrationState.spec.ts
@@ -21,12 +21,13 @@ import {
     createJitCompletedResult,
 } from "../../../../../../src/custom_auth/core/interaction_client/jit/result/JitActionResult.js";
 import { AuthenticationMethod } from "../../../../../../src/custom_auth/core/network_client/custom_auth_api/types/ApiResponseTypes.js";
+import { getDefaultLogger } from "../../../../test_resources/TestModules.js";
 
 describe("JitState", () => {
     let mockJitClient: jest.Mocked<JitClient>;
     let mockCacheClient: jest.Mocked<CustomAuthSilentCacheClient>;
     let mockConfig: CustomAuthBrowserConfiguration;
-    let mockLogger: jest.Mocked<Logger>;
+    let mockLogger: Logger;
     let correlationId: string;
 
     const mockAuthMethod: AuthenticationMethod = {
@@ -52,10 +53,7 @@ describe("JitState", () => {
             },
         } as any;
 
-        mockLogger = {
-            verbose: jest.fn(),
-            error: jest.fn(),
-        } as any;
+        mockLogger = getDefaultLogger();
     });
 
     describe("AuthMethodRegistrationRequiredState", () => {
diff --git a/lib/msal-browser/test/custom_auth/core/auth_flow/mfa/state/MfaState.spec.ts b/lib/msal-browser/test/custom_auth/core/auth_flow/mfa/state/MfaState.spec.ts
@@ -15,7 +15,7 @@ import {
 } from "../../../../../../src/custom_auth/core/interaction_client/mfa/result/MfaActionResult.js";
 import { CustomAuthAccountData } from "../../../../../../src/custom_auth/get_account/auth_flow/CustomAuthAccountData.js";
 import { customAuthConfig } from "../../../../test_resources/CustomAuthConfig.js";
-import { TestAccounDetails } from "../../../../test_resources/TestConstants.js";
+import { TestAccountDetails } from "../../../../test_resources/TestConstants.js";
 import {
     MfaAwaitingState,
     MfaVerificationRequiredState,
@@ -280,7 +280,7 @@ describe("MfaVerificationRequiredState", () => {
                     authority: "https://test-authority.com",
                     tenantId: "test-tenant-id",
                     scopes: ["openid", "profile"],
-                    account: TestAccounDetails,
+                    account: TestAccountDetails,
                     idTokenClaims: {},
                     fromCache: false,
                     uniqueId: "test-unique-id",
diff --git a/lib/msal-browser/test/custom_auth/get_account/interaction_client/CustomAuthSilentCacheClient.spec.ts b/lib/msal-browser/test/custom_auth/get_account/interaction_client/CustomAuthSilentCacheClient.spec.ts
@@ -17,7 +17,7 @@ import {
 } from "@azure/msal-common/browser";
 import {
     TestTokenResponse,
-    TestAccounDetails,
+    TestAccountDetails,
     TestServerTokenResponse,
     TestHomeAccountId,
     TestTenantId,
@@ -156,7 +156,7 @@ describe("CustomAuthSilentCacheClient", () => {
             authority: customAuthConfig.auth.authority,
             correlationId: "test-correlation-id",
             scopes: defaultScopes,
-            account: TestAccounDetails,
+            account: TestAccountDetails,
             forceRefresh: false,
             storeInCache: {
                 idToken: true,
@@ -167,7 +167,7 @@ describe("CustomAuthSilentCacheClient", () => {
 
         beforeEach(() => {
             accountEntityToCache =
-                AccountEntity.createFromAccountInfo(TestAccounDetails);
+                AccountEntity.createFromAccountInfo(TestAccountDetails);
             accessTokenEntityToCache = createAccessTokenEntity(mockCrypto);
             refreshTokenEntityToCache = createRefreshTokenEntity();
 
@@ -431,7 +431,7 @@ function createAccessTokenEntity(browserCrypto: ICrypto): AccessTokenEntity {
 
     return CacheHelpers.createAccessTokenEntity(
         TestHomeAccountId,
-        TestAccounDetails.environment,
+        TestAccountDetails.environment,
         TestTokenResponse.ACCESS_TOKEN,
         customAuthConfig.auth.clientId,
         TestTenantId,
@@ -447,7 +447,7 @@ function createAccessTokenEntity(browserCrypto: ICrypto): AccessTokenEntity {
 function createRefreshTokenEntity(): RefreshTokenEntity {
     return CacheHelpers.createRefreshTokenEntity(
         TestHomeAccountId,
-        TestAccounDetails.environment,
+        TestAccountDetails.environment,
         TestServerTokenResponse.refresh_token,
         customAuthConfig.auth.clientId
     );
diff --git a/lib/msal-browser/test/custom_auth/test_resources/TestConstants.ts b/lib/msal-browser/test/custom_auth/test_resources/TestConstants.ts
@@ -19,7 +19,7 @@ export const TestTenantId = "d37e5645-4170-4ce0-a618-1b9008b14e58"; // fake tena
 export const TestUsername = "abc@test.com"; // fake username
 export const TestLoginHint = "loginHint"; // fake login hint
 
-export const TestAccounDetails = {
+export const TestAccountDetails = {
     homeAccountId: TestHomeAccountId,
     environment: "spasamples.ciamlogin.com",
     tenantId: TestTenantId,
diff --git a/lib/msal-browser/test/custom_auth/test_resources/TestModules.ts b/lib/msal-browser/test/custom_auth/test_resources/TestModules.ts
@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { ICrypto, IPerformanceClient, Logger } from "@azure/msal-common";
+import {
+    ICrypto,
+    IPerformanceClient,
+    Logger,
+} from "@azure/msal-common/browser";
 import { EventHandler } from "../../../src/event/EventHandler.js";
 import { CryptoOps } from "../../../src/crypto/CryptoOps.js";
 import { BrowserCacheManager } from "../../../src/cache/BrowserCacheManager.js";
