@azure/msal-common 14.0.0-alpha.1 → 14.0.0-beta.0

package/dist/cache/entities/AccountEntity.js

@@ -1,4 +1,4 @@
-/*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
+/*! @azure/msal-common v14.0.0-beta.0 2023-06-19 */
 'use strict';
 import { Separators, CacheAccountType, CacheType, Constants } from '../../utils/Constants.js';
 import { buildClientInfo } from '../../account/ClientInfo.js';
@@ -6,253 +6,253 @@ import { StringUtils } from '../../utils/StringUtils.js';
 import { ClientAuthError } from '../../error/ClientAuthError.js';
 import { AuthorityType } from '../../authority/AuthorityType.js';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Type that defines required and optional parameters for an Account field (based on universal cache schema implemented by all MSALs).
- *
- * Key : Value Schema
- *
- * Key: <home_account_id>-<environment>-<realm*>
- *
- * Value Schema:
- * {
- *      homeAccountId: home account identifier for the auth scheme,
- *      environment: entity that issued the token, represented as a full host
- *      realm: Full tenant or organizational identifier that the account belongs to
- *      localAccountId: Original tenant-specific accountID, usually used for legacy cases
- *      username: primary username that represents the user, usually corresponds to preferred_username in the v2 endpt
- *      authorityType: Accounts authority type as a string
- *      name: Full name for the account, including given name and family name,
- *      clientInfo: Full base64 encoded client info received from ESTS
- *      lastModificationTime: last time this entity was modified in the cache
- *      lastModificationApp:
- *      idTokenClaims: Object containing claims parsed from ID token
- *      nativeAccountId: Account identifier on the native device
- * }
- */
-class AccountEntity {
-    /**
-     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
-     */
-    generateAccountId() {
-        const accountId = [this.homeAccountId, this.environment];
-        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-    /**
-     * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
-     */
-    generateAccountKey() {
-        return AccountEntity.generateAccountCacheKey({
-            homeAccountId: this.homeAccountId,
-            environment: this.environment,
-            tenantId: this.realm,
-            username: this.username,
-            localAccountId: this.localAccountId,
-        });
-    }
-    /**
-     * returns the type of the cache (in this case account)
-     */
-    generateType() {
-        switch (this.authorityType) {
-            case CacheAccountType.ADFS_ACCOUNT_TYPE:
-                return CacheType.ADFS;
-            case CacheAccountType.MSAV1_ACCOUNT_TYPE:
-                return CacheType.MSA;
-            case CacheAccountType.MSSTS_ACCOUNT_TYPE:
-                return CacheType.MSSTS;
-            case CacheAccountType.GENERIC_ACCOUNT_TYPE:
-                return CacheType.GENERIC;
-            default: {
-                throw ClientAuthError.createUnexpectedAccountTypeError();
-            }
-        }
-    }
-    /**
-     * Returns the AccountInfo interface for this account.
-     */
-    getAccountInfo() {
-        return {
-            homeAccountId: this.homeAccountId,
-            environment: this.environment,
-            tenantId: this.realm,
-            username: this.username,
-            localAccountId: this.localAccountId,
-            name: this.name,
-            idTokenClaims: this.idTokenClaims,
-            nativeAccountId: this.nativeAccountId,
-        };
-    }
-    /**
-     * Generates account key from interface
-     * @param accountInterface
-     */
-    static generateAccountCacheKey(accountInterface) {
-        const accountKey = [
-            accountInterface.homeAccountId,
-            accountInterface.environment || Constants.EMPTY_STRING,
-            accountInterface.tenantId || Constants.EMPTY_STRING,
-        ];
-        return accountKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-    /**
-     * Build Account cache from IdToken, clientInfo and authority/policy. Associated with AAD.
-     * @param clientInfo
-     * @param authority
-     * @param idToken
-     * @param policy
-     */
-    static createAccount(clientInfo, homeAccountId, idToken, authority, cloudGraphHostName, msGraphHost, environment, nativeAccountId) {
-        const account = new AccountEntity();
-        account.authorityType = CacheAccountType.MSSTS_ACCOUNT_TYPE;
-        account.clientInfo = clientInfo;
-        account.homeAccountId = homeAccountId;
-        account.nativeAccountId = nativeAccountId;
-        const env = environment || (authority && authority.getPreferredCache());
-        if (!env) {
-            throw ClientAuthError.createInvalidCacheEnvironmentError();
-        }
-        account.environment = env;
-        // non AAD scenarios can have empty realm
-        account.realm = idToken?.claims?.tid || Constants.EMPTY_STRING;
-        if (idToken) {
-            account.idTokenClaims = idToken.claims;
-            // How do you account for MSA CID here?
-            account.localAccountId =
-                idToken?.claims?.oid ||
-                    idToken?.claims?.sub ||
-                    Constants.EMPTY_STRING;
-            /*
-             * In B2C scenarios the emails claim is used instead of preferred_username and it is an array.
-             * In most cases it will contain a single email. This field should not be relied upon if a custom
-             * policy is configured to return more than 1 email.
-             */
-            const preferredUsername = idToken?.claims?.preferred_username;
-            const email = idToken?.claims?.emails
-                ? idToken.claims.emails[0]
-                : null;
-            account.username =
-                preferredUsername || email || Constants.EMPTY_STRING;
-            account.name = idToken?.claims?.name;
-        }
-        account.cloudGraphHostName = cloudGraphHostName;
-        account.msGraphHost = msGraphHost;
-        return account;
-    }
-    /**
-     * Builds non-AAD/ADFS account.
-     * @param authority
-     * @param idToken
-     */
-    static createGenericAccount(homeAccountId, idToken, authority, cloudGraphHostName, msGraphHost, environment) {
-        const account = new AccountEntity();
-        account.authorityType =
-            authority && authority.authorityType === AuthorityType.Adfs
-                ? CacheAccountType.ADFS_ACCOUNT_TYPE
-                : CacheAccountType.GENERIC_ACCOUNT_TYPE;
-        account.homeAccountId = homeAccountId;
-        // non AAD scenarios can have empty realm
-        account.realm = Constants.EMPTY_STRING;
-        const env = environment || (authority && authority.getPreferredCache());
-        if (!env) {
-            throw ClientAuthError.createInvalidCacheEnvironmentError();
-        }
-        if (idToken) {
-            // How do you account for MSA CID here?
-            account.localAccountId =
-                idToken?.claims?.oid ||
-                    idToken?.claims?.sub ||
-                    Constants.EMPTY_STRING;
-            // upn claim for most ADFS scenarios
-            account.username = idToken?.claims?.upn || Constants.EMPTY_STRING;
-            account.name = idToken?.claims?.name || Constants.EMPTY_STRING;
-            account.idTokenClaims = idToken?.claims;
-        }
-        account.environment = env;
-        account.cloudGraphHostName = cloudGraphHostName;
-        account.msGraphHost = msGraphHost;
-        /*
-         * add uniqueName to claims
-         * account.name = idToken.claims.uniqueName;
-         */
-        return account;
-    }
-    /**
-     * Generate HomeAccountId from server response
-     * @param serverClientInfo
-     * @param authType
-     */
-    static generateHomeAccountId(serverClientInfo, authType, logger, cryptoObj, idToken) {
-        const accountId = idToken?.claims?.sub
-            ? idToken.claims.sub
-            : Constants.EMPTY_STRING;
-        // since ADFS does not have tid and does not set client_info
-        if (authType === AuthorityType.Adfs ||
-            authType === AuthorityType.Dsts) {
-            return accountId;
-        }
-        // for cases where there is clientInfo
-        if (serverClientInfo) {
-            try {
-                const clientInfo = buildClientInfo(serverClientInfo, cryptoObj);
-                if (!StringUtils.isEmpty(clientInfo.uid) &&
-                    !StringUtils.isEmpty(clientInfo.utid)) {
-                    return `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`;
-                }
-            }
-            catch (e) { }
-        }
-        // default to "sub" claim
-        logger.verbose("No client info in response");
-        return accountId;
-    }
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isAccountEntity(entity) {
-        if (!entity) {
-            return false;
-        }
-        return (entity.hasOwnProperty("homeAccountId") &&
-            entity.hasOwnProperty("environment") &&
-            entity.hasOwnProperty("realm") &&
-            entity.hasOwnProperty("localAccountId") &&
-            entity.hasOwnProperty("username") &&
-            entity.hasOwnProperty("authorityType"));
-    }
-    /**
-     * Helper function to determine whether 2 accountInfo objects represent the same account
-     * @param accountA
-     * @param accountB
-     * @param compareClaims - If set to true idTokenClaims will also be compared to determine account equality
-     */
-    static accountInfoIsEqual(accountA, accountB, compareClaims) {
-        if (!accountA || !accountB) {
-            return false;
-        }
-        let claimsMatch = true; // default to true so as to not fail comparison below if compareClaims: false
-        if (compareClaims) {
-            const accountAClaims = (accountA.idTokenClaims ||
-                {});
-            const accountBClaims = (accountB.idTokenClaims ||
-                {});
-            // issued at timestamp and nonce are expected to change each time a new id token is acquired
-            claimsMatch =
-                accountAClaims.iat === accountBClaims.iat &&
-                    accountAClaims.nonce === accountBClaims.nonce;
-        }
-        return (accountA.homeAccountId === accountB.homeAccountId &&
-            accountA.localAccountId === accountB.localAccountId &&
-            accountA.username === accountB.username &&
-            accountA.tenantId === accountB.tenantId &&
-            accountA.environment === accountB.environment &&
-            accountA.nativeAccountId === accountB.nativeAccountId &&
-            claimsMatch);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Type that defines required and optional parameters for an Account field (based on universal cache schema implemented by all MSALs).
+ *
+ * Key : Value Schema
+ *
+ * Key: <home_account_id>-<environment>-<realm*>
+ *
+ * Value Schema:
+ * {
+ *      homeAccountId: home account identifier for the auth scheme,
+ *      environment: entity that issued the token, represented as a full host
+ *      realm: Full tenant or organizational identifier that the account belongs to
+ *      localAccountId: Original tenant-specific accountID, usually used for legacy cases
+ *      username: primary username that represents the user, usually corresponds to preferred_username in the v2 endpt
+ *      authorityType: Accounts authority type as a string
+ *      name: Full name for the account, including given name and family name,
+ *      clientInfo: Full base64 encoded client info received from ESTS
+ *      lastModificationTime: last time this entity was modified in the cache
+ *      lastModificationApp:
+ *      idTokenClaims: Object containing claims parsed from ID token
+ *      nativeAccountId: Account identifier on the native device
+ * }
+ */
+class AccountEntity {
+    /**
+     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
+     */
+    generateAccountId() {
+        const accountId = [this.homeAccountId, this.environment];
+        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+    /**
+     * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
+     */
+    generateAccountKey() {
+        return AccountEntity.generateAccountCacheKey({
+            homeAccountId: this.homeAccountId,
+            environment: this.environment,
+            tenantId: this.realm,
+            username: this.username,
+            localAccountId: this.localAccountId,
+        });
+    }
+    /**
+     * returns the type of the cache (in this case account)
+     */
+    generateType() {
+        switch (this.authorityType) {
+            case CacheAccountType.ADFS_ACCOUNT_TYPE:
+                return CacheType.ADFS;
+            case CacheAccountType.MSAV1_ACCOUNT_TYPE:
+                return CacheType.MSA;
+            case CacheAccountType.MSSTS_ACCOUNT_TYPE:
+                return CacheType.MSSTS;
+            case CacheAccountType.GENERIC_ACCOUNT_TYPE:
+                return CacheType.GENERIC;
+            default: {
+                throw ClientAuthError.createUnexpectedAccountTypeError();
+            }
+        }
+    }
+    /**
+     * Returns the AccountInfo interface for this account.
+     */
+    getAccountInfo() {
+        return {
+            homeAccountId: this.homeAccountId,
+            environment: this.environment,
+            tenantId: this.realm,
+            username: this.username,
+            localAccountId: this.localAccountId,
+            name: this.name,
+            idTokenClaims: this.idTokenClaims,
+            nativeAccountId: this.nativeAccountId,
+        };
+    }
+    /**
+     * Generates account key from interface
+     * @param accountInterface
+     */
+    static generateAccountCacheKey(accountInterface) {
+        const accountKey = [
+            accountInterface.homeAccountId,
+            accountInterface.environment || Constants.EMPTY_STRING,
+            accountInterface.tenantId || Constants.EMPTY_STRING,
+        ];
+        return accountKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+    /**
+     * Build Account cache from IdToken, clientInfo and authority/policy. Associated with AAD.
+     * @param clientInfo
+     * @param authority
+     * @param idToken
+     * @param policy
+     */
+    static createAccount(clientInfo, homeAccountId, idToken, authority, cloudGraphHostName, msGraphHost, environment, nativeAccountId) {
+        const account = new AccountEntity();
+        account.authorityType = CacheAccountType.MSSTS_ACCOUNT_TYPE;
+        account.clientInfo = clientInfo;
+        account.homeAccountId = homeAccountId;
+        account.nativeAccountId = nativeAccountId;
+        const env = environment || (authority && authority.getPreferredCache());
+        if (!env) {
+            throw ClientAuthError.createInvalidCacheEnvironmentError();
+        }
+        account.environment = env;
+        // non AAD scenarios can have empty realm
+        account.realm = idToken?.claims?.tid || Constants.EMPTY_STRING;
+        if (idToken) {
+            account.idTokenClaims = idToken.claims;
+            // How do you account for MSA CID here?
+            account.localAccountId =
+                idToken?.claims?.oid ||
+                    idToken?.claims?.sub ||
+                    Constants.EMPTY_STRING;
+            /*
+             * In B2C scenarios the emails claim is used instead of preferred_username and it is an array.
+             * In most cases it will contain a single email. This field should not be relied upon if a custom
+             * policy is configured to return more than 1 email.
+             */
+            const preferredUsername = idToken?.claims?.preferred_username;
+            const email = idToken?.claims?.emails
+                ? idToken.claims.emails[0]
+                : null;
+            account.username =
+                preferredUsername || email || Constants.EMPTY_STRING;
+            account.name = idToken?.claims?.name;
+        }
+        account.cloudGraphHostName = cloudGraphHostName;
+        account.msGraphHost = msGraphHost;
+        return account;
+    }
+    /**
+     * Builds non-AAD/ADFS account.
+     * @param authority
+     * @param idToken
+     */
+    static createGenericAccount(homeAccountId, idToken, authority, cloudGraphHostName, msGraphHost, environment) {
+        const account = new AccountEntity();
+        account.authorityType =
+            authority && authority.authorityType === AuthorityType.Adfs
+                ? CacheAccountType.ADFS_ACCOUNT_TYPE
+                : CacheAccountType.GENERIC_ACCOUNT_TYPE;
+        account.homeAccountId = homeAccountId;
+        // non AAD scenarios can have empty realm
+        account.realm = Constants.EMPTY_STRING;
+        const env = environment || (authority && authority.getPreferredCache());
+        if (!env) {
+            throw ClientAuthError.createInvalidCacheEnvironmentError();
+        }
+        if (idToken) {
+            // How do you account for MSA CID here?
+            account.localAccountId =
+                idToken?.claims?.oid ||
+                    idToken?.claims?.sub ||
+                    Constants.EMPTY_STRING;
+            // upn claim for most ADFS scenarios
+            account.username = idToken?.claims?.upn || Constants.EMPTY_STRING;
+            account.name = idToken?.claims?.name || Constants.EMPTY_STRING;
+            account.idTokenClaims = idToken?.claims;
+        }
+        account.environment = env;
+        account.cloudGraphHostName = cloudGraphHostName;
+        account.msGraphHost = msGraphHost;
+        /*
+         * add uniqueName to claims
+         * account.name = idToken.claims.uniqueName;
+         */
+        return account;
+    }
+    /**
+     * Generate HomeAccountId from server response
+     * @param serverClientInfo
+     * @param authType
+     */
+    static generateHomeAccountId(serverClientInfo, authType, logger, cryptoObj, idToken) {
+        const accountId = idToken?.claims?.sub
+            ? idToken.claims.sub
+            : Constants.EMPTY_STRING;
+        // since ADFS does not have tid and does not set client_info
+        if (authType === AuthorityType.Adfs ||
+            authType === AuthorityType.Dsts) {
+            return accountId;
+        }
+        // for cases where there is clientInfo
+        if (serverClientInfo) {
+            try {
+                const clientInfo = buildClientInfo(serverClientInfo, cryptoObj);
+                if (!StringUtils.isEmpty(clientInfo.uid) &&
+                    !StringUtils.isEmpty(clientInfo.utid)) {
+                    return `${clientInfo.uid}${Separators.CLIENT_INFO_SEPARATOR}${clientInfo.utid}`;
+                }
+            }
+            catch (e) { }
+        }
+        // default to "sub" claim
+        logger.verbose("No client info in response");
+        return accountId;
+    }
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isAccountEntity(entity) {
+        if (!entity) {
+            return false;
+        }
+        return (entity.hasOwnProperty("homeAccountId") &&
+            entity.hasOwnProperty("environment") &&
+            entity.hasOwnProperty("realm") &&
+            entity.hasOwnProperty("localAccountId") &&
+            entity.hasOwnProperty("username") &&
+            entity.hasOwnProperty("authorityType"));
+    }
+    /**
+     * Helper function to determine whether 2 accountInfo objects represent the same account
+     * @param accountA
+     * @param accountB
+     * @param compareClaims - If set to true idTokenClaims will also be compared to determine account equality
+     */
+    static accountInfoIsEqual(accountA, accountB, compareClaims) {
+        if (!accountA || !accountB) {
+            return false;
+        }
+        let claimsMatch = true; // default to true so as to not fail comparison below if compareClaims: false
+        if (compareClaims) {
+            const accountAClaims = (accountA.idTokenClaims ||
+                {});
+            const accountBClaims = (accountB.idTokenClaims ||
+                {});
+            // issued at timestamp and nonce are expected to change each time a new id token is acquired
+            claimsMatch =
+                accountAClaims.iat === accountBClaims.iat &&
+                    accountAClaims.nonce === accountBClaims.nonce;
+        }
+        return (accountA.homeAccountId === accountB.homeAccountId &&
+            accountA.localAccountId === accountB.localAccountId &&
+            accountA.username === accountB.username &&
+            accountA.tenantId === accountB.tenantId &&
+            accountA.environment === accountB.environment &&
+            accountA.nativeAccountId === accountB.nativeAccountId &&
+            claimsMatch);
+    }
 }
 
 export { AccountEntity };

package/dist/cache/entities/AppMetadataEntity.d.ts

@@ -1,40 +1,40 @@
-/**
- * APP_METADATA Cache
- *
- * Key:Value Schema:
- *
- * Key: appmetadata-<environment>-<client_id>
- *
- * Value:
- * {
- *      clientId: client ID of the application
- *      environment: entity that issued the token, represented as a full host
- *      familyId: Family ID identifier, '1' represents Microsoft Family
- * }
- */
-export declare class AppMetadataEntity {
-    clientId: string;
-    environment: string;
-    familyId?: string;
-    /**
-     * Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>
-     */
-    generateAppMetadataKey(): string;
-    /**
-     * Generate AppMetadata Cache Key
-     */
-    static generateAppMetadataCacheKey(environment: string, clientId: string): string;
-    /**
-     * Creates AppMetadataEntity
-     * @param clientId
-     * @param environment
-     * @param familyId
-     */
-    static createAppMetadataEntity(clientId: string, environment: string, familyId?: string): AppMetadataEntity;
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isAppMetadataEntity(key: string, entity: object): boolean;
-}
+/**
+ * APP_METADATA Cache
+ *
+ * Key:Value Schema:
+ *
+ * Key: appmetadata-<environment>-<client_id>
+ *
+ * Value:
+ * {
+ *      clientId: client ID of the application
+ *      environment: entity that issued the token, represented as a full host
+ *      familyId: Family ID identifier, '1' represents Microsoft Family
+ * }
+ */
+export declare class AppMetadataEntity {
+    clientId: string;
+    environment: string;
+    familyId?: string;
+    /**
+     * Generate AppMetadata Cache Key as per the schema: appmetadata-<environment>-<client_id>
+     */
+    generateAppMetadataKey(): string;
+    /**
+     * Generate AppMetadata Cache Key
+     */
+    static generateAppMetadataCacheKey(environment: string, clientId: string): string;
+    /**
+     * Creates AppMetadataEntity
+     * @param clientId
+     * @param environment
+     * @param familyId
+     */
+    static createAppMetadataEntity(clientId: string, environment: string, familyId?: string): AppMetadataEntity;
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isAppMetadataEntity(key: string, entity: object): boolean;
+}
 //# sourceMappingURL=AppMetadataEntity.d.ts.map