@azure/msal-common 14.8.0 → 14.9.0

package/dist/index.cjs

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v14.8.0 2024-03-22 */
+/*! @azure/msal-common v14.9.0 2024-04-11 */
 'use strict';
 'use strict';
 
@@ -66,11 +66,20 @@ const Constants = {
 };
 const HttpStatus = {
     SUCCESS_RANGE_START: 200,
+    SUCCESS: 200,
     SUCCESS_RANGE_END: 299,
     REDIRECT: 302,
     CLIENT_ERROR_RANGE_START: 400,
+    BAD_REQUEST: 400,
+    UNAUTHORIZED: 401,
+    NOT_FOUND: 404,
+    REQUEST_TIMEOUT: 408,
+    TOO_MANY_REQUESTS: 429,
     CLIENT_ERROR_RANGE_END: 499,
     SERVER_ERROR_RANGE_START: 500,
+    INTERNAL_SERVER_ERROR: 500,
+    SERVICE_UNAVAILABLE: 503,
+    GATEWAY_TIMEOUT: 504,
     SERVER_ERROR_RANGE_END: 599,
 };
 const OIDC_DEFAULT_SCOPES = [
@@ -310,6 +319,8 @@ const JsonWebTokenTypes = {
     Pop: "pop",
 };
 const ONE_DAY_IN_MS = 86400000;
+// Token renewal offset default in seconds
+const DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300;
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -943,7 +954,7 @@ class Logger {
 
 /* eslint-disable header/header */
 const name = "@azure/msal-common";
-const version = "14.8.0";
+const version = "14.9.0";
 
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
@@ -2653,6 +2664,44 @@ function getCloudDiscoveryMetadataFromNetworkResponse(response, authorityHost) {
     return null;
 }
 
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const cacheQuotaExceededErrorCode = "cache_quota_exceeded";
+const cacheUnknownErrorCode = "cache_error_unknown";
+
+var CacheErrorCodes = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    cacheQuotaExceededErrorCode: cacheQuotaExceededErrorCode,
+    cacheUnknownErrorCode: cacheUnknownErrorCode
+});
+
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const CacheErrorMessages = {
+    [cacheQuotaExceededErrorCode]: "Exceeded cache storage capacity.",
+    [cacheUnknownErrorCode]: "Unexpected error occurred when using cache storage.",
+};
+/**
+ * Error thrown when there is an error with the cache
+ */
+class CacheError extends Error {
+    constructor(errorCode, errorMessage) {
+        const message = errorMessage ||
+            (CacheErrorMessages[errorCode]
+                ? CacheErrorMessages[errorCode]
+                : CacheErrorMessages[cacheUnknownErrorCode]);
+        super(`${errorCode}: ${message}`);
+        Object.setPrototypeOf(this, CacheError.prototype);
+        this.name = "CacheError";
+        this.errorCode = errorCode;
+        this.errorMessage = message;
+    }
+}
+
 /*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
@@ -2815,27 +2864,51 @@ class CacheManager {
     }
     /**
      * saves a cache record
-     * @param cacheRecord
+     * @param cacheRecord {CacheRecord}
+     * @param storeInCache {?StoreInCache}
+     * @param correlationId {?string} correlation id
      */
-    async saveCacheRecord(cacheRecord, storeInCache) {
+    async saveCacheRecord(cacheRecord, storeInCache, correlationId) {
         if (!cacheRecord) {
             throw createClientAuthError(invalidCacheRecord);
         }
-        if (!!cacheRecord.account) {
-            this.setAccount(cacheRecord.account);
-        }
-        if (!!cacheRecord.idToken && storeInCache?.idToken !== false) {
-            this.setIdTokenCredential(cacheRecord.idToken);
-        }
-        if (!!cacheRecord.accessToken && storeInCache?.accessToken !== false) {
-            await this.saveAccessToken(cacheRecord.accessToken);
-        }
-        if (!!cacheRecord.refreshToken &&
-            storeInCache?.refreshToken !== false) {
-            this.setRefreshTokenCredential(cacheRecord.refreshToken);
+        try {
+            if (!!cacheRecord.account) {
+                this.setAccount(cacheRecord.account);
+            }
+            if (!!cacheRecord.idToken && storeInCache?.idToken !== false) {
+                this.setIdTokenCredential(cacheRecord.idToken);
+            }
+            if (!!cacheRecord.accessToken &&
+                storeInCache?.accessToken !== false) {
+                await this.saveAccessToken(cacheRecord.accessToken);
+            }
+            if (!!cacheRecord.refreshToken &&
+                storeInCache?.refreshToken !== false) {
+                this.setRefreshTokenCredential(cacheRecord.refreshToken);
+            }
+            if (!!cacheRecord.appMetadata) {
+                this.setAppMetadata(cacheRecord.appMetadata);
+            }
         }
-        if (!!cacheRecord.appMetadata) {
-            this.setAppMetadata(cacheRecord.appMetadata);
+        catch (e) {
+            this.commonLogger?.error(`CacheManager.saveCacheRecord: failed`);
+            if (e instanceof Error) {
+                this.commonLogger?.errorPii(`CacheManager.saveCacheRecord: ${e.message}`, correlationId);
+                if (e.name === "QuotaExceededError" ||
+                    e.name === "NS_ERROR_DOM_QUOTA_REACHED" ||
+                    e.message.includes("exceeded the quota")) {
+                    this.commonLogger?.error(`CacheManager.saveCacheRecord: exceeded storage quota`, correlationId);
+                    throw new CacheError(cacheQuotaExceededErrorCode);
+                }
+                else {
+                    throw new CacheError(e.name, e.message);
+                }
+            }
+            else {
+                this.commonLogger?.errorPii(`CacheManager.saveCacheRecord: ${e}`, correlationId);
+                throw new CacheError(cacheUnknownErrorCode);
+            }
         }
     }
     /**
@@ -3886,8 +3959,6 @@ class DefaultStorageClass extends CacheManager {
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
-// Token renewal offset default in seconds
-const DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = 300;
 const DEFAULT_SYSTEM_OPTIONS = {
     tokenRenewalOffsetSeconds: DEFAULT_TOKEN_RENEWAL_OFFSET_SEC,
     preventCorsPreflight: false,
@@ -4802,6 +4873,7 @@ const PerformanceEvents = {
      * Used to acquire a new set of tokens from the authorize endpoint in a hidden iframe.
      */
     SilentIframeClientAcquireToken: "silentIframeClientAcquireToken",
+    AwaitConcurrentIframe: "awaitConcurrentIframe",
     /**
      * acquireToken API in SilentRereshClient (msal-browser).
      * Used to acquire a new set of tokens from the token endpoint using a refresh token.
@@ -5426,7 +5498,7 @@ RegionDiscovery.IMDS_OPTIONS = {
  * @internal
  */
 class Authority {
-    constructor(authority, networkInterface, cacheManager, authorityOptions, logger, correlationId, performanceClient) {
+    constructor(authority, networkInterface, cacheManager, authorityOptions, logger, correlationId, performanceClient, managedIdentity) {
         this.canonicalAuthority = authority;
         this._canonicalAuthority.validateAsUri();
         this.networkInterface = networkInterface;
@@ -5440,6 +5512,7 @@ class Authority {
         this.logger = logger;
         this.performanceClient = performanceClient;
         this.correlationId = correlationId;
+        this.managedIdentity = managedIdentity || false;
         this.regionDiscovery = new RegionDiscovery(networkInterface, this.logger, this.performanceClient, this.correlationId);
     }
     /**
@@ -5645,7 +5718,7 @@ class Authority {
         return `${this.canonicalAuthority}v2.0/.well-known/openid-configuration`;
     }
     /**
-     * Boolean that returns whethr or not tenant discovery has been completed.
+     * Boolean that returns whether or not tenant discovery has been completed.
      */
     discoveryComplete() {
         return !!this.metadata;
@@ -6097,7 +6170,10 @@ class Authority {
      * helper function to generate environment from authority object
      */
     getPreferredCache() {
-        if (this.discoveryComplete()) {
+        if (this.managedIdentity) {
+            return Constants.DEFAULT_AUTHORITY_HOST;
+        }
+        else if (this.discoveryComplete()) {
             return this.metadata.preferred_cache;
         }
         else {
@@ -6841,7 +6917,7 @@ class ResponseHandler {
                     return await ResponseHandler.generateAuthenticationResult(this.cryptoObj, authority, cacheRecord, false, request, idTokenClaims, requestStateObj, undefined, serverRequestId);
                 }
             }
-            await this.cacheStorage.saveCacheRecord(cacheRecord, request.storeInCache);
+            await this.cacheStorage.saveCacheRecord(cacheRecord, request.storeInCache, request.correlationId);
         }
         finally {
             if (this.persistencePlugin &&
@@ -7322,7 +7398,11 @@ class AuthorizationCodeClient extends BaseClient {
             }
             else if (request.account) {
                 const accountSid = this.extractAccountSid(request.account);
-                const accountLoginHintClaim = this.extractLoginHint(request.account);
+                let accountLoginHintClaim = this.extractLoginHint(request.account);
+                if (accountLoginHintClaim && request.domainHint) {
+                    this.logger.warning(`AuthorizationCodeClient.createAuthCodeUrlQueryString: "domainHint" param is set, skipping opaque "login_hint" claim. Please consider not passing domainHint`);
+                    accountLoginHintClaim = null;
+                }
                 // If login_hint claim is present, use it over sid/username
                 if (accountLoginHintClaim) {
                     this.logger.verbose("createAuthCodeUrlQueryString: login_hint claim present on account");
@@ -8295,6 +8375,10 @@ function addError(error, logger, event, stackMaxSize = 5) {
         event.subErrorCode = error.subError;
         return;
     }
+    else if (error instanceof CacheError) {
+        event.errorCode = error.errorCode;
+        return;
+    }
     else if (event.errorStack?.length) {
         logger.trace("PerformanceClient.addErrorStack: Stack already exist", event.correlationId);
         return;
@@ -8568,7 +8652,7 @@ class PerformanceClient {
             manuallyCompletedCount: 0,
         };
         event.durationMs = Math.round(event.durationMs || this.getDurationMs(event.startTimeMs));
-        const context = endContext(event, this.abbreviations, this.eventStack.get(rootEvent.correlationId), error);
+        const context = JSON.stringify(endContext(event, this.abbreviations, this.eventStack.get(rootEvent.correlationId), error));
         if (isRoot) {
             queueInfo = this.getQueueInfo(event.correlationId);
             this.discardCache(rootEvent.correlationId);
@@ -8795,6 +8879,8 @@ exports.AuthorizationCodeClient = AuthorizationCodeClient;
 exports.AzureCloudInstance = AzureCloudInstance;
 exports.BaseClient = BaseClient;
 exports.CacheAccountType = CacheAccountType;
+exports.CacheError = CacheError;
+exports.CacheErrorCodes = CacheErrorCodes;
 exports.CacheHelpers = CacheHelpers;
 exports.CacheManager = CacheManager;
 exports.CacheOutcome = CacheOutcome;
@@ -8813,6 +8899,7 @@ exports.Constants = Constants;
 exports.CredentialType = CredentialType;
 exports.DEFAULT_CRYPTO_IMPLEMENTATION = DEFAULT_CRYPTO_IMPLEMENTATION;
 exports.DEFAULT_SYSTEM_OPTIONS = DEFAULT_SYSTEM_OPTIONS;
+exports.DEFAULT_TOKEN_RENEWAL_OFFSET_SEC = DEFAULT_TOKEN_RENEWAL_OFFSET_SEC;
 exports.DefaultStorageClass = DefaultStorageClass;
 exports.Errors = Errors;
 exports.GrantType = GrantType;