@azure/msal-common 14.4.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 (199) 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.mjs +788 -788
  12. package/dist/authority/AuthorityFactory.d.ts +31 -31
  13. package/dist/authority/AuthorityFactory.mjs +47 -47
  14. package/dist/authority/AuthorityMetadata.d.ts +503 -503
  15. package/dist/authority/AuthorityMetadata.mjs +603 -603
  16. package/dist/authority/AuthorityOptions.d.ts +27 -27
  17. package/dist/authority/AuthorityOptions.mjs +18 -18
  18. package/dist/authority/AuthorityType.d.ts +10 -10
  19. package/dist/authority/AuthorityType.mjs +13 -13
  20. package/dist/authority/AzureRegion.d.ts +1 -1
  21. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  22. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  23. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  24. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  25. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  26. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  27. package/dist/authority/ImdsOptions.d.ts +5 -5
  28. package/dist/authority/OIDCOptions.d.ts +8 -8
  29. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  30. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  31. package/dist/authority/ProtocolMode.d.ts +8 -8
  32. package/dist/authority/ProtocolMode.mjs +11 -11
  33. package/dist/authority/RegionDiscovery.d.ts +32 -32
  34. package/dist/authority/RegionDiscovery.mjs +106 -106
  35. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  36. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  37. package/dist/cache/CacheManager.d.ts +485 -485
  38. package/dist/cache/CacheManager.mjs +1102 -1102
  39. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  40. package/dist/cache/entities/AccountEntity.d.ts +101 -101
  41. package/dist/cache/entities/AccountEntity.mjs +218 -218
  42. package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
  43. package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
  44. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
  45. package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
  46. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  47. package/dist/cache/entities/CacheRecord.mjs +14 -14
  48. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  49. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  50. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -5
  51. package/dist/cache/entities/RefreshTokenEntity.d.ts.map +1 -1
  52. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  53. package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
  54. package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
  55. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  56. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  57. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  58. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  59. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  60. package/dist/cache/utils/CacheHelpers.d.ts +64 -64
  61. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  62. package/dist/cache/utils/CacheHelpers.mjs +234 -231
  63. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  64. package/dist/cache/utils/CacheTypes.d.ts +67 -67
  65. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  66. package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
  67. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  68. package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
  69. package/dist/client/BaseClient.d.ts +51 -51
  70. package/dist/client/BaseClient.mjs +100 -100
  71. package/dist/client/RefreshTokenClient.d.ts +35 -35
  72. package/dist/client/RefreshTokenClient.d.ts.map +1 -1
  73. package/dist/client/RefreshTokenClient.mjs +193 -187
  74. package/dist/client/RefreshTokenClient.mjs.map +1 -1
  75. package/dist/client/SilentFlowClient.d.ts +27 -27
  76. package/dist/client/SilentFlowClient.mjs +118 -118
  77. package/dist/config/AppTokenProvider.d.ts +38 -38
  78. package/dist/config/ClientConfiguration.d.ts +150 -150
  79. package/dist/config/ClientConfiguration.mjs +97 -97
  80. package/dist/crypto/ICrypto.d.ts +58 -58
  81. package/dist/crypto/ICrypto.mjs +30 -30
  82. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  83. package/dist/crypto/JoseHeader.d.ts +22 -22
  84. package/dist/crypto/JoseHeader.mjs +37 -37
  85. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  86. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  87. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  88. package/dist/error/AuthError.d.ts +44 -44
  89. package/dist/error/AuthError.mjs +46 -46
  90. package/dist/error/AuthErrorCodes.d.ts +5 -5
  91. package/dist/error/AuthErrorCodes.mjs +9 -9
  92. package/dist/error/ClientAuthError.d.ts +237 -237
  93. package/dist/error/ClientAuthError.mjs +249 -249
  94. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  95. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  96. package/dist/error/ClientConfigurationError.d.ts +128 -128
  97. package/dist/error/ClientConfigurationError.mjs +135 -135
  98. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  99. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  100. package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
  101. package/dist/error/InteractionRequiredAuthError.d.ts.map +1 -1
  102. package/dist/error/InteractionRequiredAuthError.mjs +78 -77
  103. package/dist/error/InteractionRequiredAuthError.mjs.map +1 -1
  104. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +6 -5
  105. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts.map +1 -1
  106. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -12
  107. package/dist/error/InteractionRequiredAuthErrorCodes.mjs.map +1 -1
  108. package/dist/error/JoseHeaderError.d.ts +15 -15
  109. package/dist/error/JoseHeaderError.mjs +22 -22
  110. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  111. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  112. package/dist/error/ServerError.d.ts +7 -7
  113. package/dist/error/ServerError.mjs +14 -14
  114. package/dist/index.cjs +8289 -8277
  115. package/dist/index.cjs.map +1 -1
  116. package/dist/index.d.ts +98 -98
  117. package/dist/index.mjs +1 -1
  118. package/dist/logger/Logger.d.ts +95 -95
  119. package/dist/logger/Logger.mjs +188 -188
  120. package/dist/network/INetworkModule.d.ts +29 -29
  121. package/dist/network/INetworkModule.mjs +12 -12
  122. package/dist/network/NetworkManager.d.ts +33 -33
  123. package/dist/network/NetworkManager.mjs +34 -34
  124. package/dist/network/RequestThumbprint.d.ts +18 -18
  125. package/dist/network/ThrottlingUtils.d.ts +42 -42
  126. package/dist/network/ThrottlingUtils.mjs +95 -95
  127. package/dist/packageMetadata.d.ts +2 -2
  128. package/dist/packageMetadata.mjs +3 -3
  129. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  130. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  131. package/dist/request/BaseAuthRequest.d.ts +43 -43
  132. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  133. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  134. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  135. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  136. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  137. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  138. package/dist/request/CommonRefreshTokenRequest.d.ts +23 -22
  139. package/dist/request/CommonRefreshTokenRequest.d.ts.map +1 -1
  140. package/dist/request/CommonSilentFlowRequest.d.ts +21 -20
  141. package/dist/request/CommonSilentFlowRequest.d.ts.map +1 -1
  142. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  143. package/dist/request/NativeRequest.d.ts +19 -19
  144. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  145. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  146. package/dist/request/RequestParameterBuilder.mjs +381 -381
  147. package/dist/request/RequestValidator.d.ts +33 -33
  148. package/dist/request/RequestValidator.mjs +81 -81
  149. package/dist/request/ScopeSet.d.ts +88 -88
  150. package/dist/request/ScopeSet.mjs +197 -197
  151. package/dist/request/StoreInCache.d.ts +8 -8
  152. package/dist/response/AuthenticationResult.d.ts +41 -41
  153. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  154. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  155. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  156. package/dist/response/IMDSBadResponse.d.ts +4 -4
  157. package/dist/response/ResponseHandler.d.ts +67 -67
  158. package/dist/response/ResponseHandler.d.ts.map +1 -1
  159. package/dist/response/ResponseHandler.mjs +312 -312
  160. package/dist/response/ResponseHandler.mjs.map +1 -1
  161. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  162. package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
  163. package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
  164. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  165. package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
  166. package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
  167. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  168. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  169. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  170. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  171. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  172. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  173. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  174. package/dist/url/IUri.d.ts +12 -12
  175. package/dist/url/UrlString.d.ts +48 -48
  176. package/dist/url/UrlString.mjs +161 -161
  177. package/dist/utils/Constants.d.ts +365 -365
  178. package/dist/utils/Constants.mjs +375 -375
  179. package/dist/utils/FunctionWrappers.d.ts +27 -27
  180. package/dist/utils/FunctionWrappers.mjs +84 -84
  181. package/dist/utils/MsalTypes.d.ts +6 -6
  182. package/dist/utils/ProtocolUtils.d.ts +42 -42
  183. package/dist/utils/ProtocolUtils.mjs +69 -69
  184. package/dist/utils/StringUtils.d.ts +40 -40
  185. package/dist/utils/StringUtils.mjs +95 -95
  186. package/dist/utils/TimeUtils.d.ts +27 -27
  187. package/dist/utils/TimeUtils.mjs +45 -45
  188. package/dist/utils/UrlUtils.d.ts +10 -10
  189. package/dist/utils/UrlUtils.mjs +44 -44
  190. package/package.json +92 -92
  191. package/src/cache/entities/RefreshTokenEntity.ts +3 -1
  192. package/src/cache/utils/CacheHelpers.ts +6 -1
  193. package/src/client/AuthorizationCodeClient.ts +2 -1
  194. package/src/client/RefreshTokenClient.ts +13 -1
  195. package/src/error/InteractionRequiredAuthError.ts +2 -0
  196. package/src/error/InteractionRequiredAuthErrorCodes.ts +1 -0
  197. package/src/request/CommonRefreshTokenRequest.ts +1 -0
  198. package/src/request/CommonSilentFlowRequest.ts +1 -0
  199. package/src/response/ResponseHandler.ts +8 -4
@@ -1,28 +1,28 @@
1
- import { Logger } from "../logger/Logger";
2
- import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
3
- /**
4
- * Wraps a function with a performance measurement.
5
- * Usage: invoke(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
6
- * @param callback
7
- * @param eventName
8
- * @param logger
9
- * @param telemetryClient
10
- * @param correlationId
11
- * @returns
12
- * @internal
13
- */
14
- export declare const invoke: <T extends any[], U>(callback: (...args: T) => U, eventName: string, logger: Logger, telemetryClient?: IPerformanceClient, correlationId?: string) => (...args: T) => U;
15
- /**
16
- * Wraps an async function with a performance measurement.
17
- * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
18
- * @param callback
19
- * @param eventName
20
- * @param logger
21
- * @param telemetryClient
22
- * @param correlationId
23
- * @returns
24
- * @internal
25
- *
26
- */
27
- export declare const invokeAsync: <T extends any[], U>(callback: (...args: T) => Promise<U>, eventName: string, logger: Logger, telemetryClient?: IPerformanceClient, correlationId?: string) => (...args: T) => Promise<U>;
1
+ import { Logger } from "../logger/Logger";
2
+ import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
3
+ /**
4
+ * Wraps a function with a performance measurement.
5
+ * Usage: invoke(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
6
+ * @param callback
7
+ * @param eventName
8
+ * @param logger
9
+ * @param telemetryClient
10
+ * @param correlationId
11
+ * @returns
12
+ * @internal
13
+ */
14
+ export declare const invoke: <T extends any[], U>(callback: (...args: T) => U, eventName: string, logger: Logger, telemetryClient?: IPerformanceClient, correlationId?: string) => (...args: T) => U;
15
+ /**
16
+ * Wraps an async function with a performance measurement.
17
+ * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
18
+ * @param callback
19
+ * @param eventName
20
+ * @param logger
21
+ * @param telemetryClient
22
+ * @param correlationId
23
+ * @returns
24
+ * @internal
25
+ *
26
+ */
27
+ export declare const invokeAsync: <T extends any[], U>(callback: (...args: T) => Promise<U>, eventName: string, logger: Logger, telemetryClient?: IPerformanceClient, correlationId?: string) => (...args: T) => Promise<U>;
28
28
  //# sourceMappingURL=FunctionWrappers.d.ts.map
@@ -1,88 +1,88 @@
1
- /*! @azure/msal-common v14.4.0 2023-11-07 */
1
+ /*! @azure/msal-common v14.4.1-beta.0 2023-11-14 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- /**
8
- * Wraps a function with a performance measurement.
9
- * Usage: invoke(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
10
- * @param callback
11
- * @param eventName
12
- * @param logger
13
- * @param telemetryClient
14
- * @param correlationId
15
- * @returns
16
- * @internal
17
- */
18
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
19
- const invoke = (callback, eventName, logger, telemetryClient, correlationId) => {
20
- return (...args) => {
21
- logger.trace(`Executing function ${eventName}`);
22
- const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
23
- try {
24
- const result = callback(...args);
25
- inProgressEvent?.end({
26
- success: true,
27
- });
28
- logger.trace(`Returning result from ${eventName}`);
29
- return result;
30
- }
31
- catch (e) {
32
- logger.trace(`Error occurred in ${eventName}`);
33
- try {
34
- logger.trace(JSON.stringify(e));
35
- }
36
- catch (e) {
37
- logger.trace("Unable to print error message.");
38
- }
39
- inProgressEvent?.end({
40
- success: false,
41
- });
42
- throw e;
43
- }
44
- };
45
- };
46
- /**
47
- * Wraps an async function with a performance measurement.
48
- * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
49
- * @param callback
50
- * @param eventName
51
- * @param logger
52
- * @param telemetryClient
53
- * @param correlationId
54
- * @returns
55
- * @internal
56
- *
57
- */
58
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
59
- const invokeAsync = (callback, eventName, logger, telemetryClient, correlationId) => {
60
- return (...args) => {
61
- logger.trace(`Executing function ${eventName}`);
62
- const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
63
- telemetryClient?.setPreQueueTime(eventName, correlationId);
64
- return callback(...args)
65
- .then((response) => {
66
- logger.trace(`Returning result from ${eventName}`);
67
- inProgressEvent?.end({
68
- success: true,
69
- });
70
- return response;
71
- })
72
- .catch((e) => {
73
- logger.trace(`Error occurred in ${eventName}`);
74
- try {
75
- logger.trace(JSON.stringify(e));
76
- }
77
- catch (e) {
78
- logger.trace("Unable to print error message.");
79
- }
80
- inProgressEvent?.end({
81
- success: false,
82
- });
83
- throw e;
84
- });
85
- };
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ /**
8
+ * Wraps a function with a performance measurement.
9
+ * Usage: invoke(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
10
+ * @param callback
11
+ * @param eventName
12
+ * @param logger
13
+ * @param telemetryClient
14
+ * @param correlationId
15
+ * @returns
16
+ * @internal
17
+ */
18
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
19
+ const invoke = (callback, eventName, logger, telemetryClient, correlationId) => {
20
+ return (...args) => {
21
+ logger.trace(`Executing function ${eventName}`);
22
+ const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
23
+ try {
24
+ const result = callback(...args);
25
+ inProgressEvent?.end({
26
+ success: true,
27
+ });
28
+ logger.trace(`Returning result from ${eventName}`);
29
+ return result;
30
+ }
31
+ catch (e) {
32
+ logger.trace(`Error occurred in ${eventName}`);
33
+ try {
34
+ logger.trace(JSON.stringify(e));
35
+ }
36
+ catch (e) {
37
+ logger.trace("Unable to print error message.");
38
+ }
39
+ inProgressEvent?.end({
40
+ success: false,
41
+ });
42
+ throw e;
43
+ }
44
+ };
45
+ };
46
+ /**
47
+ * Wraps an async function with a performance measurement.
48
+ * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
49
+ * @param callback
50
+ * @param eventName
51
+ * @param logger
52
+ * @param telemetryClient
53
+ * @param correlationId
54
+ * @returns
55
+ * @internal
56
+ *
57
+ */
58
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
59
+ const invokeAsync = (callback, eventName, logger, telemetryClient, correlationId) => {
60
+ return (...args) => {
61
+ logger.trace(`Executing function ${eventName}`);
62
+ const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
63
+ telemetryClient?.setPreQueueTime(eventName, correlationId);
64
+ return callback(...args)
65
+ .then((response) => {
66
+ logger.trace(`Returning result from ${eventName}`);
67
+ inProgressEvent?.end({
68
+ success: true,
69
+ });
70
+ return response;
71
+ })
72
+ .catch((e) => {
73
+ logger.trace(`Error occurred in ${eventName}`);
74
+ try {
75
+ logger.trace(JSON.stringify(e));
76
+ }
77
+ catch (e) {
78
+ logger.trace("Unable to print error message.");
79
+ }
80
+ inProgressEvent?.end({
81
+ success: false,
82
+ });
83
+ throw e;
84
+ });
85
+ };
86
86
  };
87
87
 
88
88
  export { invoke, invokeAsync };
@@ -1,7 +1,7 @@
1
- /**
2
- * Key-Value type to support queryParams, extraQueryParams and claims
3
- */
4
- export type StringDict = {
5
- [key: string]: string;
6
- };
1
+ /**
2
+ * Key-Value type to support queryParams, extraQueryParams and claims
3
+ */
4
+ export type StringDict = {
5
+ [key: string]: string;
6
+ };
7
7
  //# sourceMappingURL=MsalTypes.d.ts.map
@@ -1,43 +1,43 @@
1
- import { ICrypto } from "../crypto/ICrypto";
2
- /**
3
- * Type which defines the object that is stringified, encoded and sent in the state value.
4
- * Contains the following:
5
- * - id - unique identifier for this request
6
- * - ts - timestamp for the time the request was made. Used to ensure that token expiration is not calculated incorrectly.
7
- * - platformState - string value sent from the platform.
8
- */
9
- export type LibraryStateObject = {
10
- id: string;
11
- meta?: Record<string, string>;
12
- };
13
- /**
14
- * Type which defines the stringified and encoded object sent to the service in the authorize request.
15
- */
16
- export type RequestStateObject = {
17
- userRequestState: string;
18
- libraryState: LibraryStateObject;
19
- };
20
- /**
21
- * Class which provides helpers for OAuth 2.0 protocol specific values
22
- */
23
- export declare class ProtocolUtils {
24
- /**
25
- * Appends user state with random guid, or returns random guid.
26
- * @param userState
27
- * @param randomGuid
28
- */
29
- static setRequestState(cryptoObj: ICrypto, userState?: string, meta?: Record<string, string>): string;
30
- /**
31
- * Generates the state value used by the common library.
32
- * @param randomGuid
33
- * @param cryptoObj
34
- */
35
- static generateLibraryState(cryptoObj: ICrypto, meta?: Record<string, string>): string;
36
- /**
37
- * Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user.
38
- * @param state
39
- * @param cryptoObj
40
- */
41
- static parseRequestState(cryptoObj: ICrypto, state: string): RequestStateObject;
42
- }
1
+ import { ICrypto } from "../crypto/ICrypto";
2
+ /**
3
+ * Type which defines the object that is stringified, encoded and sent in the state value.
4
+ * Contains the following:
5
+ * - id - unique identifier for this request
6
+ * - ts - timestamp for the time the request was made. Used to ensure that token expiration is not calculated incorrectly.
7
+ * - platformState - string value sent from the platform.
8
+ */
9
+ export type LibraryStateObject = {
10
+ id: string;
11
+ meta?: Record<string, string>;
12
+ };
13
+ /**
14
+ * Type which defines the stringified and encoded object sent to the service in the authorize request.
15
+ */
16
+ export type RequestStateObject = {
17
+ userRequestState: string;
18
+ libraryState: LibraryStateObject;
19
+ };
20
+ /**
21
+ * Class which provides helpers for OAuth 2.0 protocol specific values
22
+ */
23
+ export declare class ProtocolUtils {
24
+ /**
25
+ * Appends user state with random guid, or returns random guid.
26
+ * @param userState
27
+ * @param randomGuid
28
+ */
29
+ static setRequestState(cryptoObj: ICrypto, userState?: string, meta?: Record<string, string>): string;
30
+ /**
31
+ * Generates the state value used by the common library.
32
+ * @param randomGuid
33
+ * @param cryptoObj
34
+ */
35
+ static generateLibraryState(cryptoObj: ICrypto, meta?: Record<string, string>): string;
36
+ /**
37
+ * Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user.
38
+ * @param state
39
+ * @param cryptoObj
40
+ */
41
+ static parseRequestState(cryptoObj: ICrypto, state: string): RequestStateObject;
42
+ }
43
43
  //# sourceMappingURL=ProtocolUtils.d.ts.map
@@ -1,77 +1,77 @@
1
- /*! @azure/msal-common v14.4.0 2023-11-07 */
1
+ /*! @azure/msal-common v14.4.1-beta.0 2023-11-14 */
2
2
  'use strict';
3
3
  import { Constants } from './Constants.mjs';
4
4
  import { createClientAuthError } from '../error/ClientAuthError.mjs';
5
5
  import { noCryptoObject, invalidState } from '../error/ClientAuthErrorCodes.mjs';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- /**
12
- * Class which provides helpers for OAuth 2.0 protocol specific values
13
- */
14
- class ProtocolUtils {
15
- /**
16
- * Appends user state with random guid, or returns random guid.
17
- * @param userState
18
- * @param randomGuid
19
- */
20
- static setRequestState(cryptoObj, userState, meta) {
21
- const libraryState = ProtocolUtils.generateLibraryState(cryptoObj, meta);
22
- return userState
23
- ? `${libraryState}${Constants.RESOURCE_DELIM}${userState}`
24
- : libraryState;
25
- }
26
- /**
27
- * Generates the state value used by the common library.
28
- * @param randomGuid
29
- * @param cryptoObj
30
- */
31
- static generateLibraryState(cryptoObj, meta) {
32
- if (!cryptoObj) {
33
- throw createClientAuthError(noCryptoObject);
34
- }
35
- // Create a state object containing a unique id and the timestamp of the request creation
36
- const stateObj = {
37
- id: cryptoObj.createNewGuid(),
38
- };
39
- if (meta) {
40
- stateObj.meta = meta;
41
- }
42
- const stateString = JSON.stringify(stateObj);
43
- return cryptoObj.base64Encode(stateString);
44
- }
45
- /**
46
- * Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user.
47
- * @param state
48
- * @param cryptoObj
49
- */
50
- static parseRequestState(cryptoObj, state) {
51
- if (!cryptoObj) {
52
- throw createClientAuthError(noCryptoObject);
53
- }
54
- if (!state) {
55
- throw createClientAuthError(invalidState);
56
- }
57
- try {
58
- // Split the state between library state and user passed state and decode them separately
59
- const splitState = state.split(Constants.RESOURCE_DELIM);
60
- const libraryState = splitState[0];
61
- const userState = splitState.length > 1
62
- ? splitState.slice(1).join(Constants.RESOURCE_DELIM)
63
- : Constants.EMPTY_STRING;
64
- const libraryStateString = cryptoObj.base64Decode(libraryState);
65
- const libraryStateObj = JSON.parse(libraryStateString);
66
- return {
67
- userRequestState: userState || Constants.EMPTY_STRING,
68
- libraryState: libraryStateObj,
69
- };
70
- }
71
- catch (e) {
72
- throw createClientAuthError(invalidState);
73
- }
74
- }
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ /**
12
+ * Class which provides helpers for OAuth 2.0 protocol specific values
13
+ */
14
+ class ProtocolUtils {
15
+ /**
16
+ * Appends user state with random guid, or returns random guid.
17
+ * @param userState
18
+ * @param randomGuid
19
+ */
20
+ static setRequestState(cryptoObj, userState, meta) {
21
+ const libraryState = ProtocolUtils.generateLibraryState(cryptoObj, meta);
22
+ return userState
23
+ ? `${libraryState}${Constants.RESOURCE_DELIM}${userState}`
24
+ : libraryState;
25
+ }
26
+ /**
27
+ * Generates the state value used by the common library.
28
+ * @param randomGuid
29
+ * @param cryptoObj
30
+ */
31
+ static generateLibraryState(cryptoObj, meta) {
32
+ if (!cryptoObj) {
33
+ throw createClientAuthError(noCryptoObject);
34
+ }
35
+ // Create a state object containing a unique id and the timestamp of the request creation
36
+ const stateObj = {
37
+ id: cryptoObj.createNewGuid(),
38
+ };
39
+ if (meta) {
40
+ stateObj.meta = meta;
41
+ }
42
+ const stateString = JSON.stringify(stateObj);
43
+ return cryptoObj.base64Encode(stateString);
44
+ }
45
+ /**
46
+ * Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user.
47
+ * @param state
48
+ * @param cryptoObj
49
+ */
50
+ static parseRequestState(cryptoObj, state) {
51
+ if (!cryptoObj) {
52
+ throw createClientAuthError(noCryptoObject);
53
+ }
54
+ if (!state) {
55
+ throw createClientAuthError(invalidState);
56
+ }
57
+ try {
58
+ // Split the state between library state and user passed state and decode them separately
59
+ const splitState = state.split(Constants.RESOURCE_DELIM);
60
+ const libraryState = splitState[0];
61
+ const userState = splitState.length > 1
62
+ ? splitState.slice(1).join(Constants.RESOURCE_DELIM)
63
+ : Constants.EMPTY_STRING;
64
+ const libraryStateString = cryptoObj.base64Decode(libraryState);
65
+ const libraryStateObj = JSON.parse(libraryStateString);
66
+ return {
67
+ userRequestState: userState || Constants.EMPTY_STRING,
68
+ libraryState: libraryStateObj,
69
+ };
70
+ }
71
+ catch (e) {
72
+ throw createClientAuthError(invalidState);
73
+ }
74
+ }
75
75
  }
76
76
 
77
77
  export { ProtocolUtils };
@@ -1,41 +1,41 @@
1
- /**
2
- * @hidden
3
- */
4
- export declare class StringUtils {
5
- /**
6
- * Check if stringified object is empty
7
- * @param strObj
8
- */
9
- static isEmptyObj(strObj?: string): boolean;
10
- static startsWith(str: string, search: string): boolean;
11
- static endsWith(str: string, search: string): boolean;
12
- /**
13
- * Parses string into an object.
14
- *
15
- * @param query
16
- */
17
- static queryStringToObject<T>(query: string): T;
18
- /**
19
- * Trims entries in an array.
20
- *
21
- * @param arr
22
- */
23
- static trimArrayEntries(arr: Array<string>): Array<string>;
24
- /**
25
- * Removes empty strings from array
26
- * @param arr
27
- */
28
- static removeEmptyStringsFromArray(arr: Array<string>): Array<string>;
29
- /**
30
- * Attempts to parse a string into JSON
31
- * @param str
32
- */
33
- static jsonParseHelper<T>(str: string): T | null;
34
- /**
35
- * Tests if a given string matches a given pattern, with support for wildcards and queries.
36
- * @param pattern Wildcard pattern to string match. Supports "*" for wildcards and "?" for queries
37
- * @param input String to match against
38
- */
39
- static matchPattern(pattern: string, input: string): boolean;
40
- }
1
+ /**
2
+ * @hidden
3
+ */
4
+ export declare class StringUtils {
5
+ /**
6
+ * Check if stringified object is empty
7
+ * @param strObj
8
+ */
9
+ static isEmptyObj(strObj?: string): boolean;
10
+ static startsWith(str: string, search: string): boolean;
11
+ static endsWith(str: string, search: string): boolean;
12
+ /**
13
+ * Parses string into an object.
14
+ *
15
+ * @param query
16
+ */
17
+ static queryStringToObject<T>(query: string): T;
18
+ /**
19
+ * Trims entries in an array.
20
+ *
21
+ * @param arr
22
+ */
23
+ static trimArrayEntries(arr: Array<string>): Array<string>;
24
+ /**
25
+ * Removes empty strings from array
26
+ * @param arr
27
+ */
28
+ static removeEmptyStringsFromArray(arr: Array<string>): Array<string>;
29
+ /**
30
+ * Attempts to parse a string into JSON
31
+ * @param str
32
+ */
33
+ static jsonParseHelper<T>(str: string): T | null;
34
+ /**
35
+ * Tests if a given string matches a given pattern, with support for wildcards and queries.
36
+ * @param pattern Wildcard pattern to string match. Supports "*" for wildcards and "?" for queries
37
+ * @param input String to match against
38
+ */
39
+ static matchPattern(pattern: string, input: string): boolean;
40
+ }
41
41
  //# sourceMappingURL=StringUtils.d.ts.map