@azure/msal-browser 3.1.0 → 3.2.0

package/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/AzureAD/microsoft-authentication-library-for-js.git"
   },
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Microsoft Authentication Library for js",
   "keywords": [
     "implicit",
@@ -100,6 +100,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@azure/msal-common": "14.0.3"
+    "@azure/msal-common": "14.1.0"
   }
 }

package/src/app/IPublicClientApplication.ts

@@ -13,7 +13,10 @@ import { PopupRequest } from "../request/PopupRequest";
 import { SilentRequest } from "../request/SilentRequest";
 import { SsoSilentRequest } from "../request/SsoSilentRequest";
 import { EndSessionRequest } from "../request/EndSessionRequest";
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { WrapperSKU } from "../utils/BrowserConstants";
 import { INavigationClient } from "../navigation/INavigationClient";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
@@ -74,27 +77,37 @@ export interface IPublicClientApplication {
 export const stubbedPublicClientApplication: IPublicClientApplication = {
     initialize: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenSilent: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenByCode: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     getAllAccounts: () => {
@@ -111,37 +124,51 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
     },
     handleRedirectPromise: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     loginPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     loginRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logout: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logoutRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logoutPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     ssoSilent: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     addEventCallback: () => {
@@ -163,10 +190,14 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
         return;
     },
     getTokenCache: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     getLogger: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     setLogger: () => {
         return;
@@ -184,16 +215,22 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
         return;
     },
     getConfiguration: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     hydrateCache: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     clearCache: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
 };

package/src/app/PublicClientApplication.ts

@@ -15,6 +15,7 @@ import { IController } from "../controllers/IController";
 import {
     PerformanceCallbackFunction,
     AccountInfo,
+    AccountFilter,
     Logger,
 } from "@azure/msal-common";
 import { EndSessionRequest } from "../request/EndSessionRequest";
@@ -188,12 +189,22 @@ export class PublicClientApplication implements IPublicClientApplication {
         this.controller.disableAccountStorageEvents();
     }
 
+    /**
+     * Returns the first account found in the cache that matches the account filter passed in.
+     * @param accountFilter
+     * @returns The first account found in the cache matching the provided filter or null if no account could be found.
+     */
+    getAccount(accountFilter: AccountFilter): AccountInfo | null {
+        return this.controller.getAccount(accountFilter);
+    }
+
     /**
      * Returns the signed in account matching homeAccountId.
      * (the account object is created at the time of successful login)
      * or null when no matching account is found
      * @param homeAccountId
      * @returns The account object stored in MSAL
+     * @deprecated - Use getAccount instead
      */
     getAccountByHomeId(homeAccountId: string): AccountInfo | null {
         return this.controller.getAccountByHomeId(homeAccountId);
@@ -205,6 +216,7 @@ export class PublicClientApplication implements IPublicClientApplication {
      * or null when no matching account is found
      * @param localAccountId
      * @returns The account object stored in MSAL
+     * @deprecated - Use getAccount instead
      */
     getAccountByLocalId(localId: string): AccountInfo | null {
         return this.controller.getAccountByLocalId(localId);
@@ -217,19 +229,19 @@ export class PublicClientApplication implements IPublicClientApplication {
      * This API is provided for convenience but getAccountById should be used for best reliability
      * @param userName
      * @returns The account object stored in MSAL
+     * @deprecated - Use getAccount instead
      */
     getAccountByUsername(userName: string): AccountInfo | null {
         return this.controller.getAccountByUsername(userName);
     }
 
     /**
-     * Returns all accounts that MSAL currently has data for.
-     * (the account object is created at the time of successful login)
-     * or empty array when no accounts are found
-     * @returns Array of account objects in cache
+     * Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
+     * @param accountFilter - (Optional) filter to narrow down the accounts returned
+     * @returns Array of AccountInfo objects in cache
      */
-    getAllAccounts(): AccountInfo[] {
-        return this.controller.getAllAccounts();
+    getAllAccounts(accountFilter?: AccountFilter): AccountInfo[] {
+        return this.controller.getAllAccounts(accountFilter);
     }
 
     /**

package/src/broker/nativeBroker/NativeMessageHandler.ts

@@ -10,22 +10,24 @@ import {
 import {
     Logger,
     AuthError,
+    createAuthError,
+    AuthErrorCodes,
     AuthenticationScheme,
     InProgressPerformanceEvent,
     PerformanceEvents,
     IPerformanceClient,
-    ICrypto,
 } from "@azure/msal-common";
 import {
     NativeExtensionRequest,
     NativeExtensionRequestBody,
 } from "./NativeRequest";
-import { NativeAuthError } from "../../error/NativeAuthError";
+import { createNativeAuthError } from "../../error/NativeAuthError";
 import {
     createBrowserAuthError,
     BrowserAuthErrorCodes,
 } from "../../error/BrowserAuthError";
 import { BrowserConfiguration } from "../../config/Configuration";
+import { createNewGuid } from "../../crypto/BrowserCrypto";
 
 type ResponseResolvers<T> = {
     resolve: (value: T | PromiseLike<T>) => void;
@@ -38,7 +40,6 @@ export class NativeMessageHandler {
     private extensionId: string | undefined;
     private extensionVersion: string | undefined;
     private logger: Logger;
-    private crypto: ICrypto;
     private readonly handshakeTimeoutMs: number;
     private timeoutId: number | undefined;
     private resolvers: Map<string, ResponseResolvers<object>>;
@@ -52,7 +53,6 @@ export class NativeMessageHandler {
         logger: Logger,
         handshakeTimeoutMs: number,
         performanceClient: IPerformanceClient,
-        crypto: ICrypto,
         extensionId?: string
     ) {
         this.logger = logger;
@@ -66,7 +66,6 @@ export class NativeMessageHandler {
         this.handshakeEvent = performanceClient.startMeasurement(
             PerformanceEvents.NativeMessageHandlerHandshake
         );
-        this.crypto = crypto;
     }
 
     /**
@@ -78,7 +77,7 @@ export class NativeMessageHandler {
         const req: NativeExtensionRequest = {
             channel: NativeConstants.CHANNEL_ID,
             extensionId: this.extensionId,
-            responseId: this.crypto.createNewGuid(),
+            responseId: createNewGuid(),
             body: body,
         };
 
@@ -107,8 +106,7 @@ export class NativeMessageHandler {
     static async createProvider(
         logger: Logger,
         handshakeTimeoutMs: number,
-        performanceClient: IPerformanceClient,
-        crypto: ICrypto
+        performanceClient: IPerformanceClient
     ): Promise<NativeMessageHandler> {
         logger.trace("NativeMessageHandler - createProvider called.");
         try {
@@ -116,7 +114,6 @@ export class NativeMessageHandler {
                 logger,
                 handshakeTimeoutMs,
                 performanceClient,
-                crypto,
                 NativeConstants.PREFERRED_EXTENSION_ID
             );
             await preferredProvider.sendHandshakeRequest();
@@ -126,8 +123,7 @@ export class NativeMessageHandler {
             const backupProvider = new NativeMessageHandler(
                 logger,
                 handshakeTimeoutMs,
-                performanceClient,
-                crypto
+                performanceClient
             );
             await backupProvider.sendHandshakeRequest();
             return backupProvider;
@@ -147,7 +143,7 @@ export class NativeMessageHandler {
         const req: NativeExtensionRequest = {
             channel: NativeConstants.CHANNEL_ID,
             extensionId: this.extensionId,
-            responseId: this.crypto.createNewGuid(),
+            responseId: createNewGuid(),
             body: {
                 method: NativeExtensionMethod.HandshakeRequest,
             },
@@ -283,7 +279,7 @@ export class NativeMessageHandler {
                 );
                 if (response.status !== "Success") {
                     resolver.reject(
-                        NativeAuthError.createError(
+                        createNativeAuthError(
                             response.code,
                             response.description,
                             response.ext
@@ -295,7 +291,7 @@ export class NativeMessageHandler {
                         response.result["description"]
                     ) {
                         resolver.reject(
-                            NativeAuthError.createError(
+                            createNativeAuthError(
                                 response.result["code"],
                                 response.result["description"],
                                 response.result["ext"]
@@ -305,7 +301,8 @@ export class NativeMessageHandler {
                         resolver.resolve(response.result);
                     }
                 } else {
-                    throw AuthError.createUnexpectedError(
+                    throw createAuthError(
+                        AuthErrorCodes.unexpectedError,
                         "Event does not contain result."
                     );
                 }

package/src/broker/nativeBroker/NativeStatusCodes.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// Status Codes that can be thrown by WAM
+export const USER_INTERACTION_REQUIRED = "USER_INTERACTION_REQUIRED";
+export const USER_CANCEL = "USER_CANCEL";
+export const NO_NETWORK = "NO_NETWORK";
+export const TRANSIENT_ERROR = "TRANSIENT_ERROR";
+export const PERSISTENT_ERROR = "PERSISTENT_ERROR";
+export const DISABLED = "DISABLED";
+export const ACCOUNT_UNAVAILABLE = "ACCOUNT_UNAVAILABLE";

package/src/cache/BrowserCacheManager.ts

@@ -27,11 +27,14 @@ import {
     CcsCredentialType,
     AuthToken,
     ValidCredentialType,
-    ClientAuthError,
     TokenKeys,
     CredentialType,
     CacheRecord,
     AuthenticationScheme,
+    createClientAuthError,
+    ClientAuthErrorCodes,
+    PerformanceEvents,
+    IPerformanceClient,
 } from "@azure/msal-common";
 import { CacheOptions } from "../config/Configuration";
 import {
@@ -614,7 +617,9 @@ export class BrowserCacheManager extends CacheManager {
                 this.logger.error(
                     `BrowserCacheManager:addTokenKey - CredentialType provided invalid. CredentialType: ${type}`
                 );
-                ClientAuthError.createUnexpectedCredentialTypeError();
+                throw createClientAuthError(
+                    ClientAuthErrorCodes.unexpectedCredentialType
+                );
         }
 
         this.setItem(
@@ -685,7 +690,9 @@ export class BrowserCacheManager extends CacheManager {
                 this.logger.error(
                     `BrowserCacheManager:removeTokenKey - CredentialType provided invalid. CredentialType: ${type}`
                 );
-                ClientAuthError.createUnexpectedCredentialTypeError();
+                throw createClientAuthError(
+                    ClientAuthErrorCodes.unexpectedCredentialType
+                );
         }
 
         this.setItem(
@@ -1171,7 +1178,9 @@ export class BrowserCacheManager extends CacheManager {
         if (matchingAccounts.length === 1) {
             return matchingAccounts[0];
         } else if (matchingAccounts.length > 1) {
-            throw ClientAuthError.createMultipleMatchingAccountsInCacheError();
+            throw createClientAuthError(
+                ClientAuthErrorCodes.multipleMatchingAccounts
+            );
         }
 
         return null;
@@ -1353,10 +1362,16 @@ export class BrowserCacheManager extends CacheManager {
 
     /**
      * Clears all access tokes that have claims prior to saving the current one
-     * @param credential
+     * @param performanceClient {IPerformanceClient}
      * @returns
      */
-    async clearTokensAndKeysWithClaims(): Promise<void> {
+    async clearTokensAndKeysWithClaims(
+        performanceClient: IPerformanceClient
+    ): Promise<void> {
+        performanceClient.addQueueMeasurement(
+            PerformanceEvents.ClearTokensAndKeysWithClaims
+        );
+
         const tokenKeys = this.getTokenKeys();
 
         const removedAccessTokens: Array<Promise<void>> = [];

package/src/cache/BrowserStorage.ts

@@ -3,7 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { BrowserCacheLocation } from "../utils/BrowserConstants";
 import { IWindowStorage } from "./IWindowStorage";
 
@@ -17,17 +20,12 @@ export class BrowserStorage implements IWindowStorage<string> {
 
     private validateWindowStorage(cacheLocation: string): void {
         if (
-            cacheLocation !== BrowserCacheLocation.LocalStorage &&
-            cacheLocation !== BrowserCacheLocation.SessionStorage
+            (cacheLocation !== BrowserCacheLocation.LocalStorage &&
+                cacheLocation !== BrowserCacheLocation.SessionStorage) ||
+            !window[cacheLocation]
         ) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
-            );
-        }
-        const storageSupported = !!window[cacheLocation];
-        if (!storageSupported) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
+            throw createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.storageNotSupported
             );
         }
     }

package/src/config/Configuration.ts

@@ -17,9 +17,11 @@ import {
     AzureCloudInstance,
     AzureCloudOptions,
     ApplicationTelemetry,
-    ClientConfigurationError,
+    createClientConfigurationError,
+    ClientConfigurationErrorCodes,
     IPerformanceClient,
     StubPerformanceClient,
+    Logger,
 } from "@azure/msal-common";
 import {
     BrowserCacheLocation,
@@ -323,7 +325,8 @@ export function buildConfiguration(
         pollIntervalMilliseconds: BrowserConstants.DEFAULT_POLL_INTERVAL_MS,
     };
 
-    const providedSystemOptions: BrowserSystemOptions = {
+    const providedSystemOptions: Required<BrowserSystemOptions> = {
+        ...DEFAULT_BROWSER_SYSTEM_OPTIONS,
         ...userInputSystem,
         loggerOptions: userInputSystem?.loggerOptions || DEFAULT_LOGGER_OPTIONS,
     };
@@ -341,10 +344,13 @@ export function buildConfiguration(
         userInputAuth?.protocolMode !== ProtocolMode.OIDC &&
         userInputAuth?.OIDCOptions
     ) {
-        // Logger has not been created yet
-        // eslint-disable-next-line no-console
-        console.warn(
-            ClientConfigurationError.createCannotSetOIDCOptionsError()
+        const logger = new Logger(providedSystemOptions.loggerOptions);
+        logger.warning(
+            JSON.stringify(
+                createClientConfigurationError(
+                    ClientConfigurationErrorCodes.cannotSetOIDCOptions
+                )
+            )
         );
     }
 
@@ -354,7 +360,9 @@ export function buildConfiguration(
         userInputAuth.protocolMode !== ProtocolMode.AAD &&
         providedSystemOptions?.allowNativeBroker
     ) {
-        throw ClientConfigurationError.createCannotAllowNativeBrokerError();
+        throw createClientConfigurationError(
+            ClientConfigurationErrorCodes.cannotAllowNativeBroker
+        );
     }
 
     const overlayedConfig: BrowserConfiguration = {
@@ -367,7 +375,7 @@ export function buildConfiguration(
             },
         },
         cache: { ...DEFAULT_CACHE_OPTIONS, ...userInputCache },
-        system: { ...DEFAULT_BROWSER_SYSTEM_OPTIONS, ...providedSystemOptions },
+        system: providedSystemOptions,
         telemetry: { ...DEFAULT_TELEMETRY_OPTIONS, ...userInputTelemetry },
     };
 

package/src/controllers/IController.ts

@@ -9,6 +9,7 @@ import {
     PerformanceCallbackFunction,
     IPerformanceClient,
     CommonSilentFlowRequest,
+    AccountFilter,
 } from "@azure/msal-common";
 import { RedirectRequest } from "../request/RedirectRequest";
 import { PopupRequest } from "../request/PopupRequest";
@@ -64,13 +65,15 @@ export interface IController {
 
     disableAccountStorageEvents(): void;
 
+    getAccount(accountFilter: AccountFilter): AccountInfo | null;
+
     getAccountByHomeId(homeAccountId: string): AccountInfo | null;
 
     getAccountByLocalId(localId: string): AccountInfo | null;
 
     getAccountByUsername(userName: string): AccountInfo | null;
 
-    getAllAccounts(): AccountInfo[];
+    getAllAccounts(accountFilter?: AccountFilter): AccountInfo[];
 
     handleRedirectPromise(hash?: string): Promise<AuthenticationResult | null>;