@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,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,98 +1,98 @@
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
- * 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
- if (correlationId) {
24
- // Track number of times this API is called in a single request
25
- const eventCount = eventName + "CallCount";
26
- telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId);
27
- }
28
- try {
29
- const result = callback(...args);
30
- inProgressEvent?.end({
31
- success: true,
32
- });
33
- logger.trace(`Returning result from ${eventName}`);
34
- return result;
35
- }
36
- catch (e) {
37
- logger.trace(`Error occurred in ${eventName}`);
38
- try {
39
- logger.trace(JSON.stringify(e));
40
- }
41
- catch (e) {
42
- logger.trace("Unable to print error message.");
43
- }
44
- inProgressEvent?.end({
45
- success: false,
46
- }, e);
47
- throw e;
48
- }
49
- };
50
- };
51
- /**
52
- * Wraps an async function with a performance measurement.
53
- * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
54
- * @param callback
55
- * @param eventName
56
- * @param logger
57
- * @param telemetryClient
58
- * @param correlationId
59
- * @returns
60
- * @internal
61
- *
62
- */
63
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
64
- const invokeAsync = (callback, eventName, logger, telemetryClient, correlationId) => {
65
- return (...args) => {
66
- logger.trace(`Executing function ${eventName}`);
67
- const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
68
- if (correlationId) {
69
- // Track number of times this API is called in a single request
70
- const eventCount = eventName + "CallCount";
71
- telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId);
72
- }
73
- telemetryClient?.setPreQueueTime(eventName, correlationId);
74
- return callback(...args)
75
- .then((response) => {
76
- logger.trace(`Returning result from ${eventName}`);
77
- inProgressEvent?.end({
78
- success: true,
79
- });
80
- return response;
81
- })
82
- .catch((e) => {
83
- logger.trace(`Error occurred in ${eventName}`);
84
- try {
85
- logger.trace(JSON.stringify(e));
86
- }
87
- catch (e) {
88
- logger.trace("Unable to print error message.");
89
- }
90
- inProgressEvent?.end({
91
- success: false,
92
- }, e);
93
- throw e;
94
- });
95
- };
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
+ if (correlationId) {
24
+ // Track number of times this API is called in a single request
25
+ const eventCount = eventName + "CallCount";
26
+ telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId);
27
+ }
28
+ try {
29
+ const result = callback(...args);
30
+ inProgressEvent?.end({
31
+ success: true,
32
+ });
33
+ logger.trace(`Returning result from ${eventName}`);
34
+ return result;
35
+ }
36
+ catch (e) {
37
+ logger.trace(`Error occurred in ${eventName}`);
38
+ try {
39
+ logger.trace(JSON.stringify(e));
40
+ }
41
+ catch (e) {
42
+ logger.trace("Unable to print error message.");
43
+ }
44
+ inProgressEvent?.end({
45
+ success: false,
46
+ }, e);
47
+ throw e;
48
+ }
49
+ };
50
+ };
51
+ /**
52
+ * Wraps an async function with a performance measurement.
53
+ * Usage: invokeAsync(functionToCall, performanceClient, "EventName", "correlationId")(...argsToPassToFunction)
54
+ * @param callback
55
+ * @param eventName
56
+ * @param logger
57
+ * @param telemetryClient
58
+ * @param correlationId
59
+ * @returns
60
+ * @internal
61
+ *
62
+ */
63
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
64
+ const invokeAsync = (callback, eventName, logger, telemetryClient, correlationId) => {
65
+ return (...args) => {
66
+ logger.trace(`Executing function ${eventName}`);
67
+ const inProgressEvent = telemetryClient?.startMeasurement(eventName, correlationId);
68
+ if (correlationId) {
69
+ // Track number of times this API is called in a single request
70
+ const eventCount = eventName + "CallCount";
71
+ telemetryClient?.incrementFields({ [eventCount]: 1 }, correlationId);
72
+ }
73
+ telemetryClient?.setPreQueueTime(eventName, correlationId);
74
+ return callback(...args)
75
+ .then((response) => {
76
+ logger.trace(`Returning result from ${eventName}`);
77
+ inProgressEvent?.end({
78
+ success: true,
79
+ });
80
+ return response;
81
+ })
82
+ .catch((e) => {
83
+ logger.trace(`Error occurred in ${eventName}`);
84
+ try {
85
+ logger.trace(JSON.stringify(e));
86
+ }
87
+ catch (e) {
88
+ logger.trace("Unable to print error message.");
89
+ }
90
+ inProgressEvent?.end({
91
+ success: false,
92
+ }, e);
93
+ throw e;
94
+ });
95
+ };
96
96
  };
97
97
 
98
98
  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.14.0 2024-07-23 */
1
+ /*! @azure/msal-common v14.14.2 2024-08-28 */
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