@azure/msal-browser 3.6.0 → 3.7.0

package/src/naa/mapping/NestedAppAuthAdapter.ts

@@ -7,7 +7,6 @@ import { TokenRequest } from "../TokenRequest";
 import { AccountInfo as NaaAccountInfo } from "../AccountInfo";
 import { RedirectRequest } from "../../request/RedirectRequest";
 import { PopupRequest } from "../../request/PopupRequest";
-import { TokenResponse } from "../TokenResponse";
 import {
     AccountInfo as MsalAccountInfo,
     AuthError,
@@ -29,6 +28,7 @@ import { isBridgeError } from "../BridgeError";
 import { BridgeStatusCode } from "../BridgeStatusCode";
 import { AuthenticationResult } from "../../response/AuthenticationResult";
 import {} from "../../error/BrowserAuthErrorCodes";
+import { AuthResult } from "../AuthResult";
 
 export class NestedAppAuthAdapter {
     protected crypto: ICrypto;
@@ -66,7 +66,7 @@ export class NestedAppAuthAdapter {
             this.clientCapabilities
         );
         const tokenRequest: TokenRequest = {
-            userObjectId: request.account?.homeAccountId,
+            platformBrokerId: request.account?.homeAccountId,
             clientId: this.clientId,
             authority: request.authority,
             scope: request.scopes.join(" "),
@@ -74,7 +74,6 @@ export class NestedAppAuthAdapter {
                 request.correlationId !== undefined
                     ? request.correlationId
                     : this.crypto.createNewGuid(),
-            nonce: request.nonce,
             claims: !StringUtils.isEmptyObj(claims) ? claims : undefined,
             state: request.state,
             authenticationScheme:
@@ -87,34 +86,35 @@ export class NestedAppAuthAdapter {
 
     public fromNaaTokenResponse(
         request: TokenRequest,
-        response: TokenResponse,
+        response: AuthResult,
         reqTimestamp: number
     ): AuthenticationResult {
-        if (!response.id_token || !response.access_token) {
+        if (!response.token.id_token || !response.token.access_token) {
             throw createClientAuthError(ClientAuthErrorCodes.nullOrEmptyToken);
         }
 
         const expiresOn = new Date(
-            (reqTimestamp + (response.expires_in || 0)) * 1000
+            (reqTimestamp + (response.token.expires_in || 0)) * 1000
         );
         const idTokenClaims = AuthToken.extractTokenClaims(
-            response.id_token,
+            response.token.id_token,
             this.crypto.base64Decode
         );
         const account = this.fromNaaAccountInfo(
             response.account,
             idTokenClaims
         );
+        const scopes = response.token.scope || request.scope;
 
         const authenticationResult: AuthenticationResult = {
-            authority: response.authority || account.environment,
+            authority: response.token.authority || account.environment,
             uniqueId: account.localAccountId,
             tenantId: account.tenantId,
-            scopes: response.scope.split(" "),
+            scopes: scopes.split(" "),
             account,
-            idToken: response.id_token !== undefined ? response.id_token : "",
+            idToken: response.token.id_token,
             idTokenClaims,
-            accessToken: response.access_token,
+            accessToken: response.token.access_token,
             fromCache: true,
             expiresOn: expiresOn,
             tokenType:
@@ -204,32 +204,32 @@ export class NestedAppAuthAdapter {
         | InteractionRequiredAuthError {
         if (isBridgeError(error)) {
             switch (error.status) {
-                case BridgeStatusCode.USER_CANCEL:
+                case BridgeStatusCode.UserCancel:
                     return new ClientAuthError(
                         ClientAuthErrorCodes.userCanceled
                     );
-                case BridgeStatusCode.NO_NETWORK:
+                case BridgeStatusCode.NoNetwork:
                     return new ClientAuthError(
                         ClientAuthErrorCodes.noNetworkConnectivity
                     );
-                case BridgeStatusCode.ACCOUNT_UNAVAILABLE:
+                case BridgeStatusCode.AccountUnavailable:
                     return new ClientAuthError(
                         ClientAuthErrorCodes.noAccountFound
                     );
-                case BridgeStatusCode.DISABLED:
+                case BridgeStatusCode.Disabled:
                     return new ClientAuthError(
                         ClientAuthErrorCodes.nestedAppAuthBridgeDisabled
                     );
-                case BridgeStatusCode.NESTED_APP_AUTH_UNAVAILABLE:
+                case BridgeStatusCode.NestedAppAuthUnavailable:
                     return new ClientAuthError(
                         error.code ||
                             ClientAuthErrorCodes.nestedAppAuthBridgeDisabled,
                         error.description
                     );
-                case BridgeStatusCode.TRANSIENT_ERROR:
-                case BridgeStatusCode.PERSISTENT_ERROR:
+                case BridgeStatusCode.TransientError:
+                case BridgeStatusCode.PersistentError:
                     return new ServerError(error.code, error.description);
-                case BridgeStatusCode.USER_INTERACTION_REQUIRED:
+                case BridgeStatusCode.UserInteractionRequired:
                     return new InteractionRequiredAuthError(
                         error.code,
                         error.description

package/src/operatingcontext/BaseOperatingContext.ts

@@ -3,13 +3,18 @@
  * Licensed under the MIT License.
  */
 
-import { Logger } from "@azure/msal-common";
+import { Logger, LogLevel } from "@azure/msal-common";
 import {
     BrowserConfiguration,
     buildConfiguration,
     Configuration,
 } from "../config/Configuration";
 import { version, name } from "../packageMetadata";
+import {
+    BrowserCacheLocation,
+    LOG_LEVEL_CACHE_KEY,
+    LOG_PII_CACHE_KEY,
+} from "../utils/BrowserConstants";
 
 /**
  * Base class for operating context
@@ -24,6 +29,31 @@ export abstract class BaseOperatingContext {
     protected available: boolean;
     protected browserEnvironment: boolean;
 
+    protected static loggerCallback(level: LogLevel, message: string): void {
+        switch (level) {
+            case LogLevel.Error:
+                // eslint-disable-next-line no-console
+                console.error(message);
+                return;
+            case LogLevel.Info:
+                // eslint-disable-next-line no-console
+                console.info(message);
+                return;
+            case LogLevel.Verbose:
+                // eslint-disable-next-line no-console
+                console.debug(message);
+                return;
+            case LogLevel.Warning:
+                // eslint-disable-next-line no-console
+                console.warn(message);
+                return;
+            default:
+                // eslint-disable-next-line no-console
+                console.log(message);
+                return;
+        }
+    }
+
     constructor(config: Configuration) {
         /*
          * If loaded in an environment where window is not available,
@@ -31,13 +61,40 @@ export abstract class BaseOperatingContext {
          * This is to support server-side rendering environments.
          */
         this.browserEnvironment = typeof window !== "undefined";
-
         this.config = buildConfiguration(config, this.browserEnvironment);
-        this.logger = new Logger(
-            this.config.system.loggerOptions,
-            name,
-            version
-        );
+
+        let sessionStorage: Storage | undefined;
+        try {
+            sessionStorage = window[BrowserCacheLocation.SessionStorage];
+            // Mute errors if it's a non-browser environment or cookies are blocked.
+        } catch (e) {}
+
+        const logLevelKey = sessionStorage?.getItem(LOG_LEVEL_CACHE_KEY);
+        const piiLoggingKey = sessionStorage
+            ?.getItem(LOG_PII_CACHE_KEY)
+            ?.toLowerCase();
+
+        const piiLoggingEnabled =
+            piiLoggingKey === "true"
+                ? true
+                : piiLoggingKey === "false"
+                ? false
+                : undefined;
+        const loggerOptions = { ...this.config.system.loggerOptions };
+
+        const logLevel =
+            logLevelKey && Object.keys(LogLevel).includes(logLevelKey)
+                ? LogLevel[logLevelKey]
+                : undefined;
+        if (logLevel) {
+            loggerOptions.loggerCallback = BaseOperatingContext.loggerCallback;
+            loggerOptions.logLevel = logLevel;
+        }
+        if (piiLoggingEnabled !== undefined) {
+            loggerOptions.piiLoggingEnabled = piiLoggingEnabled;
+        }
+
+        this.logger = new Logger(loggerOptions, name, version);
         this.available = false;
     }
 

package/src/packageMetadata.ts

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

package/src/telemetry/BrowserPerformanceClient.ts

@@ -4,20 +4,65 @@
  */
 
 import {
+    Constants,
+    InProgressPerformanceEvent,
+    IPerformanceClient,
     Logger,
+    PerformanceClient,
     PerformanceEvent,
     PerformanceEvents,
-    IPerformanceClient,
-    PerformanceClient,
-    IPerformanceMeasurement,
-    InProgressPerformanceEvent,
-    SubMeasurement,
     PreQueueEvent,
-    Constants,
+    SubMeasurement,
 } from "@azure/msal-common";
-import { BrowserPerformanceMeasurement } from "./BrowserPerformanceMeasurement";
 import { Configuration } from "../config/Configuration";
 import { name, version } from "../packageMetadata";
+import {
+    BROWSER_PERF_ENABLED_KEY,
+    BrowserCacheLocation,
+} from "../utils/BrowserConstants";
+
+/**
+ * Returns browser performance measurement module if session flag is enabled. Returns undefined otherwise.
+ */
+function getPerfMeasurementModule() {
+    let sessionStorage: Storage | undefined;
+    try {
+        sessionStorage = window[BrowserCacheLocation.SessionStorage];
+        const perfEnabled = sessionStorage?.getItem(BROWSER_PERF_ENABLED_KEY);
+        if (Number(perfEnabled) === 1) {
+            return import("./BrowserPerformanceMeasurement");
+        }
+        // Mute errors if it's a non-browser environment or cookies are blocked.
+    } catch (e) {}
+
+    return undefined;
+}
+
+/**
+ * Returns boolean, indicating whether browser supports window.performance.now() function.
+ */
+function supportsBrowserPerformanceNow(): boolean {
+    return (
+        typeof window !== "undefined" &&
+        typeof window.performance !== "undefined" &&
+        typeof window.performance.now === "function"
+    );
+}
+
+/**
+ * Returns event duration in milliseconds using window performance API if available. Returns undefined otherwise.
+ * @param startTime {DOMHighResTimeStamp | undefined}
+ * @returns {number | undefined}
+ */
+function getPerfDurationMs(
+    startTime: DOMHighResTimeStamp | undefined
+): number | undefined {
+    if (!startTime || !supportsBrowserPerformanceNow()) {
+        return undefined;
+    }
+
+    return Math.round(window.performance.now() - startTime);
+}
 
 export class BrowserPerformanceClient
     extends PerformanceClient
@@ -42,13 +87,6 @@ export class BrowserPerformanceClient
         );
     }
 
-    startPerformanceMeasurement(
-        measureName: string,
-        correlationId: string
-    ): IPerformanceMeasurement {
-        return new BrowserPerformanceMeasurement(measureName, correlationId);
-    }
-
     generateId(): string {
         return window.crypto.randomUUID();
     }
@@ -60,32 +98,27 @@ export class BrowserPerformanceClient
     private deleteIncompleteSubMeasurements(
         inProgressEvent: InProgressPerformanceEvent
     ): void {
-        const rootEvent = this.eventsByCorrelationId.get(
-            inProgressEvent.event.correlationId
-        );
-        const isRootEvent =
-            rootEvent && rootEvent.eventId === inProgressEvent.event.eventId;
-        const incompleteMeasurements: SubMeasurement[] = [];
-        if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
-            rootEvent.incompleteSubMeasurements.forEach((subMeasurement) => {
-                incompleteMeasurements.push({ ...subMeasurement });
-            });
-        }
-        // Clean up remaining marks for incomplete sub-measurements
-        if (incompleteMeasurements.length > 0) {
-            BrowserPerformanceMeasurement.flushMeasurements(
+        void getPerfMeasurementModule()?.then((module) => {
+            const rootEvent = this.eventsByCorrelationId.get(
+                inProgressEvent.event.correlationId
+            );
+            const isRootEvent =
+                rootEvent &&
+                rootEvent.eventId === inProgressEvent.event.eventId;
+            const incompleteMeasurements: SubMeasurement[] = [];
+            if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
+                rootEvent.incompleteSubMeasurements.forEach(
+                    (subMeasurement: SubMeasurement) => {
+                        incompleteMeasurements.push({ ...subMeasurement });
+                    }
+                );
+            }
+            // Clean up remaining marks for incomplete sub-measurements
+            module.BrowserPerformanceMeasurement.flushMeasurements(
                 inProgressEvent.event.correlationId,
                 incompleteMeasurements
             );
-        }
-    }
-
-    supportsBrowserPerformanceNow(): boolean {
-        return (
-            typeof window !== "undefined" &&
-            typeof window.performance !== "undefined" &&
-            typeof window.performance.now === "function"
-        );
+        });
     }
 
     /**
@@ -102,11 +135,25 @@ export class BrowserPerformanceClient
     ): InProgressPerformanceEvent {
         // Capture page visibilityState and then invoke start/end measurement
         const startPageVisibility = this.getPageVisibility();
-
         const inProgressEvent = super.startMeasurement(
             measureName,
             correlationId
         );
+        const startTime: number | undefined = supportsBrowserPerformanceNow()
+            ? window.performance.now()
+            : undefined;
+
+        const browserMeasurement = getPerfMeasurementModule()?.then(
+            (module) => {
+                return new module.BrowserPerformanceMeasurement(
+                    measureName,
+                    inProgressEvent.event.correlationId
+                );
+            }
+        );
+        void browserMeasurement?.then((measurement) =>
+            measurement.startMeasurement()
+        );
 
         return {
             ...inProgressEvent,
@@ -114,18 +161,24 @@ export class BrowserPerformanceClient
                 event?: Partial<PerformanceEvent>
             ): PerformanceEvent | null => {
                 const res = inProgressEvent.end({
+                    ...event,
                     startPageVisibility,
                     endPageVisibility: this.getPageVisibility(),
-                    ...event,
+                    durationMs: getPerfDurationMs(startTime),
                 });
+                void browserMeasurement?.then((measurement) =>
+                    measurement.endMeasurement()
+                );
                 this.deleteIncompleteSubMeasurements(inProgressEvent);
 
                 return res;
             },
             discard: () => {
                 inProgressEvent.discard();
+                void browserMeasurement?.then((measurement) =>
+                    measurement.flushMeasurement()
+                );
                 this.deleteIncompleteSubMeasurements(inProgressEvent);
-                inProgressEvent.measurement.flushMeasurement();
             },
         };
     }
@@ -140,7 +193,7 @@ export class BrowserPerformanceClient
         eventName: PerformanceEvents,
         correlationId?: string
     ): void {
-        if (!this.supportsBrowserPerformanceNow()) {
+        if (!supportsBrowserPerformanceNow()) {
             this.logger.trace(
                 `BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`
             );
@@ -193,7 +246,7 @@ export class BrowserPerformanceClient
         queueTime?: number,
         manuallyCompleted?: boolean
     ): void {
-        if (!this.supportsBrowserPerformanceNow()) {
+        if (!supportsBrowserPerformanceNow()) {
             this.logger.trace(
                 `BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`
             );

package/src/utils/BrowserConstants.ts

@@ -239,3 +239,14 @@ export const CacheLookupPolicy = {
 } as const;
 export type CacheLookupPolicy =
     (typeof CacheLookupPolicy)[keyof typeof CacheLookupPolicy];
+
+export const iFrameRenewalPolicies: CacheLookupPolicy[] = [
+    CacheLookupPolicy.Default,
+    CacheLookupPolicy.Skip,
+    CacheLookupPolicy.RefreshTokenAndNetwork,
+];
+
+export const LOG_LEVEL_CACHE_KEY = "msal.browser.log.level";
+export const LOG_PII_CACHE_KEY = "msal.browser.log.pii";
+
+export const BROWSER_PERF_ENABLED_KEY = "msal.browser.performance.enabled";

package/dist/naa/AccountRequests.d.ts

@@ -1,10 +0,0 @@
-export type AccountByHomeIdRequest = {
-    homeAccountId: string;
-};
-export type AccountByLocalIdRequest = {
-    localAccountId: string;
-};
-export type AccountByUsernameRequest = {
-    username: string;
-};
-//# sourceMappingURL=AccountRequests.d.ts.map

package/dist/naa/AccountRequests.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AccountRequests.d.ts","sourceRoot":"","sources":["../../src/naa/AccountRequests.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,sBAAsB,GAAG;IACjC,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,cAAc,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/naa/InitializeBridgeResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"InitializeBridgeResponse.d.ts","sourceRoot":"","sources":["../../src/naa/InitializeBridgeResponse.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,MAAM,WAAW,wBAAwB;IACrC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB"}

package/src/naa/AccountRequests.ts

@@ -1,16 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export type AccountByHomeIdRequest = {
-    homeAccountId: string;
-};
-
-export type AccountByLocalIdRequest = {
-    localAccountId: string;
-};
-
-export type AccountByUsernameRequest = {
-    username: string;
-};