@azure/msal-browser 3.4.0 → 3.5.1-beta.0

package/dist/request/RedirectRequest.d.ts

@@ -1,36 +1,36 @@
-import { CommonAuthorizationUrlRequest, StringDict } from "@azure/msal-common";
-/**
- * RedirectRequest: Request object passed by user to retrieve a Code from the
- * server (first leg of authorization code grant flow) with a full page redirect.
- *
- * - scopes                     - Array of scopes the application is requesting access to.
- * - authority                  - Url of the authority which the application acquires tokens from.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
- * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
- * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
- * - prompt                     - Indicates the type of user interaction that is required.
- *          login: will force the user to enter their credentials on that request, negating single-sign on
- *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
- *          consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
- *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
- *          create: will direct the user to the account creation experience instead of the log in experience
- *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
- * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the login_hint or preferred_username claim.
- * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
- * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
- * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
- * - tokenBodyParameters        - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
- * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
- * - claims                     - In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met, exceptions will contain claims that need to be consented to.
- * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
- * - redirectStartPage          - The page that should be returned to after loginRedirect or acquireTokenRedirect. This should only be used if this is different from the redirectUri and will default to the page that initiates the request. When the navigateToLoginRequestUrl config option is set to false this parameter will be ignored.
- * - onRedirectNavigate         - Callback that will be passed the url that MSAL will navigate to. Returning false in the callback will stop navigation.
- */
-export type RedirectRequest = Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "scopes" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "nativeBroker">> & {
-    scopes: Array<string>;
-    redirectStartPage?: string;
-    onRedirectNavigate?: (url: string) => boolean | void;
-    tokenBodyParameters?: StringDict;
-};
+import { CommonAuthorizationUrlRequest, StringDict } from "@azure/msal-common";
+/**
+ * RedirectRequest: Request object passed by user to retrieve a Code from the
+ * server (first leg of authorization code grant flow) with a full page redirect.
+ *
+ * - scopes                     - Array of scopes the application is requesting access to.
+ * - authority                  - Url of the authority which the application acquires tokens from.
+ * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
+ * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
+ * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
+ * - prompt                     - Indicates the type of user interaction that is required.
+ *          login: will force the user to enter their credentials on that request, negating single-sign on
+ *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
+ *          consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
+ *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
+ *          create: will direct the user to the account creation experience instead of the log in experience
+ *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
+ * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the login_hint or preferred_username claim.
+ * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
+ * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
+ * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
+ * - tokenBodyParameters        - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
+ * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
+ * - claims                     - In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met, exceptions will contain claims that need to be consented to.
+ * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
+ * - redirectStartPage          - The page that should be returned to after loginRedirect or acquireTokenRedirect. This should only be used if this is different from the redirectUri and will default to the page that initiates the request. When the navigateToLoginRequestUrl config option is set to false this parameter will be ignored.
+ * - onRedirectNavigate         - Callback that will be passed the url that MSAL will navigate to. Returning false in the callback will stop navigation.
+ */
+export type RedirectRequest = Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "scopes" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "nativeBroker">> & {
+    scopes: Array<string>;
+    redirectStartPage?: string;
+    onRedirectNavigate?: (url: string) => boolean | void;
+    tokenBodyParameters?: StringDict;
+};
 //# sourceMappingURL=RedirectRequest.d.ts.map

package/dist/request/SilentRequest.d.ts

@@ -1,33 +1,33 @@
-import { AccountInfo, CommonSilentFlowRequest, StringDict } from "@azure/msal-common";
-import { CacheLookupPolicy } from "../utils/BrowserConstants";
-/**
- * SilentRequest: Request object passed by user to retrieve tokens from the
- * cache, renew an expired token with a refresh token, or retrieve a code (first leg of authorization code grant flow)
- * in a hidden iframe.
- *
- * - scopes                 - Array of scopes the application is requesting access to.
- * - authority              - Url of the authority which the application acquires tokens from.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - account                - Account entity to lookup the credentials.
- * - forceRefresh           - Forces silent requests to make network calls if true.
- * - extraQueryParameters   - String to string map of custom query parameters added to the /authorize call. Only used when renewing the refresh token.
- * - tokenBodyParameters    - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
- * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call. Only used when renewing access tokens.
- * - redirectUri            - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal. Only used for cases where refresh token is expired.
- * - cacheLookupPolicy      - Enum of different ways the silent token can be retrieved.
- * - prompt                 - Indicates the type of user interaction that is required.
- *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
- *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
- */
-export type SilentRequest = Omit<CommonSilentFlowRequest, "authority" | "correlationId" | "forceRefresh" | "account" | "requestedClaimsHash"> & {
-    redirectUri?: string;
-    extraQueryParameters?: StringDict;
-    authority?: string;
-    account?: AccountInfo;
-    correlationId?: string;
-    forceRefresh?: boolean;
-    cacheLookupPolicy?: CacheLookupPolicy;
-    prompt?: string;
-    tokenBodyParameters?: StringDict;
-};
+import { AccountInfo, CommonSilentFlowRequest, StringDict } from "@azure/msal-common";
+import { CacheLookupPolicy } from "../utils/BrowserConstants";
+/**
+ * SilentRequest: Request object passed by user to retrieve tokens from the
+ * cache, renew an expired token with a refresh token, or retrieve a code (first leg of authorization code grant flow)
+ * in a hidden iframe.
+ *
+ * - scopes                 - Array of scopes the application is requesting access to.
+ * - authority              - Url of the authority which the application acquires tokens from.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - account                - Account entity to lookup the credentials.
+ * - forceRefresh           - Forces silent requests to make network calls if true.
+ * - extraQueryParameters   - String to string map of custom query parameters added to the /authorize call. Only used when renewing the refresh token.
+ * - tokenBodyParameters    - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
+ * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call. Only used when renewing access tokens.
+ * - redirectUri            - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal. Only used for cases where refresh token is expired.
+ * - cacheLookupPolicy      - Enum of different ways the silent token can be retrieved.
+ * - prompt                 - Indicates the type of user interaction that is required.
+ *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
+ *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
+ */
+export type SilentRequest = Omit<CommonSilentFlowRequest, "authority" | "correlationId" | "forceRefresh" | "account" | "requestedClaimsHash"> & {
+    redirectUri?: string;
+    extraQueryParameters?: StringDict;
+    authority?: string;
+    account?: AccountInfo;
+    correlationId?: string;
+    forceRefresh?: boolean;
+    cacheLookupPolicy?: CacheLookupPolicy;
+    prompt?: string;
+    tokenBodyParameters?: StringDict;
+};
 //# sourceMappingURL=SilentRequest.d.ts.map

package/dist/request/SsoSilentRequest.d.ts

@@ -1,30 +1,30 @@
-import { CommonAuthorizationUrlRequest, StringDict } from "@azure/msal-common";
-/**
- * Request object passed by user to ssoSilent to retrieve a Code from the server (first leg of authorization code grant flow)
- *
- * - scopes                     - Array of scopes the application is requesting access to (optional for ssoSilent calls)
- * - claims                     - A stringified claims request which will be added to all /authorize and /token calls
- * - authority                  - Url of the authority which the application acquires tokens from.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
- * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
- * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
- * - prompt                     - Indicates the type of user interaction that is required.
- *          login: will force the user to enter their credentials on that request, negating single-sign on
- *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
- *          consent: will trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
- *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
- *          create: will direct the user to the account creation experience instead of the log in experience
- *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
- * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the login_hint or preferred_username claim.
- * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
- * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
- * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
- * - tokenBodyParameters        - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
- * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
- * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
- */
-export type SsoSilentRequest = Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "nativeBroker">> & {
-    tokenBodyParameters?: StringDict;
-};
+import { CommonAuthorizationUrlRequest, StringDict } from "@azure/msal-common";
+/**
+ * Request object passed by user to ssoSilent to retrieve a Code from the server (first leg of authorization code grant flow)
+ *
+ * - scopes                     - Array of scopes the application is requesting access to (optional for ssoSilent calls)
+ * - claims                     - A stringified claims request which will be added to all /authorize and /token calls
+ * - authority                  - Url of the authority which the application acquires tokens from.
+ * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
+ * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
+ * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
+ * - prompt                     - Indicates the type of user interaction that is required.
+ *          login: will force the user to enter their credentials on that request, negating single-sign on
+ *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
+ *          consent: will trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
+ *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
+ *          create: will direct the user to the account creation experience instead of the log in experience
+ *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
+ * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the login_hint or preferred_username claim.
+ * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
+ * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
+ * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
+ * - tokenBodyParameters        - String to string map of custom token request body parameters added to the /token call. Only used when renewing access tokens.
+ * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
+ * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
+ */
+export type SsoSilentRequest = Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "nativeBroker">> & {
+    tokenBodyParameters?: StringDict;
+};
 //# sourceMappingURL=SsoSilentRequest.d.ts.map

package/dist/response/AuthenticationResult.d.ts

@@ -1,5 +1,5 @@
-import { AccountInfo, AuthenticationResult as CommonAuthenticationResult } from "@azure/msal-common";
-export type AuthenticationResult = CommonAuthenticationResult & {
-    account: AccountInfo;
-};
+import { AccountInfo, AuthenticationResult as CommonAuthenticationResult } from "@azure/msal-common";
+export type AuthenticationResult = CommonAuthenticationResult & {
+    account: AccountInfo;
+};
 //# sourceMappingURL=AuthenticationResult.d.ts.map

package/dist/response/ResponseHandler.d.ts

@@ -0,0 +1,8 @@
+import { ICrypto, Logger, ServerAuthorizationCodeResponse } from "@azure/msal-common";
+import { InteractionType } from "../utils/BrowserConstants";
+export declare function deserializeResponse(responseString: string, responseLocation: string, logger: Logger): ServerAuthorizationCodeResponse;
+/**
+ * Returns the interaction type that the response object belongs to
+ */
+export declare function validateInteractionType(response: ServerAuthorizationCodeResponse, browserCrypto: ICrypto, interactionType: InteractionType): void;
+//# sourceMappingURL=ResponseHandler.d.ts.map

package/dist/response/ResponseHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseHandler.d.ts","sourceRoot":"","sources":["../../src/response/ResponseHandler.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,OAAO,EACP,MAAM,EACN,+BAA+B,EAElC,MAAM,oBAAoB,CAAC;AAM5B,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,wBAAgB,mBAAmB,CAC/B,cAAc,EAAE,MAAM,EACtB,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,MAAM,GACf,+BAA+B,CAuBjC;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACnC,QAAQ,EAAE,+BAA+B,EACzC,aAAa,EAAE,OAAO,EACtB,eAAe,EAAE,eAAe,GACjC,IAAI,CAkBN"}

package/dist/response/ResponseHandler.mjs

@@ -0,0 +1,46 @@
+/*! @azure/msal-browser v3.5.1-beta.0 2023-11-14 */
+'use strict';
+import { UrlUtils } from '@azure/msal-common';
+import { createBrowserAuthError } from '../error/BrowserAuthError.mjs';
+import { extractBrowserRequestState } from '../utils/BrowserProtocolUtils.mjs';
+import { hashEmptyError, hashDoesNotContainKnownProperties, noStateInHash, unableToParseState, stateInteractionTypeMismatch } from '../error/BrowserAuthErrorCodes.mjs';
+
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+function deserializeResponse(responseString, responseLocation, logger) {
+    // Deserialize hash fragment response parameters.
+    const serverParams = UrlUtils.getDeserializedResponse(responseString);
+    if (!serverParams) {
+        if (!UrlUtils.stripLeadingHashOrQuery(responseString)) {
+            // Hash or Query string is empty
+            logger.error(`The request has returned to the redirectUri but a ${responseLocation} is not present. It's likely that the ${responseLocation} has been removed or the page has been redirected by code running on the redirectUri page.`);
+            throw createBrowserAuthError(hashEmptyError);
+        }
+        else {
+            logger.error(`A ${responseLocation} is present in the iframe but it does not contain known properties. It's likely that the ${responseLocation} has been replaced by code running on the redirectUri page.`);
+            logger.errorPii(`The ${responseLocation} detected is: ${responseString}`);
+            throw createBrowserAuthError(hashDoesNotContainKnownProperties);
+        }
+    }
+    return serverParams;
+}
+/**
+ * Returns the interaction type that the response object belongs to
+ */
+function validateInteractionType(response, browserCrypto, interactionType) {
+    if (!response.state) {
+        throw createBrowserAuthError(noStateInHash);
+    }
+    const platformStateObj = extractBrowserRequestState(browserCrypto, response.state);
+    if (!platformStateObj) {
+        throw createBrowserAuthError(unableToParseState);
+    }
+    if (platformStateObj.interactionType !== interactionType) {
+        throw createBrowserAuthError(stateInteractionTypeMismatch);
+    }
+}
+
+export { deserializeResponse, validateInteractionType };
+//# sourceMappingURL=ResponseHandler.mjs.map

package/dist/response/ResponseHandler.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseHandler.mjs","sources":["../../src/response/ResponseHandler.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;AAKA;AAWA;AAEA;AA6BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/telemetry/BrowserPerformanceClient.d.ts

@@ -1,37 +1,37 @@
-import { PerformanceEvents, IPerformanceClient, PerformanceClient, IPerformanceMeasurement, InProgressPerformanceEvent } from "@azure/msal-common";
-import { Configuration } from "../config/Configuration";
-export declare class BrowserPerformanceClient extends PerformanceClient implements IPerformanceClient {
-    constructor(configuration: Configuration, intFields?: Set<string>);
-    startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
-    generateId(): string;
-    private getPageVisibility;
-    private deleteIncompleteSubMeasurements;
-    supportsBrowserPerformanceNow(): boolean;
-    /**
-     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
-     * Also captures browser page visibilityState.
-     *
-     * @param {PerformanceEvents} measureName
-     * @param {?string} [correlationId]
-     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
-     */
-    startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
-    /**
-     * Adds pre-queue time to preQueueTimeByCorrelationId map.
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @returns
-     */
-    setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
-    /**
-     * Calculates and adds queue time measurement for given performance event.
-     *
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @param {?number} queueTime
-     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
-     * @returns
-     */
-    addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
-}
+import { PerformanceEvents, IPerformanceClient, PerformanceClient, IPerformanceMeasurement, InProgressPerformanceEvent } from "@azure/msal-common";
+import { Configuration } from "../config/Configuration";
+export declare class BrowserPerformanceClient extends PerformanceClient implements IPerformanceClient {
+    constructor(configuration: Configuration, intFields?: Set<string>);
+    startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
+    generateId(): string;
+    private getPageVisibility;
+    private deleteIncompleteSubMeasurements;
+    supportsBrowserPerformanceNow(): boolean;
+    /**
+     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
+     * Also captures browser page visibilityState.
+     *
+     * @param {PerformanceEvents} measureName
+     * @param {?string} [correlationId]
+     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
+     */
+    startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
+    /**
+     * Adds pre-queue time to preQueueTimeByCorrelationId map.
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @returns
+     */
+    setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
+    /**
+     * Calculates and adds queue time measurement for given performance event.
+     *
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @param {?number} queueTime
+     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
+     * @returns
+     */
+    addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
+}
 //# sourceMappingURL=BrowserPerformanceClient.d.ts.map

package/dist/telemetry/BrowserPerformanceClient.mjs

@@ -1,133 +1,133 @@
-/*! @azure/msal-browser v3.4.0 2023-10-30 */
+/*! @azure/msal-browser v3.5.1-beta.0 2023-11-14 */
 'use strict';
 import { PerformanceClient, Constants, Logger } from '@azure/msal-common';
 import { BrowserPerformanceMeasurement } from './BrowserPerformanceMeasurement.mjs';
 import { name, version } from '../packageMetadata.mjs';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-class BrowserPerformanceClient extends PerformanceClient {
-    constructor(configuration, intFields) {
-        super(configuration.auth.clientId, configuration.auth.authority || `${Constants.DEFAULT_AUTHORITY}`, new Logger(configuration.system?.loggerOptions || {}, name, version), name, version, configuration.telemetry?.application || {
-            appName: "",
-            appVersion: "",
-        }, intFields);
-    }
-    startPerformanceMeasurement(measureName, correlationId) {
-        return new BrowserPerformanceMeasurement(measureName, correlationId);
-    }
-    generateId() {
-        return window.crypto.randomUUID();
-    }
-    getPageVisibility() {
-        return document.visibilityState?.toString() || null;
-    }
-    deleteIncompleteSubMeasurements(inProgressEvent) {
-        const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
-        const isRootEvent = rootEvent && rootEvent.eventId === inProgressEvent.event.eventId;
-        const incompleteMeasurements = [];
-        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(inProgressEvent.event.correlationId, incompleteMeasurements);
-        }
-    }
-    supportsBrowserPerformanceNow() {
-        return (typeof window !== "undefined" &&
-            typeof window.performance !== "undefined" &&
-            typeof window.performance.now === "function");
-    }
-    /**
-     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
-     * Also captures browser page visibilityState.
-     *
-     * @param {PerformanceEvents} measureName
-     * @param {?string} [correlationId]
-     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
-     */
-    startMeasurement(measureName, correlationId) {
-        // Capture page visibilityState and then invoke start/end measurement
-        const startPageVisibility = this.getPageVisibility();
-        const inProgressEvent = super.startMeasurement(measureName, correlationId);
-        return {
-            ...inProgressEvent,
-            end: (event) => {
-                const res = inProgressEvent.end({
-                    startPageVisibility,
-                    endPageVisibility: this.getPageVisibility(),
-                    ...event,
-                });
-                this.deleteIncompleteSubMeasurements(inProgressEvent);
-                return res;
-            },
-            discard: () => {
-                inProgressEvent.discard();
-                this.deleteIncompleteSubMeasurements(inProgressEvent);
-                inProgressEvent.measurement.flushMeasurement();
-            },
-        };
-    }
-    /**
-     * Adds pre-queue time to preQueueTimeByCorrelationId map.
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @returns
-     */
-    setPreQueueTime(eventName, correlationId) {
-        if (!this.supportsBrowserPerformanceNow()) {
-            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
-            return;
-        }
-        if (!correlationId) {
-            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
-            return;
-        }
-        const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
-        /**
-         * Manually complete queue measurement if there is an incomplete pre-queue event.
-         * Incomplete pre-queue events are instrumentation bugs that should be fixed.
-         */
-        if (preQueueEvent) {
-            this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
-            this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
-        }
-        this.preQueueTimeByCorrelationId.set(correlationId, {
-            name: eventName,
-            time: window.performance.now(),
-        });
-    }
-    /**
-     * Calculates and adds queue time measurement for given performance event.
-     *
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @param {?number} queueTime
-     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
-     * @returns
-     */
-    addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
-        if (!this.supportsBrowserPerformanceNow()) {
-            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
-            return;
-        }
-        if (!correlationId) {
-            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
-            return;
-        }
-        const preQueueTime = super.getPreQueueTime(eventName, correlationId);
-        if (!preQueueTime) {
-            return;
-        }
-        const currentTime = window.performance.now();
-        const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
-        return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+class BrowserPerformanceClient extends PerformanceClient {
+    constructor(configuration, intFields) {
+        super(configuration.auth.clientId, configuration.auth.authority || `${Constants.DEFAULT_AUTHORITY}`, new Logger(configuration.system?.loggerOptions || {}, name, version), name, version, configuration.telemetry?.application || {
+            appName: "",
+            appVersion: "",
+        }, intFields);
+    }
+    startPerformanceMeasurement(measureName, correlationId) {
+        return new BrowserPerformanceMeasurement(measureName, correlationId);
+    }
+    generateId() {
+        return window.crypto.randomUUID();
+    }
+    getPageVisibility() {
+        return document.visibilityState?.toString() || null;
+    }
+    deleteIncompleteSubMeasurements(inProgressEvent) {
+        const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
+        const isRootEvent = rootEvent && rootEvent.eventId === inProgressEvent.event.eventId;
+        const incompleteMeasurements = [];
+        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(inProgressEvent.event.correlationId, incompleteMeasurements);
+        }
+    }
+    supportsBrowserPerformanceNow() {
+        return (typeof window !== "undefined" &&
+            typeof window.performance !== "undefined" &&
+            typeof window.performance.now === "function");
+    }
+    /**
+     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
+     * Also captures browser page visibilityState.
+     *
+     * @param {PerformanceEvents} measureName
+     * @param {?string} [correlationId]
+     * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
+     */
+    startMeasurement(measureName, correlationId) {
+        // Capture page visibilityState and then invoke start/end measurement
+        const startPageVisibility = this.getPageVisibility();
+        const inProgressEvent = super.startMeasurement(measureName, correlationId);
+        return {
+            ...inProgressEvent,
+            end: (event) => {
+                const res = inProgressEvent.end({
+                    startPageVisibility,
+                    endPageVisibility: this.getPageVisibility(),
+                    ...event,
+                });
+                this.deleteIncompleteSubMeasurements(inProgressEvent);
+                return res;
+            },
+            discard: () => {
+                inProgressEvent.discard();
+                this.deleteIncompleteSubMeasurements(inProgressEvent);
+                inProgressEvent.measurement.flushMeasurement();
+            },
+        };
+    }
+    /**
+     * Adds pre-queue time to preQueueTimeByCorrelationId map.
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @returns
+     */
+    setPreQueueTime(eventName, correlationId) {
+        if (!this.supportsBrowserPerformanceNow()) {
+            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
+            return;
+        }
+        if (!correlationId) {
+            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
+            return;
+        }
+        const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
+        /**
+         * Manually complete queue measurement if there is an incomplete pre-queue event.
+         * Incomplete pre-queue events are instrumentation bugs that should be fixed.
+         */
+        if (preQueueEvent) {
+            this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
+            this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
+        }
+        this.preQueueTimeByCorrelationId.set(correlationId, {
+            name: eventName,
+            time: window.performance.now(),
+        });
+    }
+    /**
+     * Calculates and adds queue time measurement for given performance event.
+     *
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @param {?number} queueTime
+     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
+     * @returns
+     */
+    addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
+        if (!this.supportsBrowserPerformanceNow()) {
+            this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
+            return;
+        }
+        if (!correlationId) {
+            this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
+            return;
+        }
+        const preQueueTime = super.getPreQueueTime(eventName, correlationId);
+        if (!preQueueTime) {
+            return;
+        }
+        const currentTime = window.performance.now();
+        const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
+        return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
+    }
 }
 
 export { BrowserPerformanceClient };