@azure/msal-common 14.6.0-alpha.0 → 14.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (203) hide show
  1. package/dist/account/AccountInfo.d.ts +58 -58
  2. package/dist/account/AccountInfo.mjs +59 -59
  3. package/dist/account/AuthToken.d.ts +17 -17
  4. package/dist/account/AuthToken.mjs +58 -58
  5. package/dist/account/CcsCredential.d.ts +9 -9
  6. package/dist/account/CcsCredential.mjs +8 -8
  7. package/dist/account/ClientCredentials.d.ts +14 -14
  8. package/dist/account/ClientInfo.d.ts +18 -18
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +83 -83
  11. package/dist/account/TokenClaims.mjs +20 -20
  12. package/dist/authority/Authority.d.ts +253 -254
  13. package/dist/authority/Authority.d.ts.map +1 -1
  14. package/dist/authority/Authority.mjs +827 -816
  15. package/dist/authority/Authority.mjs.map +1 -1
  16. package/dist/authority/AuthorityFactory.d.ts +31 -31
  17. package/dist/authority/AuthorityFactory.mjs +47 -47
  18. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  19. package/dist/authority/AuthorityMetadata.mjs +603 -603
  20. package/dist/authority/AuthorityOptions.d.ts +27 -27
  21. package/dist/authority/AuthorityOptions.mjs +18 -18
  22. package/dist/authority/AuthorityType.d.ts +10 -10
  23. package/dist/authority/AuthorityType.mjs +13 -13
  24. package/dist/authority/AzureRegion.d.ts +1 -1
  25. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  26. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  27. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  28. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  29. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  30. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  31. package/dist/authority/ImdsOptions.d.ts +5 -5
  32. package/dist/authority/OIDCOptions.d.ts +8 -8
  33. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  34. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  35. package/dist/authority/ProtocolMode.d.ts +8 -8
  36. package/dist/authority/ProtocolMode.mjs +11 -11
  37. package/dist/authority/RegionDiscovery.d.ts +32 -32
  38. package/dist/authority/RegionDiscovery.mjs +106 -106
  39. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  40. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  41. package/dist/cache/CacheManager.d.ts +508 -508
  42. package/dist/cache/CacheManager.mjs +1237 -1237
  43. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  44. package/dist/cache/entities/AccountEntity.d.ts +106 -106
  45. package/dist/cache/entities/AccountEntity.mjs +244 -244
  46. package/dist/cache/entities/AppMetadataEntity.d.ts +11 -39
  47. package/dist/cache/entities/AppMetadataEntity.d.ts.map +1 -1
  48. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +15 -48
  49. package/dist/cache/entities/AuthorityMetadataEntity.d.ts.map +1 -1
  50. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  51. package/dist/cache/entities/CacheRecord.mjs +14 -14
  52. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  53. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  54. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -7
  55. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  56. package/dist/cache/entities/ThrottlingEntity.d.ts +7 -7
  57. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  58. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  59. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  60. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  61. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  62. package/dist/cache/utils/CacheHelpers.d.ts +94 -70
  63. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  64. package/dist/cache/utils/CacheHelpers.mjs +326 -252
  65. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  66. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  67. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  68. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  69. package/dist/client/BaseClient.d.ts +51 -51
  70. package/dist/client/BaseClient.mjs +100 -100
  71. package/dist/client/RefreshTokenClient.d.ts +35 -35
  72. package/dist/client/RefreshTokenClient.mjs +204 -204
  73. package/dist/client/SilentFlowClient.d.ts +27 -27
  74. package/dist/client/SilentFlowClient.mjs +128 -128
  75. package/dist/config/AppTokenProvider.d.ts +38 -38
  76. package/dist/config/ClientConfiguration.d.ts +150 -150
  77. package/dist/config/ClientConfiguration.d.ts.map +1 -1
  78. package/dist/config/ClientConfiguration.mjs +98 -96
  79. package/dist/config/ClientConfiguration.mjs.map +1 -1
  80. package/dist/constants/AADServerParamKeys.d.ts +52 -52
  81. package/dist/constants/AADServerParamKeys.mjs +56 -56
  82. package/dist/crypto/ICrypto.d.ts +58 -58
  83. package/dist/crypto/ICrypto.mjs +30 -30
  84. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  85. package/dist/crypto/JoseHeader.d.ts +22 -22
  86. package/dist/crypto/JoseHeader.mjs +37 -37
  87. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  88. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  89. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  90. package/dist/error/AuthError.d.ts +44 -44
  91. package/dist/error/AuthError.mjs +46 -46
  92. package/dist/error/AuthErrorCodes.d.ts +5 -5
  93. package/dist/error/AuthErrorCodes.mjs +9 -9
  94. package/dist/error/ClientAuthError.d.ts +237 -237
  95. package/dist/error/ClientAuthError.mjs +249 -249
  96. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  97. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  98. package/dist/error/ClientConfigurationError.d.ts +128 -128
  99. package/dist/error/ClientConfigurationError.mjs +135 -135
  100. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  101. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  102. package/dist/error/InteractionRequiredAuthError.d.ts +61 -61
  103. package/dist/error/InteractionRequiredAuthError.mjs +84 -84
  104. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -7
  105. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -13
  106. package/dist/error/JoseHeaderError.d.ts +15 -15
  107. package/dist/error/JoseHeaderError.mjs +22 -22
  108. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  109. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  110. package/dist/error/ServerError.d.ts +7 -7
  111. package/dist/error/ServerError.mjs +14 -14
  112. package/dist/index.cjs +8557 -8611
  113. package/dist/index.cjs.map +1 -1
  114. package/dist/index.d.ts +99 -99
  115. package/dist/index.d.ts.map +1 -1
  116. package/dist/index.mjs +2 -4
  117. package/dist/index.mjs.map +1 -1
  118. package/dist/logger/Logger.d.ts +95 -95
  119. package/dist/logger/Logger.mjs +188 -188
  120. package/dist/network/INetworkModule.d.ts +29 -29
  121. package/dist/network/INetworkModule.mjs +12 -12
  122. package/dist/network/NetworkManager.d.ts +33 -33
  123. package/dist/network/NetworkManager.mjs +34 -34
  124. package/dist/network/RequestThumbprint.d.ts +18 -18
  125. package/dist/network/ThrottlingUtils.d.ts +42 -42
  126. package/dist/network/ThrottlingUtils.mjs +95 -95
  127. package/dist/packageMetadata.d.ts +2 -2
  128. package/dist/packageMetadata.d.ts.map +1 -1
  129. package/dist/packageMetadata.mjs +4 -4
  130. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  131. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  132. package/dist/request/BaseAuthRequest.d.ts +43 -43
  133. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  134. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  135. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  136. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  137. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  138. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  139. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
  140. package/dist/request/CommonSilentFlowRequest.d.ts +27 -27
  141. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  142. package/dist/request/NativeRequest.d.ts +19 -19
  143. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  144. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  145. package/dist/request/RequestParameterBuilder.mjs +381 -381
  146. package/dist/request/RequestValidator.d.ts +33 -33
  147. package/dist/request/RequestValidator.mjs +81 -81
  148. package/dist/request/ScopeSet.d.ts +88 -88
  149. package/dist/request/ScopeSet.mjs +197 -197
  150. package/dist/request/StoreInCache.d.ts +8 -8
  151. package/dist/response/AuthenticationResult.d.ts +41 -41
  152. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  153. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  154. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  155. package/dist/response/IMDSBadResponse.d.ts +4 -4
  156. package/dist/response/ResponseHandler.d.ts +69 -69
  157. package/dist/response/ResponseHandler.mjs +350 -347
  158. package/dist/response/ResponseHandler.mjs.map +1 -1
  159. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  160. package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -47
  161. package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -57
  162. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  163. package/dist/telemetry/performance/PerformanceClient.d.ts +198 -198
  164. package/dist/telemetry/performance/PerformanceClient.mjs +412 -412
  165. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  166. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  167. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  168. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  169. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  170. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  171. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  172. package/dist/url/IUri.d.ts +12 -12
  173. package/dist/url/UrlString.d.ts +48 -48
  174. package/dist/url/UrlString.mjs +161 -161
  175. package/dist/utils/Constants.d.ts +296 -298
  176. package/dist/utils/Constants.d.ts.map +1 -1
  177. package/dist/utils/Constants.mjs +310 -313
  178. package/dist/utils/Constants.mjs.map +1 -1
  179. package/dist/utils/FunctionWrappers.d.ts +27 -27
  180. package/dist/utils/FunctionWrappers.mjs +84 -84
  181. package/dist/utils/MsalTypes.d.ts +6 -6
  182. package/dist/utils/ProtocolUtils.d.ts +42 -42
  183. package/dist/utils/ProtocolUtils.mjs +69 -69
  184. package/dist/utils/StringUtils.d.ts +40 -40
  185. package/dist/utils/StringUtils.mjs +95 -95
  186. package/dist/utils/TimeUtils.d.ts +27 -27
  187. package/dist/utils/TimeUtils.mjs +45 -45
  188. package/dist/utils/UrlUtils.d.ts +10 -10
  189. package/dist/utils/UrlUtils.mjs +44 -44
  190. package/package.json +1 -1
  191. package/src/authority/Authority.ts +58 -25
  192. package/src/cache/entities/AppMetadataEntity.ts +6 -81
  193. package/src/cache/entities/AuthorityMetadataEntity.ts +2 -94
  194. package/src/cache/utils/CacheHelpers.ts +111 -0
  195. package/src/config/ClientConfiguration.ts +4 -4
  196. package/src/index.ts +0 -1
  197. package/src/packageMetadata.ts +1 -1
  198. package/src/response/ResponseHandler.ts +5 -5
  199. package/src/utils/Constants.ts +0 -4
  200. package/dist/cache/entities/AppMetadataEntity.mjs +0 -73
  201. package/dist/cache/entities/AppMetadataEntity.mjs.map +0 -1
  202. package/dist/cache/entities/AuthorityMetadataEntity.mjs +0 -86
  203. package/dist/cache/entities/AuthorityMetadataEntity.mjs.map +0 -1
@@ -1,15 +1,15 @@
1
- import { IdTokenEntity } from "./IdTokenEntity";
2
- import { AccessTokenEntity } from "./AccessTokenEntity";
3
- import { RefreshTokenEntity } from "./RefreshTokenEntity";
4
- import { AccountEntity } from "./AccountEntity";
5
- import { AppMetadataEntity } from "./AppMetadataEntity";
6
- /** @internal */
7
- export declare class CacheRecord {
8
- account: AccountEntity | null;
9
- idToken: IdTokenEntity | null;
10
- accessToken: AccessTokenEntity | null;
11
- refreshToken: RefreshTokenEntity | null;
12
- appMetadata: AppMetadataEntity | null;
13
- constructor(accountEntity?: AccountEntity | null, idTokenEntity?: IdTokenEntity | null, accessTokenEntity?: AccessTokenEntity | null, refreshTokenEntity?: RefreshTokenEntity | null, appMetadataEntity?: AppMetadataEntity | null);
14
- }
1
+ import { IdTokenEntity } from "./IdTokenEntity";
2
+ import { AccessTokenEntity } from "./AccessTokenEntity";
3
+ import { RefreshTokenEntity } from "./RefreshTokenEntity";
4
+ import { AccountEntity } from "./AccountEntity";
5
+ import { AppMetadataEntity } from "./AppMetadataEntity";
6
+ /** @internal */
7
+ export declare class CacheRecord {
8
+ account: AccountEntity | null;
9
+ idToken: IdTokenEntity | null;
10
+ accessToken: AccessTokenEntity | null;
11
+ refreshToken: RefreshTokenEntity | null;
12
+ appMetadata: AppMetadataEntity | null;
13
+ constructor(accountEntity?: AccountEntity | null, idTokenEntity?: IdTokenEntity | null, accessTokenEntity?: AccessTokenEntity | null, refreshTokenEntity?: RefreshTokenEntity | null, appMetadataEntity?: AppMetadataEntity | null);
14
+ }
15
15
  //# sourceMappingURL=CacheRecord.d.ts.map
@@ -1,18 +1,18 @@
1
- /*! @azure/msal-common v14.6.0-alpha.0 2023-12-15 */
1
+ /*! @azure/msal-common v14.6.0 2024-01-09 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- /** @internal */
8
- class CacheRecord {
9
- constructor(accountEntity, idTokenEntity, accessTokenEntity, refreshTokenEntity, appMetadataEntity) {
10
- this.account = accountEntity || null;
11
- this.idToken = idTokenEntity || null;
12
- this.accessToken = accessTokenEntity || null;
13
- this.refreshToken = refreshTokenEntity || null;
14
- this.appMetadata = appMetadataEntity || null;
15
- }
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ /** @internal */
8
+ class CacheRecord {
9
+ constructor(accountEntity, idTokenEntity, accessTokenEntity, refreshTokenEntity, appMetadataEntity) {
10
+ this.account = accountEntity || null;
11
+ this.idToken = idTokenEntity || null;
12
+ this.accessToken = accessTokenEntity || null;
13
+ this.refreshToken = refreshTokenEntity || null;
14
+ this.appMetadata = appMetadataEntity || null;
15
+ }
16
16
  }
17
17
 
18
18
  export { CacheRecord };
@@ -1,31 +1,31 @@
1
- import { CredentialType, AuthenticationScheme } from "../../utils/Constants";
2
- /**
3
- * Credential Cache Type
4
- */
5
- export type CredentialEntity = {
6
- /** Identifier for the user in their home tenant*/
7
- homeAccountId: string;
8
- /** Entity that issued the token, represented as a full host */
9
- environment: string;
10
- /** Type of credential */
11
- credentialType: CredentialType;
12
- /** Client ID of the application */
13
- clientId: string;
14
- /** Actual credential as a string */
15
- secret: string;
16
- /** Family ID identifier, usually only used for refresh tokens */
17
- familyId?: string;
18
- /** Full tenant or organizational identifier that the account belongs to */
19
- realm?: string;
20
- /** Permissions that are included in the token, or for refresh tokens, the resource identifier. */
21
- target?: string;
22
- /** Matches the SHA 256 hash of the obo_assertion for the OBO flow */
23
- userAssertionHash?: string;
24
- /** Matches the authentication scheme for which the token was issued (i.e. Bearer or pop) */
25
- tokenType?: AuthenticationScheme;
26
- /** KeyId for PoP and SSH tokens stored in the kid claim */
27
- keyId?: string;
28
- /** Matches the SHA 256 hash of the claims object included in the token request */
29
- requestedClaimsHash?: string;
30
- };
1
+ import { CredentialType, AuthenticationScheme } from "../../utils/Constants";
2
+ /**
3
+ * Credential Cache Type
4
+ */
5
+ export type CredentialEntity = {
6
+ /** Identifier for the user in their home tenant*/
7
+ homeAccountId: string;
8
+ /** Entity that issued the token, represented as a full host */
9
+ environment: string;
10
+ /** Type of credential */
11
+ credentialType: CredentialType;
12
+ /** Client ID of the application */
13
+ clientId: string;
14
+ /** Actual credential as a string */
15
+ secret: string;
16
+ /** Family ID identifier, usually only used for refresh tokens */
17
+ familyId?: string;
18
+ /** Full tenant or organizational identifier that the account belongs to */
19
+ realm?: string;
20
+ /** Permissions that are included in the token, or for refresh tokens, the resource identifier. */
21
+ target?: string;
22
+ /** Matches the SHA 256 hash of the obo_assertion for the OBO flow */
23
+ userAssertionHash?: string;
24
+ /** Matches the authentication scheme for which the token was issued (i.e. Bearer or pop) */
25
+ tokenType?: AuthenticationScheme;
26
+ /** KeyId for PoP and SSH tokens stored in the kid claim */
27
+ keyId?: string;
28
+ /** Matches the SHA 256 hash of the claims object included in the token request */
29
+ requestedClaimsHash?: string;
30
+ };
31
31
  //# sourceMappingURL=CredentialEntity.d.ts.map
@@ -1,9 +1,9 @@
1
- import { CredentialEntity } from "./CredentialEntity";
2
- /**
3
- * Id Token Cache Type
4
- */
5
- export type IdTokenEntity = CredentialEntity & {
6
- /** Full tenant or organizational identifier that the account belongs to */
7
- realm: string;
8
- };
1
+ import { CredentialEntity } from "./CredentialEntity";
2
+ /**
3
+ * Id Token Cache Type
4
+ */
5
+ export type IdTokenEntity = CredentialEntity & {
6
+ /** Full tenant or organizational identifier that the account belongs to */
7
+ realm: string;
8
+ };
9
9
  //# sourceMappingURL=IdTokenEntity.d.ts.map
@@ -1,8 +1,8 @@
1
- import { CredentialEntity } from "./CredentialEntity";
2
- /**
3
- * Refresh Token Cache Type
4
- */
5
- export type RefreshTokenEntity = CredentialEntity & {
6
- expiresOn?: string;
7
- };
1
+ import { CredentialEntity } from "./CredentialEntity";
2
+ /**
3
+ * Refresh Token Cache Type
4
+ */
5
+ export type RefreshTokenEntity = CredentialEntity & {
6
+ expiresOn?: string;
7
+ };
8
8
  //# sourceMappingURL=RefreshTokenEntity.d.ts.map
@@ -1,6 +1,6 @@
1
- export type ServerTelemetryEntity = {
2
- failedRequests: Array<string | number>;
3
- errors: string[];
4
- cacheHits: number;
5
- };
1
+ export type ServerTelemetryEntity = {
2
+ failedRequests: Array<string | number>;
3
+ errors: string[];
4
+ cacheHits: number;
5
+ };
6
6
  //# sourceMappingURL=ServerTelemetryEntity.d.ts.map
@@ -1,8 +1,8 @@
1
- export type ThrottlingEntity = {
2
- throttleTime: number;
3
- error?: string;
4
- errorCodes?: Array<string>;
5
- errorMessage?: string;
6
- subError?: string;
7
- };
1
+ export type ThrottlingEntity = {
2
+ throttleTime: number;
3
+ error?: string;
4
+ errorCodes?: Array<string>;
5
+ errorMessage?: string;
6
+ subError?: string;
7
+ };
8
8
  //# sourceMappingURL=ThrottlingEntity.d.ts.map
@@ -1,167 +1,167 @@
1
- import { AccountFilter } from "../utils/CacheTypes";
2
- import { CacheRecord } from "../entities/CacheRecord";
3
- import { AccountEntity } from "../entities/AccountEntity";
4
- import { AccountInfo } from "../../account/AccountInfo";
5
- import { AppMetadataEntity } from "../entities/AppMetadataEntity";
6
- import { ServerTelemetryEntity } from "../entities/ServerTelemetryEntity";
7
- import { ThrottlingEntity } from "../entities/ThrottlingEntity";
8
- import { IdTokenEntity } from "../entities/IdTokenEntity";
9
- import { AccessTokenEntity } from "../entities/AccessTokenEntity";
10
- import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
11
- import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
12
- import { StoreInCache } from "../../request/StoreInCache";
13
- export interface ICacheManager {
14
- /**
15
- * fetch the account entity from the platform cache
16
- * @param accountKey
17
- */
18
- getAccount(accountKey: string): AccountEntity | null;
19
- /**
20
- * set account entity in the platform cache
21
- * @param account
22
- */
23
- setAccount(account: AccountEntity): void;
24
- /**
25
- * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
26
- * @param key
27
- * @param homeAccountId
28
- * @param tenantId
29
- * @returns
30
- */
31
- isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
32
- /**
33
- * fetch the idToken entity from the platform cache
34
- * @param idTokenKey
35
- */
36
- getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
37
- /**
38
- * set idToken entity to the platform cache
39
- * @param idToken
40
- */
41
- setIdTokenCredential(idToken: IdTokenEntity): void;
42
- /**
43
- * fetch the idToken entity from the platform cache
44
- * @param accessTokenKey
45
- */
46
- getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
47
- /**
48
- * set idToken entity to the platform cache
49
- * @param accessToken
50
- */
51
- setAccessTokenCredential(accessToken: AccessTokenEntity): void;
52
- /**
53
- * fetch the idToken entity from the platform cache
54
- * @param refreshTokenKey
55
- */
56
- getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
57
- /**
58
- * set idToken entity to the platform cache
59
- * @param refreshToken
60
- */
61
- setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
62
- /**
63
- * fetch appMetadata entity from the platform cache
64
- * @param appMetadataKey
65
- */
66
- getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
67
- /**
68
- * set appMetadata entity to the platform cache
69
- * @param appMetadata
70
- */
71
- setAppMetadata(appMetadata: AppMetadataEntity): void;
72
- /**
73
- * fetch server telemetry entity from the platform cache
74
- * @param serverTelemetryKey
75
- */
76
- getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
77
- /**
78
- * set server telemetry entity to the platform cache
79
- * @param serverTelemetryKey
80
- * @param serverTelemetry
81
- */
82
- setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
83
- /**
84
- * fetch cloud discovery metadata entity from the platform cache
85
- * @param key
86
- */
87
- getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
88
- /**
89
- * Get cache keys for authority metadata
90
- */
91
- getAuthorityMetadataKeys(): Array<string>;
92
- /**
93
- * set cloud discovery metadata entity to the platform cache
94
- * @param key
95
- * @param value
96
- */
97
- setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
98
- /**
99
- * Provide an alias to find a matching AuthorityMetadataEntity in cache
100
- * @param host
101
- */
102
- getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
103
- /**
104
- * given an authority generates the cache key for authorityMetadata
105
- * @param authority
106
- */
107
- generateAuthorityMetadataCacheKey(authority: string): string;
108
- /**
109
- * fetch throttling entity from the platform cache
110
- * @param throttlingCacheKey
111
- */
112
- getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
113
- /**
114
- * set throttling entity to the platform cache
115
- * @param throttlingCacheKey
116
- * @param throttlingCache
117
- */
118
- setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
119
- /**
120
- * Returns all accounts in cache
121
- */
122
- getAllAccounts(): AccountInfo[];
123
- /**
124
- * saves a cache record
125
- * @param cacheRecord
126
- */
127
- saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: StoreInCache): Promise<void>;
128
- /**
129
- * retrieve accounts matching all provided filters; if no filter is set, get all accounts
130
- * @param homeAccountId
131
- * @param environment
132
- * @param realm
133
- */
134
- getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
135
- /**
136
- * Get AccountInfo object based on provided filters
137
- * @param filter
138
- */
139
- getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
140
- /**
141
- * Removes all accounts and related tokens from cache.
142
- */
143
- removeAllAccounts(): Promise<void>;
144
- /**
145
- * returns a boolean if the given account is removed
146
- * @param account
147
- */
148
- removeAccount(accountKey: string): Promise<void>;
149
- /**
150
- * returns a boolean if the given account is removed
151
- * @param account
152
- */
153
- removeAccountContext(account: AccountEntity): Promise<void>;
154
- /**
155
- * @param key
156
- */
157
- removeIdToken(key: string): void;
158
- /**
159
- * @param key
160
- */
161
- removeAccessToken(key: string): Promise<void>;
162
- /**
163
- * @param key
164
- */
165
- removeRefreshToken(key: string): void;
166
- }
1
+ import { AccountFilter } from "../utils/CacheTypes";
2
+ import { CacheRecord } from "../entities/CacheRecord";
3
+ import { AccountEntity } from "../entities/AccountEntity";
4
+ import { AccountInfo } from "../../account/AccountInfo";
5
+ import { AppMetadataEntity } from "../entities/AppMetadataEntity";
6
+ import { ServerTelemetryEntity } from "../entities/ServerTelemetryEntity";
7
+ import { ThrottlingEntity } from "../entities/ThrottlingEntity";
8
+ import { IdTokenEntity } from "../entities/IdTokenEntity";
9
+ import { AccessTokenEntity } from "../entities/AccessTokenEntity";
10
+ import { RefreshTokenEntity } from "../entities/RefreshTokenEntity";
11
+ import { AuthorityMetadataEntity } from "../entities/AuthorityMetadataEntity";
12
+ import { StoreInCache } from "../../request/StoreInCache";
13
+ export interface ICacheManager {
14
+ /**
15
+ * fetch the account entity from the platform cache
16
+ * @param accountKey
17
+ */
18
+ getAccount(accountKey: string): AccountEntity | null;
19
+ /**
20
+ * set account entity in the platform cache
21
+ * @param account
22
+ */
23
+ setAccount(account: AccountEntity): void;
24
+ /**
25
+ * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
26
+ * @param key
27
+ * @param homeAccountId
28
+ * @param tenantId
29
+ * @returns
30
+ */
31
+ isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
32
+ /**
33
+ * fetch the idToken entity from the platform cache
34
+ * @param idTokenKey
35
+ */
36
+ getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
37
+ /**
38
+ * set idToken entity to the platform cache
39
+ * @param idToken
40
+ */
41
+ setIdTokenCredential(idToken: IdTokenEntity): void;
42
+ /**
43
+ * fetch the idToken entity from the platform cache
44
+ * @param accessTokenKey
45
+ */
46
+ getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
47
+ /**
48
+ * set idToken entity to the platform cache
49
+ * @param accessToken
50
+ */
51
+ setAccessTokenCredential(accessToken: AccessTokenEntity): void;
52
+ /**
53
+ * fetch the idToken entity from the platform cache
54
+ * @param refreshTokenKey
55
+ */
56
+ getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
57
+ /**
58
+ * set idToken entity to the platform cache
59
+ * @param refreshToken
60
+ */
61
+ setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
62
+ /**
63
+ * fetch appMetadata entity from the platform cache
64
+ * @param appMetadataKey
65
+ */
66
+ getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
67
+ /**
68
+ * set appMetadata entity to the platform cache
69
+ * @param appMetadata
70
+ */
71
+ setAppMetadata(appMetadata: AppMetadataEntity): void;
72
+ /**
73
+ * fetch server telemetry entity from the platform cache
74
+ * @param serverTelemetryKey
75
+ */
76
+ getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
77
+ /**
78
+ * set server telemetry entity to the platform cache
79
+ * @param serverTelemetryKey
80
+ * @param serverTelemetry
81
+ */
82
+ setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
83
+ /**
84
+ * fetch cloud discovery metadata entity from the platform cache
85
+ * @param key
86
+ */
87
+ getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
88
+ /**
89
+ * Get cache keys for authority metadata
90
+ */
91
+ getAuthorityMetadataKeys(): Array<string>;
92
+ /**
93
+ * set cloud discovery metadata entity to the platform cache
94
+ * @param key
95
+ * @param value
96
+ */
97
+ setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
98
+ /**
99
+ * Provide an alias to find a matching AuthorityMetadataEntity in cache
100
+ * @param host
101
+ */
102
+ getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
103
+ /**
104
+ * given an authority generates the cache key for authorityMetadata
105
+ * @param authority
106
+ */
107
+ generateAuthorityMetadataCacheKey(authority: string): string;
108
+ /**
109
+ * fetch throttling entity from the platform cache
110
+ * @param throttlingCacheKey
111
+ */
112
+ getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
113
+ /**
114
+ * set throttling entity to the platform cache
115
+ * @param throttlingCacheKey
116
+ * @param throttlingCache
117
+ */
118
+ setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
119
+ /**
120
+ * Returns all accounts in cache
121
+ */
122
+ getAllAccounts(): AccountInfo[];
123
+ /**
124
+ * saves a cache record
125
+ * @param cacheRecord
126
+ */
127
+ saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: StoreInCache): Promise<void>;
128
+ /**
129
+ * retrieve accounts matching all provided filters; if no filter is set, get all accounts
130
+ * @param homeAccountId
131
+ * @param environment
132
+ * @param realm
133
+ */
134
+ getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
135
+ /**
136
+ * Get AccountInfo object based on provided filters
137
+ * @param filter
138
+ */
139
+ getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
140
+ /**
141
+ * Removes all accounts and related tokens from cache.
142
+ */
143
+ removeAllAccounts(): Promise<void>;
144
+ /**
145
+ * returns a boolean if the given account is removed
146
+ * @param account
147
+ */
148
+ removeAccount(accountKey: string): Promise<void>;
149
+ /**
150
+ * returns a boolean if the given account is removed
151
+ * @param account
152
+ */
153
+ removeAccountContext(account: AccountEntity): Promise<void>;
154
+ /**
155
+ * @param key
156
+ */
157
+ removeIdToken(key: string): void;
158
+ /**
159
+ * @param key
160
+ */
161
+ removeAccessToken(key: string): Promise<void>;
162
+ /**
163
+ * @param key
164
+ */
165
+ removeRefreshToken(key: string): void;
166
+ }
167
167
  //# sourceMappingURL=ICacheManager.d.ts.map
@@ -1,6 +1,6 @@
1
- import { TokenCacheContext } from "../persistence/TokenCacheContext";
2
- export interface ICachePlugin {
3
- beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
4
- afterCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
5
- }
1
+ import { TokenCacheContext } from "../persistence/TokenCacheContext";
2
+ export interface ICachePlugin {
3
+ beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
4
+ afterCacheAccess: (tokenCacheContext: TokenCacheContext) => Promise<void>;
5
+ }
6
6
  //# sourceMappingURL=ICachePlugin.d.ts.map
@@ -1,5 +1,5 @@
1
- export interface ISerializableTokenCache {
2
- deserialize: (cache: string) => void;
3
- serialize: () => string;
4
- }
1
+ export interface ISerializableTokenCache {
2
+ deserialize: (cache: string) => void;
3
+ serialize: () => string;
4
+ }
5
5
  //# sourceMappingURL=ISerializableTokenCache.d.ts.map
@@ -1,24 +1,24 @@
1
- import { ISerializableTokenCache } from "../interface/ISerializableTokenCache";
2
- /**
3
- * This class instance helps track the memory changes facilitating
4
- * decisions to read from and write to the persistent cache
5
- */ export declare class TokenCacheContext {
6
- /**
7
- * boolean indicating cache change
8
- */
9
- hasChanged: boolean;
10
- /**
11
- * serializable token cache interface
12
- */
13
- cache: ISerializableTokenCache;
14
- constructor(tokenCache: ISerializableTokenCache, hasChanged: boolean);
15
- /**
16
- * boolean which indicates the changes in cache
17
- */
18
- get cacheHasChanged(): boolean;
19
- /**
20
- * function to retrieve the token cache
21
- */
22
- get tokenCache(): ISerializableTokenCache;
23
- }
1
+ import { ISerializableTokenCache } from "../interface/ISerializableTokenCache";
2
+ /**
3
+ * This class instance helps track the memory changes facilitating
4
+ * decisions to read from and write to the persistent cache
5
+ */ export declare class TokenCacheContext {
6
+ /**
7
+ * boolean indicating cache change
8
+ */
9
+ hasChanged: boolean;
10
+ /**
11
+ * serializable token cache interface
12
+ */
13
+ cache: ISerializableTokenCache;
14
+ constructor(tokenCache: ISerializableTokenCache, hasChanged: boolean);
15
+ /**
16
+ * boolean which indicates the changes in cache
17
+ */
18
+ get cacheHasChanged(): boolean;
19
+ /**
20
+ * function to retrieve the token cache
21
+ */
22
+ get tokenCache(): ISerializableTokenCache;
23
+ }
24
24
  //# sourceMappingURL=TokenCacheContext.d.ts.map
@@ -1,29 +1,29 @@
1
- /*! @azure/msal-common v14.6.0-alpha.0 2023-12-15 */
1
+ /*! @azure/msal-common v14.6.0 2024-01-09 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- /**
8
- * This class instance helps track the memory changes facilitating
9
- * decisions to read from and write to the persistent cache
10
- */ class TokenCacheContext {
11
- constructor(tokenCache, hasChanged) {
12
- this.cache = tokenCache;
13
- this.hasChanged = hasChanged;
14
- }
15
- /**
16
- * boolean which indicates the changes in cache
17
- */
18
- get cacheHasChanged() {
19
- return this.hasChanged;
20
- }
21
- /**
22
- * function to retrieve the token cache
23
- */
24
- get tokenCache() {
25
- return this.cache;
26
- }
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ /**
8
+ * This class instance helps track the memory changes facilitating
9
+ * decisions to read from and write to the persistent cache
10
+ */ class TokenCacheContext {
11
+ constructor(tokenCache, hasChanged) {
12
+ this.cache = tokenCache;
13
+ this.hasChanged = hasChanged;
14
+ }
15
+ /**
16
+ * boolean which indicates the changes in cache
17
+ */
18
+ get cacheHasChanged() {
19
+ return this.hasChanged;
20
+ }
21
+ /**
22
+ * function to retrieve the token cache
23
+ */
24
+ get tokenCache() {
25
+ return this.cache;
26
+ }
27
27
  }
28
28
 
29
29
  export { TokenCacheContext };