@azure/msal-common 14.3.0 → 14.4.1-beta.0

package/src/telemetry/server/ServerTelemetryManager.ts

@@ -160,7 +160,11 @@ export class ServerTelemetryManager {
      * Get the server telemetry entity from cache or initialize a new one
      */
     getLastRequests(): ServerTelemetryEntity {
-        const initialValue: ServerTelemetryEntity = new ServerTelemetryEntity();
+        const initialValue: ServerTelemetryEntity = {
+            failedRequests: [],
+            errors: [],
+            cacheHits: 0,
+        };
         const lastRequests = this.cacheManager.getServerTelemetry(
             this.telemetryCacheKey
         ) as ServerTelemetryEntity;
@@ -181,11 +185,13 @@ export class ServerTelemetryManager {
             this.cacheManager.removeItem(this.telemetryCacheKey);
         } else {
             // Partial data was flushed to server, construct a new telemetry cache item with errors that were not flushed
-            const serverTelemEntity = new ServerTelemetryEntity();
-            serverTelemEntity.failedRequests =
-                lastRequests.failedRequests.slice(numErrorsFlushed * 2); // failedRequests contains 2 items for each error
-            serverTelemEntity.errors =
-                lastRequests.errors.slice(numErrorsFlushed);
+            const serverTelemEntity: ServerTelemetryEntity = {
+                failedRequests: lastRequests.failedRequests.slice(
+                    numErrorsFlushed * 2
+                ), // failedRequests contains 2 items for each error
+                errors: lastRequests.errors.slice(numErrorsFlushed),
+                cacheHits: 0,
+            };
 
             this.cacheManager.setServerTelemetry(
                 this.telemetryCacheKey,

package/src/url/UrlString.ts

@@ -3,22 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
 import {
     createClientConfigurationError,
     ClientConfigurationErrorCodes,
 } from "../error/ClientConfigurationError";
-import {
-    ClientAuthErrorCodes,
-    createClientAuthError,
-} from "../error/ClientAuthError";
 import { StringUtils } from "../utils/StringUtils";
 import { IUri } from "./IUri";
-import {
-    AADAuthorityConstants,
-    Constants,
-    ServerResponseType,
-} from "../utils/Constants";
+import { AADAuthorityConstants, Constants } from "../utils/Constants";
+import * as UrlUtils from "../utils/UrlUtils";
 
 /**
  * Url object class which can perform various transformations on url strings.
@@ -39,7 +31,7 @@ export class UrlString {
             );
         }
 
-        if (!this.getHash()) {
+        if (!url.includes("#")) {
             this._urlString = UrlString.canonicalizeUri(url);
         }
     }
@@ -142,13 +134,6 @@ export class UrlString {
         return UrlString.constructAuthorityUriFromObject(urlObject);
     }
 
-    /**
-     * Returns the anchor part(#) of the URL
-     */
-    getHash(): string {
-        return UrlString.parseHash(this.urlString);
-    }
-
     /**
      * Parses out the components from a url string.
      * @returns An object with the various components. Please cache this value insted of calling this multiple times on the same url.
@@ -221,58 +206,6 @@ export class UrlString {
         return relativeUrl;
     }
 
-    /**
-     * Parses hash string from given string. Returns empty string if no hash symbol is found.
-     * @param hashString
-     */
-    static parseHash(hashString: string): string {
-        const hashIndex1 = hashString.indexOf("#");
-        const hashIndex2 = hashString.indexOf("#/");
-        if (hashIndex2 > -1) {
-            return hashString.substring(hashIndex2 + 2);
-        } else if (hashIndex1 > -1) {
-            return hashString.substring(hashIndex1 + 1);
-        }
-        return Constants.EMPTY_STRING;
-    }
-
-    /**
-     * Parses query string from given string. Returns empty string if no query symbol is found.
-     * @param queryString
-     */
-    static parseQueryString(queryString: string): string {
-        const queryIndex1 = queryString.indexOf("?");
-        const queryIndex2 = queryString.indexOf("/?");
-        if (queryIndex2 > -1) {
-            return queryString.substring(queryIndex2 + 2);
-        } else if (queryIndex1 > -1) {
-            return queryString.substring(queryIndex1 + 1);
-        }
-        return Constants.EMPTY_STRING;
-    }
-
-    /**
-     * Parses query server response string from given string.
-     * Extract hash between '?code=' and '#' if trailing '# is present.
-     * Returns empty string if no query symbol is found.
-     * @param queryString
-     */
-    static parseQueryServerResponse(queryString: string): string {
-        const queryIndex1 = queryString.indexOf("?code");
-        const queryIndex2 = queryString.indexOf("/?code");
-        const hashIndex = queryString.indexOf("#");
-        if (queryIndex2 > -1 && hashIndex > -1) {
-            return queryString.substring(queryIndex2 + 2, hashIndex);
-        } else if (queryIndex2 > -1) {
-            return queryString.substring(queryIndex2 + 2);
-        } else if (queryIndex1 > -1 && hashIndex > -1) {
-            return queryString.substring(queryIndex1 + 1, hashIndex);
-        } else if (queryIndex1 > -1) {
-            return queryString.substring(queryIndex1 + 1);
-        }
-        return Constants.EMPTY_STRING;
-    }
-
     static constructAuthorityUriFromObject(urlObject: IUri): UrlString {
         return new UrlString(
             urlObject.Protocol +
@@ -283,91 +216,11 @@ export class UrlString {
         );
     }
 
-    /**
-     * Returns URL hash as server auth code response object.
-     */
-    static getDeserializedHash(hash: string): ServerAuthorizationCodeResponse {
-        // Check if given hash is empty
-        if (!hash) {
-            return {};
-        }
-        // Strip the # symbol if present
-        const parsedHash = UrlString.parseHash(hash);
-        // If # symbol was not present, above will return empty string, so give original hash value
-        const deserializedHash: ServerAuthorizationCodeResponse =
-            StringUtils.queryStringToObject<ServerAuthorizationCodeResponse>(
-                parsedHash || hash
-            );
-        // Check if deserialization didn't work
-        if (!deserializedHash) {
-            throw createClientAuthError(
-                ClientAuthErrorCodes.hashNotDeserialized
-            );
-        }
-        return deserializedHash;
-    }
-
-    /**
-     * Returns URL query string as server auth code response object.
-     */
-    static getDeserializedQueryString(
-        query: string
-    ): ServerAuthorizationCodeResponse {
-        // Check if given query is empty
-        if (!query) {
-            return {};
-        }
-        // Strip the ? symbol if present
-        const parsedQueryString = UrlString.parseQueryString(query);
-        // If ? symbol was not present, above will return empty string, so give original query value
-        const deserializedQueryString: ServerAuthorizationCodeResponse =
-            StringUtils.queryStringToObject<ServerAuthorizationCodeResponse>(
-                parsedQueryString || query
-            );
-        // Check if deserialization didn't work
-        if (!deserializedQueryString) {
-            throw createClientAuthError(
-                ClientAuthErrorCodes.hashNotDeserialized
-            );
-        }
-        return deserializedQueryString;
-    }
-    /**
-     * Returns either deserialized query string or deserialized hash, depending on the serverResponseType
-     * as a server auth code response object.
-     */
-    static getDeserializedCodeResponse(
-        serverResponseType: ServerResponseType | undefined,
-        hashFragment: string
-    ): ServerAuthorizationCodeResponse {
-        const hashUrlString = new UrlString(hashFragment);
-        let serverParams: ServerAuthorizationCodeResponse;
-        if (serverResponseType === ServerResponseType.QUERY) {
-            serverParams = UrlString.getDeserializedQueryString(hashFragment);
-        } else {
-            serverParams = UrlString.getDeserializedHash(
-                hashUrlString.getHash()
-            );
-        }
-        return serverParams;
-    }
-
     /**
      * Check if the hash of the URL string contains known properties
+     * @deprecated This API will be removed in a future version
      */
-    static hashContainsKnownProperties(hash: string): boolean {
-        if (!hash || hash.indexOf("=") < 0) {
-            // Hash doesn't contain key/value pairs
-            return false;
-        }
-
-        const parameters: ServerAuthorizationCodeResponse =
-            UrlString.getDeserializedHash(hash);
-        return !!(
-            parameters.code ||
-            parameters.error_description ||
-            parameters.error ||
-            parameters.state
-        );
+    static hashContainsKnownProperties(response: string): boolean {
+        return !!UrlUtils.getDeserializedResponse(response);
     }
 }

package/src/utils/Constants.ts

@@ -51,7 +51,6 @@ export const Constants = {
     IMDS_TIMEOUT: 2000,
     AZURE_REGION_AUTO_DISCOVER_FLAG: "TryAutoDetect",
     REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: "login.microsoft.com",
-    REGIONAL_AUTH_NON_MSI_QUERY_STRING: "allowestsrnonmsi=true",
     KNOWN_PUBLIC_CLOUDS: [
         "login.microsoftonline.com",
         "login.windows.net",
@@ -434,11 +433,12 @@ export const CacheOutcome = {
 } as const;
 export type CacheOutcome = (typeof CacheOutcome)[keyof typeof CacheOutcome];
 
-export const JsonTypes = {
+export const JsonWebTokenTypes = {
     Jwt: "JWT",
     Jwk: "JWK",
     Pop: "pop",
 } as const;
-export type JsonTypes = (typeof JsonTypes)[keyof typeof JsonTypes];
+export type JsonWebTokenTypes =
+    (typeof JsonWebTokenTypes)[keyof typeof JsonWebTokenTypes];
 
 export const ONE_DAY_IN_MS = 86400000;

package/src/utils/UrlUtils.ts

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
+import {
+    ClientAuthErrorCodes,
+    createClientAuthError,
+} from "../error/ClientAuthError";
+
+/**
+ * Parses hash string from given string. Returns empty string if no hash symbol is found.
+ * @param hashString
+ */
+export function stripLeadingHashOrQuery(responseString: string): string {
+    if (responseString.startsWith("#/")) {
+        return responseString.substring(2);
+    } else if (
+        responseString.startsWith("#") ||
+        responseString.startsWith("?")
+    ) {
+        return responseString.substring(1);
+    }
+
+    return responseString;
+}
+
+/**
+ * Returns URL hash as server auth code response object.
+ */
+export function getDeserializedResponse(
+    responseString: string
+): ServerAuthorizationCodeResponse | null {
+    // Check if given hash is empty
+    if (!responseString || responseString.indexOf("=") < 0) {
+        return null;
+    }
+    try {
+        // Strip the # or ? symbol if present
+        const normalizedResponse = stripLeadingHashOrQuery(responseString);
+        // If # symbol was not present, above will return empty string, so give original hash value
+        const deserializedHash: ServerAuthorizationCodeResponse =
+            Object.fromEntries(new URLSearchParams(normalizedResponse));
+
+        // Check for known response properties
+        if (
+            deserializedHash.code ||
+            deserializedHash.error ||
+            deserializedHash.error_description ||
+            deserializedHash.state
+        ) {
+            return deserializedHash;
+        }
+    } catch (e) {
+        throw createClientAuthError(ClientAuthErrorCodes.hashNotDeserialized);
+    }
+
+    return null;
+}

package/dist/cache/entities/ServerTelemetryEntity.mjs

@@ -1,34 +0,0 @@
-/*! @azure/msal-common v14.3.0 2023-10-30 */
-'use strict';
-import { SERVER_TELEM_CONSTANTS } from '../../utils/Constants.mjs';
-
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-class ServerTelemetryEntity {
-    constructor() {
-        this.failedRequests = [];
-        this.errors = [];
-        this.cacheHits = 0;
-    }
-    /**
-     * validates if a given cache entry is "Telemetry", parses <key,value>
-     * @param key
-     * @param entity
-     */
-    static isServerTelemetryEntity(key, entity) {
-        const validateKey = key.indexOf(SERVER_TELEM_CONSTANTS.CACHE_KEY) === 0;
-        let validateEntity = true;
-        if (entity) {
-            validateEntity =
-                entity.hasOwnProperty("failedRequests") &&
-                    entity.hasOwnProperty("errors") &&
-                    entity.hasOwnProperty("cacheHits");
-        }
-        return validateKey && validateEntity;
-    }
-}
-
-export { ServerTelemetryEntity };
-//# sourceMappingURL=ServerTelemetryEntity.mjs.map

package/dist/cache/entities/ServerTelemetryEntity.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"ServerTelemetryEntity.mjs","sources":["../../../src/cache/entities/ServerTelemetryEntity.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAOA;AACI;;;AAUA,MAAA,qBAAA,CAAA;;;;AAIG,QAAA,IAAA,CAAA,SAAA,GAAA,CAAA,CAAA;AACH,KAAA;AAcH;;;;;;;;;;;;;;;;;;;;"}