@azure/msal-common 14.1.0-alpha.0 → 14.2.0

package/dist/cache/entities/RefreshTokenEntity.mjs

@@ -1,66 +1,66 @@
-/*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
+/*! @azure/msal-common v14.2.0 2023-10-20 */
 'use strict';
 import { CredentialEntity } from './CredentialEntity.mjs';
 import { CredentialType } from '../../utils/Constants.mjs';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * 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.
- * }
- */
-class RefreshTokenEntity extends CredentialEntity {
-    /**
-     * Create RefreshTokenEntity
-     * @param homeAccountId
-     * @param authenticationResult
-     * @param clientId
-     * @param authority
-     */
-    static createRefreshTokenEntity(homeAccountId, environment, refreshToken, clientId, familyId, userAssertionHash) {
-        const rtEntity = new RefreshTokenEntity();
-        rtEntity.clientId = clientId;
-        rtEntity.credentialType = CredentialType.REFRESH_TOKEN;
-        rtEntity.environment = environment;
-        rtEntity.homeAccountId = homeAccountId;
-        rtEntity.secret = refreshToken;
-        rtEntity.userAssertionHash = userAssertionHash;
-        if (familyId)
-            rtEntity.familyId = familyId;
-        return rtEntity;
-    }
-    /**
-     * Validates an entity: checks for all expected params
-     * @param entity
-     */
-    static isRefreshTokenEntity(entity) {
-        if (!entity) {
-            return false;
-        }
-        return (entity.hasOwnProperty("homeAccountId") &&
-            entity.hasOwnProperty("environment") &&
-            entity.hasOwnProperty("credentialType") &&
-            entity.hasOwnProperty("clientId") &&
-            entity.hasOwnProperty("secret") &&
-            entity["credentialType"] === CredentialType.REFRESH_TOKEN);
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * 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.
+ * }
+ */
+class RefreshTokenEntity extends CredentialEntity {
+    /**
+     * Create RefreshTokenEntity
+     * @param homeAccountId
+     * @param authenticationResult
+     * @param clientId
+     * @param authority
+     */
+    static createRefreshTokenEntity(homeAccountId, environment, refreshToken, clientId, familyId, userAssertionHash) {
+        const rtEntity = new RefreshTokenEntity();
+        rtEntity.clientId = clientId;
+        rtEntity.credentialType = CredentialType.REFRESH_TOKEN;
+        rtEntity.environment = environment;
+        rtEntity.homeAccountId = homeAccountId;
+        rtEntity.secret = refreshToken;
+        rtEntity.userAssertionHash = userAssertionHash;
+        if (familyId)
+            rtEntity.familyId = familyId;
+        return rtEntity;
+    }
+    /**
+     * Validates an entity: checks for all expected params
+     * @param entity
+     */
+    static isRefreshTokenEntity(entity) {
+        if (!entity) {
+            return false;
+        }
+        return (entity.hasOwnProperty("homeAccountId") &&
+            entity.hasOwnProperty("environment") &&
+            entity.hasOwnProperty("credentialType") &&
+            entity.hasOwnProperty("clientId") &&
+            entity.hasOwnProperty("secret") &&
+            entity["credentialType"] === CredentialType.REFRESH_TOKEN);
+    }
 }
 
 export { RefreshTokenEntity };

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

@@ -1,13 +1,13 @@
-export declare class ServerTelemetryEntity {
-    failedRequests: Array<string | number>;
-    errors: string[];
-    cacheHits: number;
-    constructor();
-    /**
-     * validates if a given cache entry is "Telemetry", parses <key,value>
-     * @param key
-     * @param entity
-     */
-    static isServerTelemetryEntity(key: string, entity?: object): boolean;
-}
+export declare class ServerTelemetryEntity {
+    failedRequests: Array<string | number>;
+    errors: string[];
+    cacheHits: number;
+    constructor();
+    /**
+     * validates if a given cache entry is "Telemetry", parses <key,value>
+     * @param key
+     * @param entity
+     */
+    static isServerTelemetryEntity(key: string, entity?: object): boolean;
+}
 //# sourceMappingURL=ServerTelemetryEntity.d.ts.map

package/dist/cache/entities/ServerTelemetryEntity.mjs

@@ -1,33 +1,33 @@
-/*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
+/*! @azure/msal-common v14.2.0 2023-10-20 */
 '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;
-    }
+/*
+ * 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 };

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

@@ -1,14 +1,14 @@
-export declare class ThrottlingEntity {
-    throttleTime: number;
-    error?: string;
-    errorCodes?: Array<string>;
-    errorMessage?: string;
-    subError?: string;
-    /**
-     * validates if a given cache entry is "Throttling", parses <key,value>
-     * @param key
-     * @param entity
-     */
-    static isThrottlingEntity(key: string, entity?: object): boolean;
-}
+export declare class ThrottlingEntity {
+    throttleTime: number;
+    error?: string;
+    errorCodes?: Array<string>;
+    errorMessage?: string;
+    subError?: string;
+    /**
+     * validates if a given cache entry is "Throttling", parses <key,value>
+     * @param key
+     * @param entity
+     */
+    static isThrottlingEntity(key: string, entity?: object): boolean;
+}
 //# sourceMappingURL=ThrottlingEntity.d.ts.map

package/dist/cache/entities/ThrottlingEntity.mjs

@@ -1,29 +1,29 @@
-/*! @azure/msal-common v14.1.0-alpha.0 2023-09-20 */
+/*! @azure/msal-common v14.2.0 2023-10-20 */
 'use strict';
 import { ThrottlingConstants } from '../../utils/Constants.mjs';
 
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-class ThrottlingEntity {
-    /**
-     * validates if a given cache entry is "Throttling", parses <key,value>
-     * @param key
-     * @param entity
-     */
-    static isThrottlingEntity(key, entity) {
-        let validateKey = false;
-        if (key) {
-            validateKey =
-                key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
-        }
-        let validateEntity = true;
-        if (entity) {
-            validateEntity = entity.hasOwnProperty("throttleTime");
-        }
-        return validateKey && validateEntity;
-    }
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+class ThrottlingEntity {
+    /**
+     * validates if a given cache entry is "Throttling", parses <key,value>
+     * @param key
+     * @param entity
+     */
+    static isThrottlingEntity(key, entity) {
+        let validateKey = false;
+        if (key) {
+            validateKey =
+                key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
+        }
+        let validateEntity = true;
+        if (entity) {
+            validateEntity = entity.hasOwnProperty("throttleTime");
+        }
+        return validateKey && validateEntity;
+    }
 }
 
 export { ThrottlingEntity };

package/dist/cache/interface/ICacheManager.d.ts

@@ -1,167 +1,167 @@
-import { AccountFilter } from "../utils/CacheTypes";
-import { CacheRecord } from "../entities/CacheRecord";
-import { AccountEntity } from "../entities/AccountEntity";
-import { AccountInfo } from "../../account/AccountInfo";
-import { AppMetadataEntity } from "../entities/AppMetadataEntity";
-import { ServerTelemetryEntity } from "../entities/ServerTelemetryEntity";
-import { ThrottlingEntity } from "../entities/ThrottlingEntity";
-import { IdTokenEntity } from "../entities/IdTokenEntity";
-import { AccessTokenEntity } from "../entities/AccessTokenEntity";
-import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
-import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
-import { StoreInCache } from "../../request/StoreInCache";
-export interface ICacheManager {
-    /**
-     * fetch the account entity from the platform cache
-     * @param accountKey
-     */
-    getAccount(accountKey: string): AccountEntity | null;
-    /**
-     * set account entity in the platform cache
-     * @param account
-     */
-    setAccount(account: AccountEntity): void;
-    /**
-     * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
-     * @param key
-     * @param homeAccountId
-     * @param tenantId
-     * @returns
-     */
-    isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
-    /**
-     * fetch the idToken entity from the platform cache
-     * @param idTokenKey
-     */
-    getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
-    /**
-     * set idToken entity to the platform cache
-     * @param idToken
-     */
-    setIdTokenCredential(idToken: IdTokenEntity): void;
-    /**
-     * fetch the idToken entity from the platform cache
-     * @param accessTokenKey
-     */
-    getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
-    /**
-     * set idToken entity to the platform cache
-     * @param accessToken
-     */
-    setAccessTokenCredential(accessToken: AccessTokenEntity): void;
-    /**
-     * fetch the idToken entity from the platform cache
-     * @param refreshTokenKey
-     */
-    getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
-    /**
-     * set idToken entity to the platform cache
-     * @param refreshToken
-     */
-    setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
-    /**
-     * fetch appMetadata entity from the platform cache
-     * @param appMetadataKey
-     */
-    getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
-    /**
-     * set appMetadata entity to the platform cache
-     * @param appMetadata
-     */
-    setAppMetadata(appMetadata: AppMetadataEntity): void;
-    /**
-     * fetch server telemetry entity from the platform cache
-     * @param serverTelemetryKey
-     */
-    getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
-    /**
-     * set server telemetry entity to the platform cache
-     * @param serverTelemetryKey
-     * @param serverTelemetry
-     */
-    setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
-    /**
-     * fetch cloud discovery metadata entity from the platform cache
-     * @param key
-     */
-    getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
-    /**
-     * Get cache keys for authority metadata
-     */
-    getAuthorityMetadataKeys(): Array<string>;
-    /**
-     * set cloud discovery metadata entity to the platform cache
-     * @param key
-     * @param value
-     */
-    setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
-    /**
-     * Provide an alias to find a matching AuthorityMetadataEntity in cache
-     * @param host
-     */
-    getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
-    /**
-     * given an authority generates the cache key for authorityMetadata
-     * @param authority
-     */
-    generateAuthorityMetadataCacheKey(authority: string): string;
-    /**
-     * fetch throttling entity from the platform cache
-     * @param throttlingCacheKey
-     */
-    getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
-    /**
-     * set throttling entity to the platform cache
-     * @param throttlingCacheKey
-     * @param throttlingCache
-     */
-    setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
-    /**
-     * Returns all accounts in cache
-     */
-    getAllAccounts(): AccountInfo[];
-    /**
-     * saves a cache record
-     * @param cacheRecord
-     */
-    saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: StoreInCache): Promise<void>;
-    /**
-     * retrieve accounts matching all provided filters; if no filter is set, get all accounts
-     * @param homeAccountId
-     * @param environment
-     * @param realm
-     */
-    getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
-    /**
-     * Get AccountInfo object based on provided filters
-     * @param filter
-     */
-    getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
-    /**
-     * Removes all accounts and related tokens from cache.
-     */
-    removeAllAccounts(): Promise<void>;
-    /**
-     * returns a boolean if the given account is removed
-     * @param account
-     */
-    removeAccount(accountKey: string): Promise<void>;
-    /**
-     * returns a boolean if the given account is removed
-     * @param account
-     */
-    removeAccountContext(account: AccountEntity): Promise<void>;
-    /**
-     * @param key
-     */
-    removeIdToken(key: string): void;
-    /**
-     * @param key
-     */
-    removeAccessToken(key: string): Promise<void>;
-    /**
-     * @param key
-     */
-    removeRefreshToken(key: string): void;
-}
+import { AccountFilter } from "../utils/CacheTypes";
+import { CacheRecord } from "../entities/CacheRecord";
+import { AccountEntity } from "../entities/AccountEntity";
+import { AccountInfo } from "../../account/AccountInfo";
+import { AppMetadataEntity } from "../entities/AppMetadataEntity";
+import { ServerTelemetryEntity } from "../entities/ServerTelemetryEntity";
+import { ThrottlingEntity } from "../entities/ThrottlingEntity";
+import { IdTokenEntity } from "../entities/IdTokenEntity";
+import { AccessTokenEntity } from "../entities/AccessTokenEntity";
+import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
+import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
+import { StoreInCache } from "../../request/StoreInCache";
+export interface ICacheManager {
+    /**
+     * fetch the account entity from the platform cache
+     * @param accountKey
+     */
+    getAccount(accountKey: string): AccountEntity | null;
+    /**
+     * set account entity in the platform cache
+     * @param account
+     */
+    setAccount(account: AccountEntity): void;
+    /**
+     * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
+     * @param key
+     * @param homeAccountId
+     * @param tenantId
+     * @returns
+     */
+    isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
+    /**
+     * fetch the idToken entity from the platform cache
+     * @param idTokenKey
+     */
+    getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
+    /**
+     * set idToken entity to the platform cache
+     * @param idToken
+     */
+    setIdTokenCredential(idToken: IdTokenEntity): void;
+    /**
+     * fetch the idToken entity from the platform cache
+     * @param accessTokenKey
+     */
+    getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
+    /**
+     * set idToken entity to the platform cache
+     * @param accessToken
+     */
+    setAccessTokenCredential(accessToken: AccessTokenEntity): void;
+    /**
+     * fetch the idToken entity from the platform cache
+     * @param refreshTokenKey
+     */
+    getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
+    /**
+     * set idToken entity to the platform cache
+     * @param refreshToken
+     */
+    setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
+    /**
+     * fetch appMetadata entity from the platform cache
+     * @param appMetadataKey
+     */
+    getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
+    /**
+     * set appMetadata entity to the platform cache
+     * @param appMetadata
+     */
+    setAppMetadata(appMetadata: AppMetadataEntity): void;
+    /**
+     * fetch server telemetry entity from the platform cache
+     * @param serverTelemetryKey
+     */
+    getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
+    /**
+     * set server telemetry entity to the platform cache
+     * @param serverTelemetryKey
+     * @param serverTelemetry
+     */
+    setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
+    /**
+     * fetch cloud discovery metadata entity from the platform cache
+     * @param key
+     */
+    getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
+    /**
+     * Get cache keys for authority metadata
+     */
+    getAuthorityMetadataKeys(): Array<string>;
+    /**
+     * set cloud discovery metadata entity to the platform cache
+     * @param key
+     * @param value
+     */
+    setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
+    /**
+     * Provide an alias to find a matching AuthorityMetadataEntity in cache
+     * @param host
+     */
+    getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
+    /**
+     * given an authority generates the cache key for authorityMetadata
+     * @param authority
+     */
+    generateAuthorityMetadataCacheKey(authority: string): string;
+    /**
+     * fetch throttling entity from the platform cache
+     * @param throttlingCacheKey
+     */
+    getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
+    /**
+     * set throttling entity to the platform cache
+     * @param throttlingCacheKey
+     * @param throttlingCache
+     */
+    setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
+    /**
+     * Returns all accounts in cache
+     */
+    getAllAccounts(): AccountInfo[];
+    /**
+     * saves a cache record
+     * @param cacheRecord
+     */
+    saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: StoreInCache): Promise<void>;
+    /**
+     * retrieve accounts matching all provided filters; if no filter is set, get all accounts
+     * @param homeAccountId
+     * @param environment
+     * @param realm
+     */
+    getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
+    /**
+     * Get AccountInfo object based on provided filters
+     * @param filter
+     */
+    getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
+    /**
+     * Removes all accounts and related tokens from cache.
+     */
+    removeAllAccounts(): Promise<void>;
+    /**
+     * returns a boolean if the given account is removed
+     * @param account
+     */
+    removeAccount(accountKey: string): Promise<void>;
+    /**
+     * returns a boolean if the given account is removed
+     * @param account
+     */
+    removeAccountContext(account: AccountEntity): Promise<void>;
+    /**
+     * @param key
+     */
+    removeIdToken(key: string): void;
+    /**
+     * @param key
+     */
+    removeAccessToken(key: string): Promise<void>;
+    /**
+     * @param key
+     */
+    removeRefreshToken(key: string): void;
+}
 //# sourceMappingURL=ICacheManager.d.ts.map

package/dist/cache/interface/ICachePlugin.d.ts

@@ -1,6 +1,6 @@
-import { TokenCacheContext } from "../persistence/TokenCacheContext";
-export interface ICachePlugin {
-    beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
-    afterCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
-}
+import { TokenCacheContext } from "../persistence/TokenCacheContext";
+export interface ICachePlugin {
+    beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
+    afterCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
+}
 //# sourceMappingURL=ICachePlugin.d.ts.map

package/dist/cache/interface/ISerializableTokenCache.d.ts

@@ -1,5 +1,5 @@
-export interface ISerializableTokenCache {
-    deserialize: (cache: string) => void;
-    serialize: () => string;
-}
+export interface ISerializableTokenCache {
+    deserialize: (cache: string) => void;
+    serialize: () => string;
+}
 //# sourceMappingURL=ISerializableTokenCache.d.ts.map