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

package/dist/cache/entities/CredentialEntity.js

@@ -1,143 +1,143 @@
-/*! @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 { CredentialType, CacheType, Separators, Constants, AuthenticationScheme } from '../../utils/Constants.js';
 import { ClientAuthError } from '../../error/ClientAuthError.js';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Base type for credentials to be stored in the cache: eg: ACCESS_TOKEN, ID_TOKEN etc
- *
- * Key:Value Schema:
- *
- * Key: <home_account_id*>-<environment>-<credential_type>-<client_id>-<realm*>-<target*>-<requestedClaims*>-<scheme*>
- *
- * Value Schema:
- * {
- *      homeAccountId: home account identifier for the auth scheme,
- *      environment: entity that issued the token, represented as a full host
- *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
- *      clientId: client ID of the application
- *      secret: Actual credential as a string
- *      familyId: Family ID identifier, usually only used for refresh tokens
- *      realm: Full tenant or organizational identifier that the account belongs to
- *      target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
- *      tokenType: Matches the authentication scheme for which the token was issued (i.e. Bearer or pop)
- *      requestedClaimsHash: Matches the SHA 256 hash of the claims object included in the token request
- *      userAssertionHash: Matches the SHA 256 hash of the obo_assertion for the OBO flow
- * }
- */
-class CredentialEntity {
-    /**
-     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
-     */
-    generateAccountId() {
-        return CredentialEntity.generateAccountIdForCacheKey(this.homeAccountId, this.environment);
-    }
-    /**
-     * Generate Credential Id key component as per the schema: <credential_type>-<client_id>-<realm>
-     */
-    generateCredentialId() {
-        return CredentialEntity.generateCredentialIdForCacheKey(this.credentialType, this.clientId, this.realm, this.familyId);
-    }
-    /**
-     * Generate target key component as per schema: <target>
-     */
-    generateTarget() {
-        return CredentialEntity.generateTargetForCacheKey(this.target);
-    }
-    /**
-     * generates credential key
-     */
-    generateCredentialKey() {
-        return CredentialEntity.generateCredentialCacheKey(this.homeAccountId, this.environment, this.credentialType, this.clientId, this.realm, this.target, this.familyId, this.tokenType, this.requestedClaimsHash);
-    }
-    /**
-     * returns the type of the cache (in this case credential)
-     */
-    generateType() {
-        switch (this.credentialType) {
-            case CredentialType.ID_TOKEN:
-                return CacheType.ID_TOKEN;
-            case CredentialType.ACCESS_TOKEN:
-            case CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME:
-                return CacheType.ACCESS_TOKEN;
-            case CredentialType.REFRESH_TOKEN:
-                return CacheType.REFRESH_TOKEN;
-            default: {
-                throw ClientAuthError.createUnexpectedCredentialTypeError();
-            }
-        }
-    }
-    /**
-     * generates credential key
-     * <home_account_id*>-\<environment>-<credential_type>-<client_id>-<realm\*>-<target\*>-<scheme\*>
-     */
-    static generateCredentialCacheKey(homeAccountId, environment, credentialType, clientId, realm, target, familyId, tokenType, requestedClaimsHash) {
-        const credentialKey = [
-            this.generateAccountIdForCacheKey(homeAccountId, environment),
-            this.generateCredentialIdForCacheKey(credentialType, clientId, realm, familyId),
-            this.generateTargetForCacheKey(target),
-            this.generateClaimsHashForCacheKey(requestedClaimsHash),
-            this.generateSchemeForCacheKey(tokenType),
-        ];
-        return credentialKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-    /**
-     * generates Account Id for keys
-     * @param homeAccountId
-     * @param environment
-     */
-    static generateAccountIdForCacheKey(homeAccountId, environment) {
-        const accountId = [homeAccountId, environment];
-        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-    /**
-     * Generates Credential Id for keys
-     * @param credentialType
-     * @param realm
-     * @param clientId
-     * @param familyId
-     */
-    static generateCredentialIdForCacheKey(credentialType, clientId, realm, familyId) {
-        const clientOrFamilyId = credentialType === CredentialType.REFRESH_TOKEN
-            ? familyId || clientId
-            : clientId;
-        const credentialId = [
-            credentialType,
-            clientOrFamilyId,
-            realm || Constants.EMPTY_STRING,
-        ];
-        return credentialId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-    /**
-     * Generate target key component as per schema: <target>
-     */
-    static generateTargetForCacheKey(scopes) {
-        return (scopes || Constants.EMPTY_STRING).toLowerCase();
-    }
-    /**
-     * Generate requested claims key component as per schema: <requestedClaims>
-     */
-    static generateClaimsHashForCacheKey(requestedClaimsHash) {
-        return (requestedClaimsHash || Constants.EMPTY_STRING).toLowerCase();
-    }
-    /**
-     * Generate scheme key componenet as per schema: <scheme>
-     */
-    static generateSchemeForCacheKey(tokenType) {
-        /*
-         * PoP Tokens and SSH certs include scheme in cache key
-         * Cast to lowercase to handle "bearer" from ADFS
-         */
-        return tokenType &&
-            tokenType.toLowerCase() !==
-                AuthenticationScheme.BEARER.toLowerCase()
-            ? tokenType.toLowerCase()
-            : Constants.EMPTY_STRING;
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Base type for credentials to be stored in the cache: eg: ACCESS_TOKEN, ID_TOKEN etc
+ *
+ * Key:Value Schema:
+ *
+ * Key: <home_account_id*>-<environment>-<credential_type>-<client_id>-<realm*>-<target*>-<requestedClaims*>-<scheme*>
+ *
+ * Value Schema:
+ * {
+ *      homeAccountId: home account identifier for the auth scheme,
+ *      environment: entity that issued the token, represented as a full host
+ *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
+ *      clientId: client ID of the application
+ *      secret: Actual credential as a string
+ *      familyId: Family ID identifier, usually only used for refresh tokens
+ *      realm: Full tenant or organizational identifier that the account belongs to
+ *      target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
+ *      tokenType: Matches the authentication scheme for which the token was issued (i.e. Bearer or pop)
+ *      requestedClaimsHash: Matches the SHA 256 hash of the claims object included in the token request
+ *      userAssertionHash: Matches the SHA 256 hash of the obo_assertion for the OBO flow
+ * }
+ */
+class CredentialEntity {
+    /**
+     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
+     */
+    generateAccountId() {
+        return CredentialEntity.generateAccountIdForCacheKey(this.homeAccountId, this.environment);
+    }
+    /**
+     * Generate Credential Id key component as per the schema: <credential_type>-<client_id>-<realm>
+     */
+    generateCredentialId() {
+        return CredentialEntity.generateCredentialIdForCacheKey(this.credentialType, this.clientId, this.realm, this.familyId);
+    }
+    /**
+     * Generate target key component as per schema: <target>
+     */
+    generateTarget() {
+        return CredentialEntity.generateTargetForCacheKey(this.target);
+    }
+    /**
+     * generates credential key
+     */
+    generateCredentialKey() {
+        return CredentialEntity.generateCredentialCacheKey(this.homeAccountId, this.environment, this.credentialType, this.clientId, this.realm, this.target, this.familyId, this.tokenType, this.requestedClaimsHash);
+    }
+    /**
+     * returns the type of the cache (in this case credential)
+     */
+    generateType() {
+        switch (this.credentialType) {
+            case CredentialType.ID_TOKEN:
+                return CacheType.ID_TOKEN;
+            case CredentialType.ACCESS_TOKEN:
+            case CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME:
+                return CacheType.ACCESS_TOKEN;
+            case CredentialType.REFRESH_TOKEN:
+                return CacheType.REFRESH_TOKEN;
+            default: {
+                throw ClientAuthError.createUnexpectedCredentialTypeError();
+            }
+        }
+    }
+    /**
+     * generates credential key
+     * <home_account_id*>-\<environment>-<credential_type>-<client_id>-<realm\*>-<target\*>-<scheme\*>
+     */
+    static generateCredentialCacheKey(homeAccountId, environment, credentialType, clientId, realm, target, familyId, tokenType, requestedClaimsHash) {
+        const credentialKey = [
+            this.generateAccountIdForCacheKey(homeAccountId, environment),
+            this.generateCredentialIdForCacheKey(credentialType, clientId, realm, familyId),
+            this.generateTargetForCacheKey(target),
+            this.generateClaimsHashForCacheKey(requestedClaimsHash),
+            this.generateSchemeForCacheKey(tokenType),
+        ];
+        return credentialKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+    /**
+     * generates Account Id for keys
+     * @param homeAccountId
+     * @param environment
+     */
+    static generateAccountIdForCacheKey(homeAccountId, environment) {
+        const accountId = [homeAccountId, environment];
+        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+    /**
+     * Generates Credential Id for keys
+     * @param credentialType
+     * @param realm
+     * @param clientId
+     * @param familyId
+     */
+    static generateCredentialIdForCacheKey(credentialType, clientId, realm, familyId) {
+        const clientOrFamilyId = credentialType === CredentialType.REFRESH_TOKEN
+            ? familyId || clientId
+            : clientId;
+        const credentialId = [
+            credentialType,
+            clientOrFamilyId,
+            realm || Constants.EMPTY_STRING,
+        ];
+        return credentialId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+    /**
+     * Generate target key component as per schema: <target>
+     */
+    static generateTargetForCacheKey(scopes) {
+        return (scopes || Constants.EMPTY_STRING).toLowerCase();
+    }
+    /**
+     * Generate requested claims key component as per schema: <requestedClaims>
+     */
+    static generateClaimsHashForCacheKey(requestedClaimsHash) {
+        return (requestedClaimsHash || Constants.EMPTY_STRING).toLowerCase();
+    }
+    /**
+     * Generate scheme key componenet as per schema: <scheme>
+     */
+    static generateSchemeForCacheKey(tokenType) {
+        /*
+         * PoP Tokens and SSH certs include scheme in cache key
+         * Cast to lowercase to handle "bearer" from ADFS
+         */
+        return tokenType &&
+            tokenType.toLowerCase() !==
+                AuthenticationScheme.BEARER.toLowerCase()
+            ? tokenType.toLowerCase()
+            : Constants.EMPTY_STRING;
+    }
 }
 
 export { CredentialEntity };

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

@@ -1,35 +1,35 @@
-import { CredentialEntity } from "./CredentialEntity";
-/**
- * ID_TOKEN Cache
- *
- * Key:Value Schema:
- *
- * Key Example: uid.utid-login.microsoftonline.com-idtoken-clientId-contoso.com-
- *
- * Value Schema:
- * {
- *      homeAccountId: home account identifier for the auth scheme,
- *      environment: entity that issued the token, represented as a full host
- *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
- *      clientId: client ID of the application
- *      secret: Actual credential as a string
- *      realm: Full tenant or organizational identifier that the account belongs to
- * }
- */
-export declare class IdTokenEntity extends CredentialEntity {
-    realm: string;
-    /**
-     * Create IdTokenEntity
-     * @param homeAccountId
-     * @param authenticationResult
-     * @param clientId
-     * @param authority
-     */
-    static createIdTokenEntity(homeAccountId: string, environment: string, idToken: string, clientId: string, tenantId: string): IdTokenEntity;
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isIdTokenEntity(entity: object): boolean;
-}
+import { CredentialEntity } from "./CredentialEntity";
+/**
+ * ID_TOKEN Cache
+ *
+ * Key:Value Schema:
+ *
+ * Key Example: uid.utid-login.microsoftonline.com-idtoken-clientId-contoso.com-
+ *
+ * Value Schema:
+ * {
+ *      homeAccountId: home account identifier for the auth scheme,
+ *      environment: entity that issued the token, represented as a full host
+ *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
+ *      clientId: client ID of the application
+ *      secret: Actual credential as a string
+ *      realm: Full tenant or organizational identifier that the account belongs to
+ * }
+ */
+export declare class IdTokenEntity extends CredentialEntity {
+    realm: string;
+    /**
+     * Create IdTokenEntity
+     * @param homeAccountId
+     * @param authenticationResult
+     * @param clientId
+     * @param authority
+     */
+    static createIdTokenEntity(homeAccountId: string, environment: string, idToken: string, clientId: string, tenantId: string): IdTokenEntity;
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isIdTokenEntity(entity: object): boolean;
+}
 //# sourceMappingURL=IdTokenEntity.d.ts.map

package/dist/cache/entities/IdTokenEntity.js

@@ -1,63 +1,63 @@
-/*! @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 { CredentialEntity } from './CredentialEntity.js';
 import { CredentialType } from '../../utils/Constants.js';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * ID_TOKEN Cache
- *
- * Key:Value Schema:
- *
- * Key Example: uid.utid-login.microsoftonline.com-idtoken-clientId-contoso.com-
- *
- * Value Schema:
- * {
- *      homeAccountId: home account identifier for the auth scheme,
- *      environment: entity that issued the token, represented as a full host
- *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
- *      clientId: client ID of the application
- *      secret: Actual credential as a string
- *      realm: Full tenant or organizational identifier that the account belongs to
- * }
- */
-class IdTokenEntity extends CredentialEntity {
-    /**
-     * Create IdTokenEntity
-     * @param homeAccountId
-     * @param authenticationResult
-     * @param clientId
-     * @param authority
-     */
-    static createIdTokenEntity(homeAccountId, environment, idToken, clientId, tenantId) {
-        const idTokenEntity = new IdTokenEntity();
-        idTokenEntity.credentialType = CredentialType.ID_TOKEN;
-        idTokenEntity.homeAccountId = homeAccountId;
-        idTokenEntity.environment = environment;
-        idTokenEntity.clientId = clientId;
-        idTokenEntity.secret = idToken;
-        idTokenEntity.realm = tenantId;
-        return idTokenEntity;
-    }
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isIdTokenEntity(entity) {
-        if (!entity) {
-            return false;
-        }
-        return (entity.hasOwnProperty("homeAccountId") &&
-            entity.hasOwnProperty("environment") &&
-            entity.hasOwnProperty("credentialType") &&
-            entity.hasOwnProperty("realm") &&
-            entity.hasOwnProperty("clientId") &&
-            entity.hasOwnProperty("secret") &&
-            entity["credentialType"] === CredentialType.ID_TOKEN);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * ID_TOKEN Cache
+ *
+ * Key:Value Schema:
+ *
+ * Key Example: uid.utid-login.microsoftonline.com-idtoken-clientId-contoso.com-
+ *
+ * Value Schema:
+ * {
+ *      homeAccountId: home account identifier for the auth scheme,
+ *      environment: entity that issued the token, represented as a full host
+ *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
+ *      clientId: client ID of the application
+ *      secret: Actual credential as a string
+ *      realm: Full tenant or organizational identifier that the account belongs to
+ * }
+ */
+class IdTokenEntity extends CredentialEntity {
+    /**
+     * Create IdTokenEntity
+     * @param homeAccountId
+     * @param authenticationResult
+     * @param clientId
+     * @param authority
+     */
+    static createIdTokenEntity(homeAccountId, environment, idToken, clientId, tenantId) {
+        const idTokenEntity = new IdTokenEntity();
+        idTokenEntity.credentialType = CredentialType.ID_TOKEN;
+        idTokenEntity.homeAccountId = homeAccountId;
+        idTokenEntity.environment = environment;
+        idTokenEntity.clientId = clientId;
+        idTokenEntity.secret = idToken;
+        idTokenEntity.realm = tenantId;
+        return idTokenEntity;
+    }
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isIdTokenEntity(entity) {
+        if (!entity) {
+            return false;
+        }
+        return (entity.hasOwnProperty("homeAccountId") &&
+            entity.hasOwnProperty("environment") &&
+            entity.hasOwnProperty("credentialType") &&
+            entity.hasOwnProperty("realm") &&
+            entity.hasOwnProperty("clientId") &&
+            entity.hasOwnProperty("secret") &&
+            entity["credentialType"] === CredentialType.ID_TOKEN);
+    }
 }
 
 export { IdTokenEntity };

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

@@ -1,37 +1,37 @@
-import { CredentialEntity } from "./CredentialEntity";
-/**
- * REFRESH_TOKEN Cache
- *
- * Key:Value Schema:
- *
- * Key Example: uid.utid-login.microsoftonline.com-refreshtoken-clientId--
- *
- * Value:
- * {
- *      homeAccountId: home account identifier for the auth scheme,
- *      environment: entity that issued the token, represented as a full host
- *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
- *      clientId: client ID of the application
- *      secret: Actual credential as a string
- *      familyId: Family ID identifier, '1' represents Microsoft Family
- *      realm: Full tenant or organizational identifier that the account belongs to
- *      target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
- * }
- */
-export declare class RefreshTokenEntity extends CredentialEntity {
-    familyId?: string;
-    /**
-     * Create RefreshTokenEntity
-     * @param homeAccountId
-     * @param authenticationResult
-     * @param clientId
-     * @param authority
-     */
-    static createRefreshTokenEntity(homeAccountId: string, environment: string, refreshToken: string, clientId: string, familyId?: string, userAssertionHash?: string): RefreshTokenEntity;
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isRefreshTokenEntity(entity: object): boolean;
-}
+import { CredentialEntity } from "./CredentialEntity";
+/**
+ * REFRESH_TOKEN Cache
+ *
+ * Key:Value Schema:
+ *
+ * Key Example: uid.utid-login.microsoftonline.com-refreshtoken-clientId--
+ *
+ * Value:
+ * {
+ *      homeAccountId: home account identifier for the auth scheme,
+ *      environment: entity that issued the token, represented as a full host
+ *      credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
+ *      clientId: client ID of the application
+ *      secret: Actual credential as a string
+ *      familyId: Family ID identifier, '1' represents Microsoft Family
+ *      realm: Full tenant or organizational identifier that the account belongs to
+ *      target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
+ * }
+ */
+export declare class RefreshTokenEntity extends CredentialEntity {
+    familyId?: string;
+    /**
+     * Create RefreshTokenEntity
+     * @param homeAccountId
+     * @param authenticationResult
+     * @param clientId
+     * @param authority
+     */
+    static createRefreshTokenEntity(homeAccountId: string, environment: string, refreshToken: string, clientId: string, familyId?: string, userAssertionHash?: string): RefreshTokenEntity;
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isRefreshTokenEntity(entity: object): boolean;
+}
 //# sourceMappingURL=RefreshTokenEntity.d.ts.map