@azure/msal-browser 3.20.0 → 3.21.0

package/dist/cache/TokenCache.d.ts

@@ -1,78 +1,78 @@
-import { ICrypto, Logger, ExternalTokenResponse } from "@azure/msal-common";
-import { BrowserConfiguration } from "../config/Configuration";
-import { SilentRequest } from "../request/SilentRequest";
-import { BrowserCacheManager } from "./BrowserCacheManager";
-import { ITokenCache } from "./ITokenCache";
-import { AuthenticationResult } from "../response/AuthenticationResult";
-export type LoadTokenOptions = {
-    clientInfo?: string;
-    expiresOn?: number;
-    extendedExpiresOn?: number;
-};
-/**
- * Token cache manager
- */
-export declare class TokenCache implements ITokenCache {
-    isBrowserEnvironment: boolean;
-    protected config: BrowserConfiguration;
-    private storage;
-    private logger;
-    private cryptoObj;
-    constructor(configuration: BrowserConfiguration, storage: BrowserCacheManager, logger: Logger, cryptoObj: ICrypto);
-    /**
-     * API to load tokens to msal-browser cache.
-     * @param request
-     * @param response
-     * @param options
-     * @returns `AuthenticationResult` for the response that was loaded.
-     */
-    loadExternalTokens(request: SilentRequest, response: ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult;
-    /**
-     * Helper function to load account to msal-browser cache
-     * @param idToken
-     * @param environment
-     * @param clientInfo
-     * @param authorityType
-     * @param requestHomeAccountId
-     * @returns `AccountEntity`
-     */
-    private loadAccount;
-    /**
-     * Helper function to load id tokens to msal-browser cache
-     * @param idToken
-     * @param homeAccountId
-     * @param environment
-     * @param tenantId
-     * @returns `IdTokenEntity`
-     */
-    private loadIdToken;
-    /**
-     * Helper function to load access tokens to msal-browser cache
-     * @param request
-     * @param response
-     * @param homeAccountId
-     * @param environment
-     * @param tenantId
-     * @returns `AccessTokenEntity`
-     */
-    private loadAccessToken;
-    /**
-     * Helper function to load refresh tokens to msal-browser cache
-     * @param request
-     * @param response
-     * @param homeAccountId
-     * @param environment
-     * @returns `RefreshTokenEntity`
-     */
-    private loadRefreshToken;
-    /**
-     * Helper function to generate an `AuthenticationResult` for the result.
-     * @param request
-     * @param idTokenObj
-     * @param cacheRecord
-     * @param authority
-     * @returns `AuthenticationResult`
-     */
-    private generateAuthenticationResult;
-}
+import { ICrypto, Logger, ExternalTokenResponse } from "@azure/msal-common";
+import { BrowserConfiguration } from "../config/Configuration";
+import { SilentRequest } from "../request/SilentRequest";
+import { BrowserCacheManager } from "./BrowserCacheManager";
+import { ITokenCache } from "./ITokenCache";
+import { AuthenticationResult } from "../response/AuthenticationResult";
+export type LoadTokenOptions = {
+    clientInfo?: string;
+    expiresOn?: number;
+    extendedExpiresOn?: number;
+};
+/**
+ * Token cache manager
+ */
+export declare class TokenCache implements ITokenCache {
+    isBrowserEnvironment: boolean;
+    protected config: BrowserConfiguration;
+    private storage;
+    private logger;
+    private cryptoObj;
+    constructor(configuration: BrowserConfiguration, storage: BrowserCacheManager, logger: Logger, cryptoObj: ICrypto);
+    /**
+     * API to load tokens to msal-browser cache.
+     * @param request
+     * @param response
+     * @param options
+     * @returns `AuthenticationResult` for the response that was loaded.
+     */
+    loadExternalTokens(request: SilentRequest, response: ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult;
+    /**
+     * Helper function to load account to msal-browser cache
+     * @param idToken
+     * @param environment
+     * @param clientInfo
+     * @param authorityType
+     * @param requestHomeAccountId
+     * @returns `AccountEntity`
+     */
+    private loadAccount;
+    /**
+     * Helper function to load id tokens to msal-browser cache
+     * @param idToken
+     * @param homeAccountId
+     * @param environment
+     * @param tenantId
+     * @returns `IdTokenEntity`
+     */
+    private loadIdToken;
+    /**
+     * Helper function to load access tokens to msal-browser cache
+     * @param request
+     * @param response
+     * @param homeAccountId
+     * @param environment
+     * @param tenantId
+     * @returns `AccessTokenEntity`
+     */
+    private loadAccessToken;
+    /**
+     * Helper function to load refresh tokens to msal-browser cache
+     * @param request
+     * @param response
+     * @param homeAccountId
+     * @param environment
+     * @returns `RefreshTokenEntity`
+     */
+    private loadRefreshToken;
+    /**
+     * Helper function to generate an `AuthenticationResult` for the result.
+     * @param request
+     * @param idTokenObj
+     * @param cacheRecord
+     * @param authority
+     * @returns `AuthenticationResult`
+     */
+    private generateAuthenticationResult;
+}
 //# sourceMappingURL=TokenCache.d.ts.map

package/dist/cache/TokenCache.mjs

@@ -1,4 +1,4 @@
-/*! @azure/msal-browser v3.20.0 2024-07-23 */
+/*! @azure/msal-browser v3.21.0 2024-08-13 */
 'use strict';
 import { AuthToken, Authority, AccountEntity, buildAccountToCache, CacheHelpers, ScopeSet } from '@azure/msal-common';
 import { createBrowserAuthError } from '../error/BrowserAuthError.mjs';
@@ -6,200 +6,200 @@ import { base64Decode } from '../encode/Base64Decode.mjs';
 import { createNewGuid } from '../crypto/BrowserCrypto.mjs';
 import { nonBrowserEnvironment, unableToLoadToken } from '../error/BrowserAuthErrorCodes.mjs';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Token cache manager
- */
-class TokenCache {
-    constructor(configuration, storage, logger, cryptoObj) {
-        this.isBrowserEnvironment = typeof window !== "undefined";
-        this.config = configuration;
-        this.storage = storage;
-        this.logger = logger;
-        this.cryptoObj = cryptoObj;
-    }
-    // Move getAllAccounts here and cache utility APIs
-    /**
-     * API to load tokens to msal-browser cache.
-     * @param request
-     * @param response
-     * @param options
-     * @returns `AuthenticationResult` for the response that was loaded.
-     */
-    loadExternalTokens(request, response, options) {
-        if (!this.isBrowserEnvironment) {
-            throw createBrowserAuthError(nonBrowserEnvironment);
-        }
-        const idTokenClaims = response.id_token
-            ? AuthToken.extractTokenClaims(response.id_token, base64Decode)
-            : undefined;
-        const authorityOptions = {
-            protocolMode: this.config.auth.protocolMode,
-            knownAuthorities: this.config.auth.knownAuthorities,
-            cloudDiscoveryMetadata: this.config.auth.cloudDiscoveryMetadata,
-            authorityMetadata: this.config.auth.authorityMetadata,
-            skipAuthorityMetadataCache: this.config.auth.skipAuthorityMetadataCache,
-        };
-        const authority = request.authority
-            ? new Authority(Authority.generateAuthority(request.authority, request.azureCloudOptions), this.config.system.networkClient, this.storage, authorityOptions, this.logger, request.correlationId || createNewGuid())
-            : undefined;
-        const cacheRecordAccount = this.loadAccount(request, options.clientInfo || response.client_info || "", idTokenClaims, authority);
-        const idToken = this.loadIdToken(response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment, cacheRecordAccount.realm);
-        const accessToken = this.loadAccessToken(request, response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment, cacheRecordAccount.realm, options);
-        const refreshToken = this.loadRefreshToken(response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment);
-        return this.generateAuthenticationResult(request, {
-            account: cacheRecordAccount,
-            idToken,
-            accessToken,
-            refreshToken,
-        }, idTokenClaims, authority);
-    }
-    /**
-     * Helper function to load account to msal-browser cache
-     * @param idToken
-     * @param environment
-     * @param clientInfo
-     * @param authorityType
-     * @param requestHomeAccountId
-     * @returns `AccountEntity`
-     */
-    loadAccount(request, clientInfo, idTokenClaims, authority) {
-        this.logger.verbose("TokenCache - loading account");
-        if (request.account) {
-            const accountEntity = AccountEntity.createFromAccountInfo(request.account);
-            this.storage.setAccount(accountEntity);
-            return accountEntity;
-        }
-        else if (!authority || (!clientInfo && !idTokenClaims)) {
-            this.logger.error("TokenCache - if an account is not provided on the request, authority and either clientInfo or idToken must be provided instead.");
-            throw createBrowserAuthError(unableToLoadToken);
-        }
-        const homeAccountId = AccountEntity.generateHomeAccountId(clientInfo, authority.authorityType, this.logger, this.cryptoObj, idTokenClaims);
-        const claimsTenantId = idTokenClaims?.tid;
-        const cachedAccount = buildAccountToCache(this.storage, authority, homeAccountId, base64Decode, idTokenClaims, clientInfo, authority.hostnameAndPort, claimsTenantId, undefined, // authCodePayload
-        undefined, // nativeAccountId
-        this.logger);
-        this.storage.setAccount(cachedAccount);
-        return cachedAccount;
-    }
-    /**
-     * Helper function to load id tokens to msal-browser cache
-     * @param idToken
-     * @param homeAccountId
-     * @param environment
-     * @param tenantId
-     * @returns `IdTokenEntity`
-     */
-    loadIdToken(response, homeAccountId, environment, tenantId) {
-        if (!response.id_token) {
-            this.logger.verbose("TokenCache - no id token found in response");
-            return null;
-        }
-        this.logger.verbose("TokenCache - loading id token");
-        const idTokenEntity = CacheHelpers.createIdTokenEntity(homeAccountId, environment, response.id_token, this.config.auth.clientId, tenantId);
-        this.storage.setIdTokenCredential(idTokenEntity);
-        return idTokenEntity;
-    }
-    /**
-     * Helper function to load access tokens to msal-browser cache
-     * @param request
-     * @param response
-     * @param homeAccountId
-     * @param environment
-     * @param tenantId
-     * @returns `AccessTokenEntity`
-     */
-    loadAccessToken(request, response, homeAccountId, environment, tenantId, options) {
-        if (!response.access_token) {
-            this.logger.verbose("TokenCache - no access token found in response");
-            return null;
-        }
-        else if (!response.expires_in) {
-            this.logger.error("TokenCache - no expiration set on the access token. Cannot add it to the cache.");
-            return null;
-        }
-        else if (!response.scope &&
-            (!request.scopes || !request.scopes.length)) {
-            this.logger.error("TokenCache - scopes not specified in the request or response. Cannot add token to the cache.");
-            return null;
-        }
-        this.logger.verbose("TokenCache - loading access token");
-        const scopes = response.scope
-            ? ScopeSet.fromString(response.scope)
-            : new ScopeSet(request.scopes);
-        const expiresOn = options.expiresOn ||
-            response.expires_in + new Date().getTime() / 1000;
-        const extendedExpiresOn = options.extendedExpiresOn ||
-            (response.ext_expires_in || response.expires_in) +
-                new Date().getTime() / 1000;
-        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(homeAccountId, environment, response.access_token, this.config.auth.clientId, tenantId, scopes.printScopes(), expiresOn, extendedExpiresOn, base64Decode);
-        this.storage.setAccessTokenCredential(accessTokenEntity);
-        return accessTokenEntity;
-    }
-    /**
-     * Helper function to load refresh tokens to msal-browser cache
-     * @param request
-     * @param response
-     * @param homeAccountId
-     * @param environment
-     * @returns `RefreshTokenEntity`
-     */
-    loadRefreshToken(response, homeAccountId, environment) {
-        if (!response.refresh_token) {
-            this.logger.verbose("TokenCache - no refresh token found in response");
-            return null;
-        }
-        this.logger.verbose("TokenCache - loading refresh token");
-        const refreshTokenEntity = CacheHelpers.createRefreshTokenEntity(homeAccountId, environment, response.refresh_token, this.config.auth.clientId, response.foci, undefined, // userAssertionHash
-        response.refresh_token_expires_in);
-        this.storage.setRefreshTokenCredential(refreshTokenEntity);
-        return refreshTokenEntity;
-    }
-    /**
-     * Helper function to generate an `AuthenticationResult` for the result.
-     * @param request
-     * @param idTokenObj
-     * @param cacheRecord
-     * @param authority
-     * @returns `AuthenticationResult`
-     */
-    generateAuthenticationResult(request, cacheRecord, idTokenClaims, authority) {
-        let accessToken = "";
-        let responseScopes = [];
-        let expiresOn = null;
-        let extExpiresOn;
-        if (cacheRecord?.accessToken) {
-            accessToken = cacheRecord.accessToken.secret;
-            responseScopes = ScopeSet.fromString(cacheRecord.accessToken.target).asArray();
-            expiresOn = new Date(Number(cacheRecord.accessToken.expiresOn) * 1000);
-            extExpiresOn = new Date(Number(cacheRecord.accessToken.extendedExpiresOn) * 1000);
-        }
-        const accountEntity = cacheRecord.account;
-        return {
-            authority: authority ? authority.canonicalAuthority : "",
-            uniqueId: cacheRecord.account.localAccountId,
-            tenantId: cacheRecord.account.realm,
-            scopes: responseScopes,
-            account: accountEntity.getAccountInfo(),
-            idToken: cacheRecord.idToken?.secret || "",
-            idTokenClaims: idTokenClaims || {},
-            accessToken: accessToken,
-            fromCache: true,
-            expiresOn: expiresOn,
-            correlationId: request.correlationId || "",
-            requestId: "",
-            extExpiresOn: extExpiresOn,
-            familyId: cacheRecord.refreshToken?.familyId || "",
-            tokenType: cacheRecord?.accessToken?.tokenType || "",
-            state: request.state || "",
-            cloudGraphHostName: accountEntity.cloudGraphHostName || "",
-            msGraphHost: accountEntity.msGraphHost || "",
-            fromNativeBroker: false,
-        };
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Token cache manager
+ */
+class TokenCache {
+    constructor(configuration, storage, logger, cryptoObj) {
+        this.isBrowserEnvironment = typeof window !== "undefined";
+        this.config = configuration;
+        this.storage = storage;
+        this.logger = logger;
+        this.cryptoObj = cryptoObj;
+    }
+    // Move getAllAccounts here and cache utility APIs
+    /**
+     * API to load tokens to msal-browser cache.
+     * @param request
+     * @param response
+     * @param options
+     * @returns `AuthenticationResult` for the response that was loaded.
+     */
+    loadExternalTokens(request, response, options) {
+        if (!this.isBrowserEnvironment) {
+            throw createBrowserAuthError(nonBrowserEnvironment);
+        }
+        const idTokenClaims = response.id_token
+            ? AuthToken.extractTokenClaims(response.id_token, base64Decode)
+            : undefined;
+        const authorityOptions = {
+            protocolMode: this.config.auth.protocolMode,
+            knownAuthorities: this.config.auth.knownAuthorities,
+            cloudDiscoveryMetadata: this.config.auth.cloudDiscoveryMetadata,
+            authorityMetadata: this.config.auth.authorityMetadata,
+            skipAuthorityMetadataCache: this.config.auth.skipAuthorityMetadataCache,
+        };
+        const authority = request.authority
+            ? new Authority(Authority.generateAuthority(request.authority, request.azureCloudOptions), this.config.system.networkClient, this.storage, authorityOptions, this.logger, request.correlationId || createNewGuid())
+            : undefined;
+        const cacheRecordAccount = this.loadAccount(request, options.clientInfo || response.client_info || "", idTokenClaims, authority);
+        const idToken = this.loadIdToken(response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment, cacheRecordAccount.realm);
+        const accessToken = this.loadAccessToken(request, response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment, cacheRecordAccount.realm, options);
+        const refreshToken = this.loadRefreshToken(response, cacheRecordAccount.homeAccountId, cacheRecordAccount.environment);
+        return this.generateAuthenticationResult(request, {
+            account: cacheRecordAccount,
+            idToken,
+            accessToken,
+            refreshToken,
+        }, idTokenClaims, authority);
+    }
+    /**
+     * Helper function to load account to msal-browser cache
+     * @param idToken
+     * @param environment
+     * @param clientInfo
+     * @param authorityType
+     * @param requestHomeAccountId
+     * @returns `AccountEntity`
+     */
+    loadAccount(request, clientInfo, idTokenClaims, authority) {
+        this.logger.verbose("TokenCache - loading account");
+        if (request.account) {
+            const accountEntity = AccountEntity.createFromAccountInfo(request.account);
+            this.storage.setAccount(accountEntity);
+            return accountEntity;
+        }
+        else if (!authority || (!clientInfo && !idTokenClaims)) {
+            this.logger.error("TokenCache - if an account is not provided on the request, authority and either clientInfo or idToken must be provided instead.");
+            throw createBrowserAuthError(unableToLoadToken);
+        }
+        const homeAccountId = AccountEntity.generateHomeAccountId(clientInfo, authority.authorityType, this.logger, this.cryptoObj, idTokenClaims);
+        const claimsTenantId = idTokenClaims?.tid;
+        const cachedAccount = buildAccountToCache(this.storage, authority, homeAccountId, base64Decode, idTokenClaims, clientInfo, authority.hostnameAndPort, claimsTenantId, undefined, // authCodePayload
+        undefined, // nativeAccountId
+        this.logger);
+        this.storage.setAccount(cachedAccount);
+        return cachedAccount;
+    }
+    /**
+     * Helper function to load id tokens to msal-browser cache
+     * @param idToken
+     * @param homeAccountId
+     * @param environment
+     * @param tenantId
+     * @returns `IdTokenEntity`
+     */
+    loadIdToken(response, homeAccountId, environment, tenantId) {
+        if (!response.id_token) {
+            this.logger.verbose("TokenCache - no id token found in response");
+            return null;
+        }
+        this.logger.verbose("TokenCache - loading id token");
+        const idTokenEntity = CacheHelpers.createIdTokenEntity(homeAccountId, environment, response.id_token, this.config.auth.clientId, tenantId);
+        this.storage.setIdTokenCredential(idTokenEntity);
+        return idTokenEntity;
+    }
+    /**
+     * Helper function to load access tokens to msal-browser cache
+     * @param request
+     * @param response
+     * @param homeAccountId
+     * @param environment
+     * @param tenantId
+     * @returns `AccessTokenEntity`
+     */
+    loadAccessToken(request, response, homeAccountId, environment, tenantId, options) {
+        if (!response.access_token) {
+            this.logger.verbose("TokenCache - no access token found in response");
+            return null;
+        }
+        else if (!response.expires_in) {
+            this.logger.error("TokenCache - no expiration set on the access token. Cannot add it to the cache.");
+            return null;
+        }
+        else if (!response.scope &&
+            (!request.scopes || !request.scopes.length)) {
+            this.logger.error("TokenCache - scopes not specified in the request or response. Cannot add token to the cache.");
+            return null;
+        }
+        this.logger.verbose("TokenCache - loading access token");
+        const scopes = response.scope
+            ? ScopeSet.fromString(response.scope)
+            : new ScopeSet(request.scopes);
+        const expiresOn = options.expiresOn ||
+            response.expires_in + new Date().getTime() / 1000;
+        const extendedExpiresOn = options.extendedExpiresOn ||
+            (response.ext_expires_in || response.expires_in) +
+                new Date().getTime() / 1000;
+        const accessTokenEntity = CacheHelpers.createAccessTokenEntity(homeAccountId, environment, response.access_token, this.config.auth.clientId, tenantId, scopes.printScopes(), expiresOn, extendedExpiresOn, base64Decode);
+        this.storage.setAccessTokenCredential(accessTokenEntity);
+        return accessTokenEntity;
+    }
+    /**
+     * Helper function to load refresh tokens to msal-browser cache
+     * @param request
+     * @param response
+     * @param homeAccountId
+     * @param environment
+     * @returns `RefreshTokenEntity`
+     */
+    loadRefreshToken(response, homeAccountId, environment) {
+        if (!response.refresh_token) {
+            this.logger.verbose("TokenCache - no refresh token found in response");
+            return null;
+        }
+        this.logger.verbose("TokenCache - loading refresh token");
+        const refreshTokenEntity = CacheHelpers.createRefreshTokenEntity(homeAccountId, environment, response.refresh_token, this.config.auth.clientId, response.foci, undefined, // userAssertionHash
+        response.refresh_token_expires_in);
+        this.storage.setRefreshTokenCredential(refreshTokenEntity);
+        return refreshTokenEntity;
+    }
+    /**
+     * Helper function to generate an `AuthenticationResult` for the result.
+     * @param request
+     * @param idTokenObj
+     * @param cacheRecord
+     * @param authority
+     * @returns `AuthenticationResult`
+     */
+    generateAuthenticationResult(request, cacheRecord, idTokenClaims, authority) {
+        let accessToken = "";
+        let responseScopes = [];
+        let expiresOn = null;
+        let extExpiresOn;
+        if (cacheRecord?.accessToken) {
+            accessToken = cacheRecord.accessToken.secret;
+            responseScopes = ScopeSet.fromString(cacheRecord.accessToken.target).asArray();
+            expiresOn = new Date(Number(cacheRecord.accessToken.expiresOn) * 1000);
+            extExpiresOn = new Date(Number(cacheRecord.accessToken.extendedExpiresOn) * 1000);
+        }
+        const accountEntity = cacheRecord.account;
+        return {
+            authority: authority ? authority.canonicalAuthority : "",
+            uniqueId: cacheRecord.account.localAccountId,
+            tenantId: cacheRecord.account.realm,
+            scopes: responseScopes,
+            account: accountEntity.getAccountInfo(),
+            idToken: cacheRecord.idToken?.secret || "",
+            idTokenClaims: idTokenClaims || {},
+            accessToken: accessToken,
+            fromCache: true,
+            expiresOn: expiresOn,
+            correlationId: request.correlationId || "",
+            requestId: "",
+            extExpiresOn: extExpiresOn,
+            familyId: cacheRecord.refreshToken?.familyId || "",
+            tokenType: cacheRecord?.accessToken?.tokenType || "",
+            state: request.state || "",
+            cloudGraphHostName: accountEntity.cloudGraphHostName || "",
+            msGraphHost: accountEntity.msGraphHost || "",
+            fromNativeBroker: false,
+        };
+    }
 }
 
 export { TokenCache };