@azure/msal-browser 3.3.0 → 3.5.0

package/package.json

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

package/src/app/PublicClientApplication.ts

@@ -20,7 +20,7 @@ import {
 } from "@azure/msal-common";
 import { EndSessionRequest } from "../request/EndSessionRequest";
 import { SsoSilentRequest } from "../request/SsoSilentRequest";
-import { ControllerFactory } from "../controllers/ControllerFactory";
+import * as ControllerFactory from "../controllers/ControllerFactory";
 import { StandardController } from "../controllers/StandardController";
 import { BrowserConfiguration, Configuration } from "../config/Configuration";
 import { StandardOperatingContext } from "../operatingcontext/StandardOperatingContext";
@@ -38,8 +38,9 @@ export class PublicClientApplication implements IPublicClientApplication {
     public static async createPublicClientApplication(
         configuration: Configuration
     ): Promise<IPublicClientApplication> {
-        const factory = new ControllerFactory(configuration);
-        const controller = await factory.createV3Controller();
+        const controller = await ControllerFactory.createV3Controller(
+            configuration
+        );
         const pca = new PublicClientApplication(configuration, controller);
 
         return pca;

package/src/app/PublicClientNext.ts

@@ -20,7 +20,7 @@ import {
 } from "@azure/msal-common";
 import { EndSessionRequest } from "../request/EndSessionRequest";
 import { SsoSilentRequest } from "../request/SsoSilentRequest";
-import { ControllerFactory } from "../controllers/ControllerFactory";
+import * as ControllerFactory from "../controllers/ControllerFactory";
 import { BrowserConfiguration, Configuration } from "../config/Configuration";
 import { EventCallbackFunction } from "../event/EventMessage";
 import { ClearCacheRequest } from "../request/ClearCacheRequest";
@@ -47,8 +47,9 @@ export class PublicClientNext implements IPublicClientApplication {
     public static async createPublicClientApplication(
         configuration: Configuration
     ): Promise<IPublicClientApplication> {
-        const factory = new ControllerFactory(configuration);
-        const controller = await factory.createController();
+        const controller = await ControllerFactory.createController(
+            configuration
+        );
         let pca;
         if (controller !== null) {
             pca = new PublicClientNext(configuration, controller);
@@ -100,8 +101,9 @@ export class PublicClientNext implements IPublicClientApplication {
      */
     async initialize(): Promise<void> {
         if (this.controller instanceof UnknownOperatingContextController) {
-            const factory = new ControllerFactory(this.configuration);
-            const result = await factory.createController();
+            const result = await ControllerFactory.createController(
+                this.configuration
+            );
             if (result !== null) {
                 this.controller = result;
             }

package/src/cache/BrowserCacheManager.ts

@@ -36,6 +36,7 @@ import {
     PerformanceEvents,
     IPerformanceClient,
     StaticAuthorityOptions,
+    CacheHelpers,
 } from "@azure/msal-common";
 import { CacheOptions } from "../config/Configuration";
 import {
@@ -52,7 +53,7 @@ import {
 import { BrowserStorage } from "./BrowserStorage";
 import { MemoryStorage } from "./MemoryStorage";
 import { IWindowStorage } from "./IWindowStorage";
-import { BrowserProtocolUtils } from "../utils/BrowserProtocolUtils";
+import { extractBrowserRequestState } from "../utils/BrowserProtocolUtils";
 import { NativeTokenRequest } from "../broker/nativeBroker/NativeRequest";
 import { AuthenticationResult } from "../response/AuthenticationResult";
 import { SilentRequest } from "../request/SilentRequest";
@@ -234,17 +235,15 @@ export class BrowserCacheManager extends CacheManager {
                     if (credObj && credObj.hasOwnProperty("credentialType")) {
                         switch (credObj["credentialType"]) {
                             case CredentialType.ID_TOKEN:
-                                if (IdTokenEntity.isIdTokenEntity(credObj)) {
+                                if (CacheHelpers.isIdTokenEntity(credObj)) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - idToken found, saving key to token key map"
                                     );
                                     this.logger.tracePii(
                                         `BrowserCacheManager:createKeyMaps - idToken with key: ${key} found, saving key to token key map`
                                     );
-                                    const idTokenEntity = CacheManager.toObject(
-                                        new IdTokenEntity(),
-                                        credObj
-                                    );
+                                    const idTokenEntity =
+                                        credObj as IdTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -266,11 +265,7 @@ export class BrowserCacheManager extends CacheManager {
                                 break;
                             case CredentialType.ACCESS_TOKEN:
                             case CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME:
-                                if (
-                                    AccessTokenEntity.isAccessTokenEntity(
-                                        credObj
-                                    )
-                                ) {
+                                if (CacheHelpers.isAccessTokenEntity(credObj)) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - accessToken found, saving key to token key map"
                                     );
@@ -278,10 +273,7 @@ export class BrowserCacheManager extends CacheManager {
                                         `BrowserCacheManager:createKeyMaps - accessToken with key: ${key} found, saving key to token key map`
                                     );
                                     const accessTokenEntity =
-                                        CacheManager.toObject(
-                                            new AccessTokenEntity(),
-                                            credObj
-                                        );
+                                        credObj as AccessTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -303,9 +295,7 @@ export class BrowserCacheManager extends CacheManager {
                                 break;
                             case CredentialType.REFRESH_TOKEN:
                                 if (
-                                    RefreshTokenEntity.isRefreshTokenEntity(
-                                        credObj
-                                    )
+                                    CacheHelpers.isRefreshTokenEntity(credObj)
                                 ) {
                                     this.logger.trace(
                                         "BrowserCacheManager:createKeyMaps - refreshToken found, saving key to token key map"
@@ -314,10 +304,7 @@ export class BrowserCacheManager extends CacheManager {
                                         `BrowserCacheManager:createKeyMaps - refreshToken with key: ${key} found, saving key to token key map`
                                     );
                                     const refreshTokenEntity =
-                                        CacheManager.toObject(
-                                            new RefreshTokenEntity(),
-                                            credObj
-                                        );
+                                        credObj as RefreshTokenEntity;
                                     const newKey =
                                         this.updateCredentialCacheKey(
                                             key,
@@ -718,7 +705,7 @@ export class BrowserCacheManager extends CacheManager {
         }
 
         const parsedIdToken = this.validateAndParseJson(value);
-        if (!parsedIdToken || !IdTokenEntity.isIdTokenEntity(parsedIdToken)) {
+        if (!parsedIdToken || !CacheHelpers.isIdTokenEntity(parsedIdToken)) {
             this.logger.trace(
                 "BrowserCacheManager.getIdTokenCredential: called, no cache hit"
             );
@@ -729,7 +716,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getIdTokenCredential: cache hit"
         );
-        return CacheManager.toObject(new IdTokenEntity(), parsedIdToken);
+        return parsedIdToken as IdTokenEntity;
     }
 
     /**
@@ -738,7 +725,7 @@ export class BrowserCacheManager extends CacheManager {
      */
     setIdTokenCredential(idToken: IdTokenEntity): void {
         this.logger.trace("BrowserCacheManager.setIdTokenCredential called");
-        const idTokenKey = idToken.generateCredentialKey();
+        const idTokenKey = CacheHelpers.generateCredentialKey(idToken);
 
         this.setItem(idTokenKey, JSON.stringify(idToken));
 
@@ -761,7 +748,7 @@ export class BrowserCacheManager extends CacheManager {
         const parsedAccessToken = this.validateAndParseJson(value);
         if (
             !parsedAccessToken ||
-            !AccessTokenEntity.isAccessTokenEntity(parsedAccessToken)
+            !CacheHelpers.isAccessTokenEntity(parsedAccessToken)
         ) {
             this.logger.trace(
                 "BrowserCacheManager.getAccessTokenCredential: called, no cache hit"
@@ -773,10 +760,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getAccessTokenCredential: cache hit"
         );
-        return CacheManager.toObject(
-            new AccessTokenEntity(),
-            parsedAccessToken
-        );
+        return parsedAccessToken as AccessTokenEntity;
     }
 
     /**
@@ -787,7 +771,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.setAccessTokenCredential called"
         );
-        const accessTokenKey = accessToken.generateCredentialKey();
+        const accessTokenKey = CacheHelpers.generateCredentialKey(accessToken);
         this.setItem(accessTokenKey, JSON.stringify(accessToken));
 
         this.addTokenKey(accessTokenKey, CredentialType.ACCESS_TOKEN);
@@ -811,7 +795,7 @@ export class BrowserCacheManager extends CacheManager {
         const parsedRefreshToken = this.validateAndParseJson(value);
         if (
             !parsedRefreshToken ||
-            !RefreshTokenEntity.isRefreshTokenEntity(parsedRefreshToken)
+            !CacheHelpers.isRefreshTokenEntity(parsedRefreshToken)
         ) {
             this.logger.trace(
                 "BrowserCacheManager.getRefreshTokenCredential: called, no cache hit"
@@ -823,10 +807,7 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.getRefreshTokenCredential: cache hit"
         );
-        return CacheManager.toObject(
-            new RefreshTokenEntity(),
-            parsedRefreshToken
-        );
+        return parsedRefreshToken as RefreshTokenEntity;
     }
 
     /**
@@ -837,7 +818,8 @@ export class BrowserCacheManager extends CacheManager {
         this.logger.trace(
             "BrowserCacheManager.setRefreshTokenCredential called"
         );
-        const refreshTokenKey = refreshToken.generateCredentialKey();
+        const refreshTokenKey =
+            CacheHelpers.generateCredentialKey(refreshToken);
         this.setItem(refreshTokenKey, JSON.stringify(refreshToken));
 
         this.addTokenKey(refreshTokenKey, CredentialType.REFRESH_TOKEN);
@@ -898,12 +880,12 @@ export class BrowserCacheManager extends CacheManager {
             );
             return null;
         }
-        const parsedMetadata = this.validateAndParseJson(value);
+        const parsedEntity = this.validateAndParseJson(value);
         if (
-            !parsedMetadata ||
-            !ServerTelemetryEntity.isServerTelemetryEntity(
+            !parsedEntity ||
+            !CacheHelpers.isServerTelemetryEntity(
                 serverTelemetryKey,
-                parsedMetadata
+                parsedEntity
             )
         ) {
             this.logger.trace(
@@ -913,10 +895,7 @@ export class BrowserCacheManager extends CacheManager {
         }
 
         this.logger.trace("BrowserCacheManager.getServerTelemetry: cache hit");
-        return CacheManager.toObject(
-            new ServerTelemetryEntity(),
-            parsedMetadata
-        );
+        return parsedEntity as ServerTelemetryEntity;
     }
 
     /**
@@ -1605,7 +1584,7 @@ export class BrowserCacheManager extends CacheManager {
                 return;
             }
             // Extract state and ensure it matches given InteractionType, then clean request cache
-            const parsedState = BrowserProtocolUtils.extractBrowserRequestState(
+            const parsedState = extractBrowserRequestState(
                 this.cryptoImpl,
                 stateValue
             );
@@ -1804,7 +1783,7 @@ export class BrowserCacheManager extends CacheManager {
         currentCacheKey: string,
         credential: ValidCredentialType
     ): string {
-        const updatedCacheKey = credential.generateCredentialKey();
+        const updatedCacheKey = CacheHelpers.generateCredentialKey(credential);
 
         if (currentCacheKey !== updatedCacheKey) {
             const cacheItem = this.getItem(currentCacheKey);
@@ -1860,7 +1839,7 @@ export class BrowserCacheManager extends CacheManager {
             | RedirectRequest
             | PopupRequest
     ): Promise<void> {
-        const idTokenEntity = IdTokenEntity.createIdTokenEntity(
+        const idTokenEntity = CacheHelpers.createIdTokenEntity(
             result.account?.homeAccountId,
             result.account?.environment,
             result.idToken,
@@ -1872,7 +1851,7 @@ export class BrowserCacheManager extends CacheManager {
         if (request.claims) {
             claimsHash = await this.cryptoImpl.hashString(request.claims);
         }
-        const accessTokenEntity = AccessTokenEntity.createAccessTokenEntity(
+        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(
             result.account?.homeAccountId,
             result.account.environment,
             result.accessToken,
@@ -1881,7 +1860,7 @@ export class BrowserCacheManager extends CacheManager {
             result.scopes.join(" "),
             result.expiresOn?.getTime() || 0,
             result.extExpiresOn?.getTime() || 0,
-            this.cryptoImpl,
+            base64Decode,
             undefined, // refreshOn
             result.tokenType as AuthenticationScheme,
             undefined, // userAssertionHash

package/src/cache/TokenCache.ts

@@ -18,6 +18,7 @@ import {
     Constants,
     CacheRecord,
     TokenClaims,
+    CacheHelpers,
 } from "@azure/msal-common";
 import { BrowserConfiguration } from "../config/Configuration";
 import { SilentRequest } from "../request/SilentRequest";
@@ -294,7 +295,7 @@ export class TokenCache implements ITokenCache {
         environment: string,
         tenantId: string
     ): IdTokenEntity {
-        const idTokenEntity = IdTokenEntity.createIdTokenEntity(
+        const idTokenEntity = CacheHelpers.createIdTokenEntity(
             homeAccountId,
             environment,
             idToken,
@@ -355,7 +356,7 @@ export class TokenCache implements ITokenCache {
             response.expires_in + new Date().getTime() / 1000;
         const extendedExpiresOn = options.extendedExpiresOn;
 
-        const accessTokenEntity = AccessTokenEntity.createAccessTokenEntity(
+        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(
             homeAccountId,
             environment,
             response.access_token,
@@ -364,7 +365,7 @@ export class TokenCache implements ITokenCache {
             scopes,
             expiresOn,
             extendedExpiresOn,
-            this.cryptoObj
+            base64Decode
         );
 
         if (this.isBrowserEnvironment) {
@@ -399,7 +400,7 @@ export class TokenCache implements ITokenCache {
             return null;
         }
 
-        const refreshTokenEntity = RefreshTokenEntity.createRefreshTokenEntity(
+        const refreshTokenEntity = CacheHelpers.createRefreshTokenEntity(
             homeAccountId,
             environment,
             response.refresh_token,

package/src/controllers/ControllerFactory.ts

@@ -6,61 +6,42 @@
 import { TeamsAppOperatingContext } from "../operatingcontext/TeamsAppOperatingContext";
 import { StandardOperatingContext } from "../operatingcontext/StandardOperatingContext";
 import { IController } from "./IController";
-import { Logger } from "@azure/msal-common";
 import { Configuration } from "../config/Configuration";
-import { version, name } from "../packageMetadata";
 
-export class ControllerFactory {
-    protected config: Configuration;
-    protected logger: Logger;
+export async function createV3Controller(
+    config: Configuration
+): Promise<IController> {
+    const standard = new StandardOperatingContext(config);
 
-    constructor(config: Configuration) {
-        this.config = config;
-        const loggerOptions = {
-            loggerCallback: undefined,
-            piiLoggingEnabled: false,
-            logLevel: undefined,
-            correlationId: undefined,
-        };
-        this.logger = new Logger(loggerOptions, name, version);
-    }
-
-    async createV3Controller(): Promise<IController> {
-        const standard = new StandardOperatingContext(this.config);
+    await standard.initialize();
 
-        await standard.initialize();
+    const controller = await import("./StandardController");
+    return await controller.StandardController.createController(standard);
+}
 
+export async function createController(
+    config: Configuration
+): Promise<IController | null> {
+    const standard = new StandardOperatingContext(config);
+    const teamsApp = new TeamsAppOperatingContext(config);
+
+    const operatingContexts = [standard.initialize(), teamsApp.initialize()];
+
+    await Promise.all(operatingContexts);
+
+    if (
+        teamsApp.isAvailable() &&
+        teamsApp.getConfig().auth.supportsNestedAppAuth
+    ) {
+        const controller = await import("./NestedAppAuthController");
+        return await controller.NestedAppAuthController.createController(
+            teamsApp
+        );
+    } else if (standard.isAvailable()) {
         const controller = await import("./StandardController");
         return await controller.StandardController.createController(standard);
-    }
-
-    async createController(): Promise<IController | null> {
-        const standard = new StandardOperatingContext(this.config);
-        const teamsApp = new TeamsAppOperatingContext(this.config);
-
-        const operatingContexts = [
-            standard.initialize(),
-            teamsApp.initialize(),
-        ];
-
-        await Promise.all(operatingContexts);
-
-        if (
-            teamsApp.isAvailable() &&
-            teamsApp.getConfig().auth.supportsNestedAppAuth
-        ) {
-            const controller = await import("./NestedAppAuthController");
-            return await controller.NestedAppAuthController.createController(
-                teamsApp
-            );
-        } else if (standard.isAvailable()) {
-            const controller = await import("./StandardController");
-            return await controller.StandardController.createController(
-                standard
-            );
-        } else {
-            // Since neither of the actual operating contexts are available keep the UnknownOperatingContextController
-            return null;
-        }
+    } else {
+        // Since neither of the actual operating contexts are available keep the UnknownOperatingContextController
+        return null;
     }
 }

package/src/controllers/IController.ts

@@ -8,7 +8,6 @@ import {
     Logger,
     PerformanceCallbackFunction,
     IPerformanceClient,
-    CommonSilentFlowRequest,
     AccountFilter,
 } from "@azure/msal-common";
 import { RedirectRequest } from "../request/RedirectRequest";
@@ -48,11 +47,6 @@ export interface IController {
         accountId?: string
     ): Promise<AuthenticationResult>;
 
-    acquireTokenByRefreshToken(
-        commonRequest: CommonSilentFlowRequest,
-        silentRequest: SilentRequest
-    ): Promise<AuthenticationResult>;
-
     addEventCallback(callback: EventCallbackFunction): string | null;
 
     removeEventCallback(callbackId: string): void;