@azure/msal-browser 4.24.0 → 5.0.0-alpha.0

package/src/config/Configuration.ts

@@ -8,10 +8,8 @@ import {
     LoggerOptions,
     INetworkModule,
     DEFAULT_SYSTEM_OPTIONS,
-    Constants,
     ProtocolMode,
     OIDCOptions,
-    ServerResponseType,
     LogLevel,
     StubbedNetworkModule,
     AzureCloudInstance,
@@ -22,6 +20,7 @@ import {
     IPerformanceClient,
     StubPerformanceClient,
     Logger,
+    Constants,
 } from "@azure/msal-common/browser";
 import {
     BrowserCacheLocation,
@@ -70,18 +69,11 @@ export type BrowserAuthOptions = {
      * The redirect URI where the window navigates after a successful logout.
      */
     postLogoutRedirectUri?: string | null;
-    /**
-     * Boolean indicating whether to navigate to the original request URL after the auth server navigates to the redirect URL.
-     */
-    navigateToLoginRequestUrl?: boolean;
+
     /**
      * Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.
      */
     clientCapabilities?: Array<string>;
-    /**
-     * Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
-     */
-    protocolMode?: ProtocolMode;
     /**
      * Enum that configures options for the OIDC protocol mode.
      */
@@ -90,16 +82,6 @@ export type BrowserAuthOptions = {
      * Enum that represents the Azure Cloud to use.
      */
     azureCloudOptions?: AzureCloudOptions;
-    /**
-     * Flag of whether to use the local metadata cache
-     */
-    skipAuthorityMetadataCache?: boolean;
-    /**
-     * App supports nested app auth or not; defaults to
-     *
-     * @deprecated This flag is deprecated and will be removed in the next major version. createNestablePublicClientApplication should be used instead.
-     */
-    supportsNestedAppAuth?: boolean;
     /**
      * Callback that will be passed the url that MSAL will navigate to in redirect flows. Returning false in the callback will stop navigation.
      */
@@ -108,11 +90,6 @@ export type BrowserAuthOptions = {
      * Flag of whether the STS will send back additional parameters to specify where the tokens should be retrieved from.
      */
     instanceAware?: boolean;
-    /**
-     * Flag of whether to encode query parameters
-     * @deprecated This flag is deprecated and will be removed in the next major version where all extra query params will be encoded by default.
-     */
-    encodeExtraQueryParams?: boolean;
 };
 
 /** @internal */
@@ -136,31 +113,6 @@ export type CacheOptions = {
      * Used to specify the number of days cache entries written by previous versions of MSAL.js should be retained in the browser. Defaults to 5 days.
      */
     cacheRetentionDays?: number;
-    /**
-     * Used to specify the temporaryCacheLocation user wants to set. Valid values are "localStorage", "sessionStorage" and "memoryStorage".
-     * @deprecated This option is deprecated and will be removed in the next major version.
-     */
-    temporaryCacheLocation?: BrowserCacheLocation | string;
-    /**
-     * If set, MSAL stores the auth request state required for validation of the auth flows in the browser cookies. By default this flag is set to false.
-     * @deprecated This option is deprecated and will be removed in the next major version.
-     */
-    storeAuthStateInCookie?: boolean;
-    /**
-     * If set, MSAL sets the "Secure" flag on cookies so they can only be sent over HTTPS. By default this flag is set to true.
-     * @deprecated This option will be removed in the next major version and all cookies set will include the Secure attribute.
-     */
-    secureCookies?: boolean;
-    /**
-     * If set, MSAL will attempt to migrate cache entries from older versions on initialization. By default this flag is set to true if cacheLocation is localStorage, otherwise false.
-     * @deprecated This option is deprecated and will be removed in the next major version.
-     */
-    cacheMigrationEnabled?: boolean;
-    /**
-     * Flag that determines whether access tokens are stored based on requested claims
-     * @deprecated This option is deprecated and will be removed in the next major version.
-     */
-    claimsBasedCachingEnabled?: boolean;
 };
 
 export type BrowserSystemOptions = SystemOptions & {
@@ -188,19 +140,14 @@ export type BrowserSystemOptions = SystemOptions & {
      * Sets the timeout for waiting for a response hash in an iframe or popup
      */
     loadFrameTimeout?: number;
-    /**
-     * Maximum time the library should wait for a frame to load
-     * @deprecated This was previously needed for older browsers which are no longer supported by MSAL.js. This option will be removed in the next major version
-     */
-    navigateFrameWait?: number;
     /**
      * Time to wait for redirection to occur before resolving promise
      */
     redirectNavigationTimeout?: number;
     /**
-     * Sets whether popups are opened asynchronously. By default, this flag is set to false. When set to false, blank popups are opened before anything else happens. When set to true, popups are opened when making the network request.
+     * Sets whether popups are opened and navigated to later. By default, this flag is set to true. When set to true, blank popups are opened and navigates to login domain. When set to false, popups are opened directly to the login domain.
      */
-    asyncPopups?: boolean;
+    navigatePopups?: boolean;
     /**
      * Flag to enable redirect opertaions when the app is rendered in an iframe (to support scenarios such as embedded B2C login).
      */
@@ -217,6 +164,10 @@ export type BrowserSystemOptions = SystemOptions & {
      * Sets the interval length in milliseconds for polling the location attribute in popup windows (default is 30ms)
      */
     pollIntervalMilliseconds?: number;
+    /**
+     * Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
+     */
+    protocolMode?: ProtocolMode;
 };
 
 /**
@@ -283,19 +234,17 @@ export function buildConfiguration(
 ): BrowserConfiguration {
     // Default auth options for browser
     const DEFAULT_AUTH_OPTIONS: InternalAuthOptions = {
-        clientId: Constants.EMPTY_STRING,
+        clientId: "",
         authority: `${Constants.DEFAULT_AUTHORITY}`,
         knownAuthorities: [],
-        cloudDiscoveryMetadata: Constants.EMPTY_STRING,
-        authorityMetadata: Constants.EMPTY_STRING,
+        cloudDiscoveryMetadata: "",
+        authorityMetadata: "",
         redirectUri:
             typeof window !== "undefined" ? BrowserUtils.getCurrentUri() : "",
-        postLogoutRedirectUri: Constants.EMPTY_STRING,
-        navigateToLoginRequestUrl: true,
+        postLogoutRedirectUri: "",
         clientCapabilities: [],
-        protocolMode: ProtocolMode.AAD,
         OIDCOptions: {
-            serverResponseType: ServerResponseType.FRAGMENT,
+            responseMode: Constants.ResponseMode.FRAGMENT,
             defaultScopes: [
                 Constants.OPENID_SCOPE,
                 Constants.PROFILE_SCOPE,
@@ -304,28 +253,15 @@ export function buildConfiguration(
         },
         azureCloudOptions: {
             azureCloudInstance: AzureCloudInstance.None,
-            tenant: Constants.EMPTY_STRING,
+            tenant: "",
         },
-        skipAuthorityMetadataCache: false,
-        supportsNestedAppAuth: false,
         instanceAware: false,
-        encodeExtraQueryParams: false,
     };
 
     // Default cache options for browser
     const DEFAULT_CACHE_OPTIONS: Required<CacheOptions> = {
         cacheLocation: BrowserCacheLocation.SessionStorage,
         cacheRetentionDays: 5,
-        temporaryCacheLocation: BrowserCacheLocation.SessionStorage,
-        storeAuthStateInCookie: false,
-        secureCookies: false,
-        // Default cache migration to true if cache location is localStorage since entries are preserved across tabs/windows. Migration has little to no benefit in sessionStorage and memoryStorage
-        cacheMigrationEnabled:
-            userInputCache &&
-            userInputCache.cacheLocation === BrowserCacheLocation.LocalStorage
-                ? true
-                : false,
-        claimsBasedCachingEnabled: false,
     };
 
     // Default logger options for browser
@@ -352,15 +288,15 @@ export function buildConfiguration(
             userInputSystem?.loadFrameTimeout || DEFAULT_POPUP_TIMEOUT_MS,
         iframeHashTimeout:
             userInputSystem?.loadFrameTimeout || DEFAULT_IFRAME_TIMEOUT_MS,
-        navigateFrameWait: 0,
         redirectNavigationTimeout: DEFAULT_REDIRECT_TIMEOUT_MS,
-        asyncPopups: false,
         allowRedirectInIframe: false,
+        navigatePopups: true,
         allowPlatformBroker: false,
         nativeBrokerHandshakeTimeout:
             userInputSystem?.nativeBrokerHandshakeTimeout ||
             DEFAULT_NATIVE_BROKER_HANDSHAKE_TIMEOUT_MS,
         pollIntervalMilliseconds: BrowserConstants.DEFAULT_POLL_INTERVAL_MS,
+        protocolMode: ProtocolMode.AAD,
     };
 
     const providedSystemOptions: Required<BrowserSystemOptions> = {
@@ -371,15 +307,15 @@ export function buildConfiguration(
 
     const DEFAULT_TELEMETRY_OPTIONS: Required<BrowserTelemetryOptions> = {
         application: {
-            appName: Constants.EMPTY_STRING,
-            appVersion: Constants.EMPTY_STRING,
+            appName: "",
+            appVersion: "",
         },
         client: new StubPerformanceClient(),
     };
 
     // Throw an error if user has set OIDCOptions without being in OIDC protocol mode
     if (
-        userInputAuth?.protocolMode !== ProtocolMode.OIDC &&
+        userInputSystem?.protocolMode !== ProtocolMode.OIDC &&
         userInputAuth?.OIDCOptions
     ) {
         const logger = new Logger(providedSystemOptions.loggerOptions);
@@ -388,14 +324,15 @@ export function buildConfiguration(
                 createClientConfigurationError(
                     ClientConfigurationErrorCodes.cannotSetOIDCOptions
                 )
-            )
+            ),
+            ""
         );
     }
 
     // Throw an error if user has set allowPlatformBroker to true with OIDC protocol mode
     if (
-        userInputAuth?.protocolMode &&
-        userInputAuth.protocolMode === ProtocolMode.OIDC &&
+        userInputSystem?.protocolMode &&
+        userInputSystem.protocolMode === ProtocolMode.OIDC &&
         providedSystemOptions?.allowPlatformBroker
     ) {
         throw createClientConfigurationError(

package/src/controllers/ControllerFactory.ts

@@ -10,31 +10,38 @@ import { Configuration } from "../config/Configuration.js";
 import { StandardController } from "./StandardController.js";
 import { NestedAppAuthController } from "./NestedAppAuthController.js";
 import { InitializeApplicationRequest } from "../request/InitializeApplicationRequest.js";
+import { createNewGuid } from "../crypto/BrowserCrypto.js";
 
 export async function createV3Controller(
     config: Configuration,
     request?: InitializeApplicationRequest
 ): Promise<IController> {
+    const correlationId = request?.correlationId || createNewGuid();
     const standard = new StandardOperatingContext(config);
 
-    await standard.initialize();
-    return StandardController.createController(standard, request);
+    await standard.initialize(correlationId);
+    return StandardController.createController(standard, { correlationId });
 }
 
 export async function createController(
-    config: Configuration
+    config: Configuration,
+    request?: InitializeApplicationRequest
 ): Promise<IController | null> {
+    const correlationId = request?.correlationId || createNewGuid();
     const standard = new StandardOperatingContext(config);
     const nestedApp = new NestedAppOperatingContext(config);
 
-    const operatingContexts = [standard.initialize(), nestedApp.initialize()];
+    const operatingContexts = [
+        standard.initialize(correlationId),
+        nestedApp.initialize(correlationId),
+    ];
 
     await Promise.all(operatingContexts);
 
-    if (nestedApp.isAvailable() && config.auth.supportsNestedAppAuth) {
+    if (nestedApp.isAvailable()) {
         return NestedAppAuthController.createController(nestedApp);
     } else if (standard.isAvailable()) {
-        return StandardController.createController(standard);
+        return StandardController.createController(standard, { correlationId });
     } else {
         // Since neither of the actual operating contexts are available keep the UnknownOperatingContextController
         return null;

package/src/controllers/IController.ts

@@ -18,7 +18,6 @@ import { EndSessionRequest } from "../request/EndSessionRequest.js";
 import { ApiId, WrapperSKU } from "../utils/BrowserConstants.js";
 import { INavigationClient } from "../navigation/INavigationClient.js";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest.js";
-import { ITokenCache } from "../cache/ITokenCache.js";
 import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest.js";
 import { BrowserConfiguration } from "../config/Configuration.js";
 import { AuthenticationResult } from "../response/AuthenticationResult.js";
@@ -63,10 +62,6 @@ export interface IController {
 
     removePerformanceCallback(callbackId: string): boolean;
 
-    enableAccountStorageEvents(): void;
-
-    disableAccountStorageEvents(): void;
-
     getAccount(accountFilter: AccountFilter): AccountInfo | null;
 
     getAccountByHomeId(homeAccountId: string): AccountInfo | null;
@@ -77,14 +72,14 @@ export interface IController {
 
     getAllAccounts(accountFilter?: AccountFilter): AccountInfo[];
 
-    handleRedirectPromise(hash?: string): Promise<AuthenticationResult | null>;
+    handleRedirectPromise(
+        options?: HandleRedirectPromiseOptions
+    ): Promise<AuthenticationResult | null>;
 
     loginPopup(request?: PopupRequest): Promise<AuthenticationResult>;
 
     loginRedirect(request?: RedirectRequest): Promise<void>;
 
-    logout(logoutRequest?: EndSessionRequest): Promise<void>;
-
     logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>;
 
     logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>;
@@ -93,8 +88,6 @@ export interface IController {
 
     ssoSilent(request: SsoSilentRequest): Promise<AuthenticationResult>;
 
-    getTokenCache(): ITokenCache;
-
     getLogger(): Logger;
 
     setLogger(logger: Logger): void;
@@ -125,3 +118,8 @@ export interface IController {
     /** @internal */
     getPerformanceClient(): IPerformanceClient;
 }
+
+export type HandleRedirectPromiseOptions = {
+    hash?: string;
+    navigateToLoginRequestUrl?: boolean;
+};