@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,192 +1,199 @@
1
- import { ApplicationTelemetry } from "../../config/ClientConfiguration";
2
- import { Logger } from "../../logger/Logger";
3
- import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
4
- import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
5
- import { PerformanceEvent, PerformanceEvents } from "./PerformanceEvent";
6
- export interface PreQueueEvent {
7
- name: PerformanceEvents;
8
- time: number;
9
- }
10
- export declare abstract class PerformanceClient implements IPerformanceClient {
11
- protected authority: string;
12
- protected libraryName: string;
13
- protected libraryVersion: string;
14
- protected applicationTelemetry: ApplicationTelemetry;
15
- protected clientId: string;
16
- protected logger: Logger;
17
- protected callbacks: Map<string, PerformanceCallbackFunction>;
18
- /**
19
- * Multiple events with the same correlation id.
20
- * @protected
21
- * @type {Map<string, PerformanceEvent>}
22
- */
23
- protected eventsByCorrelationId: Map<string, PerformanceEvent>;
24
- /**
25
- * Map of pre-queue times by correlation Id
26
- *
27
- * @protected
28
- * @type {Map<string, PreQueueEvent>}
29
- */
30
- protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
31
- /**
32
- * Map of queue measurements by correlation Id
33
- *
34
- * @protected
35
- * @type {Map<string, Array<QueueMeasurement>>}
36
- */
37
- protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
38
- protected intFields: Set<string>;
39
- /**
40
- * Creates an instance of PerformanceClient,
41
- * an abstract class containing core performance telemetry logic.
42
- *
43
- * @constructor
44
- * @param {string} clientId Client ID of the application
45
- * @param {string} authority Authority used by the application
46
- * @param {Logger} logger Logger used by the application
47
- * @param {string} libraryName Name of the library
48
- * @param {string} libraryVersion Version of the library
49
- * @param {ApplicationTelemetry} applicationTelemetry application name and version
50
- * @param {Set<String>} intFields integer fields to be truncated
51
- */
52
- constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>);
53
- /**
54
- * Generates and returns a unique id, typically a guid.
55
- *
56
- * @abstract
57
- * @returns {string}
58
- */
59
- abstract generateId(): string;
60
- /**
61
- * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
62
- * Note: this function can be changed to abstract at the next major version bump.
63
- *
64
- * @param {string} measureName
65
- * @param {string} correlationId
66
- * @returns {IPerformanceMeasurement}
67
- */
68
- startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
69
- correlationId: string): IPerformanceMeasurement;
70
- /**
71
- * Sets pre-queue time by correlation Id
72
- *
73
- * @abstract
74
- * @param {PerformanceEvents} eventName
75
- * @param {string} correlationId
76
- * @returns
77
- */
78
- abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
79
- /**
80
- * Gets map of pre-queue times by correlation Id
81
- *
82
- * @param {PerformanceEvents} eventName
83
- * @param {string} correlationId
84
- * @returns {number}
85
- */
86
- getPreQueueTime(eventName: string, correlationId: string): number | void;
87
- /**
88
- * Calculates the difference between current time and time when function was queued.
89
- * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
90
- *
91
- * @param {number} preQueueTime
92
- * @param {number} currentTime
93
- * @returns {number}
94
- */
95
- calculateQueuedTime(preQueueTime: number, currentTime: number): number;
96
- /**
97
- * Adds queue measurement time to QueueMeasurements array for given correlation ID.
98
- *
99
- * @param {PerformanceEvents} eventName
100
- * @param {?string} correlationId
101
- * @param {?number} queueTime
102
- * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
103
- * @returns
104
- */
105
- addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
106
- /**
107
- * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
108
- *
109
- * @param {PerformanceEvents} measureName
110
- * @param {?string} [correlationId]
111
- * @returns {InProgressPerformanceEvent}
112
- */
113
- startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
114
- /**
115
- * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
116
- * as consumers should instead use the function returned by startMeasurement.
117
- * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
118
- * otherwise.
119
- *
120
- * @param {PerformanceEvent} event
121
- * @param {IPerformanceMeasurement} measurement
122
- * @returns {(PerformanceEvent | null)}
123
- */
124
- endMeasurement(event: PerformanceEvent, measurement?: IPerformanceMeasurement): PerformanceEvent | null;
125
- /**
126
- * Saves extra information to be emitted when the measurements are flushed
127
- * @param fields
128
- * @param correlationId
129
- */
130
- addFields(fields: {
131
- [key: string]: {} | undefined;
132
- }, correlationId: string): void;
133
- /**
134
- * Increment counters to be emitted when the measurements are flushed
135
- * @param fields {string[]}
136
- * @param correlationId {string} correlation identifier
137
- */
138
- incrementFields(fields: {
139
- [key: string]: number | undefined;
140
- }, correlationId: string): void;
141
- /**
142
- * Upserts event into event cache.
143
- * First key is the correlation id, second key is the event id.
144
- * Allows for events to be grouped by correlation id,
145
- * and to easily allow for properties on them to be updated.
146
- *
147
- * @private
148
- * @param {PerformanceEvent} event
149
- */
150
- protected cacheEventByCorrelationId(event: PerformanceEvent): void;
151
- private getQueueInfo;
152
- /**
153
- * Removes measurements for a given correlation id.
154
- *
155
- * @param {string} correlationId
156
- */
157
- discardMeasurements(correlationId: string): void;
158
- /**
159
- * Removes cache for a given correlation id.
160
- *
161
- * @param {string} correlationId correlation identifier
162
- */
163
- private discardCache;
164
- /**
165
- * Registers a callback function to receive performance events.
166
- *
167
- * @param {PerformanceCallbackFunction} callback
168
- * @returns {string}
169
- */
170
- addPerformanceCallback(callback: PerformanceCallbackFunction): string;
171
- /**
172
- * Removes a callback registered with addPerformanceCallback.
173
- *
174
- * @param {string} callbackId
175
- * @returns {boolean}
176
- */
177
- removePerformanceCallback(callbackId: string): boolean;
178
- /**
179
- * Emits events to all registered callbacks.
180
- *
181
- * @param {PerformanceEvent[]} events
182
- * @param {?string} [correlationId]
183
- */
184
- emitEvents(events: PerformanceEvent[], correlationId: string): void;
185
- /**
186
- * Enforce truncation of integral fields in performance event.
187
- * @param {PerformanceEvent} event performance event to update.
188
- * @param {Set<string>} intFields integral fields.
189
- */
190
- private truncateIntegralFields;
191
- }
1
+ import { ApplicationTelemetry } from "../../config/ClientConfiguration";
2
+ import { Logger } from "../../logger/Logger";
3
+ import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
4
+ import { PerformanceEvent, PerformanceEvents } from "./PerformanceEvent";
5
+ import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
6
+ export interface PreQueueEvent {
7
+ name: PerformanceEvents;
8
+ time: number;
9
+ }
10
+ export declare abstract class PerformanceClient implements IPerformanceClient {
11
+ protected authority: string;
12
+ protected libraryName: string;
13
+ protected libraryVersion: string;
14
+ protected applicationTelemetry: ApplicationTelemetry;
15
+ protected clientId: string;
16
+ protected logger: Logger;
17
+ protected callbacks: Map<string, PerformanceCallbackFunction>;
18
+ /**
19
+ * Multiple events with the same correlation id.
20
+ * @protected
21
+ * @type {Map<string, PerformanceEvent>}
22
+ */
23
+ protected eventsByCorrelationId: Map<string, PerformanceEvent>;
24
+ /**
25
+ * Map of pre-queue times by correlation Id
26
+ *
27
+ * @protected
28
+ * @type {Map<string, PreQueueEvent>}
29
+ */
30
+ protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
31
+ /**
32
+ * Map of queue measurements by correlation Id
33
+ *
34
+ * @protected
35
+ * @type {Map<string, Array<QueueMeasurement>>}
36
+ */
37
+ protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
38
+ protected intFields: Set<string>;
39
+ /**
40
+ * Creates an instance of PerformanceClient,
41
+ * an abstract class containing core performance telemetry logic.
42
+ *
43
+ * @constructor
44
+ * @param {string} clientId Client ID of the application
45
+ * @param {string} authority Authority used by the application
46
+ * @param {Logger} logger Logger used by the application
47
+ * @param {string} libraryName Name of the library
48
+ * @param {string} libraryVersion Version of the library
49
+ * @param {ApplicationTelemetry} applicationTelemetry application name and version
50
+ * @param {Set<String>} intFields integer fields to be truncated
51
+ */
52
+ constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>);
53
+ /**
54
+ * Generates and returns a unique id, typically a guid.
55
+ *
56
+ * @abstract
57
+ * @returns {string}
58
+ */
59
+ abstract generateId(): string;
60
+ /**
61
+ * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
62
+ * Note: this function can be changed to abstract at the next major version bump.
63
+ *
64
+ * @param {string} measureName
65
+ * @param {string} correlationId
66
+ * @returns {IPerformanceMeasurement}
67
+ * @deprecated This method will be removed in the next major version
68
+ */
69
+ startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
70
+ correlationId: string): IPerformanceMeasurement;
71
+ /**
72
+ * Sets pre-queue time by correlation Id
73
+ *
74
+ * @abstract
75
+ * @param {PerformanceEvents} eventName
76
+ * @param {string} correlationId
77
+ * @returns
78
+ */
79
+ abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
80
+ /**
81
+ * Gets map of pre-queue times by correlation Id
82
+ *
83
+ * @param {PerformanceEvents} eventName
84
+ * @param {string} correlationId
85
+ * @returns {number}
86
+ */
87
+ getPreQueueTime(eventName: string, correlationId: string): number | void;
88
+ /**
89
+ * Calculates the difference between current time and time when function was queued.
90
+ * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
91
+ *
92
+ * @param {number} preQueueTime
93
+ * @param {number} currentTime
94
+ * @returns {number}
95
+ */
96
+ calculateQueuedTime(preQueueTime: number, currentTime: number): number;
97
+ /**
98
+ * Adds queue measurement time to QueueMeasurements array for given correlation ID.
99
+ *
100
+ * @param {PerformanceEvents} eventName
101
+ * @param {?string} correlationId
102
+ * @param {?number} queueTime
103
+ * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
104
+ * @returns
105
+ */
106
+ addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
107
+ /**
108
+ * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
109
+ *
110
+ * @param {PerformanceEvents} measureName
111
+ * @param {?string} [correlationId]
112
+ * @returns {InProgressPerformanceEvent}
113
+ */
114
+ startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
115
+ /**
116
+ * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
117
+ * as consumers should instead use the function returned by startMeasurement.
118
+ * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
119
+ * otherwise.
120
+ *
121
+ * @param {PerformanceEvent} event
122
+ * @param {IPerformanceMeasurement} measurement
123
+ * @returns {(PerformanceEvent | null)}
124
+ */
125
+ endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
126
+ /**
127
+ * Saves extra information to be emitted when the measurements are flushed
128
+ * @param fields
129
+ * @param correlationId
130
+ */
131
+ addFields(fields: {
132
+ [key: string]: {} | undefined;
133
+ }, correlationId: string): void;
134
+ /**
135
+ * Increment counters to be emitted when the measurements are flushed
136
+ * @param fields {string[]}
137
+ * @param correlationId {string} correlation identifier
138
+ */
139
+ incrementFields(fields: {
140
+ [key: string]: number | undefined;
141
+ }, correlationId: string): void;
142
+ /**
143
+ * Upserts event into event cache.
144
+ * First key is the correlation id, second key is the event id.
145
+ * Allows for events to be grouped by correlation id,
146
+ * and to easily allow for properties on them to be updated.
147
+ *
148
+ * @private
149
+ * @param {PerformanceEvent} event
150
+ */
151
+ protected cacheEventByCorrelationId(event: PerformanceEvent): void;
152
+ private getQueueInfo;
153
+ /**
154
+ * Removes measurements for a given correlation id.
155
+ *
156
+ * @param {string} correlationId
157
+ */
158
+ discardMeasurements(correlationId: string): void;
159
+ /**
160
+ * Removes cache for a given correlation id.
161
+ *
162
+ * @param {string} correlationId correlation identifier
163
+ */
164
+ private discardCache;
165
+ /**
166
+ * Registers a callback function to receive performance events.
167
+ *
168
+ * @param {PerformanceCallbackFunction} callback
169
+ * @returns {string}
170
+ */
171
+ addPerformanceCallback(callback: PerformanceCallbackFunction): string;
172
+ /**
173
+ * Removes a callback registered with addPerformanceCallback.
174
+ *
175
+ * @param {string} callbackId
176
+ * @returns {boolean}
177
+ */
178
+ removePerformanceCallback(callbackId: string): boolean;
179
+ /**
180
+ * Emits events to all registered callbacks.
181
+ *
182
+ * @param {PerformanceEvent[]} events
183
+ * @param {?string} [correlationId]
184
+ */
185
+ emitEvents(events: PerformanceEvent[], correlationId: string): void;
186
+ /**
187
+ * Enforce truncation of integral fields in performance event.
188
+ * @param {PerformanceEvent} event performance event to update.
189
+ * @param {Set<string>} intFields integral fields.
190
+ */
191
+ private truncateIntegralFields;
192
+ /**
193
+ * Returns event duration in milliseconds
194
+ * @param startTimeMs {number}
195
+ * @returns {number}
196
+ */
197
+ private getDurationMs;
198
+ }
192
199
  //# sourceMappingURL=PerformanceClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PerformanceClient.d.ts","sourceRoot":"","sources":["../../../src/telemetry/performance/PerformanceClient.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,gBAAgB,EACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAEH,gBAAgB,EAChB,iBAAiB,EAEpB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,8BAAsB,iBAAkB,YAAW,kBAAkB;IACjE,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IACrD,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAE9D;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,SAAS,CAAC,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAElE;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAElE,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;;;;;;;;OAYG;gBAEC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,oBAAoB,EAAE,oBAAoB,EAC1C,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAkB3B;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,IAAI,MAAM;IAE7B;;;;;;;OAOG;IACH,2BAA2B,CACvB,WAAW,EAAE,MAAM,EAAE,wDAAwD;IAC7E,aAAa,EAAE,MAAM,GACtB,uBAAuB;IAI1B;;;;;;;OAOG;IACH,QAAQ,CAAC,eAAe,CACpB,SAAS,EAAE,iBAAiB,EAC5B,aAAa,CAAC,EAAE,MAAM,GACvB,IAAI;IAEP;;;;;;OAMG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAmBxE;;;;;;;OAOG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAyBtE;;;;;;;;OAQG;IACH,mBAAmB,CACf,SAAS,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,EACtB,SAAS,CAAC,EAAE,MAAM,EAClB,iBAAiB,CAAC,EAAE,OAAO,GAC5B,IAAI;IA4CP;;;;;;OAMG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,MAAM,GACvB,0BAA0B;IAqE7B;;;;;;;;;OASG;IACH,cAAc,CACV,KAAK,EAAE,gBAAgB,EACvB,WAAW,CAAC,EAAE,uBAAuB,GACtC,gBAAgB,GAAG,IAAI;IAyE1B;;;;OAIG;IACH,SAAS,CACL,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,GAAG,SAAS,CAAA;KAAE,EACzC,aAAa,EAAE,MAAM,GACtB,IAAI;IAgBP;;;;OAIG;IACH,eAAe,CACX,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,EAC7C,aAAa,EAAE,MAAM,GACtB,IAAI;IAoBP;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAsBlE,OAAO,CAAC,YAAY;IA6BpB;;;;OAIG;IACH,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAQhD;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,2BAA2B,GAAG,MAAM;IAUrE;;;;;OAKG;IACH,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAgBtD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAiBnE;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;CAOjC"}
1
+ {"version":3,"file":"PerformanceClient.d.ts","sourceRoot":"","sources":["../../../src/telemetry/performance/PerformanceClient.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,gBAAgB,EACnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEH,gBAAgB,EAChB,iBAAiB,EAEpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,8BAAsB,iBAAkB,YAAW,kBAAkB;IACjE,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IACrD,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAE9D;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAE/D;;;;;OAKG;IACH,SAAS,CAAC,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAElE;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAElE,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;;;;;;;;OAYG;gBAEC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,oBAAoB,EAAE,oBAAoB,EAC1C,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAkB3B;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,IAAI,MAAM;IAE7B;;;;;;;;OAQG;IACH,2BAA2B,CACvB,WAAW,EAAE,MAAM,EAAE,wDAAwD;IAC7E,aAAa,EAAE,MAAM,GACtB,uBAAuB;IAI1B;;;;;;;OAOG;IACH,QAAQ,CAAC,eAAe,CACpB,SAAS,EAAE,iBAAiB,EAC5B,aAAa,CAAC,EAAE,MAAM,GACvB,IAAI;IAEP;;;;;;OAMG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAmBxE;;;;;;;OAOG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAyBtE;;;;;;;;OAQG;IACH,mBAAmB,CACf,SAAS,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,EACtB,SAAS,CAAC,EAAE,MAAM,EAClB,iBAAiB,CAAC,EAAE,OAAO,GAC5B,IAAI;IA4CP;;;;;;OAMG;IACH,gBAAgB,CACZ,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,MAAM,GACvB,0BAA0B;IA6D7B;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,IAAI;IAgEhE;;;;OAIG;IACH,SAAS,CACL,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,GAAG,SAAS,CAAA;KAAE,EACzC,aAAa,EAAE,MAAM,GACtB,IAAI;IAgBP;;;;OAIG;IACH,eAAe,CACX,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,EAC7C,aAAa,EAAE,MAAM,GACtB,IAAI;IAoBP;;;;;;;;OAQG;IACH,SAAS,CAAC,yBAAyB,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAsBlE,OAAO,CAAC,YAAY;IA6BpB;;;;OAIG;IACH,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAQhD;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,2BAA2B,GAAG,MAAM;IAUrE;;;;;OAKG;IACH,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAgBtD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAiBnE;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAQ9B;;;;OAIG;IACH,OAAO,CAAC,aAAa;CAKxB"}