@azure/msal-common 14.3.0 → 14.4.1-beta.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 (246) hide show
  1. package/dist/account/AccountInfo.d.ts +31 -31
  2. package/dist/account/AuthToken.d.ts +17 -17
  3. package/dist/account/AuthToken.mjs +58 -58
  4. package/dist/account/CcsCredential.d.ts +9 -9
  5. package/dist/account/CcsCredential.mjs +8 -8
  6. package/dist/account/ClientCredentials.d.ts +14 -14
  7. package/dist/account/ClientInfo.d.ts +19 -19
  8. package/dist/account/ClientInfo.mjs +37 -37
  9. package/dist/account/TokenClaims.d.ts +65 -65
  10. package/dist/authority/Authority.d.ts +249 -249
  11. package/dist/authority/Authority.d.ts.map +1 -1
  12. package/dist/authority/Authority.mjs +788 -789
  13. package/dist/authority/Authority.mjs.map +1 -1
  14. package/dist/authority/AuthorityFactory.d.ts +31 -31
  15. package/dist/authority/AuthorityFactory.mjs +47 -47
  16. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  17. package/dist/authority/AuthorityMetadata.mjs +603 -603
  18. package/dist/authority/AuthorityOptions.d.ts +27 -27
  19. package/dist/authority/AuthorityOptions.mjs +18 -18
  20. package/dist/authority/AuthorityType.d.ts +10 -10
  21. package/dist/authority/AuthorityType.mjs +13 -13
  22. package/dist/authority/AzureRegion.d.ts +1 -1
  23. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  24. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  25. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  26. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  27. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  28. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  29. package/dist/authority/ImdsOptions.d.ts +5 -5
  30. package/dist/authority/OIDCOptions.d.ts +8 -8
  31. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  32. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  33. package/dist/authority/ProtocolMode.d.ts +8 -8
  34. package/dist/authority/ProtocolMode.mjs +11 -11
  35. package/dist/authority/RegionDiscovery.d.ts +32 -32
  36. package/dist/authority/RegionDiscovery.mjs +106 -106
  37. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  38. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  39. package/dist/cache/CacheManager.d.ts +485 -480
  40. package/dist/cache/CacheManager.d.ts.map +1 -1
  41. package/dist/cache/CacheManager.mjs +1102 -1089
  42. package/dist/cache/CacheManager.mjs.map +1 -1
  43. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  44. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  45. package/dist/cache/entities/AccountEntity.mjs +218 -218
  46. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  47. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  48. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  49. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  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 -5
  55. package/dist/cache/entities/RefreshTokenEntity.d.ts.map +1 -1
  56. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -12
  57. package/dist/cache/entities/ServerTelemetryEntity.d.ts.map +1 -1
  58. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  59. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  60. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  61. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  62. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  63. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  64. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  65. package/dist/cache/utils/CacheHelpers.d.ts +64 -58
  66. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  67. package/dist/cache/utils/CacheHelpers.mjs +236 -217
  68. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  69. package/dist/cache/utils/CacheTypes.d.ts +67 -67
  70. package/dist/client/AuthorizationCodeClient.d.ts +74 -73
  71. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  72. package/dist/client/AuthorizationCodeClient.mjs +402 -408
  73. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  74. package/dist/client/BaseClient.d.ts +51 -51
  75. package/dist/client/BaseClient.mjs +100 -100
  76. package/dist/client/RefreshTokenClient.d.ts +35 -35
  77. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  78. package/dist/client/RefreshTokenClient.mjs +193 -187
  79. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  80. package/dist/client/SilentFlowClient.d.ts +27 -27
  81. package/dist/client/SilentFlowClient.d.ts.map +1 -1
  82. package/dist/client/SilentFlowClient.mjs +118 -116
  83. package/dist/client/SilentFlowClient.mjs.map +1 -1
  84. package/dist/config/AppTokenProvider.d.ts +38 -38
  85. package/dist/config/ClientConfiguration.d.ts +150 -150
  86. package/dist/config/ClientConfiguration.mjs +97 -97
  87. package/dist/crypto/ICrypto.d.ts +58 -58
  88. package/dist/crypto/ICrypto.d.ts.map +1 -1
  89. package/dist/crypto/ICrypto.mjs +30 -30
  90. package/dist/crypto/ICrypto.mjs.map +1 -1
  91. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  92. package/dist/crypto/JoseHeader.d.ts +22 -22
  93. package/dist/crypto/JoseHeader.d.ts.map +1 -1
  94. package/dist/crypto/JoseHeader.mjs +38 -38
  95. package/dist/crypto/JoseHeader.mjs.map +1 -1
  96. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  97. package/dist/crypto/PopTokenGenerator.d.ts.map +1 -1
  98. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  99. package/dist/crypto/PopTokenGenerator.mjs.map +1 -1
  100. package/dist/crypto/SignedHttpRequest.d.ts +15 -11
  101. package/dist/crypto/SignedHttpRequest.d.ts.map +1 -1
  102. package/dist/error/AuthError.d.ts +44 -44
  103. package/dist/error/AuthError.mjs +46 -46
  104. package/dist/error/AuthErrorCodes.d.ts +5 -5
  105. package/dist/error/AuthErrorCodes.mjs +9 -9
  106. package/dist/error/ClientAuthError.d.ts +237 -237
  107. package/dist/error/ClientAuthError.mjs +249 -249
  108. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  109. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  110. package/dist/error/ClientConfigurationError.d.ts +128 -128
  111. package/dist/error/ClientConfigurationError.mjs +135 -135
  112. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  113. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  114. package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
  115. package/dist/error/InteractionRequiredAuthError.d.ts.map +1 -1
  116. package/dist/error/InteractionRequiredAuthError.mjs +78 -77
  117. package/dist/error/InteractionRequiredAuthError.mjs.map +1 -1
  118. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +6 -5
  119. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts.map +1 -1
  120. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -12
  121. package/dist/error/InteractionRequiredAuthErrorCodes.mjs.map +1 -1
  122. package/dist/error/JoseHeaderError.d.ts +15 -15
  123. package/dist/error/JoseHeaderError.mjs +22 -22
  124. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  125. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  126. package/dist/error/ServerError.d.ts +7 -7
  127. package/dist/error/ServerError.mjs +14 -14
  128. package/dist/index.cjs +8300 -8350
  129. package/dist/index.cjs.map +1 -1
  130. package/dist/index.d.ts +98 -97
  131. package/dist/index.d.ts.map +1 -1
  132. package/dist/index.mjs +4 -3
  133. package/dist/index.mjs.map +1 -1
  134. package/dist/logger/Logger.d.ts +95 -95
  135. package/dist/logger/Logger.mjs +188 -188
  136. package/dist/network/INetworkModule.d.ts +29 -29
  137. package/dist/network/INetworkModule.mjs +12 -12
  138. package/dist/network/NetworkManager.d.ts +33 -33
  139. package/dist/network/NetworkManager.mjs +34 -34
  140. package/dist/network/RequestThumbprint.d.ts +18 -16
  141. package/dist/network/RequestThumbprint.d.ts.map +1 -1
  142. package/dist/network/ThrottlingUtils.d.ts +42 -42
  143. package/dist/network/ThrottlingUtils.mjs +95 -95
  144. package/dist/packageMetadata.d.ts +2 -2
  145. package/dist/packageMetadata.mjs +4 -4
  146. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  147. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  148. package/dist/request/BaseAuthRequest.d.ts +43 -40
  149. package/dist/request/BaseAuthRequest.d.ts.map +1 -1
  150. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  151. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  152. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  153. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  154. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  155. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  156. package/dist/request/CommonRefreshTokenRequest.d.ts +23 -22
  157. package/dist/request/CommonRefreshTokenRequest.d.ts.map +1 -1
  158. package/dist/request/CommonSilentFlowRequest.d.ts +21 -20
  159. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  160. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  161. package/dist/request/NativeRequest.d.ts +19 -19
  162. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  163. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  164. package/dist/request/RequestParameterBuilder.mjs +381 -381
  165. package/dist/request/RequestValidator.d.ts +33 -33
  166. package/dist/request/RequestValidator.mjs +81 -81
  167. package/dist/request/ScopeSet.d.ts +88 -88
  168. package/dist/request/ScopeSet.mjs +197 -197
  169. package/dist/request/StoreInCache.d.ts +8 -8
  170. package/dist/response/AuthenticationResult.d.ts +41 -41
  171. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  172. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  173. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  174. package/dist/response/IMDSBadResponse.d.ts +4 -4
  175. package/dist/response/ResponseHandler.d.ts +67 -67
  176. package/dist/response/ResponseHandler.d.ts.map +1 -1
  177. package/dist/response/ResponseHandler.mjs +312 -312
  178. package/dist/response/ResponseHandler.mjs.map +1 -1
  179. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  180. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  181. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  182. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  183. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  184. package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
  185. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -457
  186. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  187. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -249
  188. package/dist/telemetry/performance/PerformanceEvent.mjs.map +1 -1
  189. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  190. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  191. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  192. package/dist/telemetry/server/ServerTelemetryManager.d.ts.map +1 -1
  193. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -198
  194. package/dist/telemetry/server/ServerTelemetryManager.mjs.map +1 -1
  195. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  196. package/dist/url/IUri.d.ts +12 -12
  197. package/dist/url/UrlString.d.ts +48 -83
  198. package/dist/url/UrlString.d.ts.map +1 -1
  199. package/dist/url/UrlString.mjs +163 -282
  200. package/dist/url/UrlString.mjs.map +1 -1
  201. package/dist/utils/Constants.d.ts +365 -366
  202. package/dist/utils/Constants.d.ts.map +1 -1
  203. package/dist/utils/Constants.mjs +376 -377
  204. package/dist/utils/Constants.mjs.map +1 -1
  205. package/dist/utils/FunctionWrappers.d.ts +27 -27
  206. package/dist/utils/FunctionWrappers.mjs +84 -84
  207. package/dist/utils/MsalTypes.d.ts +6 -6
  208. package/dist/utils/ProtocolUtils.d.ts +42 -42
  209. package/dist/utils/ProtocolUtils.mjs +69 -69
  210. package/dist/utils/StringUtils.d.ts +40 -40
  211. package/dist/utils/StringUtils.mjs +95 -95
  212. package/dist/utils/TimeUtils.d.ts +27 -27
  213. package/dist/utils/TimeUtils.mjs +45 -45
  214. package/dist/utils/UrlUtils.d.ts +11 -0
  215. package/dist/utils/UrlUtils.d.ts.map +1 -0
  216. package/dist/utils/UrlUtils.mjs +52 -0
  217. package/dist/utils/UrlUtils.mjs.map +1 -0
  218. package/package.json +92 -92
  219. package/src/authority/Authority.ts +2 -3
  220. package/src/cache/CacheManager.ts +63 -22
  221. package/src/cache/entities/RefreshTokenEntity.ts +3 -1
  222. package/src/cache/entities/ServerTelemetryEntity.ts +2 -30
  223. package/src/cache/utils/CacheHelpers.ts +27 -1
  224. package/src/client/AuthorizationCodeClient.ts +5 -14
  225. package/src/client/RefreshTokenClient.ts +20 -2
  226. package/src/client/SilentFlowClient.ts +8 -4
  227. package/src/crypto/ICrypto.ts +7 -2
  228. package/src/crypto/JoseHeader.ts +4 -4
  229. package/src/crypto/PopTokenGenerator.ts +2 -0
  230. package/src/crypto/SignedHttpRequest.ts +6 -0
  231. package/src/error/InteractionRequiredAuthError.ts +2 -0
  232. package/src/error/InteractionRequiredAuthErrorCodes.ts +1 -0
  233. package/src/index.ts +3 -1
  234. package/src/network/RequestThumbprint.ts +2 -0
  235. package/src/packageMetadata.ts +1 -1
  236. package/src/request/BaseAuthRequest.ts +3 -0
  237. package/src/request/CommonRefreshTokenRequest.ts +1 -0
  238. package/src/request/CommonSilentFlowRequest.ts +1 -0
  239. package/src/response/ResponseHandler.ts +8 -4
  240. package/src/telemetry/performance/PerformanceEvent.ts +12 -1
  241. package/src/telemetry/server/ServerTelemetryManager.ts +12 -6
  242. package/src/url/UrlString.ts +6 -153
  243. package/src/utils/Constants.ts +3 -3
  244. package/src/utils/UrlUtils.ts +60 -0
  245. package/dist/cache/entities/ServerTelemetryEntity.mjs +0 -34
  246. package/dist/cache/entities/ServerTelemetryEntity.mjs.map +0 -1
@@ -1,114 +1,114 @@
1
- /*! @azure/msal-common v14.3.0 2023-10-30 */
1
+ /*! @azure/msal-common v14.4.1-beta.0 2023-11-14 */
2
2
  'use strict';
3
3
  import { Constants, ResponseCodes, RegionDiscoverySources } from '../utils/Constants.mjs';
4
4
  import { PerformanceEvents } from '../telemetry/performance/PerformanceEvent.mjs';
5
5
  import { invokeAsync } from '../utils/FunctionWrappers.mjs';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- class RegionDiscovery {
12
- constructor(networkInterface, logger, performanceClient, correlationId) {
13
- this.networkInterface = networkInterface;
14
- this.logger = logger;
15
- this.performanceClient = performanceClient;
16
- this.correlationId = correlationId;
17
- }
18
- /**
19
- * Detect the region from the application's environment.
20
- *
21
- * @returns Promise<string | null>
22
- */
23
- async detectRegion(environmentRegion, regionDiscoveryMetadata) {
24
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryDetectRegion, this.correlationId);
25
- // Initialize auto detected region with the region from the envrionment
26
- let autodetectedRegionName = environmentRegion;
27
- // Check if a region was detected from the environment, if not, attempt to get the region from IMDS
28
- if (!autodetectedRegionName) {
29
- const options = RegionDiscovery.IMDS_OPTIONS;
30
- try {
31
- const localIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(Constants.IMDS_VERSION, options);
32
- if (localIMDSVersionResponse.status ===
33
- ResponseCodes.httpSuccess) {
34
- autodetectedRegionName = localIMDSVersionResponse.body;
35
- regionDiscoveryMetadata.region_source =
36
- RegionDiscoverySources.IMDS;
37
- }
38
- // If the response using the local IMDS version failed, try to fetch the current version of IMDS and retry.
39
- if (localIMDSVersionResponse.status ===
40
- ResponseCodes.httpBadRequest) {
41
- const currentIMDSVersion = await invokeAsync(this.getCurrentVersion.bind(this), PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.logger, this.performanceClient, this.correlationId)(options);
42
- if (!currentIMDSVersion) {
43
- regionDiscoveryMetadata.region_source =
44
- RegionDiscoverySources.FAILED_AUTO_DETECTION;
45
- return null;
46
- }
47
- const currentIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(currentIMDSVersion, options);
48
- if (currentIMDSVersionResponse.status ===
49
- ResponseCodes.httpSuccess) {
50
- autodetectedRegionName =
51
- currentIMDSVersionResponse.body;
52
- regionDiscoveryMetadata.region_source =
53
- RegionDiscoverySources.IMDS;
54
- }
55
- }
56
- }
57
- catch (e) {
58
- regionDiscoveryMetadata.region_source =
59
- RegionDiscoverySources.FAILED_AUTO_DETECTION;
60
- return null;
61
- }
62
- }
63
- else {
64
- regionDiscoveryMetadata.region_source =
65
- RegionDiscoverySources.ENVIRONMENT_VARIABLE;
66
- }
67
- // If no region was auto detected from the environment or from the IMDS endpoint, mark the attempt as a FAILED_AUTO_DETECTION
68
- if (!autodetectedRegionName) {
69
- regionDiscoveryMetadata.region_source =
70
- RegionDiscoverySources.FAILED_AUTO_DETECTION;
71
- }
72
- return autodetectedRegionName || null;
73
- }
74
- /**
75
- * Make the call to the IMDS endpoint
76
- *
77
- * @param imdsEndpointUrl
78
- * @returns Promise<NetworkResponse<string>>
79
- */
80
- async getRegionFromIMDS(version, options) {
81
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.correlationId);
82
- return this.networkInterface.sendGetRequestAsync(`${Constants.IMDS_ENDPOINT}?api-version=${version}&format=text`, options, Constants.IMDS_TIMEOUT);
83
- }
84
- /**
85
- * Get the most recent version of the IMDS endpoint available
86
- *
87
- * @returns Promise<string | null>
88
- */
89
- async getCurrentVersion(options) {
90
- this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.correlationId);
91
- try {
92
- const response = await this.networkInterface.sendGetRequestAsync(`${Constants.IMDS_ENDPOINT}?format=json`, options);
93
- // When IMDS endpoint is called without the api version query param, bad request response comes back with latest version.
94
- if (response.status === ResponseCodes.httpBadRequest &&
95
- response.body &&
96
- response.body["newest-versions"] &&
97
- response.body["newest-versions"].length > 0) {
98
- return response.body["newest-versions"][0];
99
- }
100
- return null;
101
- }
102
- catch (e) {
103
- return null;
104
- }
105
- }
106
- }
107
- // Options for the IMDS endpoint request
108
- RegionDiscovery.IMDS_OPTIONS = {
109
- headers: {
110
- Metadata: "true",
111
- },
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ class RegionDiscovery {
12
+ constructor(networkInterface, logger, performanceClient, correlationId) {
13
+ this.networkInterface = networkInterface;
14
+ this.logger = logger;
15
+ this.performanceClient = performanceClient;
16
+ this.correlationId = correlationId;
17
+ }
18
+ /**
19
+ * Detect the region from the application's environment.
20
+ *
21
+ * @returns Promise<string | null>
22
+ */
23
+ async detectRegion(environmentRegion, regionDiscoveryMetadata) {
24
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryDetectRegion, this.correlationId);
25
+ // Initialize auto detected region with the region from the envrionment
26
+ let autodetectedRegionName = environmentRegion;
27
+ // Check if a region was detected from the environment, if not, attempt to get the region from IMDS
28
+ if (!autodetectedRegionName) {
29
+ const options = RegionDiscovery.IMDS_OPTIONS;
30
+ try {
31
+ const localIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(Constants.IMDS_VERSION, options);
32
+ if (localIMDSVersionResponse.status ===
33
+ ResponseCodes.httpSuccess) {
34
+ autodetectedRegionName = localIMDSVersionResponse.body;
35
+ regionDiscoveryMetadata.region_source =
36
+ RegionDiscoverySources.IMDS;
37
+ }
38
+ // If the response using the local IMDS version failed, try to fetch the current version of IMDS and retry.
39
+ if (localIMDSVersionResponse.status ===
40
+ ResponseCodes.httpBadRequest) {
41
+ const currentIMDSVersion = await invokeAsync(this.getCurrentVersion.bind(this), PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.logger, this.performanceClient, this.correlationId)(options);
42
+ if (!currentIMDSVersion) {
43
+ regionDiscoveryMetadata.region_source =
44
+ RegionDiscoverySources.FAILED_AUTO_DETECTION;
45
+ return null;
46
+ }
47
+ const currentIMDSVersionResponse = await invokeAsync(this.getRegionFromIMDS.bind(this), PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.logger, this.performanceClient, this.correlationId)(currentIMDSVersion, options);
48
+ if (currentIMDSVersionResponse.status ===
49
+ ResponseCodes.httpSuccess) {
50
+ autodetectedRegionName =
51
+ currentIMDSVersionResponse.body;
52
+ regionDiscoveryMetadata.region_source =
53
+ RegionDiscoverySources.IMDS;
54
+ }
55
+ }
56
+ }
57
+ catch (e) {
58
+ regionDiscoveryMetadata.region_source =
59
+ RegionDiscoverySources.FAILED_AUTO_DETECTION;
60
+ return null;
61
+ }
62
+ }
63
+ else {
64
+ regionDiscoveryMetadata.region_source =
65
+ RegionDiscoverySources.ENVIRONMENT_VARIABLE;
66
+ }
67
+ // If no region was auto detected from the environment or from the IMDS endpoint, mark the attempt as a FAILED_AUTO_DETECTION
68
+ if (!autodetectedRegionName) {
69
+ regionDiscoveryMetadata.region_source =
70
+ RegionDiscoverySources.FAILED_AUTO_DETECTION;
71
+ }
72
+ return autodetectedRegionName || null;
73
+ }
74
+ /**
75
+ * Make the call to the IMDS endpoint
76
+ *
77
+ * @param imdsEndpointUrl
78
+ * @returns Promise<NetworkResponse<string>>
79
+ */
80
+ async getRegionFromIMDS(version, options) {
81
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetRegionFromIMDS, this.correlationId);
82
+ return this.networkInterface.sendGetRequestAsync(`${Constants.IMDS_ENDPOINT}?api-version=${version}&format=text`, options, Constants.IMDS_TIMEOUT);
83
+ }
84
+ /**
85
+ * Get the most recent version of the IMDS endpoint available
86
+ *
87
+ * @returns Promise<string | null>
88
+ */
89
+ async getCurrentVersion(options) {
90
+ this.performanceClient?.addQueueMeasurement(PerformanceEvents.RegionDiscoveryGetCurrentVersion, this.correlationId);
91
+ try {
92
+ const response = await this.networkInterface.sendGetRequestAsync(`${Constants.IMDS_ENDPOINT}?format=json`, options);
93
+ // When IMDS endpoint is called without the api version query param, bad request response comes back with latest version.
94
+ if (response.status === ResponseCodes.httpBadRequest &&
95
+ response.body &&
96
+ response.body["newest-versions"] &&
97
+ response.body["newest-versions"].length > 0) {
98
+ return response.body["newest-versions"][0];
99
+ }
100
+ return null;
101
+ }
102
+ catch (e) {
103
+ return null;
104
+ }
105
+ }
106
+ }
107
+ // Options for the IMDS endpoint request
108
+ RegionDiscovery.IMDS_OPTIONS = {
109
+ headers: {
110
+ Metadata: "true",
111
+ },
112
112
  };
113
113
 
114
114
  export { RegionDiscovery };
@@ -1,7 +1,7 @@
1
- import { RegionDiscoveryOutcomes, RegionDiscoverySources } from "../utils/Constants";
2
- export type RegionDiscoveryMetadata = {
3
- region_used?: string;
4
- region_source?: RegionDiscoverySources;
5
- region_outcome?: RegionDiscoveryOutcomes;
6
- };
1
+ import { RegionDiscoveryOutcomes, RegionDiscoverySources } from "../utils/Constants";
2
+ export type RegionDiscoveryMetadata = {
3
+ region_used?: string;
4
+ region_source?: RegionDiscoverySources;
5
+ region_outcome?: RegionDiscoveryOutcomes;
6
+ };
7
7
  //# sourceMappingURL=RegionDiscoveryMetadata.d.ts.map
@@ -1,16 +1,16 @@
1
- /// <reference types="node" />
2
- import { AccountInfo } from "../../account/AccountInfo";
3
- import { LoggerOptions } from "../../config/ClientConfiguration";
4
- import { NativeRequest } from "../../request/NativeRequest";
5
- import { NativeSignOutRequest } from "../../request/NativeSignOutRequest";
6
- import { AuthenticationResult } from "../../response/AuthenticationResult";
7
- export interface INativeBrokerPlugin {
8
- isBrokerAvailable: boolean;
9
- setLogger(loggerOptions: LoggerOptions): void;
10
- getAccountById(accountId: string, correlationId: string): Promise<AccountInfo>;
11
- getAllAccounts(clientId: string, correlationId: string): Promise<AccountInfo[]>;
12
- acquireTokenSilent(request: NativeRequest): Promise<AuthenticationResult>;
13
- acquireTokenInteractive(request: NativeRequest, windowHandle?: Buffer): Promise<AuthenticationResult>;
14
- signOut(request: NativeSignOutRequest): Promise<void>;
15
- }
1
+ /// <reference types="node" />
2
+ import { AccountInfo } from "../../account/AccountInfo";
3
+ import { LoggerOptions } from "../../config/ClientConfiguration";
4
+ import { NativeRequest } from "../../request/NativeRequest";
5
+ import { NativeSignOutRequest } from "../../request/NativeSignOutRequest";
6
+ import { AuthenticationResult } from "../../response/AuthenticationResult";
7
+ export interface INativeBrokerPlugin {
8
+ isBrokerAvailable: boolean;
9
+ setLogger(loggerOptions: LoggerOptions): void;
10
+ getAccountById(accountId: string, correlationId: string): Promise<AccountInfo>;
11
+ getAllAccounts(clientId: string, correlationId: string): Promise<AccountInfo[]>;
12
+ acquireTokenSilent(request: NativeRequest): Promise<AuthenticationResult>;
13
+ acquireTokenInteractive(request: NativeRequest, windowHandle?: Buffer): Promise<AuthenticationResult>;
14
+ signOut(request: NativeSignOutRequest): Promise<void>;
15
+ }
16
16
  //# sourceMappingURL=INativeBrokerPlugin.d.ts.map