@azure/msal-browser 5.0.0-beta.0 → 5.0.1

package/src/request/PopupRequest.ts

@@ -9,30 +9,6 @@ import { PopupWindowAttributes } from "./PopupWindowAttributes.js";
 /**
  * PopupRequest: Request object passed by user to retrieve a Code from the
  * server (first leg of authorization code grant flow) with a popup window.
- *
- * - 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 outgoing token service requests
- * - extraParameters            - String to string map of custom query parameters added to outgoing token service requests
- * - 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.
- * - popupWindowAttributes      - Optional popup window attributes. popupSize with height and width, and popupPosition with top and left can be set.
- * - popupWindowParent          - Optional window object to use as the parent when opening popup windows. Uses global `window` if not given.
- * - overrideInteractionInProgress - Optional flag to allow overriding an existing interaction_in_progress state for popup flows. **WARNING**: Use with caution! For usage details and examples, see the [login-user.md](../../../docs/login-user.md#handling-interaction_in_progress-errors) documentation.
  */
 
 export type PopupRequest = Partial<
@@ -46,8 +22,20 @@ export type PopupRequest = Partial<
         | "platformBroker"
     >
 > & {
+    /**
+     * Array of scopes the application is requesting access to.
+     */
     scopes: Array<string>;
+    /**
+     * Optional popup window attributes. popupSize with height and width, and popupPosition with top and left can be set.
+     */
     popupWindowAttributes?: PopupWindowAttributes;
+    /**
+     * Optional window object to use as the parent when opening popup windows. Uses global `window` if not given.
+     */
     popupWindowParent?: Window;
+    /**
+     * Optional flag to allow overriding an existing interaction_in_progress state for popup flows. **WARNING**: Use with caution! For usage details and examples, see the [login-user.md](../../../docs/login-user.md#handling-interaction_in_progress-errors) documentation.
+     */
     overrideInteractionInProgress?: boolean;
 };

package/src/request/RedirectRequest.ts

@@ -8,28 +8,6 @@ import { CommonAuthorizationUrlRequest } from "@azure/msal-common/browser";
 /**
  * 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 outgoing token service requests
- * - extraParameters            - String to string map of custom query parameters added to outgoing token service requests
- * - 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.
  */
 export type RedirectRequest = Partial<
     Omit<
@@ -42,6 +20,12 @@ export type RedirectRequest = Partial<
         | "platformBroker"
     >
 > & {
+    /**
+     * Array of scopes the application is requesting access to.
+     */
     scopes: Array<string>;
+    /**
+     * 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.
+     */
     redirectStartPage?: string;
 };

package/src/request/SilentRequest.ts

@@ -14,31 +14,51 @@ import { CacheLookupPolicy } from "../utils/BrowserConstants.js";
  * 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 outgoing token service requests. Only used when renewing access tokens.
- * - extraParameters        - String to string map of custom query parameters added to outgoing token service requests. 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"
 > & {
+    /**
+     * 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.
+     */
     redirectUri?: string;
+    /**
+     * String to string map of custom query parameters added to outgoing token service requests. Unless the parameter is ONLY supported on query string use extraParameters instead.
+     */
     extraQueryParameters?: StringDict;
+    /**
+     * Url of the authority which the application acquires tokens from.
+     */
     authority?: string;
+    /**
+     * Account entity to lookup the credentials.
+     */
     account?: AccountInfo;
+    /**
+     * Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+     */
     correlationId?: string;
+    /**
+     * Forces silent requests to make network calls if true.
+     */
     forceRefresh?: boolean;
+    /**
+     * Enum of different ways the silent token can be retrieved.
+     */
     cacheLookupPolicy?: CacheLookupPolicy;
+    /**
+     * 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.
+     */
     prompt?: string;
+    /**
+     * A value included in the request that is also returned in the token response when a hidden iframe is used.
+     */
     state?: string;
 };

package/src/request/SsoSilentRequest.ts

@@ -7,27 +7,6 @@ import { CommonAuthorizationUrlRequest } from "@azure/msal-common/browser";
 
 /**
  * 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 outgoing token service requests. Only used when renewing access tokens.
- * - extraParameters            - String to string map of custom query parameters added to outgoing token service requests. Only used when renewing access tokens.
- * - 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<

package/src/telemetry/BrowserPerformanceEvents.ts

@@ -179,3 +179,8 @@ export const Encrypt = "encrypt";
 export const Decrypt = "decrypt";
 export const GenerateEarKey = "generateEarKey";
 export const DecryptEarResponse = "decryptEarResponse";
+
+export const LoadAccount = "loadAccount";
+export const LoadIdToken = "loadIdToken";
+export const LoadAccessToken = "loadAccessToken";
+export const LoadRefreshToken = "loadRefreshToken";

package/src/telemetry/BrowserRootPerformanceEvents.ts

@@ -39,3 +39,5 @@ export const SsoSilent = "ssoSilent";
 export const InitializeClientApplication = "initializeClientApplication";
 // Update cache storage
 export const LocalStorageUpdated = "localStorageUpdated";
+// Load external tokens
+export const LoadExternalTokens = "loadExternalTokens";