@azure/msal-common 14.14.0 → 14.14.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 (185) hide show
  1. package/dist/account/AccountInfo.d.ts +66 -66
  2. package/dist/account/AccountInfo.mjs +77 -77
  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 +19 -19
  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 +254 -254
  13. package/dist/authority/Authority.mjs +836 -836
  14. package/dist/authority/AuthorityFactory.d.ts +18 -18
  15. package/dist/authority/AuthorityFactory.mjs +28 -28
  16. package/dist/authority/AuthorityMetadata.d.ts +43 -43
  17. package/dist/authority/AuthorityMetadata.mjs +137 -137
  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 +497 -497
  40. package/dist/cache/CacheManager.mjs +1249 -1249
  41. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  42. package/dist/cache/entities/AccountEntity.d.ts +106 -106
  43. package/dist/cache/entities/AccountEntity.mjs +240 -240
  44. package/dist/cache/entities/AppMetadataEntity.d.ts +11 -11
  45. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +15 -15
  46. package/dist/cache/entities/CacheRecord.d.ts +13 -13
  47. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  48. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  49. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -7
  50. package/dist/cache/entities/ServerTelemetryEntity.d.ts +6 -6
  51. package/dist/cache/entities/ThrottlingEntity.d.ts +7 -7
  52. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  53. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  54. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  55. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  56. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  57. package/dist/cache/utils/CacheHelpers.d.ts +94 -94
  58. package/dist/cache/utils/CacheHelpers.mjs +324 -324
  59. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  60. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  61. package/dist/client/AuthorizationCodeClient.mjs +420 -420
  62. package/dist/client/BaseClient.d.ts +51 -51
  63. package/dist/client/BaseClient.mjs +100 -100
  64. package/dist/client/RefreshTokenClient.d.ts +35 -35
  65. package/dist/client/RefreshTokenClient.mjs +211 -211
  66. package/dist/client/SilentFlowClient.d.ts +27 -27
  67. package/dist/client/SilentFlowClient.mjs +133 -133
  68. package/dist/config/AppTokenProvider.d.ts +38 -38
  69. package/dist/config/ClientConfiguration.d.ts +150 -150
  70. package/dist/config/ClientConfiguration.mjs +95 -95
  71. package/dist/constants/AADServerParamKeys.d.ts +53 -53
  72. package/dist/constants/AADServerParamKeys.mjs +57 -57
  73. package/dist/crypto/ICrypto.d.ts +68 -68
  74. package/dist/crypto/ICrypto.mjs +36 -36
  75. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  76. package/dist/crypto/JoseHeader.d.ts +22 -22
  77. package/dist/crypto/JoseHeader.mjs +37 -37
  78. package/dist/crypto/PopTokenGenerator.d.ts +59 -59
  79. package/dist/crypto/PopTokenGenerator.mjs +81 -81
  80. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  81. package/dist/error/AuthError.d.ts +44 -44
  82. package/dist/error/AuthError.mjs +46 -46
  83. package/dist/error/AuthErrorCodes.d.ts +5 -5
  84. package/dist/error/AuthErrorCodes.mjs +9 -9
  85. package/dist/error/CacheError.d.ts +20 -20
  86. package/dist/error/CacheError.mjs +24 -24
  87. package/dist/error/CacheErrorCodes.d.ts +2 -2
  88. package/dist/error/CacheErrorCodes.mjs +6 -6
  89. package/dist/error/ClientAuthError.d.ts +237 -237
  90. package/dist/error/ClientAuthError.mjs +249 -249
  91. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  92. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  93. package/dist/error/ClientConfigurationError.d.ts +128 -128
  94. package/dist/error/ClientConfigurationError.mjs +135 -135
  95. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  96. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  97. package/dist/error/InteractionRequiredAuthError.d.ts +65 -65
  98. package/dist/error/InteractionRequiredAuthError.mjs +85 -85
  99. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -7
  100. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -13
  101. package/dist/error/JoseHeaderError.d.ts +15 -15
  102. package/dist/error/JoseHeaderError.mjs +22 -22
  103. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  104. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  105. package/dist/error/ServerError.d.ts +15 -15
  106. package/dist/error/ServerError.mjs +16 -16
  107. package/dist/index.cjs +8658 -8658
  108. package/dist/index.cjs.map +1 -1
  109. package/dist/index.d.ts +107 -107
  110. package/dist/index.mjs +1 -1
  111. package/dist/logger/Logger.d.ts +95 -95
  112. package/dist/logger/Logger.mjs +188 -188
  113. package/dist/network/INetworkModule.d.ts +29 -29
  114. package/dist/network/INetworkModule.mjs +12 -12
  115. package/dist/network/NetworkManager.d.ts +33 -33
  116. package/dist/network/NetworkManager.mjs +34 -34
  117. package/dist/network/RequestThumbprint.d.ts +18 -18
  118. package/dist/network/ThrottlingUtils.d.ts +42 -42
  119. package/dist/network/ThrottlingUtils.mjs +95 -95
  120. package/dist/packageMetadata.d.ts +2 -2
  121. package/dist/packageMetadata.mjs +4 -4
  122. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  123. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  124. package/dist/request/BaseAuthRequest.d.ts +47 -47
  125. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  126. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  127. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  128. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  129. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  130. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  131. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
  132. package/dist/request/CommonSilentFlowRequest.d.ts +27 -27
  133. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  134. package/dist/request/NativeRequest.d.ts +19 -19
  135. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  136. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  137. package/dist/request/RequestParameterBuilder.mjs +382 -382
  138. package/dist/request/RequestValidator.d.ts +27 -27
  139. package/dist/request/RequestValidator.mjs +64 -64
  140. package/dist/request/ScopeSet.d.ts +88 -88
  141. package/dist/request/ScopeSet.mjs +197 -197
  142. package/dist/request/StoreInCache.d.ts +8 -8
  143. package/dist/response/AuthenticationResult.d.ts +41 -41
  144. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  145. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  146. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  147. package/dist/response/IMDSBadResponse.d.ts +4 -4
  148. package/dist/response/ResponseHandler.d.ts +69 -69
  149. package/dist/response/ResponseHandler.mjs +374 -374
  150. package/dist/response/ServerAuthorizationCodeResponse.d.ts +26 -26
  151. package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -47
  152. package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -57
  153. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  154. package/dist/telemetry/performance/PerformanceClient.d.ts +242 -242
  155. package/dist/telemetry/performance/PerformanceClient.mjs +587 -587
  156. package/dist/telemetry/performance/PerformanceEvent.d.ts +511 -505
  157. package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
  158. package/dist/telemetry/performance/PerformanceEvent.mjs +480 -480
  159. package/dist/telemetry/performance/PerformanceEvent.mjs.map +1 -1
  160. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  161. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  162. package/dist/telemetry/server/ServerTelemetryManager.d.ts +78 -78
  163. package/dist/telemetry/server/ServerTelemetryManager.mjs +260 -260
  164. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  165. package/dist/url/IUri.d.ts +12 -12
  166. package/dist/url/UrlString.d.ts +48 -48
  167. package/dist/url/UrlString.mjs +161 -161
  168. package/dist/utils/ClientAssertionUtils.d.ts +2 -2
  169. package/dist/utils/ClientAssertionUtils.mjs +16 -16
  170. package/dist/utils/Constants.d.ts +309 -309
  171. package/dist/utils/Constants.mjs +322 -322
  172. package/dist/utils/FunctionWrappers.d.ts +27 -27
  173. package/dist/utils/FunctionWrappers.mjs +94 -94
  174. package/dist/utils/MsalTypes.d.ts +6 -6
  175. package/dist/utils/ProtocolUtils.d.ts +42 -42
  176. package/dist/utils/ProtocolUtils.mjs +69 -69
  177. package/dist/utils/StringUtils.d.ts +40 -40
  178. package/dist/utils/StringUtils.mjs +95 -95
  179. package/dist/utils/TimeUtils.d.ts +25 -25
  180. package/dist/utils/TimeUtils.mjs +43 -43
  181. package/dist/utils/UrlUtils.d.ts +10 -10
  182. package/dist/utils/UrlUtils.mjs +44 -44
  183. package/package.json +1 -1
  184. package/src/packageMetadata.ts +1 -1
  185. package/src/telemetry/performance/PerformanceEvent.ts +7 -0
@@ -1,6 +1,6 @@
1
- export type CloudDiscoveryMetadata = {
2
- preferred_network: string;
3
- preferred_cache: string;
4
- aliases: Array<string>;
5
- };
1
+ export type CloudDiscoveryMetadata = {
2
+ preferred_network: string;
3
+ preferred_cache: string;
4
+ aliases: Array<string>;
5
+ };
6
6
  //# sourceMappingURL=CloudDiscoveryMetadata.d.ts.map
@@ -1,14 +1,14 @@
1
- /**
2
- * The OpenID Configuration Endpoint Response type. Used by the authority class to get relevant OAuth endpoints.
3
- */
4
- export type CloudInstanceDiscoveryErrorResponse = {
5
- error: String;
6
- error_description: String;
7
- error_codes?: Array<Number>;
8
- timestamp?: String;
9
- trace_id?: String;
10
- correlation_id?: String;
11
- error_uri?: String;
12
- };
13
- export declare function isCloudInstanceDiscoveryErrorResponse(response: object): boolean;
1
+ /**
2
+ * The OpenID Configuration Endpoint Response type. Used by the authority class to get relevant OAuth endpoints.
3
+ */
4
+ export type CloudInstanceDiscoveryErrorResponse = {
5
+ error: String;
6
+ error_description: String;
7
+ error_codes?: Array<Number>;
8
+ timestamp?: String;
9
+ trace_id?: String;
10
+ correlation_id?: String;
11
+ error_uri?: String;
12
+ };
13
+ export declare function isCloudInstanceDiscoveryErrorResponse(response: object): boolean;
14
14
  //# sourceMappingURL=CloudInstanceDiscoveryErrorResponse.d.ts.map
@@ -1,12 +1,12 @@
1
- /*! @azure/msal-common v14.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- function isCloudInstanceDiscoveryErrorResponse(response) {
8
- return (response.hasOwnProperty("error") &&
9
- response.hasOwnProperty("error_description"));
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ function isCloudInstanceDiscoveryErrorResponse(response) {
8
+ return (response.hasOwnProperty("error") &&
9
+ response.hasOwnProperty("error_description"));
10
10
  }
11
11
 
12
12
  export { isCloudInstanceDiscoveryErrorResponse };
@@ -1,10 +1,10 @@
1
- import { CloudDiscoveryMetadata } from "./CloudDiscoveryMetadata";
2
- /**
3
- * The OpenID Configuration Endpoint Response type. Used by the authority class to get relevant OAuth endpoints.
4
- */
5
- export type CloudInstanceDiscoveryResponse = {
6
- tenant_discovery_endpoint: string;
7
- metadata: Array<CloudDiscoveryMetadata>;
8
- };
9
- export declare function isCloudInstanceDiscoveryResponse(response: object): boolean;
1
+ import { CloudDiscoveryMetadata } from "./CloudDiscoveryMetadata";
2
+ /**
3
+ * The OpenID Configuration Endpoint Response type. Used by the authority class to get relevant OAuth endpoints.
4
+ */
5
+ export type CloudInstanceDiscoveryResponse = {
6
+ tenant_discovery_endpoint: string;
7
+ metadata: Array<CloudDiscoveryMetadata>;
8
+ };
9
+ export declare function isCloudInstanceDiscoveryResponse(response: object): boolean;
10
10
  //# sourceMappingURL=CloudInstanceDiscoveryResponse.d.ts.map
@@ -1,12 +1,12 @@
1
- /*! @azure/msal-common v14.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- function isCloudInstanceDiscoveryResponse(response) {
8
- return (response.hasOwnProperty("tenant_discovery_endpoint") &&
9
- response.hasOwnProperty("metadata"));
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ function isCloudInstanceDiscoveryResponse(response) {
8
+ return (response.hasOwnProperty("tenant_discovery_endpoint") &&
9
+ response.hasOwnProperty("metadata"));
10
10
  }
11
11
 
12
12
  export { isCloudInstanceDiscoveryResponse };
@@ -1,6 +1,6 @@
1
- export type ImdsOptions = {
2
- headers?: {
3
- Metadata: string;
4
- };
5
- };
1
+ export type ImdsOptions = {
2
+ headers?: {
3
+ Metadata: string;
4
+ };
5
+ };
6
6
  //# sourceMappingURL=ImdsOptions.d.ts.map
@@ -1,9 +1,9 @@
1
- import { ServerResponseType } from "../utils/Constants";
2
- /**
3
- * Options for the OIDC protocol mode.
4
- */
5
- export type OIDCOptions = {
6
- serverResponseType?: ServerResponseType;
7
- defaultScopes?: Array<string>;
8
- };
1
+ import { ServerResponseType } from "../utils/Constants";
2
+ /**
3
+ * Options for the OIDC protocol mode.
4
+ */
5
+ export type OIDCOptions = {
6
+ serverResponseType?: ServerResponseType;
7
+ defaultScopes?: Array<string>;
8
+ };
9
9
  //# sourceMappingURL=OIDCOptions.d.ts.map
@@ -1,12 +1,12 @@
1
- /**
2
- * Tenant Discovery Response which contains the relevant OAuth endpoints and data needed for authentication and authorization.
3
- */
4
- export type OpenIdConfigResponse = {
5
- authorization_endpoint: string;
6
- token_endpoint: string;
7
- end_session_endpoint?: string;
8
- issuer: string;
9
- jwks_uri: string;
10
- };
11
- export declare function isOpenIdConfigResponse(response: object): boolean;
1
+ /**
2
+ * Tenant Discovery Response which contains the relevant OAuth endpoints and data needed for authentication and authorization.
3
+ */
4
+ export type OpenIdConfigResponse = {
5
+ authorization_endpoint: string;
6
+ token_endpoint: string;
7
+ end_session_endpoint?: string;
8
+ issuer: string;
9
+ jwks_uri: string;
10
+ };
11
+ export declare function isOpenIdConfigResponse(response: object): boolean;
12
12
  //# sourceMappingURL=OpenIdConfigResponse.d.ts.map
@@ -1,14 +1,14 @@
1
- /*! @azure/msal-common v14.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- function isOpenIdConfigResponse(response) {
8
- return (response.hasOwnProperty("authorization_endpoint") &&
9
- response.hasOwnProperty("token_endpoint") &&
10
- response.hasOwnProperty("issuer") &&
11
- response.hasOwnProperty("jwks_uri"));
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ function isOpenIdConfigResponse(response) {
8
+ return (response.hasOwnProperty("authorization_endpoint") &&
9
+ response.hasOwnProperty("token_endpoint") &&
10
+ response.hasOwnProperty("issuer") &&
11
+ response.hasOwnProperty("jwks_uri"));
12
12
  }
13
13
 
14
14
  export { isOpenIdConfigResponse };
@@ -1,9 +1,9 @@
1
- /**
2
- * Protocol modes supported by MSAL.
3
- */
4
- export declare const ProtocolMode: {
5
- readonly AAD: "AAD";
6
- readonly OIDC: "OIDC";
7
- };
8
- export type ProtocolMode = (typeof ProtocolMode)[keyof typeof ProtocolMode];
1
+ /**
2
+ * Protocol modes supported by MSAL.
3
+ */
4
+ export declare const ProtocolMode: {
5
+ readonly AAD: "AAD";
6
+ readonly OIDC: "OIDC";
7
+ };
8
+ export type ProtocolMode = (typeof ProtocolMode)[keyof typeof ProtocolMode];
9
9
  //# sourceMappingURL=ProtocolMode.d.ts.map
@@ -1,15 +1,15 @@
1
- /*! @azure/msal-common v14.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- /**
8
- * Protocol modes supported by MSAL.
9
- */
10
- const ProtocolMode = {
11
- AAD: "AAD",
12
- OIDC: "OIDC",
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ /**
8
+ * Protocol modes supported by MSAL.
9
+ */
10
+ const ProtocolMode = {
11
+ AAD: "AAD",
12
+ OIDC: "OIDC",
13
13
  };
14
14
 
15
15
  export { ProtocolMode };
@@ -1,33 +1,33 @@
1
- import { INetworkModule } from "../network/INetworkModule";
2
- import { RegionDiscoveryMetadata } from "./RegionDiscoveryMetadata";
3
- import { ImdsOptions } from "./ImdsOptions";
4
- import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
5
- import { Logger } from "../logger/Logger";
6
- export declare class RegionDiscovery {
7
- protected networkInterface: INetworkModule;
8
- private logger;
9
- protected performanceClient: IPerformanceClient | undefined;
10
- protected correlationId: string | undefined;
11
- protected static IMDS_OPTIONS: ImdsOptions;
12
- constructor(networkInterface: INetworkModule, logger: Logger, performanceClient?: IPerformanceClient, correlationId?: string);
13
- /**
14
- * Detect the region from the application's environment.
15
- *
16
- * @returns Promise<string | null>
17
- */
18
- detectRegion(environmentRegion: string | undefined, regionDiscoveryMetadata: RegionDiscoveryMetadata): Promise<string | null>;
19
- /**
20
- * Make the call to the IMDS endpoint
21
- *
22
- * @param imdsEndpointUrl
23
- * @returns Promise<NetworkResponse<string>>
24
- */
25
- private getRegionFromIMDS;
26
- /**
27
- * Get the most recent version of the IMDS endpoint available
28
- *
29
- * @returns Promise<string | null>
30
- */
31
- private getCurrentVersion;
32
- }
1
+ import { INetworkModule } from "../network/INetworkModule";
2
+ import { RegionDiscoveryMetadata } from "./RegionDiscoveryMetadata";
3
+ import { ImdsOptions } from "./ImdsOptions";
4
+ import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
5
+ import { Logger } from "../logger/Logger";
6
+ export declare class RegionDiscovery {
7
+ protected networkInterface: INetworkModule;
8
+ private logger;
9
+ protected performanceClient: IPerformanceClient | undefined;
10
+ protected correlationId: string | undefined;
11
+ protected static IMDS_OPTIONS: ImdsOptions;
12
+ constructor(networkInterface: INetworkModule, logger: Logger, performanceClient?: IPerformanceClient, correlationId?: string);
13
+ /**
14
+ * Detect the region from the application's environment.
15
+ *
16
+ * @returns Promise<string | null>
17
+ */
18
+ detectRegion(environmentRegion: string | undefined, regionDiscoveryMetadata: RegionDiscoveryMetadata): Promise<string | null>;
19
+ /**
20
+ * Make the call to the IMDS endpoint
21
+ *
22
+ * @param imdsEndpointUrl
23
+ * @returns Promise<NetworkResponse<string>>
24
+ */
25
+ private getRegionFromIMDS;
26
+ /**
27
+ * Get the most recent version of the IMDS endpoint available
28
+ *
29
+ * @returns Promise<string | null>
30
+ */
31
+ private getCurrentVersion;
32
+ }
33
33
  //# sourceMappingURL=RegionDiscovery.d.ts.map
@@ -1,114 +1,114 @@
1
- /*! @azure/msal-common v14.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
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