@azure/msal-common 14.5.0 → 14.6.0-alpha.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 (234) hide show
  1. package/dist/account/AccountInfo.d.ts +58 -58
  2. package/dist/account/AccountInfo.mjs +59 -59
  3. package/dist/account/AuthToken.d.ts +17 -17
  4. package/dist/account/AuthToken.mjs +58 -58
  5. package/dist/account/CcsCredential.d.ts +9 -9
  6. package/dist/account/CcsCredential.mjs +8 -8
  7. package/dist/account/ClientCredentials.d.ts +14 -14
  8. package/dist/account/ClientInfo.d.ts +18 -18
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +83 -83
  11. package/dist/account/TokenClaims.mjs +20 -20
  12. package/dist/authority/Authority.d.ts +254 -253
  13. package/dist/authority/Authority.d.ts.map +1 -1
  14. package/dist/authority/Authority.mjs +815 -811
  15. package/dist/authority/Authority.mjs.map +1 -1
  16. package/dist/authority/AuthorityFactory.d.ts +31 -31
  17. package/dist/authority/AuthorityFactory.mjs +47 -47
  18. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  19. package/dist/authority/AuthorityMetadata.mjs +603 -603
  20. package/dist/authority/AuthorityOptions.d.ts +27 -27
  21. package/dist/authority/AuthorityOptions.mjs +18 -18
  22. package/dist/authority/AuthorityType.d.ts +10 -10
  23. package/dist/authority/AuthorityType.mjs +13 -13
  24. package/dist/authority/AzureRegion.d.ts +1 -1
  25. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  26. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  27. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  28. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  29. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  30. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  31. package/dist/authority/ImdsOptions.d.ts +5 -5
  32. package/dist/authority/OIDCOptions.d.ts +8 -8
  33. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  34. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  35. package/dist/authority/ProtocolMode.d.ts +8 -8
  36. package/dist/authority/ProtocolMode.mjs +11 -11
  37. package/dist/authority/RegionDiscovery.d.ts +32 -32
  38. package/dist/authority/RegionDiscovery.mjs +106 -106
  39. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  40. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  41. package/dist/cache/CacheManager.d.ts +508 -517
  42. package/dist/cache/CacheManager.d.ts.map +1 -1
  43. package/dist/cache/CacheManager.mjs +1237 -1263
  44. package/dist/cache/CacheManager.mjs.map +1 -1
  45. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  46. package/dist/cache/entities/AccountEntity.d.ts +106 -106
  47. package/dist/cache/entities/AccountEntity.mjs +244 -244
  48. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  49. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  50. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  51. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  52. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  53. package/dist/cache/entities/CacheRecord.mjs +14 -14
  54. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  55. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  56. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -5
  57. package/dist/cache/entities/RefreshTokenEntity.d.ts.map +1 -1
  58. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  59. package/dist/cache/entities/ThrottlingEntity.d.ts +7 -13
  60. package/dist/cache/entities/ThrottlingEntity.d.ts.map +1 -1
  61. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  62. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  63. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  64. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  65. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  66. package/dist/cache/utils/CacheHelpers.d.ts +70 -64
  67. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  68. package/dist/cache/utils/CacheHelpers.mjs +252 -233
  69. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  70. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  71. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  72. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  73. package/dist/client/BaseClient.d.ts +51 -51
  74. package/dist/client/BaseClient.mjs +100 -100
  75. package/dist/client/RefreshTokenClient.d.ts +35 -35
  76. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  77. package/dist/client/RefreshTokenClient.mjs +206 -187
  78. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  79. package/dist/client/SilentFlowClient.d.ts +27 -27
  80. package/dist/client/SilentFlowClient.d.ts.map +1 -1
  81. package/dist/client/SilentFlowClient.mjs +129 -118
  82. package/dist/client/SilentFlowClient.mjs.map +1 -1
  83. package/dist/config/AppTokenProvider.d.ts +38 -38
  84. package/dist/config/ClientConfiguration.d.ts +150 -150
  85. package/dist/config/ClientConfiguration.d.ts.map +1 -1
  86. package/dist/config/ClientConfiguration.mjs +96 -98
  87. package/dist/config/ClientConfiguration.mjs.map +1 -1
  88. package/dist/constants/AADServerParamKeys.d.ts +52 -51
  89. package/dist/constants/AADServerParamKeys.d.ts.map +1 -1
  90. package/dist/constants/AADServerParamKeys.mjs +57 -56
  91. package/dist/constants/AADServerParamKeys.mjs.map +1 -1
  92. package/dist/crypto/ICrypto.d.ts +58 -58
  93. package/dist/crypto/ICrypto.mjs +30 -30
  94. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  95. package/dist/crypto/JoseHeader.d.ts +22 -22
  96. package/dist/crypto/JoseHeader.mjs +37 -37
  97. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  98. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  99. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  100. package/dist/error/AuthError.d.ts +44 -44
  101. package/dist/error/AuthError.mjs +46 -46
  102. package/dist/error/AuthErrorCodes.d.ts +5 -5
  103. package/dist/error/AuthErrorCodes.mjs +9 -9
  104. package/dist/error/ClientAuthError.d.ts +237 -237
  105. package/dist/error/ClientAuthError.mjs +249 -249
  106. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  107. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  108. package/dist/error/ClientConfigurationError.d.ts +128 -128
  109. package/dist/error/ClientConfigurationError.mjs +135 -135
  110. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  111. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  112. package/dist/error/InteractionRequiredAuthError.d.ts +61 -57
  113. package/dist/error/InteractionRequiredAuthError.d.ts.map +1 -1
  114. package/dist/error/InteractionRequiredAuthError.mjs +85 -77
  115. package/dist/error/InteractionRequiredAuthError.mjs.map +1 -1
  116. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -5
  117. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts.map +1 -1
  118. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +15 -13
  119. package/dist/error/InteractionRequiredAuthErrorCodes.mjs.map +1 -1
  120. package/dist/error/JoseHeaderError.d.ts +15 -15
  121. package/dist/error/JoseHeaderError.mjs +22 -22
  122. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  123. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  124. package/dist/error/ServerError.d.ts +7 -7
  125. package/dist/error/ServerError.mjs +14 -14
  126. package/dist/index.cjs +8628 -8597
  127. package/dist/index.cjs.map +1 -1
  128. package/dist/index.d.ts +99 -99
  129. package/dist/index.d.ts.map +1 -1
  130. package/dist/index.mjs +2 -3
  131. package/dist/index.mjs.map +1 -1
  132. package/dist/logger/Logger.d.ts +95 -95
  133. package/dist/logger/Logger.mjs +188 -188
  134. package/dist/network/INetworkModule.d.ts +29 -29
  135. package/dist/network/INetworkModule.mjs +12 -12
  136. package/dist/network/NetworkManager.d.ts +33 -33
  137. package/dist/network/NetworkManager.mjs +34 -34
  138. package/dist/network/RequestThumbprint.d.ts +18 -18
  139. package/dist/network/ThrottlingUtils.d.ts +42 -42
  140. package/dist/network/ThrottlingUtils.mjs +95 -95
  141. package/dist/packageMetadata.d.ts +2 -2
  142. package/dist/packageMetadata.d.ts.map +1 -1
  143. package/dist/packageMetadata.mjs +4 -4
  144. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  145. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  146. package/dist/request/BaseAuthRequest.d.ts +43 -43
  147. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  148. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  149. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  150. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  151. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  152. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  153. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
  154. package/dist/request/CommonSilentFlowRequest.d.ts +27 -20
  155. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  156. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  157. package/dist/request/NativeRequest.d.ts +19 -19
  158. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  159. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  160. package/dist/request/RequestParameterBuilder.mjs +381 -381
  161. package/dist/request/RequestValidator.d.ts +33 -33
  162. package/dist/request/RequestValidator.mjs +81 -81
  163. package/dist/request/ScopeSet.d.ts +88 -88
  164. package/dist/request/ScopeSet.mjs +197 -197
  165. package/dist/request/StoreInCache.d.ts +8 -8
  166. package/dist/response/AuthenticationResult.d.ts +41 -41
  167. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  168. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  169. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  170. package/dist/response/IMDSBadResponse.d.ts +4 -4
  171. package/dist/response/ResponseHandler.d.ts +69 -69
  172. package/dist/response/ResponseHandler.d.ts.map +1 -1
  173. package/dist/response/ResponseHandler.mjs +346 -336
  174. package/dist/response/ResponseHandler.mjs.map +1 -1
  175. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  176. package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -46
  177. package/dist/response/ServerAuthorizationTokenResponse.d.ts.map +1 -1
  178. package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -51
  179. package/dist/telemetry/performance/IPerformanceClient.d.ts.map +1 -1
  180. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  181. package/dist/telemetry/performance/PerformanceClient.d.ts +198 -191
  182. package/dist/telemetry/performance/PerformanceClient.d.ts.map +1 -1
  183. package/dist/telemetry/performance/PerformanceClient.mjs +413 -409
  184. package/dist/telemetry/performance/PerformanceClient.mjs.map +1 -1
  185. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  186. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  187. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  188. package/dist/telemetry/performance/StubPerformanceClient.d.ts.map +1 -1
  189. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  190. package/dist/telemetry/performance/StubPerformanceClient.mjs.map +1 -1
  191. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  192. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  193. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  194. package/dist/url/IUri.d.ts +12 -12
  195. package/dist/url/UrlString.d.ts +48 -48
  196. package/dist/url/UrlString.mjs +161 -161
  197. package/dist/utils/Constants.d.ts +298 -296
  198. package/dist/utils/Constants.d.ts.map +1 -1
  199. package/dist/utils/Constants.mjs +313 -310
  200. package/dist/utils/Constants.mjs.map +1 -1
  201. package/dist/utils/FunctionWrappers.d.ts +27 -27
  202. package/dist/utils/FunctionWrappers.mjs +84 -84
  203. package/dist/utils/MsalTypes.d.ts +6 -6
  204. package/dist/utils/ProtocolUtils.d.ts +42 -42
  205. package/dist/utils/ProtocolUtils.mjs +69 -69
  206. package/dist/utils/StringUtils.d.ts +40 -40
  207. package/dist/utils/StringUtils.mjs +95 -95
  208. package/dist/utils/TimeUtils.d.ts +27 -27
  209. package/dist/utils/TimeUtils.mjs +45 -45
  210. package/dist/utils/UrlUtils.d.ts +10 -10
  211. package/dist/utils/UrlUtils.mjs +44 -44
  212. package/package.json +1 -1
  213. package/src/authority/Authority.ts +9 -3
  214. package/src/cache/CacheManager.ts +0 -54
  215. package/src/cache/entities/RefreshTokenEntity.ts +3 -1
  216. package/src/cache/entities/ThrottlingEntity.ts +2 -24
  217. package/src/cache/utils/CacheHelpers.ts +26 -1
  218. package/src/client/RefreshTokenClient.ts +40 -7
  219. package/src/client/SilentFlowClient.ts +30 -10
  220. package/src/config/ClientConfiguration.ts +4 -4
  221. package/src/constants/AADServerParamKeys.ts +1 -0
  222. package/src/error/InteractionRequiredAuthError.ts +12 -0
  223. package/src/error/InteractionRequiredAuthErrorCodes.ts +2 -0
  224. package/src/index.ts +1 -0
  225. package/src/packageMetadata.ts +1 -1
  226. package/src/request/CommonSilentFlowRequest.ts +7 -0
  227. package/src/response/ResponseHandler.ts +21 -5
  228. package/src/response/ServerAuthorizationTokenResponse.ts +1 -0
  229. package/src/telemetry/performance/IPerformanceClient.ts +6 -0
  230. package/src/telemetry/performance/PerformanceClient.ts +24 -31
  231. package/src/telemetry/performance/StubPerformanceClient.ts +0 -1
  232. package/src/utils/Constants.ts +4 -0
  233. package/dist/cache/entities/ThrottlingEntity.mjs +0 -30
  234. package/dist/cache/entities/ThrottlingEntity.mjs.map +0 -1
@@ -1,4 +1,4 @@
1
- /*! @azure/msal-common v14.5.0 2023-12-01 */
1
+ /*! @azure/msal-common v14.6.0-alpha.0 2023-12-15 */
2
2
  'use strict';
3
3
  import { Constants, ResponseMode, OIDC_DEFAULT_SCOPES, HeaderNames, CLIENT_INFO, ClaimsRequestKeys, PasswordGrantConstants, AuthenticationScheme, ThrottlingConstants } from '../utils/Constants.mjs';
4
4
  import { RESPONSE_TYPE, RESPONSE_MODE, NATIVE_BROKER, SCOPE, CLIENT_ID, REDIRECT_URI, POST_LOGOUT_URI, ID_TOKEN_HINT, DOMAIN_HINT, LOGIN_HINT, SID, CLAIMS, CLIENT_REQUEST_ID, X_CLIENT_SKU, X_CLIENT_VER, X_CLIENT_OS, X_CLIENT_CPU, X_APP_NAME, X_APP_VER, PROMPT, STATE, NONCE, CODE_CHALLENGE, CODE_CHALLENGE_METHOD, CODE, DEVICE_CODE, REFRESH_TOKEN, CODE_VERIFIER, CLIENT_SECRET, CLIENT_ASSERTION, CLIENT_ASSERTION_TYPE, OBO_ASSERTION, REQUESTED_TOKEN_USE, GRANT_TYPE, TOKEN_TYPE, REQ_CNF, X_CLIENT_CURR_TELEM, X_CLIENT_LAST_TELEM, X_MS_LIB_CAPABILITY, LOGOUT_HINT } from '../constants/AADServerParamKeys.mjs';
@@ -7,386 +7,386 @@ import { createClientConfigurationError } from '../error/ClientConfigurationErro
7
7
  import { RequestValidator } from './RequestValidator.mjs';
8
8
  import { pkceParamsMissing, invalidClaims } from '../error/ClientConfigurationErrorCodes.mjs';
9
9
 
10
- /*
11
- * Copyright (c) Microsoft Corporation. All rights reserved.
12
- * Licensed under the MIT License.
13
- */
14
- /** @internal */
15
- class RequestParameterBuilder {
16
- constructor() {
17
- this.parameters = new Map();
18
- }
19
- /**
20
- * add response_type = code
21
- */
22
- addResponseTypeCode() {
23
- this.parameters.set(RESPONSE_TYPE, encodeURIComponent(Constants.CODE_RESPONSE_TYPE));
24
- }
25
- /**
26
- * add response_type = token id_token
27
- */
28
- addResponseTypeForTokenAndIdToken() {
29
- this.parameters.set(RESPONSE_TYPE, encodeURIComponent(`${Constants.TOKEN_RESPONSE_TYPE} ${Constants.ID_TOKEN_RESPONSE_TYPE}`));
30
- }
31
- /**
32
- * add response_mode. defaults to query.
33
- * @param responseMode
34
- */
35
- addResponseMode(responseMode) {
36
- this.parameters.set(RESPONSE_MODE, encodeURIComponent(responseMode ? responseMode : ResponseMode.QUERY));
37
- }
38
- /**
39
- * Add flag to indicate STS should attempt to use WAM if available
40
- */
41
- addNativeBroker() {
42
- this.parameters.set(NATIVE_BROKER, encodeURIComponent("1"));
43
- }
44
- /**
45
- * add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios
46
- * @param scopeSet
47
- * @param addOidcScopes
48
- */
49
- addScopes(scopes, addOidcScopes = true, defaultScopes = OIDC_DEFAULT_SCOPES) {
50
- // Always add openid to the scopes when adding OIDC scopes
51
- if (addOidcScopes &&
52
- !defaultScopes.includes("openid") &&
53
- !scopes.includes("openid")) {
54
- defaultScopes.push("openid");
55
- }
56
- const requestScopes = addOidcScopes
57
- ? [...(scopes || []), ...defaultScopes]
58
- : scopes || [];
59
- const scopeSet = new ScopeSet(requestScopes);
60
- this.parameters.set(SCOPE, encodeURIComponent(scopeSet.printScopes()));
61
- }
62
- /**
63
- * add clientId
64
- * @param clientId
65
- */
66
- addClientId(clientId) {
67
- this.parameters.set(CLIENT_ID, encodeURIComponent(clientId));
68
- }
69
- /**
70
- * add redirect_uri
71
- * @param redirectUri
72
- */
73
- addRedirectUri(redirectUri) {
74
- RequestValidator.validateRedirectUri(redirectUri);
75
- this.parameters.set(REDIRECT_URI, encodeURIComponent(redirectUri));
76
- }
77
- /**
78
- * add post logout redirectUri
79
- * @param redirectUri
80
- */
81
- addPostLogoutRedirectUri(redirectUri) {
82
- RequestValidator.validateRedirectUri(redirectUri);
83
- this.parameters.set(POST_LOGOUT_URI, encodeURIComponent(redirectUri));
84
- }
85
- /**
86
- * add id_token_hint to logout request
87
- * @param idTokenHint
88
- */
89
- addIdTokenHint(idTokenHint) {
90
- this.parameters.set(ID_TOKEN_HINT, encodeURIComponent(idTokenHint));
91
- }
92
- /**
93
- * add domain_hint
94
- * @param domainHint
95
- */
96
- addDomainHint(domainHint) {
97
- this.parameters.set(DOMAIN_HINT, encodeURIComponent(domainHint));
98
- }
99
- /**
100
- * add login_hint
101
- * @param loginHint
102
- */
103
- addLoginHint(loginHint) {
104
- this.parameters.set(LOGIN_HINT, encodeURIComponent(loginHint));
105
- }
106
- /**
107
- * Adds the CCS (Cache Credential Service) query parameter for login_hint
108
- * @param loginHint
109
- */
110
- addCcsUpn(loginHint) {
111
- this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`UPN:${loginHint}`));
112
- }
113
- /**
114
- * Adds the CCS (Cache Credential Service) query parameter for account object
115
- * @param loginHint
116
- */
117
- addCcsOid(clientInfo) {
118
- this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`Oid:${clientInfo.uid}@${clientInfo.utid}`));
119
- }
120
- /**
121
- * add sid
122
- * @param sid
123
- */
124
- addSid(sid) {
125
- this.parameters.set(SID, encodeURIComponent(sid));
126
- }
127
- /**
128
- * add claims
129
- * @param claims
130
- */
131
- addClaims(claims, clientCapabilities) {
132
- const mergedClaims = this.addClientCapabilitiesToClaims(claims, clientCapabilities);
133
- RequestValidator.validateClaims(mergedClaims);
134
- this.parameters.set(CLAIMS, encodeURIComponent(mergedClaims));
135
- }
136
- /**
137
- * add correlationId
138
- * @param correlationId
139
- */
140
- addCorrelationId(correlationId) {
141
- this.parameters.set(CLIENT_REQUEST_ID, encodeURIComponent(correlationId));
142
- }
143
- /**
144
- * add library info query params
145
- * @param libraryInfo
146
- */
147
- addLibraryInfo(libraryInfo) {
148
- // Telemetry Info
149
- this.parameters.set(X_CLIENT_SKU, libraryInfo.sku);
150
- this.parameters.set(X_CLIENT_VER, libraryInfo.version);
151
- if (libraryInfo.os) {
152
- this.parameters.set(X_CLIENT_OS, libraryInfo.os);
153
- }
154
- if (libraryInfo.cpu) {
155
- this.parameters.set(X_CLIENT_CPU, libraryInfo.cpu);
156
- }
157
- }
158
- /**
159
- * Add client telemetry parameters
160
- * @param appTelemetry
161
- */
162
- addApplicationTelemetry(appTelemetry) {
163
- if (appTelemetry?.appName) {
164
- this.parameters.set(X_APP_NAME, appTelemetry.appName);
165
- }
166
- if (appTelemetry?.appVersion) {
167
- this.parameters.set(X_APP_VER, appTelemetry.appVersion);
168
- }
169
- }
170
- /**
171
- * add prompt
172
- * @param prompt
173
- */
174
- addPrompt(prompt) {
175
- RequestValidator.validatePrompt(prompt);
176
- this.parameters.set(`${PROMPT}`, encodeURIComponent(prompt));
177
- }
178
- /**
179
- * add state
180
- * @param state
181
- */
182
- addState(state) {
183
- if (state) {
184
- this.parameters.set(STATE, encodeURIComponent(state));
185
- }
186
- }
187
- /**
188
- * add nonce
189
- * @param nonce
190
- */
191
- addNonce(nonce) {
192
- this.parameters.set(NONCE, encodeURIComponent(nonce));
193
- }
194
- /**
195
- * add code_challenge and code_challenge_method
196
- * - throw if either of them are not passed
197
- * @param codeChallenge
198
- * @param codeChallengeMethod
199
- */
200
- addCodeChallengeParams(codeChallenge, codeChallengeMethod) {
201
- RequestValidator.validateCodeChallengeParams(codeChallenge, codeChallengeMethod);
202
- if (codeChallenge && codeChallengeMethod) {
203
- this.parameters.set(CODE_CHALLENGE, encodeURIComponent(codeChallenge));
204
- this.parameters.set(CODE_CHALLENGE_METHOD, encodeURIComponent(codeChallengeMethod));
205
- }
206
- else {
207
- throw createClientConfigurationError(pkceParamsMissing);
208
- }
209
- }
210
- /**
211
- * add the `authorization_code` passed by the user to exchange for a token
212
- * @param code
213
- */
214
- addAuthorizationCode(code) {
215
- this.parameters.set(CODE, encodeURIComponent(code));
216
- }
217
- /**
218
- * add the `authorization_code` passed by the user to exchange for a token
219
- * @param code
220
- */
221
- addDeviceCode(code) {
222
- this.parameters.set(DEVICE_CODE, encodeURIComponent(code));
223
- }
224
- /**
225
- * add the `refreshToken` passed by the user
226
- * @param refreshToken
227
- */
228
- addRefreshToken(refreshToken) {
229
- this.parameters.set(REFRESH_TOKEN, encodeURIComponent(refreshToken));
230
- }
231
- /**
232
- * add the `code_verifier` passed by the user to exchange for a token
233
- * @param codeVerifier
234
- */
235
- addCodeVerifier(codeVerifier) {
236
- this.parameters.set(CODE_VERIFIER, encodeURIComponent(codeVerifier));
237
- }
238
- /**
239
- * add client_secret
240
- * @param clientSecret
241
- */
242
- addClientSecret(clientSecret) {
243
- this.parameters.set(CLIENT_SECRET, encodeURIComponent(clientSecret));
244
- }
245
- /**
246
- * add clientAssertion for confidential client flows
247
- * @param clientAssertion
248
- */
249
- addClientAssertion(clientAssertion) {
250
- if (clientAssertion) {
251
- this.parameters.set(CLIENT_ASSERTION, encodeURIComponent(clientAssertion));
252
- }
253
- }
254
- /**
255
- * add clientAssertionType for confidential client flows
256
- * @param clientAssertionType
257
- */
258
- addClientAssertionType(clientAssertionType) {
259
- if (clientAssertionType) {
260
- this.parameters.set(CLIENT_ASSERTION_TYPE, encodeURIComponent(clientAssertionType));
261
- }
262
- }
263
- /**
264
- * add OBO assertion for confidential client flows
265
- * @param clientAssertion
266
- */
267
- addOboAssertion(oboAssertion) {
268
- this.parameters.set(OBO_ASSERTION, encodeURIComponent(oboAssertion));
269
- }
270
- /**
271
- * add grant type
272
- * @param grantType
273
- */
274
- addRequestTokenUse(tokenUse) {
275
- this.parameters.set(REQUESTED_TOKEN_USE, encodeURIComponent(tokenUse));
276
- }
277
- /**
278
- * add grant type
279
- * @param grantType
280
- */
281
- addGrantType(grantType) {
282
- this.parameters.set(GRANT_TYPE, encodeURIComponent(grantType));
283
- }
284
- /**
285
- * add client info
286
- *
287
- */
288
- addClientInfo() {
289
- this.parameters.set(CLIENT_INFO, "1");
290
- }
291
- /**
292
- * add extraQueryParams
293
- * @param eQParams
294
- */
295
- addExtraQueryParameters(eQParams) {
296
- const sanitizedEQParams = RequestValidator.sanitizeEQParams(eQParams, this.parameters);
297
- Object.keys(sanitizedEQParams).forEach((key) => {
298
- this.parameters.set(key, eQParams[key]);
299
- });
300
- }
301
- addClientCapabilitiesToClaims(claims, clientCapabilities) {
302
- let mergedClaims;
303
- // Parse provided claims into JSON object or initialize empty object
304
- if (!claims) {
305
- mergedClaims = {};
306
- }
307
- else {
308
- try {
309
- mergedClaims = JSON.parse(claims);
310
- }
311
- catch (e) {
312
- throw createClientConfigurationError(invalidClaims);
313
- }
314
- }
315
- if (clientCapabilities && clientCapabilities.length > 0) {
316
- if (!mergedClaims.hasOwnProperty(ClaimsRequestKeys.ACCESS_TOKEN)) {
317
- // Add access_token key to claims object
318
- mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN] = {};
319
- }
320
- // Add xms_cc claim with provided clientCapabilities to access_token key
321
- mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN][ClaimsRequestKeys.XMS_CC] = {
322
- values: clientCapabilities,
323
- };
324
- }
325
- return JSON.stringify(mergedClaims);
326
- }
327
- /**
328
- * adds `username` for Password Grant flow
329
- * @param username
330
- */
331
- addUsername(username) {
332
- this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username));
333
- }
334
- /**
335
- * adds `password` for Password Grant flow
336
- * @param password
337
- */
338
- addPassword(password) {
339
- this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password));
340
- }
341
- /**
342
- * add pop_jwk to query params
343
- * @param cnfString
344
- */
345
- addPopToken(cnfString) {
346
- if (cnfString) {
347
- this.parameters.set(TOKEN_TYPE, AuthenticationScheme.POP);
348
- this.parameters.set(REQ_CNF, encodeURIComponent(cnfString));
349
- }
350
- }
351
- /**
352
- * add SSH JWK and key ID to query params
353
- */
354
- addSshJwk(sshJwkString) {
355
- if (sshJwkString) {
356
- this.parameters.set(TOKEN_TYPE, AuthenticationScheme.SSH);
357
- this.parameters.set(REQ_CNF, encodeURIComponent(sshJwkString));
358
- }
359
- }
360
- /**
361
- * add server telemetry fields
362
- * @param serverTelemetryManager
363
- */
364
- addServerTelemetry(serverTelemetryManager) {
365
- this.parameters.set(X_CLIENT_CURR_TELEM, serverTelemetryManager.generateCurrentRequestHeaderValue());
366
- this.parameters.set(X_CLIENT_LAST_TELEM, serverTelemetryManager.generateLastRequestHeaderValue());
367
- }
368
- /**
369
- * Adds parameter that indicates to the server that throttling is supported
370
- */
371
- addThrottling() {
372
- this.parameters.set(X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE);
373
- }
374
- /**
375
- * Adds logout_hint parameter for "silent" logout which prevent server account picker
376
- */
377
- addLogoutHint(logoutHint) {
378
- this.parameters.set(LOGOUT_HINT, encodeURIComponent(logoutHint));
379
- }
380
- /**
381
- * Utility to create a URL from the params map
382
- */
383
- createQueryString() {
384
- const queryParameterArray = new Array();
385
- this.parameters.forEach((value, key) => {
386
- queryParameterArray.push(`${key}=${value}`);
387
- });
388
- return queryParameterArray.join("&");
389
- }
10
+ /*
11
+ * Copyright (c) Microsoft Corporation. All rights reserved.
12
+ * Licensed under the MIT License.
13
+ */
14
+ /** @internal */
15
+ class RequestParameterBuilder {
16
+ constructor() {
17
+ this.parameters = new Map();
18
+ }
19
+ /**
20
+ * add response_type = code
21
+ */
22
+ addResponseTypeCode() {
23
+ this.parameters.set(RESPONSE_TYPE, encodeURIComponent(Constants.CODE_RESPONSE_TYPE));
24
+ }
25
+ /**
26
+ * add response_type = token id_token
27
+ */
28
+ addResponseTypeForTokenAndIdToken() {
29
+ this.parameters.set(RESPONSE_TYPE, encodeURIComponent(`${Constants.TOKEN_RESPONSE_TYPE} ${Constants.ID_TOKEN_RESPONSE_TYPE}`));
30
+ }
31
+ /**
32
+ * add response_mode. defaults to query.
33
+ * @param responseMode
34
+ */
35
+ addResponseMode(responseMode) {
36
+ this.parameters.set(RESPONSE_MODE, encodeURIComponent(responseMode ? responseMode : ResponseMode.QUERY));
37
+ }
38
+ /**
39
+ * Add flag to indicate STS should attempt to use WAM if available
40
+ */
41
+ addNativeBroker() {
42
+ this.parameters.set(NATIVE_BROKER, encodeURIComponent("1"));
43
+ }
44
+ /**
45
+ * add scopes. set addOidcScopes to false to prevent default scopes in non-user scenarios
46
+ * @param scopeSet
47
+ * @param addOidcScopes
48
+ */
49
+ addScopes(scopes, addOidcScopes = true, defaultScopes = OIDC_DEFAULT_SCOPES) {
50
+ // Always add openid to the scopes when adding OIDC scopes
51
+ if (addOidcScopes &&
52
+ !defaultScopes.includes("openid") &&
53
+ !scopes.includes("openid")) {
54
+ defaultScopes.push("openid");
55
+ }
56
+ const requestScopes = addOidcScopes
57
+ ? [...(scopes || []), ...defaultScopes]
58
+ : scopes || [];
59
+ const scopeSet = new ScopeSet(requestScopes);
60
+ this.parameters.set(SCOPE, encodeURIComponent(scopeSet.printScopes()));
61
+ }
62
+ /**
63
+ * add clientId
64
+ * @param clientId
65
+ */
66
+ addClientId(clientId) {
67
+ this.parameters.set(CLIENT_ID, encodeURIComponent(clientId));
68
+ }
69
+ /**
70
+ * add redirect_uri
71
+ * @param redirectUri
72
+ */
73
+ addRedirectUri(redirectUri) {
74
+ RequestValidator.validateRedirectUri(redirectUri);
75
+ this.parameters.set(REDIRECT_URI, encodeURIComponent(redirectUri));
76
+ }
77
+ /**
78
+ * add post logout redirectUri
79
+ * @param redirectUri
80
+ */
81
+ addPostLogoutRedirectUri(redirectUri) {
82
+ RequestValidator.validateRedirectUri(redirectUri);
83
+ this.parameters.set(POST_LOGOUT_URI, encodeURIComponent(redirectUri));
84
+ }
85
+ /**
86
+ * add id_token_hint to logout request
87
+ * @param idTokenHint
88
+ */
89
+ addIdTokenHint(idTokenHint) {
90
+ this.parameters.set(ID_TOKEN_HINT, encodeURIComponent(idTokenHint));
91
+ }
92
+ /**
93
+ * add domain_hint
94
+ * @param domainHint
95
+ */
96
+ addDomainHint(domainHint) {
97
+ this.parameters.set(DOMAIN_HINT, encodeURIComponent(domainHint));
98
+ }
99
+ /**
100
+ * add login_hint
101
+ * @param loginHint
102
+ */
103
+ addLoginHint(loginHint) {
104
+ this.parameters.set(LOGIN_HINT, encodeURIComponent(loginHint));
105
+ }
106
+ /**
107
+ * Adds the CCS (Cache Credential Service) query parameter for login_hint
108
+ * @param loginHint
109
+ */
110
+ addCcsUpn(loginHint) {
111
+ this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`UPN:${loginHint}`));
112
+ }
113
+ /**
114
+ * Adds the CCS (Cache Credential Service) query parameter for account object
115
+ * @param loginHint
116
+ */
117
+ addCcsOid(clientInfo) {
118
+ this.parameters.set(HeaderNames.CCS_HEADER, encodeURIComponent(`Oid:${clientInfo.uid}@${clientInfo.utid}`));
119
+ }
120
+ /**
121
+ * add sid
122
+ * @param sid
123
+ */
124
+ addSid(sid) {
125
+ this.parameters.set(SID, encodeURIComponent(sid));
126
+ }
127
+ /**
128
+ * add claims
129
+ * @param claims
130
+ */
131
+ addClaims(claims, clientCapabilities) {
132
+ const mergedClaims = this.addClientCapabilitiesToClaims(claims, clientCapabilities);
133
+ RequestValidator.validateClaims(mergedClaims);
134
+ this.parameters.set(CLAIMS, encodeURIComponent(mergedClaims));
135
+ }
136
+ /**
137
+ * add correlationId
138
+ * @param correlationId
139
+ */
140
+ addCorrelationId(correlationId) {
141
+ this.parameters.set(CLIENT_REQUEST_ID, encodeURIComponent(correlationId));
142
+ }
143
+ /**
144
+ * add library info query params
145
+ * @param libraryInfo
146
+ */
147
+ addLibraryInfo(libraryInfo) {
148
+ // Telemetry Info
149
+ this.parameters.set(X_CLIENT_SKU, libraryInfo.sku);
150
+ this.parameters.set(X_CLIENT_VER, libraryInfo.version);
151
+ if (libraryInfo.os) {
152
+ this.parameters.set(X_CLIENT_OS, libraryInfo.os);
153
+ }
154
+ if (libraryInfo.cpu) {
155
+ this.parameters.set(X_CLIENT_CPU, libraryInfo.cpu);
156
+ }
157
+ }
158
+ /**
159
+ * Add client telemetry parameters
160
+ * @param appTelemetry
161
+ */
162
+ addApplicationTelemetry(appTelemetry) {
163
+ if (appTelemetry?.appName) {
164
+ this.parameters.set(X_APP_NAME, appTelemetry.appName);
165
+ }
166
+ if (appTelemetry?.appVersion) {
167
+ this.parameters.set(X_APP_VER, appTelemetry.appVersion);
168
+ }
169
+ }
170
+ /**
171
+ * add prompt
172
+ * @param prompt
173
+ */
174
+ addPrompt(prompt) {
175
+ RequestValidator.validatePrompt(prompt);
176
+ this.parameters.set(`${PROMPT}`, encodeURIComponent(prompt));
177
+ }
178
+ /**
179
+ * add state
180
+ * @param state
181
+ */
182
+ addState(state) {
183
+ if (state) {
184
+ this.parameters.set(STATE, encodeURIComponent(state));
185
+ }
186
+ }
187
+ /**
188
+ * add nonce
189
+ * @param nonce
190
+ */
191
+ addNonce(nonce) {
192
+ this.parameters.set(NONCE, encodeURIComponent(nonce));
193
+ }
194
+ /**
195
+ * add code_challenge and code_challenge_method
196
+ * - throw if either of them are not passed
197
+ * @param codeChallenge
198
+ * @param codeChallengeMethod
199
+ */
200
+ addCodeChallengeParams(codeChallenge, codeChallengeMethod) {
201
+ RequestValidator.validateCodeChallengeParams(codeChallenge, codeChallengeMethod);
202
+ if (codeChallenge && codeChallengeMethod) {
203
+ this.parameters.set(CODE_CHALLENGE, encodeURIComponent(codeChallenge));
204
+ this.parameters.set(CODE_CHALLENGE_METHOD, encodeURIComponent(codeChallengeMethod));
205
+ }
206
+ else {
207
+ throw createClientConfigurationError(pkceParamsMissing);
208
+ }
209
+ }
210
+ /**
211
+ * add the `authorization_code` passed by the user to exchange for a token
212
+ * @param code
213
+ */
214
+ addAuthorizationCode(code) {
215
+ this.parameters.set(CODE, encodeURIComponent(code));
216
+ }
217
+ /**
218
+ * add the `authorization_code` passed by the user to exchange for a token
219
+ * @param code
220
+ */
221
+ addDeviceCode(code) {
222
+ this.parameters.set(DEVICE_CODE, encodeURIComponent(code));
223
+ }
224
+ /**
225
+ * add the `refreshToken` passed by the user
226
+ * @param refreshToken
227
+ */
228
+ addRefreshToken(refreshToken) {
229
+ this.parameters.set(REFRESH_TOKEN, encodeURIComponent(refreshToken));
230
+ }
231
+ /**
232
+ * add the `code_verifier` passed by the user to exchange for a token
233
+ * @param codeVerifier
234
+ */
235
+ addCodeVerifier(codeVerifier) {
236
+ this.parameters.set(CODE_VERIFIER, encodeURIComponent(codeVerifier));
237
+ }
238
+ /**
239
+ * add client_secret
240
+ * @param clientSecret
241
+ */
242
+ addClientSecret(clientSecret) {
243
+ this.parameters.set(CLIENT_SECRET, encodeURIComponent(clientSecret));
244
+ }
245
+ /**
246
+ * add clientAssertion for confidential client flows
247
+ * @param clientAssertion
248
+ */
249
+ addClientAssertion(clientAssertion) {
250
+ if (clientAssertion) {
251
+ this.parameters.set(CLIENT_ASSERTION, encodeURIComponent(clientAssertion));
252
+ }
253
+ }
254
+ /**
255
+ * add clientAssertionType for confidential client flows
256
+ * @param clientAssertionType
257
+ */
258
+ addClientAssertionType(clientAssertionType) {
259
+ if (clientAssertionType) {
260
+ this.parameters.set(CLIENT_ASSERTION_TYPE, encodeURIComponent(clientAssertionType));
261
+ }
262
+ }
263
+ /**
264
+ * add OBO assertion for confidential client flows
265
+ * @param clientAssertion
266
+ */
267
+ addOboAssertion(oboAssertion) {
268
+ this.parameters.set(OBO_ASSERTION, encodeURIComponent(oboAssertion));
269
+ }
270
+ /**
271
+ * add grant type
272
+ * @param grantType
273
+ */
274
+ addRequestTokenUse(tokenUse) {
275
+ this.parameters.set(REQUESTED_TOKEN_USE, encodeURIComponent(tokenUse));
276
+ }
277
+ /**
278
+ * add grant type
279
+ * @param grantType
280
+ */
281
+ addGrantType(grantType) {
282
+ this.parameters.set(GRANT_TYPE, encodeURIComponent(grantType));
283
+ }
284
+ /**
285
+ * add client info
286
+ *
287
+ */
288
+ addClientInfo() {
289
+ this.parameters.set(CLIENT_INFO, "1");
290
+ }
291
+ /**
292
+ * add extraQueryParams
293
+ * @param eQParams
294
+ */
295
+ addExtraQueryParameters(eQParams) {
296
+ const sanitizedEQParams = RequestValidator.sanitizeEQParams(eQParams, this.parameters);
297
+ Object.keys(sanitizedEQParams).forEach((key) => {
298
+ this.parameters.set(key, eQParams[key]);
299
+ });
300
+ }
301
+ addClientCapabilitiesToClaims(claims, clientCapabilities) {
302
+ let mergedClaims;
303
+ // Parse provided claims into JSON object or initialize empty object
304
+ if (!claims) {
305
+ mergedClaims = {};
306
+ }
307
+ else {
308
+ try {
309
+ mergedClaims = JSON.parse(claims);
310
+ }
311
+ catch (e) {
312
+ throw createClientConfigurationError(invalidClaims);
313
+ }
314
+ }
315
+ if (clientCapabilities && clientCapabilities.length > 0) {
316
+ if (!mergedClaims.hasOwnProperty(ClaimsRequestKeys.ACCESS_TOKEN)) {
317
+ // Add access_token key to claims object
318
+ mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN] = {};
319
+ }
320
+ // Add xms_cc claim with provided clientCapabilities to access_token key
321
+ mergedClaims[ClaimsRequestKeys.ACCESS_TOKEN][ClaimsRequestKeys.XMS_CC] = {
322
+ values: clientCapabilities,
323
+ };
324
+ }
325
+ return JSON.stringify(mergedClaims);
326
+ }
327
+ /**
328
+ * adds `username` for Password Grant flow
329
+ * @param username
330
+ */
331
+ addUsername(username) {
332
+ this.parameters.set(PasswordGrantConstants.username, encodeURIComponent(username));
333
+ }
334
+ /**
335
+ * adds `password` for Password Grant flow
336
+ * @param password
337
+ */
338
+ addPassword(password) {
339
+ this.parameters.set(PasswordGrantConstants.password, encodeURIComponent(password));
340
+ }
341
+ /**
342
+ * add pop_jwk to query params
343
+ * @param cnfString
344
+ */
345
+ addPopToken(cnfString) {
346
+ if (cnfString) {
347
+ this.parameters.set(TOKEN_TYPE, AuthenticationScheme.POP);
348
+ this.parameters.set(REQ_CNF, encodeURIComponent(cnfString));
349
+ }
350
+ }
351
+ /**
352
+ * add SSH JWK and key ID to query params
353
+ */
354
+ addSshJwk(sshJwkString) {
355
+ if (sshJwkString) {
356
+ this.parameters.set(TOKEN_TYPE, AuthenticationScheme.SSH);
357
+ this.parameters.set(REQ_CNF, encodeURIComponent(sshJwkString));
358
+ }
359
+ }
360
+ /**
361
+ * add server telemetry fields
362
+ * @param serverTelemetryManager
363
+ */
364
+ addServerTelemetry(serverTelemetryManager) {
365
+ this.parameters.set(X_CLIENT_CURR_TELEM, serverTelemetryManager.generateCurrentRequestHeaderValue());
366
+ this.parameters.set(X_CLIENT_LAST_TELEM, serverTelemetryManager.generateLastRequestHeaderValue());
367
+ }
368
+ /**
369
+ * Adds parameter that indicates to the server that throttling is supported
370
+ */
371
+ addThrottling() {
372
+ this.parameters.set(X_MS_LIB_CAPABILITY, ThrottlingConstants.X_MS_LIB_CAPABILITY_VALUE);
373
+ }
374
+ /**
375
+ * Adds logout_hint parameter for "silent" logout which prevent server account picker
376
+ */
377
+ addLogoutHint(logoutHint) {
378
+ this.parameters.set(LOGOUT_HINT, encodeURIComponent(logoutHint));
379
+ }
380
+ /**
381
+ * Utility to create a URL from the params map
382
+ */
383
+ createQueryString() {
384
+ const queryParameterArray = new Array();
385
+ this.parameters.forEach((value, key) => {
386
+ queryParameterArray.push(`${key}=${value}`);
387
+ });
388
+ return queryParameterArray.join("&");
389
+ }
390
390
  }
391
391
 
392
392
  export { RequestParameterBuilder };