@azure/msal-common 15.7.1 → 15.8.1

package/src/client/BaseClient.ts

@@ -187,7 +187,11 @@ export abstract class BaseClient {
         options: NetworkRequestOptions,
         correlationId: string
     ): Promise<NetworkResponse<T>> {
-        ThrottlingUtils.preProcess(this.cacheManager, thumbprint);
+        ThrottlingUtils.preProcess(
+            this.cacheManager,
+            thumbprint,
+            correlationId
+        );
 
         let response;
         try {
@@ -244,7 +248,12 @@ export abstract class BaseClient {
             }
         }
 
-        ThrottlingUtils.postProcess(this.cacheManager, thumbprint, response);
+        ThrottlingUtils.postProcess(
+            this.cacheManager,
+            thumbprint,
+            response,
+            correlationId
+        );
 
         return response;
     }

package/src/client/RefreshTokenClient.ts

@@ -212,9 +212,9 @@ export class RefreshTokenClient extends BaseClient {
         )(
             request.account,
             foci,
+            request.correlationId,
             undefined,
-            this.performanceClient,
-            request.correlationId
+            this.performanceClient
         );
 
         if (!refreshToken) {
@@ -274,7 +274,10 @@ export class RefreshTokenClient extends BaseClient {
                     );
                     const badRefreshTokenKey =
                         generateCredentialKey(refreshToken);
-                    this.cacheManager.removeRefreshToken(badRefreshTokenKey);
+                    this.cacheManager.removeRefreshToken(
+                        badRefreshTokenKey,
+                        request.correlationId
+                    );
                 }
             }
 

package/src/client/SilentFlowClient.ts

@@ -115,14 +115,17 @@ export class SilentFlowClient extends BaseClient {
         const environment =
             request.authority || this.authority.getPreferredCache();
         const cacheRecord: CacheRecord = {
-            account: this.cacheManager.readAccountFromCache(request.account),
+            account: this.cacheManager.readAccountFromCache(
+                request.account,
+                request.correlationId
+            ),
             accessToken: cachedAccessToken,
             idToken: this.cacheManager.getIdToken(
                 request.account,
+                request.correlationId,
                 tokenKeys,
                 requestTenantId,
-                this.performanceClient,
-                request.correlationId
+                this.performanceClient
             ),
             refreshToken: null,
             appMetadata:

package/src/error/CacheError.ts

@@ -3,20 +3,20 @@
  * Licensed under the MIT License.
  */
 
+import { AuthError } from "./AuthError.js";
 import * as CacheErrorCodes from "./CacheErrorCodes.js";
 export { CacheErrorCodes };
 
 export const CacheErrorMessages = {
-    [CacheErrorCodes.cacheQuotaExceededErrorCode]:
-        "Exceeded cache storage capacity.",
-    [CacheErrorCodes.cacheUnknownErrorCode]:
+    [CacheErrorCodes.cacheQuotaExceeded]: "Exceeded cache storage capacity.",
+    [CacheErrorCodes.cacheErrorUnknown]:
         "Unexpected error occurred when using cache storage.",
 };
 
 /**
  * Error thrown when there is an error with the cache
  */
-export class CacheError extends Error {
+export class CacheError extends AuthError {
     /**
      * Short string denoting error
      */
@@ -32,7 +32,7 @@ export class CacheError extends Error {
             errorMessage ||
             (CacheErrorMessages[errorCode]
                 ? CacheErrorMessages[errorCode]
-                : CacheErrorMessages[CacheErrorCodes.cacheUnknownErrorCode]);
+                : CacheErrorMessages[CacheErrorCodes.cacheErrorUnknown]);
 
         super(`${errorCode}: ${message}`);
         Object.setPrototypeOf(this, CacheError.prototype);
@@ -42,3 +42,24 @@ export class CacheError extends Error {
         this.errorMessage = message;
     }
 }
+
+/**
+ * Helper function to wrap browser errors in a CacheError object
+ * @param e
+ * @returns
+ */
+export function createCacheError(e: unknown): CacheError {
+    if (!(e instanceof Error)) {
+        return new CacheError(CacheErrorCodes.cacheErrorUnknown);
+    }
+
+    if (
+        e.name === "QuotaExceededError" ||
+        e.name === "NS_ERROR_DOM_QUOTA_REACHED" ||
+        e.message.includes("exceeded the quota")
+    ) {
+        return new CacheError(CacheErrorCodes.cacheQuotaExceeded);
+    } else {
+        return new CacheError(e.name, e.message);
+    }
+}

package/src/error/CacheErrorCodes.ts

@@ -3,5 +3,5 @@
  * Licensed under the MIT License.
  */
 
-export const cacheQuotaExceededErrorCode = "cache_quota_exceeded";
-export const cacheUnknownErrorCode = "cache_error_unknown";
+export const cacheQuotaExceeded = "cache_quota_exceeded";
+export const cacheErrorUnknown = "cache_error_unknown";

package/src/error/ClientConfigurationError.ts

@@ -19,8 +19,6 @@ export const ClientConfigurationErrorMessages = {
     [ClientConfigurationErrorCodes.urlEmptyError]: "URL was empty or null.",
     [ClientConfigurationErrorCodes.emptyInputScopesError]:
         "Scopes cannot be passed as null, undefined or empty array because they are required to obtain an access token.",
-    [ClientConfigurationErrorCodes.invalidPromptValue]:
-        "Please see here for valid configuration options: https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_common.html#commonauthorizationurlrequest",
     [ClientConfigurationErrorCodes.invalidClaims]:
         "Given claims parameter must be a stringified JSON object.",
     [ClientConfigurationErrorCodes.tokenRequestEmpty]:
@@ -94,12 +92,6 @@ export const ClientConfigurationErrorMessage = {
             ClientConfigurationErrorCodes.emptyInputScopesError
         ],
     },
-    invalidPrompt: {
-        code: ClientConfigurationErrorCodes.invalidPromptValue,
-        desc: ClientConfigurationErrorMessages[
-            ClientConfigurationErrorCodes.invalidPromptValue
-        ],
-    },
     invalidClaimsRequest: {
         code: ClientConfigurationErrorCodes.invalidClaims,
         desc: ClientConfigurationErrorMessages[

package/src/error/ClientConfigurationErrorCodes.ts

@@ -9,7 +9,6 @@ export const authorityUriInsecure = "authority_uri_insecure";
 export const urlParseError = "url_parse_error";
 export const urlEmptyError = "empty_url_error";
 export const emptyInputScopesError = "empty_input_scopes_error";
-export const invalidPromptValue = "invalid_prompt_value";
 export const invalidClaims = "invalid_claims";
 export const tokenRequestEmpty = "token_request_empty";
 export const logoutRequestEmpty = "logout_request_empty";

package/src/exports-common.ts

@@ -142,7 +142,11 @@ export {
 } from "./error/AuthError.js";
 export { ServerError } from "./error/ServerError.js";
 export { NetworkError, createNetworkError } from "./error/NetworkError.js";
-export { CacheError, CacheErrorCodes } from "./error/CacheError.js";
+export {
+    CacheError,
+    CacheErrorCodes,
+    createCacheError,
+} from "./error/CacheError.js";
 export {
     ClientAuthError,
     ClientAuthErrorMessage,

package/src/network/ThrottlingUtils.ts

@@ -38,14 +38,15 @@ export class ThrottlingUtils {
      */
     static preProcess(
         cacheManager: CacheManager,
-        thumbprint: RequestThumbprint
+        thumbprint: RequestThumbprint,
+        correlationId: string
     ): void {
         const key = ThrottlingUtils.generateThrottlingStorageKey(thumbprint);
         const value = cacheManager.getThrottlingCache(key);
 
         if (value) {
             if (value.throttleTime < Date.now()) {
-                cacheManager.removeItem(key);
+                cacheManager.removeItem(key, correlationId);
                 return;
             }
             throw new ServerError(
@@ -65,7 +66,8 @@ export class ThrottlingUtils {
     static postProcess(
         cacheManager: CacheManager,
         thumbprint: RequestThumbprint,
-        response: NetworkResponse<ServerAuthorizationTokenResponse>
+        response: NetworkResponse<ServerAuthorizationTokenResponse>,
+        correlationId: string
     ): void {
         if (
             ThrottlingUtils.checkResponseStatus(response) ||
@@ -82,7 +84,8 @@ export class ThrottlingUtils {
             };
             cacheManager.setThrottlingCache(
                 ThrottlingUtils.generateThrottlingStorageKey(thumbprint),
-                thumbprintValue
+                thumbprintValue,
+                correlationId
             );
         }
     }
@@ -146,6 +149,6 @@ export class ThrottlingUtils {
             homeAccountIdentifier
         );
         const key = this.generateThrottlingStorageKey(thumbprint);
-        cacheManager.removeItem(key);
+        cacheManager.removeItem(key, request.correlationId);
     }
 }

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-common";
-export const version = "15.7.1";
+export const version = "15.8.1";

package/src/response/ResponseHandler.ts

@@ -279,7 +279,10 @@ export class ResponseHandler {
                 cacheRecord.account
             ) {
                 const key = cacheRecord.account.generateAccountKey();
-                const account = this.cacheStorage.getAccount(key);
+                const account = this.cacheStorage.getAccount(
+                    key,
+                    request.correlationId
+                );
                 if (!account) {
                     this.logger.warning(
                         "Account used to refresh tokens not in persistence, refreshed tokens will not be stored in the cache"
@@ -369,6 +372,7 @@ export class ResponseHandler {
                 authority,
                 this.homeAccountIdentifier,
                 this.cryptoObj.base64Decode,
+                request.correlationId,
                 idTokenClaims,
                 serverTokenResponse.client_info,
                 env,
@@ -610,6 +614,7 @@ export function buildAccountToCache(
     authority: Authority,
     homeAccountId: string,
     base64Decode: (input: string) => string,
+    correlationId: string,
     idTokenClaims?: TokenClaims,
     clientInfo?: string,
     environment?: string,
@@ -628,7 +633,7 @@ export function buildAccountToCache(
 
     let cachedAccount: AccountEntity | null = null;
     if (baseAccountKey) {
-        cachedAccount = cacheStorage.getAccount(baseAccountKey);
+        cachedAccount = cacheStorage.getAccount(baseAccountKey, correlationId);
     }
 
     const baseAccount =

package/src/telemetry/server/ServerTelemetryManager.ts

@@ -204,7 +204,8 @@ export class ServerTelemetryManager {
 
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
 
         return;
@@ -219,7 +220,8 @@ export class ServerTelemetryManager {
 
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
         return lastRequests.cacheHits;
     }
@@ -250,7 +252,10 @@ export class ServerTelemetryManager {
         const errorCount = lastRequests.errors.length;
         if (numErrorsFlushed === errorCount) {
             // All errors were sent on last request, clear Telemetry cache
-            this.cacheManager.removeItem(this.telemetryCacheKey);
+            this.cacheManager.removeItem(
+                this.telemetryCacheKey,
+                this.correlationId
+            );
         } else {
             // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed
             const serverTelemEntity: ServerTelemetryEntity = {
@@ -263,7 +268,8 @@ export class ServerTelemetryManager {
 
             this.cacheManager.setServerTelemetry(
                 this.telemetryCacheKey,
-                serverTelemEntity
+                serverTelemEntity,
+                this.correlationId
             );
         }
     }
@@ -351,7 +357,8 @@ export class ServerTelemetryManager {
         lastRequests.nativeBrokerErrorCode = errorCode;
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
     }
 
@@ -364,7 +371,8 @@ export class ServerTelemetryManager {
         delete lastRequests.nativeBrokerErrorCode;
         this.cacheManager.setServerTelemetry(
             this.telemetryCacheKey,
-            lastRequests
+            lastRequests,
+            this.correlationId
         );
     }
 

package/dist/request/RequestValidator.d.ts

@@ -1,28 +0,0 @@
-/**
- * Validates server consumable params from the "request" objects
- */
-export declare class RequestValidator {
-    /**
-     * Utility to check if the `redirectUri` in the request is a non-null value
-     * @param redirectUri
-     */
-    static validateRedirectUri(redirectUri: string): void;
-    /**
-     * Utility to validate prompt sent by the user in the request
-     * @param prompt
-     */
-    static validatePrompt(prompt: string): void;
-    static validateClaims(claims: string): void;
-    /**
-     * Utility to validate code_challenge and code_challenge_method
-     * @param codeChallenge
-     * @param codeChallengeMethod
-     */
-    static validateCodeChallengeParams(codeChallenge: string, codeChallengeMethod: string): void;
-    /**
-     * Utility to validate code_challenge_method
-     * @param codeChallengeMethod
-     */
-    static validateCodeChallengeMethod(codeChallengeMethod: string): void;
-}
-//# sourceMappingURL=RequestValidator.d.ts.map

package/dist/request/RequestValidator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RequestValidator.d.ts","sourceRoot":"","sources":["../../src/request/RequestValidator.ts"],"names":[],"mappings":"AAWA;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAQrD;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAc3C,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAU3C;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAC9B,aAAa,EAAE,MAAM,EACrB,mBAAmB,EAAE,MAAM,GAC5B,IAAI;IAUP;;;OAGG;IACH,MAAM,CAAC,2BAA2B,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI;CAYxE"}

package/dist/request/RequestValidator.mjs

@@ -1,73 +0,0 @@
-/*! @azure/msal-common v15.7.1 2025-06-18 */
-'use strict';
-import { createClientConfigurationError } from '../error/ClientConfigurationError.mjs';
-import { CodeChallengeMethodValues, PromptValue } from '../utils/Constants.mjs';
-import { redirectUriEmpty, invalidPromptValue, invalidClaims, pkceParamsMissing, invalidCodeChallengeMethod } from '../error/ClientConfigurationErrorCodes.mjs';
-
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Validates server consumable params from the "request" objects
- */
-class RequestValidator {
-    /**
-     * Utility to check if the `redirectUri` in the request is a non-null value
-     * @param redirectUri
-     */
-    static validateRedirectUri(redirectUri) {
-        if (!redirectUri) {
-            throw createClientConfigurationError(redirectUriEmpty);
-        }
-    }
-    /**
-     * Utility to validate prompt sent by the user in the request
-     * @param prompt
-     */
-    static validatePrompt(prompt) {
-        const promptValues = [];
-        for (const value in PromptValue) {
-            promptValues.push(PromptValue[value]);
-        }
-        if (promptValues.indexOf(prompt) < 0) {
-            throw createClientConfigurationError(invalidPromptValue);
-        }
-    }
-    static validateClaims(claims) {
-        try {
-            JSON.parse(claims);
-        }
-        catch (e) {
-            throw createClientConfigurationError(invalidClaims);
-        }
-    }
-    /**
-     * Utility to validate code_challenge and code_challenge_method
-     * @param codeChallenge
-     * @param codeChallengeMethod
-     */
-    static validateCodeChallengeParams(codeChallenge, codeChallengeMethod) {
-        if (!codeChallenge || !codeChallengeMethod) {
-            throw createClientConfigurationError(pkceParamsMissing);
-        }
-        else {
-            this.validateCodeChallengeMethod(codeChallengeMethod);
-        }
-    }
-    /**
-     * Utility to validate code_challenge_method
-     * @param codeChallengeMethod
-     */
-    static validateCodeChallengeMethod(codeChallengeMethod) {
-        if ([
-            CodeChallengeMethodValues.PLAIN,
-            CodeChallengeMethodValues.S256,
-        ].indexOf(codeChallengeMethod) < 0) {
-            throw createClientConfigurationError(invalidCodeChallengeMethod);
-        }
-    }
-}
-
-export { RequestValidator };
-//# sourceMappingURL=RequestValidator.mjs.map

package/dist/request/RequestValidator.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"RequestValidator.mjs","sources":["../../src/request/RequestValidator.ts"],"sourcesContent":[null],"names":["ClientConfigurationErrorCodes.redirectUriEmpty","ClientConfigurationErrorCodes.invalidPromptValue","ClientConfigurationErrorCodes.invalidClaims","ClientConfigurationErrorCodes.pkceParamsMissing","ClientConfigurationErrorCodes.invalidCodeChallengeMethod"],"mappings":";;;;;;AAAA;;;AAGG;AAQH;;AAEG;MACU,gBAAgB,CAAA;AACzB;;;AAGG;IACH,OAAO,mBAAmB,CAAC,WAAmB,EAAA;QAC1C,IAAI,CAAC,WAAW,EAAE;AACd,YAAA,MAAM,8BAA8B,CAChCA,gBAA8C,CACjD,CAAC;AACL,SAAA;KACJ;AAED;;;AAGG;IACH,OAAO,cAAc,CAAC,MAAc,EAAA;QAChC,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB,QAAA,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE;YAC7B,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;AACzC,SAAA;QAED,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;AAClC,YAAA,MAAM,8BAA8B,CAChCC,kBAAgD,CACnD,CAAC;AACL,SAAA;KACJ;IAED,OAAO,cAAc,CAAC,MAAc,EAAA;QAChC,IAAI;AACA,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACtB,SAAA;AAAC,QAAA,OAAO,CAAC,EAAE;AACR,YAAA,MAAM,8BAA8B,CAChCC,aAA2C,CAC9C,CAAC;AACL,SAAA;KACJ;AAED;;;;AAIG;AACH,IAAA,OAAO,2BAA2B,CAC9B,aAAqB,EACrB,mBAA2B,EAAA;AAE3B,QAAA,IAAI,CAAC,aAAa,IAAI,CAAC,mBAAmB,EAAE;AACxC,YAAA,MAAM,8BAA8B,CAChCC,iBAA+C,CAClD,CAAC;AACL,SAAA;AAAM,aAAA;AACH,YAAA,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,CAAC;AACzD,SAAA;KACJ;AAED;;;AAGG;IACH,OAAO,2BAA2B,CAAC,mBAA2B,EAAA;QAC1D,IACI;AACI,YAAA,yBAAyB,CAAC,KAAK;AAC/B,YAAA,yBAAyB,CAAC,IAAI;AACjC,SAAA,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,EACpC;AACE,YAAA,MAAM,8BAA8B,CAChCC,0BAAwD,CAC3D,CAAC;AACL,SAAA;KACJ;AACJ;;;;"}