@azure/msal-common 14.0.0-alpha.1 → 14.0.0-alpha.2

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 (167) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +62 -62
  3. package/dist/account/AccountInfo.d.ts +31 -31
  4. package/dist/account/AuthToken.d.ts +20 -20
  5. package/dist/account/AuthToken.js +48 -48
  6. package/dist/account/CcsCredential.d.ts +8 -8
  7. package/dist/account/CcsCredential.js +9 -9
  8. package/dist/account/ClientCredentials.d.ts +14 -14
  9. package/dist/account/ClientInfo.d.ts +19 -19
  10. package/dist/account/ClientInfo.js +37 -37
  11. package/dist/account/DecodedAuthToken.d.ts +8 -8
  12. package/dist/account/TokenClaims.d.ts +65 -65
  13. package/dist/authority/Authority.d.ts +228 -215
  14. package/dist/authority/Authority.d.ts.map +1 -1
  15. package/dist/authority/Authority.js +716 -682
  16. package/dist/authority/Authority.js.map +1 -1
  17. package/dist/authority/AuthorityFactory.d.ts +30 -30
  18. package/dist/authority/AuthorityFactory.js +47 -47
  19. package/dist/authority/AuthorityMetadata.d.ts +622 -622
  20. package/dist/authority/AuthorityMetadata.js +876 -876
  21. package/dist/authority/AuthorityOptions.d.ts +18 -18
  22. package/dist/authority/AuthorityOptions.js +19 -19
  23. package/dist/authority/AuthorityType.d.ts +9 -9
  24. package/dist/authority/AuthorityType.js +14 -14
  25. package/dist/authority/AzureRegion.d.ts +1 -1
  26. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  27. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  28. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  29. package/dist/authority/CloudInstanceDiscoveryErrorResponse.js +8 -8
  30. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  31. package/dist/authority/CloudInstanceDiscoveryResponse.js +8 -8
  32. package/dist/authority/ImdsOptions.d.ts +5 -5
  33. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  34. package/dist/authority/OpenIdConfigResponse.js +10 -10
  35. package/dist/authority/ProtocolMode.d.ts +7 -7
  36. package/dist/authority/ProtocolMode.js +12 -12
  37. package/dist/authority/RegionDiscovery.d.ts +30 -30
  38. package/dist/authority/RegionDiscovery.js +108 -108
  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 +443 -443
  42. package/dist/cache/CacheManager.js +1011 -1011
  43. package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
  44. package/dist/cache/entities/AccessTokenEntity.js +111 -111
  45. package/dist/cache/entities/AccountEntity.d.ts +99 -99
  46. package/dist/cache/entities/AccountEntity.js +248 -248
  47. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  48. package/dist/cache/entities/AppMetadataEntity.js +66 -66
  49. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +47 -47
  50. package/dist/cache/entities/AuthorityMetadataEntity.js +77 -77
  51. package/dist/cache/entities/CacheRecord.d.ts +13 -13
  52. package/dist/cache/entities/CacheRecord.js +13 -13
  53. package/dist/cache/entities/CredentialEntity.d.ts +88 -88
  54. package/dist/cache/entities/CredentialEntity.js +136 -136
  55. package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
  56. package/dist/cache/entities/IdTokenEntity.js +56 -56
  57. package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
  58. package/dist/cache/entities/RefreshTokenEntity.js +59 -59
  59. package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
  60. package/dist/cache/entities/ServerTelemetryEntity.js +27 -27
  61. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  62. package/dist/cache/entities/ThrottlingEntity.js +23 -23
  63. package/dist/cache/interface/ICacheManager.d.ts +165 -165
  64. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  65. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  66. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  67. package/dist/cache/persistence/TokenCacheContext.js +25 -25
  68. package/dist/cache/utils/CacheTypes.d.ts +62 -62
  69. package/dist/client/AuthorizationCodeClient.d.ts +71 -71
  70. package/dist/client/AuthorizationCodeClient.js +433 -433
  71. package/dist/client/BaseClient.d.ts +50 -50
  72. package/dist/client/BaseClient.js +92 -92
  73. package/dist/client/RefreshTokenClient.d.ts +34 -34
  74. package/dist/client/RefreshTokenClient.js +239 -239
  75. package/dist/client/SilentFlowClient.d.ts +24 -24
  76. package/dist/client/SilentFlowClient.js +94 -94
  77. package/dist/config/AppTokenProvider.d.ts +38 -38
  78. package/dist/config/ClientConfiguration.d.ts +133 -133
  79. package/dist/config/ClientConfiguration.js +88 -88
  80. package/dist/crypto/ICrypto.d.ts +62 -62
  81. package/dist/crypto/ICrypto.js +42 -42
  82. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  83. package/dist/crypto/JoseHeader.d.ts +21 -21
  84. package/dist/crypto/JoseHeader.js +36 -36
  85. package/dist/crypto/PopTokenGenerator.d.ts +57 -57
  86. package/dist/crypto/PopTokenGenerator.js +83 -83
  87. package/dist/crypto/SignedHttpRequest.d.ts +11 -11
  88. package/dist/error/AuthError.d.ts +47 -47
  89. package/dist/error/AuthError.js +51 -51
  90. package/dist/error/ClientAuthError.d.ts +412 -412
  91. package/dist/error/ClientAuthError.js +519 -519
  92. package/dist/error/ClientConfigurationError.d.ts +198 -198
  93. package/dist/error/ClientConfigurationError.js +249 -249
  94. package/dist/error/InteractionRequiredAuthError.d.ts +59 -59
  95. package/dist/error/InteractionRequiredAuthError.js +78 -78
  96. package/dist/error/JoseHeaderError.d.ts +28 -28
  97. package/dist/error/JoseHeaderError.js +39 -39
  98. package/dist/error/ServerError.d.ts +7 -7
  99. package/dist/error/ServerError.js +14 -14
  100. package/dist/index.cjs.js +8843 -8809
  101. package/dist/index.cjs.js.map +1 -1
  102. package/dist/index.d.ts +93 -93
  103. package/dist/index.js +1 -1
  104. package/dist/logger/Logger.d.ts +95 -95
  105. package/dist/logger/Logger.js +197 -197
  106. package/dist/network/INetworkModule.d.ts +29 -29
  107. package/dist/network/INetworkModule.js +14 -14
  108. package/dist/network/NetworkManager.d.ts +32 -32
  109. package/dist/network/NetworkManager.js +33 -33
  110. package/dist/network/RequestThumbprint.d.ts +16 -16
  111. package/dist/network/ThrottlingUtils.d.ts +41 -41
  112. package/dist/network/ThrottlingUtils.js +94 -94
  113. package/dist/packageMetadata.d.ts +2 -2
  114. package/dist/packageMetadata.js +4 -4
  115. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  116. package/dist/request/AuthenticationHeaderParser.js +55 -55
  117. package/dist/request/BaseAuthRequest.d.ts +37 -37
  118. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  119. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  120. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  121. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  122. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  123. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  124. package/dist/request/CommonRefreshTokenRequest.d.ts +19 -19
  125. package/dist/request/CommonSilentFlowRequest.d.ts +18 -18
  126. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  127. package/dist/request/NativeRequest.d.ts +19 -19
  128. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  129. package/dist/request/RequestParameterBuilder.d.ts +216 -216
  130. package/dist/request/RequestParameterBuilder.js +374 -374
  131. package/dist/request/RequestValidator.d.ts +33 -33
  132. package/dist/request/RequestValidator.js +83 -83
  133. package/dist/request/ScopeSet.d.ts +88 -88
  134. package/dist/request/ScopeSet.js +197 -197
  135. package/dist/response/AuthenticationResult.d.ts +39 -39
  136. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  137. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  138. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  139. package/dist/response/IMDSBadResponse.d.ts +4 -4
  140. package/dist/response/ResponseHandler.d.ts +72 -72
  141. package/dist/response/ResponseHandler.js +300 -300
  142. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  143. package/dist/response/ServerAuthorizationTokenResponse.d.ts +44 -44
  144. package/dist/telemetry/performance/IPerformanceClient.d.ts +42 -42
  145. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  146. package/dist/telemetry/performance/PerformanceClient.d.ts +189 -189
  147. package/dist/telemetry/performance/PerformanceClient.js +406 -406
  148. package/dist/telemetry/performance/PerformanceEvent.d.ts +439 -439
  149. package/dist/telemetry/performance/PerformanceEvent.js +227 -227
  150. package/dist/telemetry/performance/StubPerformanceClient.d.ts +19 -19
  151. package/dist/telemetry/performance/StubPerformanceClient.js +36 -36
  152. package/dist/telemetry/server/ServerTelemetryManager.d.ts +65 -65
  153. package/dist/telemetry/server/ServerTelemetryManager.js +196 -196
  154. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  155. package/dist/url/IUri.d.ts +12 -12
  156. package/dist/url/UrlString.d.ts +70 -70
  157. package/dist/url/UrlString.js +242 -242
  158. package/dist/utils/Constants.d.ts +331 -331
  159. package/dist/utils/Constants.js +373 -373
  160. package/dist/utils/MsalTypes.d.ts +6 -6
  161. package/dist/utils/ProtocolUtils.d.ts +42 -42
  162. package/dist/utils/ProtocolUtils.js +71 -71
  163. package/dist/utils/StringUtils.d.ts +53 -53
  164. package/dist/utils/StringUtils.js +124 -124
  165. package/dist/utils/TimeUtils.d.ts +27 -27
  166. package/dist/utils/TimeUtils.js +45 -45
  167. package/package.json +79 -79
@@ -1,66 +1,66 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-alpha.2 2023-05-17 */
2
2
  'use strict';
3
3
  import { CredentialEntity } from './CredentialEntity.js';
4
4
  import { CredentialType } from '../../utils/Constants.js';
5
5
 
6
- /*
7
- * Copyright (c) Microsoft Corporation. All rights reserved.
8
- * Licensed under the MIT License.
9
- */
10
- /**
11
- * REFRESH_TOKEN Cache
12
- *
13
- * Key:Value Schema:
14
- *
15
- * Key Example: uid.utid-login.microsoftonline.com-refreshtoken-clientId--
16
- *
17
- * Value:
18
- * {
19
- * homeAccountId: home account identifier for the auth scheme,
20
- * environment: entity that issued the token, represented as a full host
21
- * credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
22
- * clientId: client ID of the application
23
- * secret: Actual credential as a string
24
- * familyId: Family ID identifier, '1' represents Microsoft Family
25
- * realm: Full tenant or organizational identifier that the account belongs to
26
- * target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
27
- * }
28
- */
29
- class RefreshTokenEntity extends CredentialEntity {
30
- /**
31
- * Create RefreshTokenEntity
32
- * @param homeAccountId
33
- * @param authenticationResult
34
- * @param clientId
35
- * @param authority
36
- */
37
- static createRefreshTokenEntity(homeAccountId, environment, refreshToken, clientId, familyId, userAssertionHash) {
38
- const rtEntity = new RefreshTokenEntity();
39
- rtEntity.clientId = clientId;
40
- rtEntity.credentialType = CredentialType.REFRESH_TOKEN;
41
- rtEntity.environment = environment;
42
- rtEntity.homeAccountId = homeAccountId;
43
- rtEntity.secret = refreshToken;
44
- rtEntity.userAssertionHash = userAssertionHash;
45
- if (familyId)
46
- rtEntity.familyId = familyId;
47
- return rtEntity;
48
- }
49
- /**
50
- * Validates an entity: checks for all expected params
51
- * @param entity
52
- */
53
- static isRefreshTokenEntity(entity) {
54
- if (!entity) {
55
- return false;
56
- }
57
- return (entity.hasOwnProperty("homeAccountId") &&
58
- entity.hasOwnProperty("environment") &&
59
- entity.hasOwnProperty("credentialType") &&
60
- entity.hasOwnProperty("clientId") &&
61
- entity.hasOwnProperty("secret") &&
62
- entity["credentialType"] === CredentialType.REFRESH_TOKEN);
63
- }
6
+ /*
7
+ * Copyright (c) Microsoft Corporation. All rights reserved.
8
+ * Licensed under the MIT License.
9
+ */
10
+ /**
11
+ * REFRESH_TOKEN Cache
12
+ *
13
+ * Key:Value Schema:
14
+ *
15
+ * Key Example: uid.utid-login.microsoftonline.com-refreshtoken-clientId--
16
+ *
17
+ * Value:
18
+ * {
19
+ * homeAccountId: home account identifier for the auth scheme,
20
+ * environment: entity that issued the token, represented as a full host
21
+ * credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other
22
+ * clientId: client ID of the application
23
+ * secret: Actual credential as a string
24
+ * familyId: Family ID identifier, '1' represents Microsoft Family
25
+ * realm: Full tenant or organizational identifier that the account belongs to
26
+ * target: Permissions that are included in the token, or for refresh tokens, the resource identifier.
27
+ * }
28
+ */
29
+ class RefreshTokenEntity extends CredentialEntity {
30
+ /**
31
+ * Create RefreshTokenEntity
32
+ * @param homeAccountId
33
+ * @param authenticationResult
34
+ * @param clientId
35
+ * @param authority
36
+ */
37
+ static createRefreshTokenEntity(homeAccountId, environment, refreshToken, clientId, familyId, userAssertionHash) {
38
+ const rtEntity = new RefreshTokenEntity();
39
+ rtEntity.clientId = clientId;
40
+ rtEntity.credentialType = CredentialType.REFRESH_TOKEN;
41
+ rtEntity.environment = environment;
42
+ rtEntity.homeAccountId = homeAccountId;
43
+ rtEntity.secret = refreshToken;
44
+ rtEntity.userAssertionHash = userAssertionHash;
45
+ if (familyId)
46
+ rtEntity.familyId = familyId;
47
+ return rtEntity;
48
+ }
49
+ /**
50
+ * Validates an entity: checks for all expected params
51
+ * @param entity
52
+ */
53
+ static isRefreshTokenEntity(entity) {
54
+ if (!entity) {
55
+ return false;
56
+ }
57
+ return (entity.hasOwnProperty("homeAccountId") &&
58
+ entity.hasOwnProperty("environment") &&
59
+ entity.hasOwnProperty("credentialType") &&
60
+ entity.hasOwnProperty("clientId") &&
61
+ entity.hasOwnProperty("secret") &&
62
+ entity["credentialType"] === CredentialType.REFRESH_TOKEN);
63
+ }
64
64
  }
65
65
 
66
66
  export { RefreshTokenEntity };
@@ -1,13 +1,13 @@
1
- export declare class ServerTelemetryEntity {
2
- failedRequests: Array<string | number>;
3
- errors: string[];
4
- cacheHits: number;
5
- constructor();
6
- /**
7
- * validates if a given cache entry is "Telemetry", parses <key,value>
8
- * @param key
9
- * @param entity
10
- */
11
- static isServerTelemetryEntity(key: string, entity?: object): boolean;
12
- }
1
+ export declare class ServerTelemetryEntity {
2
+ failedRequests: Array<string | number>;
3
+ errors: string[];
4
+ cacheHits: number;
5
+ constructor();
6
+ /**
7
+ * validates if a given cache entry is "Telemetry", parses <key,value>
8
+ * @param key
9
+ * @param entity
10
+ */
11
+ static isServerTelemetryEntity(key: string, entity?: object): boolean;
12
+ }
13
13
  //# sourceMappingURL=ServerTelemetryEntity.d.ts.map
@@ -1,33 +1,33 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-alpha.2 2023-05-17 */
2
2
  'use strict';
3
3
  import { SERVER_TELEM_CONSTANTS } from '../../utils/Constants.js';
4
4
 
5
- /*
6
- * Copyright (c) Microsoft Corporation. All rights reserved.
7
- * Licensed under the MIT License.
8
- */
9
- class ServerTelemetryEntity {
10
- constructor() {
11
- this.failedRequests = [];
12
- this.errors = [];
13
- this.cacheHits = 0;
14
- }
15
- /**
16
- * validates if a given cache entry is "Telemetry", parses <key,value>
17
- * @param key
18
- * @param entity
19
- */
20
- static isServerTelemetryEntity(key, entity) {
21
- const validateKey = key.indexOf(SERVER_TELEM_CONSTANTS.CACHE_KEY) === 0;
22
- let validateEntity = true;
23
- if (entity) {
24
- validateEntity =
25
- entity.hasOwnProperty("failedRequests") &&
26
- entity.hasOwnProperty("errors") &&
27
- entity.hasOwnProperty("cacheHits");
28
- }
29
- return validateKey && validateEntity;
30
- }
5
+ /*
6
+ * Copyright (c) Microsoft Corporation. All rights reserved.
7
+ * Licensed under the MIT License.
8
+ */
9
+ class ServerTelemetryEntity {
10
+ constructor() {
11
+ this.failedRequests = [];
12
+ this.errors = [];
13
+ this.cacheHits = 0;
14
+ }
15
+ /**
16
+ * validates if a given cache entry is "Telemetry", parses <key,value>
17
+ * @param key
18
+ * @param entity
19
+ */
20
+ static isServerTelemetryEntity(key, entity) {
21
+ const validateKey = key.indexOf(SERVER_TELEM_CONSTANTS.CACHE_KEY) === 0;
22
+ let validateEntity = true;
23
+ if (entity) {
24
+ validateEntity =
25
+ entity.hasOwnProperty("failedRequests") &&
26
+ entity.hasOwnProperty("errors") &&
27
+ entity.hasOwnProperty("cacheHits");
28
+ }
29
+ return validateKey && validateEntity;
30
+ }
31
31
  }
32
32
 
33
33
  export { ServerTelemetryEntity };
@@ -1,14 +1,14 @@
1
- export declare class ThrottlingEntity {
2
- throttleTime: number;
3
- error?: string;
4
- errorCodes?: Array<string>;
5
- errorMessage?: string;
6
- subError?: string;
7
- /**
8
- * validates if a given cache entry is "Throttling", parses <key,value>
9
- * @param key
10
- * @param entity
11
- */
12
- static isThrottlingEntity(key: string, entity?: object): boolean;
13
- }
1
+ export declare class ThrottlingEntity {
2
+ throttleTime: number;
3
+ error?: string;
4
+ errorCodes?: Array<string>;
5
+ errorMessage?: string;
6
+ subError?: string;
7
+ /**
8
+ * validates if a given cache entry is "Throttling", parses <key,value>
9
+ * @param key
10
+ * @param entity
11
+ */
12
+ static isThrottlingEntity(key: string, entity?: object): boolean;
13
+ }
14
14
  //# sourceMappingURL=ThrottlingEntity.d.ts.map
@@ -1,29 +1,29 @@
1
- /*! @azure/msal-common v14.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-common v14.0.0-alpha.2 2023-05-17 */
2
2
  'use strict';
3
3
  import { ThrottlingConstants } from '../../utils/Constants.js';
4
4
 
5
- /*
6
- * Copyright (c) Microsoft Corporation. All rights reserved.
7
- * Licensed under the MIT License.
8
- */
9
- class ThrottlingEntity {
10
- /**
11
- * validates if a given cache entry is "Throttling", parses <key,value>
12
- * @param key
13
- * @param entity
14
- */
15
- static isThrottlingEntity(key, entity) {
16
- let validateKey = false;
17
- if (key) {
18
- validateKey =
19
- key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
20
- }
21
- let validateEntity = true;
22
- if (entity) {
23
- validateEntity = entity.hasOwnProperty("throttleTime");
24
- }
25
- return validateKey && validateEntity;
26
- }
5
+ /*
6
+ * Copyright (c) Microsoft Corporation. All rights reserved.
7
+ * Licensed under the MIT License.
8
+ */
9
+ class ThrottlingEntity {
10
+ /**
11
+ * validates if a given cache entry is "Throttling", parses <key,value>
12
+ * @param key
13
+ * @param entity
14
+ */
15
+ static isThrottlingEntity(key, entity) {
16
+ let validateKey = false;
17
+ if (key) {
18
+ validateKey =
19
+ key.indexOf(ThrottlingConstants.THROTTLING_PREFIX) === 0;
20
+ }
21
+ let validateEntity = true;
22
+ if (entity) {
23
+ validateEntity = entity.hasOwnProperty("throttleTime");
24
+ }
25
+ return validateKey && validateEntity;
26
+ }
27
27
  }
28
28
 
29
29
  export { ThrottlingEntity };
@@ -1,166 +1,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
- export interface ICacheManager {
13
- /**
14
- * fetch the account entity from the platform cache
15
- * @param accountKey
16
- */
17
- getAccount(accountKey: string): AccountEntity | null;
18
- /**
19
- * set account entity in the platform cache
20
- * @param account
21
- */
22
- setAccount(account: AccountEntity): void;
23
- /**
24
- * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
25
- * @param key
26
- * @param homeAccountId
27
- * @param tenantId
28
- * @returns
29
- */
30
- isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
31
- /**
32
- * fetch the idToken entity from the platform cache
33
- * @param idTokenKey
34
- */
35
- getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
36
- /**
37
- * set idToken entity to the platform cache
38
- * @param idToken
39
- */
40
- setIdTokenCredential(idToken: IdTokenEntity): void;
41
- /**
42
- * fetch the idToken entity from the platform cache
43
- * @param accessTokenKey
44
- */
45
- getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
46
- /**
47
- * set idToken entity to the platform cache
48
- * @param accessToken
49
- */
50
- setAccessTokenCredential(accessToken: AccessTokenEntity): void;
51
- /**
52
- * fetch the idToken entity from the platform cache
53
- * @param refreshTokenKey
54
- */
55
- getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
56
- /**
57
- * set idToken entity to the platform cache
58
- * @param refreshToken
59
- */
60
- setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
61
- /**
62
- * fetch appMetadata entity from the platform cache
63
- * @param appMetadataKey
64
- */
65
- getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
66
- /**
67
- * set appMetadata entity to the platform cache
68
- * @param appMetadata
69
- */
70
- setAppMetadata(appMetadata: AppMetadataEntity): void;
71
- /**
72
- * fetch server telemetry entity from the platform cache
73
- * @param serverTelemetryKey
74
- */
75
- getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
76
- /**
77
- * set server telemetry entity to the platform cache
78
- * @param serverTelemetryKey
79
- * @param serverTelemetry
80
- */
81
- setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
82
- /**
83
- * fetch cloud discovery metadata entity from the platform cache
84
- * @param key
85
- */
86
- getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
87
- /**
88
- * Get cache keys for authority metadata
89
- */
90
- getAuthorityMetadataKeys(): Array<string>;
91
- /**
92
- * set cloud discovery metadata entity to the platform cache
93
- * @param key
94
- * @param value
95
- */
96
- setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
97
- /**
98
- * Provide an alias to find a matching AuthorityMetadataEntity in cache
99
- * @param host
100
- */
101
- getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
102
- /**
103
- * given an authority generates the cache key for authorityMetadata
104
- * @param authority
105
- */
106
- generateAuthorityMetadataCacheKey(authority: string): string;
107
- /**
108
- * fetch throttling entity from the platform cache
109
- * @param throttlingCacheKey
110
- */
111
- getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
112
- /**
113
- * set throttling entity to the platform cache
114
- * @param throttlingCacheKey
115
- * @param throttlingCache
116
- */
117
- setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
118
- /**
119
- * Returns all accounts in cache
120
- */
121
- getAllAccounts(): AccountInfo[];
122
- /**
123
- * saves a cache record
124
- * @param cacheRecord
125
- */
126
- saveCacheRecord(cacheRecord: CacheRecord): Promise<void>;
127
- /**
128
- * retrieve accounts matching all provided filters; if no filter is set, get all accounts
129
- * @param homeAccountId
130
- * @param environment
131
- * @param realm
132
- */
133
- getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
134
- /**
135
- * Get AccountInfo object based on provided filters
136
- * @param filter
137
- */
138
- getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
139
- /**
140
- * Removes all accounts and related tokens from cache.
141
- */
142
- removeAllAccounts(): Promise<void>;
143
- /**
144
- * returns a boolean if the given account is removed
145
- * @param account
146
- */
147
- removeAccount(accountKey: string): Promise<void>;
148
- /**
149
- * returns a boolean if the given account is removed
150
- * @param account
151
- */
152
- removeAccountContext(account: AccountEntity): Promise<void>;
153
- /**
154
- * @param key
155
- */
156
- removeIdToken(key: string): void;
157
- /**
158
- * @param key
159
- */
160
- removeAccessToken(key: string): Promise<void>;
161
- /**
162
- * @param key
163
- */
164
- removeRefreshToken(key: string): void;
165
- }
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
+ export interface ICacheManager {
13
+ /**
14
+ * fetch the account entity from the platform cache
15
+ * @param accountKey
16
+ */
17
+ getAccount(accountKey: string): AccountEntity | null;
18
+ /**
19
+ * set account entity in the platform cache
20
+ * @param account
21
+ */
22
+ setAccount(account: AccountEntity): void;
23
+ /**
24
+ * Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
25
+ * @param key
26
+ * @param homeAccountId
27
+ * @param tenantId
28
+ * @returns
29
+ */
30
+ isAccountKey(key: string, homeAccountId?: string, tenantId?: string): boolean;
31
+ /**
32
+ * fetch the idToken entity from the platform cache
33
+ * @param idTokenKey
34
+ */
35
+ getIdTokenCredential(idTokenKey: string): IdTokenEntity | null;
36
+ /**
37
+ * set idToken entity to the platform cache
38
+ * @param idToken
39
+ */
40
+ setIdTokenCredential(idToken: IdTokenEntity): void;
41
+ /**
42
+ * fetch the idToken entity from the platform cache
43
+ * @param accessTokenKey
44
+ */
45
+ getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null;
46
+ /**
47
+ * set idToken entity to the platform cache
48
+ * @param accessToken
49
+ */
50
+ setAccessTokenCredential(accessToken: AccessTokenEntity): void;
51
+ /**
52
+ * fetch the idToken entity from the platform cache
53
+ * @param refreshTokenKey
54
+ */
55
+ getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null;
56
+ /**
57
+ * set idToken entity to the platform cache
58
+ * @param refreshToken
59
+ */
60
+ setRefreshTokenCredential(refreshToken: RefreshTokenEntity): void;
61
+ /**
62
+ * fetch appMetadata entity from the platform cache
63
+ * @param appMetadataKey
64
+ */
65
+ getAppMetadata(appMetadataKey: string): AppMetadataEntity | null;
66
+ /**
67
+ * set appMetadata entity to the platform cache
68
+ * @param appMetadata
69
+ */
70
+ setAppMetadata(appMetadata: AppMetadataEntity): void;
71
+ /**
72
+ * fetch server telemetry entity from the platform cache
73
+ * @param serverTelemetryKey
74
+ */
75
+ getServerTelemetry(serverTelemetryKey: string): ServerTelemetryEntity | null;
76
+ /**
77
+ * set server telemetry entity to the platform cache
78
+ * @param serverTelemetryKey
79
+ * @param serverTelemetry
80
+ */
81
+ setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity): void;
82
+ /**
83
+ * fetch cloud discovery metadata entity from the platform cache
84
+ * @param key
85
+ */
86
+ getAuthorityMetadata(key: string): AuthorityMetadataEntity | null;
87
+ /**
88
+ * Get cache keys for authority metadata
89
+ */
90
+ getAuthorityMetadataKeys(): Array<string>;
91
+ /**
92
+ * set cloud discovery metadata entity to the platform cache
93
+ * @param key
94
+ * @param value
95
+ */
96
+ setAuthorityMetadata(key: string, value: AuthorityMetadataEntity): void;
97
+ /**
98
+ * Provide an alias to find a matching AuthorityMetadataEntity in cache
99
+ * @param host
100
+ */
101
+ getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null;
102
+ /**
103
+ * given an authority generates the cache key for authorityMetadata
104
+ * @param authority
105
+ */
106
+ generateAuthorityMetadataCacheKey(authority: string): string;
107
+ /**
108
+ * fetch throttling entity from the platform cache
109
+ * @param throttlingCacheKey
110
+ */
111
+ getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null;
112
+ /**
113
+ * set throttling entity to the platform cache
114
+ * @param throttlingCacheKey
115
+ * @param throttlingCache
116
+ */
117
+ setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity): void;
118
+ /**
119
+ * Returns all accounts in cache
120
+ */
121
+ getAllAccounts(): AccountInfo[];
122
+ /**
123
+ * saves a cache record
124
+ * @param cacheRecord
125
+ */
126
+ saveCacheRecord(cacheRecord: CacheRecord): Promise<void>;
127
+ /**
128
+ * retrieve accounts matching all provided filters; if no filter is set, get all accounts
129
+ * @param homeAccountId
130
+ * @param environment
131
+ * @param realm
132
+ */
133
+ getAccountsFilteredBy(filter: AccountFilter): AccountEntity[];
134
+ /**
135
+ * Get AccountInfo object based on provided filters
136
+ * @param filter
137
+ */
138
+ getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | null;
139
+ /**
140
+ * Removes all accounts and related tokens from cache.
141
+ */
142
+ removeAllAccounts(): Promise<void>;
143
+ /**
144
+ * returns a boolean if the given account is removed
145
+ * @param account
146
+ */
147
+ removeAccount(accountKey: string): Promise<void>;
148
+ /**
149
+ * returns a boolean if the given account is removed
150
+ * @param account
151
+ */
152
+ removeAccountContext(account: AccountEntity): Promise<void>;
153
+ /**
154
+ * @param key
155
+ */
156
+ removeIdToken(key: string): void;
157
+ /**
158
+ * @param key
159
+ */
160
+ removeAccessToken(key: string): Promise<void>;
161
+ /**
162
+ * @param key
163
+ */
164
+ removeRefreshToken(key: string): void;
165
+ }
166
166
  //# 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