@azure/msal-browser 3.20.0 → 3.22.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 (187) hide show
  1. package/dist/app/IPublicClientApplication.d.ts +53 -53
  2. package/dist/app/IPublicClientApplication.mjs +105 -105
  3. package/dist/app/PublicClientApplication.d.ts +293 -293
  4. package/dist/app/PublicClientApplication.mjs +364 -364
  5. package/dist/app/PublicClientNext.d.ts +276 -276
  6. package/dist/app/PublicClientNext.mjs +354 -354
  7. package/dist/broker/nativeBroker/NativeMessageHandler.d.ts +62 -62
  8. package/dist/broker/nativeBroker/NativeMessageHandler.mjs +254 -254
  9. package/dist/broker/nativeBroker/NativeRequest.d.ts +45 -45
  10. package/dist/broker/nativeBroker/NativeResponse.d.ts +48 -48
  11. package/dist/broker/nativeBroker/NativeStatusCodes.d.ts +7 -7
  12. package/dist/broker/nativeBroker/NativeStatusCodes.mjs +11 -11
  13. package/dist/cache/AccountManager.d.ts +48 -48
  14. package/dist/cache/AccountManager.mjs +126 -126
  15. package/dist/cache/AsyncMemoryStorage.d.ts +50 -50
  16. package/dist/cache/AsyncMemoryStorage.mjs +131 -131
  17. package/dist/cache/BrowserCacheManager.d.ts +385 -385
  18. package/dist/cache/BrowserCacheManager.mjs +1294 -1294
  19. package/dist/cache/BrowserStorage.d.ts +11 -11
  20. package/dist/cache/BrowserStorage.mjs +32 -32
  21. package/dist/cache/DatabaseStorage.d.ts +56 -56
  22. package/dist/cache/DatabaseStorage.mjs +200 -200
  23. package/dist/cache/IAsyncStorage.d.ts +27 -27
  24. package/dist/cache/ITokenCache.d.ts +11 -11
  25. package/dist/cache/IWindowStorage.d.ts +27 -27
  26. package/dist/cache/MemoryStorage.d.ts +11 -11
  27. package/dist/cache/MemoryStorage.mjs +31 -31
  28. package/dist/cache/TokenCache.d.ts +77 -77
  29. package/dist/cache/TokenCache.mjs +195 -195
  30. package/dist/config/Configuration.d.ts +213 -208
  31. package/dist/config/Configuration.d.ts.map +1 -1
  32. package/dist/config/Configuration.mjs +128 -128
  33. package/dist/config/Configuration.mjs.map +1 -1
  34. package/dist/controllers/ControllerFactory.d.ts +5 -5
  35. package/dist/controllers/ControllerFactory.mjs +25 -25
  36. package/dist/controllers/IController.d.ts +60 -60
  37. package/dist/controllers/NestedAppAuthController.d.ts +202 -202
  38. package/dist/controllers/NestedAppAuthController.mjs +473 -473
  39. package/dist/controllers/StandardController.d.ts +405 -405
  40. package/dist/controllers/StandardController.d.ts.map +1 -1
  41. package/dist/controllers/StandardController.mjs +1334 -1316
  42. package/dist/controllers/StandardController.mjs.map +1 -1
  43. package/dist/controllers/UnknownOperatingContextController.d.ts +86 -86
  44. package/dist/controllers/UnknownOperatingContextController.mjs +256 -256
  45. package/dist/crypto/BrowserCrypto.d.ts +52 -52
  46. package/dist/crypto/BrowserCrypto.mjs +151 -151
  47. package/dist/crypto/CryptoOps.d.ts +74 -74
  48. package/dist/crypto/CryptoOps.mjs +176 -176
  49. package/dist/crypto/PkceGenerator.d.ts +8 -8
  50. package/dist/crypto/PkceGenerator.mjs +54 -54
  51. package/dist/crypto/SignedHttpRequest.d.ts +30 -30
  52. package/dist/crypto/SignedHttpRequest.mjs +39 -39
  53. package/dist/encode/Base64Decode.d.ts +9 -9
  54. package/dist/encode/Base64Decode.mjs +36 -36
  55. package/dist/encode/Base64Encode.d.ts +19 -19
  56. package/dist/encode/Base64Encode.mjs +43 -43
  57. package/dist/error/BrowserAuthError.d.ts +255 -255
  58. package/dist/error/BrowserAuthError.mjs +263 -263
  59. package/dist/error/BrowserAuthErrorCodes.d.ts +46 -46
  60. package/dist/error/BrowserAuthErrorCodes.mjs +50 -50
  61. package/dist/error/BrowserConfigurationAuthError.d.ts +33 -33
  62. package/dist/error/BrowserConfigurationAuthError.mjs +40 -40
  63. package/dist/error/BrowserConfigurationAuthError.mjs.map +1 -1
  64. package/dist/error/BrowserConfigurationAuthErrorCodes.d.ts +3 -3
  65. package/dist/error/BrowserConfigurationAuthErrorCodes.mjs +7 -7
  66. package/dist/error/NativeAuthError.d.ts +29 -29
  67. package/dist/error/NativeAuthError.mjs +60 -60
  68. package/dist/error/NativeAuthErrorCodes.d.ts +2 -2
  69. package/dist/error/NativeAuthErrorCodes.mjs +6 -6
  70. package/dist/error/NestedAppAuthError.d.ts +14 -14
  71. package/dist/error/NestedAppAuthError.mjs +23 -23
  72. package/dist/event/EventHandler.d.ts +41 -41
  73. package/dist/event/EventHandler.mjs +125 -125
  74. package/dist/event/EventMessage.d.ts +25 -25
  75. package/dist/event/EventMessage.mjs +68 -68
  76. package/dist/event/EventType.d.ts +29 -29
  77. package/dist/event/EventType.mjs +32 -32
  78. package/dist/index.d.ts +40 -40
  79. package/dist/index.mjs +1 -1
  80. package/dist/interaction_client/BaseInteractionClient.d.ts +50 -50
  81. package/dist/interaction_client/BaseInteractionClient.mjs +106 -106
  82. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.d.ts +4 -4
  83. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.mjs +10 -10
  84. package/dist/interaction_client/NativeInteractionClient.d.ts +151 -151
  85. package/dist/interaction_client/NativeInteractionClient.mjs +621 -621
  86. package/dist/interaction_client/PopupClient.d.ts +105 -105
  87. package/dist/interaction_client/PopupClient.d.ts.map +1 -1
  88. package/dist/interaction_client/PopupClient.mjs +433 -433
  89. package/dist/interaction_client/PopupClient.mjs.map +1 -1
  90. package/dist/interaction_client/RedirectClient.d.ts +50 -50
  91. package/dist/interaction_client/RedirectClient.d.ts.map +1 -1
  92. package/dist/interaction_client/RedirectClient.mjs +315 -314
  93. package/dist/interaction_client/RedirectClient.mjs.map +1 -1
  94. package/dist/interaction_client/SilentAuthCodeClient.d.ts +23 -23
  95. package/dist/interaction_client/SilentAuthCodeClient.mjs +57 -57
  96. package/dist/interaction_client/SilentCacheClient.d.ts +16 -16
  97. package/dist/interaction_client/SilentCacheClient.mjs +42 -42
  98. package/dist/interaction_client/SilentIframeClient.d.ts +32 -32
  99. package/dist/interaction_client/SilentIframeClient.d.ts.map +1 -1
  100. package/dist/interaction_client/SilentIframeClient.mjs +110 -100
  101. package/dist/interaction_client/SilentIframeClient.mjs.map +1 -1
  102. package/dist/interaction_client/SilentRefreshClient.d.ts +20 -20
  103. package/dist/interaction_client/SilentRefreshClient.mjs +47 -47
  104. package/dist/interaction_client/StandardInteractionClient.d.ts +48 -48
  105. package/dist/interaction_client/StandardInteractionClient.mjs +199 -199
  106. package/dist/interaction_handler/InteractionHandler.d.ts +33 -33
  107. package/dist/interaction_handler/InteractionHandler.mjs +93 -93
  108. package/dist/interaction_handler/RedirectHandler.d.ts +32 -32
  109. package/dist/interaction_handler/RedirectHandler.mjs +134 -134
  110. package/dist/interaction_handler/SilentHandler.d.ts +13 -13
  111. package/dist/interaction_handler/SilentHandler.mjs +134 -134
  112. package/dist/naa/AccountInfo.d.ts +11 -11
  113. package/dist/naa/AuthBridge.d.ts +8 -8
  114. package/dist/naa/AuthResult.d.ts +6 -6
  115. package/dist/naa/BridgeAccountContext.d.ts +12 -12
  116. package/dist/naa/BridgeCapabilities.d.ts +3 -3
  117. package/dist/naa/BridgeError.d.ts +9 -9
  118. package/dist/naa/BridgeError.mjs +7 -7
  119. package/dist/naa/BridgeProxy.d.ts +67 -67
  120. package/dist/naa/BridgeProxy.mjs +148 -148
  121. package/dist/naa/BridgeRequest.d.ts +7 -7
  122. package/dist/naa/BridgeRequestEnvelope.d.ts +12 -12
  123. package/dist/naa/BridgeResponseEnvelope.d.ts +13 -13
  124. package/dist/naa/BridgeStatusCode.d.ts +11 -11
  125. package/dist/naa/BridgeStatusCode.mjs +14 -14
  126. package/dist/naa/IBridgeProxy.d.ts +10 -10
  127. package/dist/naa/InitContext.d.ts +8 -8
  128. package/dist/naa/TokenRequest.d.ts +18 -18
  129. package/dist/naa/TokenResponse.d.ts +13 -13
  130. package/dist/naa/mapping/NestedAppAuthAdapter.d.ts +35 -35
  131. package/dist/naa/mapping/NestedAppAuthAdapter.mjs +179 -179
  132. package/dist/navigation/INavigationClient.d.ts +16 -16
  133. package/dist/navigation/NavigationClient.d.ts +22 -22
  134. package/dist/navigation/NavigationClient.mjs +40 -40
  135. package/dist/navigation/NavigationOptions.d.ts +12 -12
  136. package/dist/network/FetchClient.d.ts +26 -26
  137. package/dist/network/FetchClient.mjs +99 -99
  138. package/dist/operatingcontext/BaseOperatingContext.d.ts +41 -41
  139. package/dist/operatingcontext/BaseOperatingContext.mjs +94 -94
  140. package/dist/operatingcontext/NestedAppOperatingContext.d.ts +34 -34
  141. package/dist/operatingcontext/NestedAppOperatingContext.mjs +71 -71
  142. package/dist/operatingcontext/StandardOperatingContext.d.ts +25 -25
  143. package/dist/operatingcontext/StandardOperatingContext.mjs +43 -43
  144. package/dist/operatingcontext/UnknownOperatingContext.d.ts +25 -25
  145. package/dist/operatingcontext/UnknownOperatingContext.mjs +42 -42
  146. package/dist/packageMetadata.d.ts +2 -2
  147. package/dist/packageMetadata.mjs +4 -4
  148. package/dist/request/AuthorizationCodeRequest.d.ts +8 -8
  149. package/dist/request/AuthorizationUrlRequest.d.ts +8 -8
  150. package/dist/request/ClearCacheRequest.d.ts +10 -10
  151. package/dist/request/EndSessionPopupRequest.d.ts +18 -18
  152. package/dist/request/EndSessionRequest.d.ts +15 -15
  153. package/dist/request/InitializeApplicationRequest.d.ts +8 -8
  154. package/dist/request/PopupRequest.d.ts +34 -34
  155. package/dist/request/PopupWindowAttributes.d.ts +15 -15
  156. package/dist/request/RedirectRequest.d.ts +40 -35
  157. package/dist/request/RedirectRequest.d.ts.map +1 -1
  158. package/dist/request/RequestHelpers.d.ts +13 -13
  159. package/dist/request/RequestHelpers.mjs +53 -53
  160. package/dist/request/SilentRequest.d.ts +33 -33
  161. package/dist/request/SsoSilentRequest.d.ts +29 -29
  162. package/dist/response/AuthenticationResult.d.ts +4 -4
  163. package/dist/response/ResponseHandler.d.ts +7 -7
  164. package/dist/response/ResponseHandler.mjs +36 -36
  165. package/dist/telemetry/BrowserPerformanceClient.d.ts +34 -34
  166. package/dist/telemetry/BrowserPerformanceClient.mjs +162 -162
  167. package/dist/telemetry/BrowserPerformanceMeasurement.d.ts +21 -21
  168. package/dist/telemetry/BrowserPerformanceMeasurement.mjs +92 -92
  169. package/dist/utils/BrowserConstants.d.ts +180 -180
  170. package/dist/utils/BrowserConstants.mjs +212 -212
  171. package/dist/utils/BrowserProtocolUtils.d.ts +11 -11
  172. package/dist/utils/BrowserProtocolUtils.mjs +21 -21
  173. package/dist/utils/BrowserUtils.d.ts +75 -75
  174. package/dist/utils/BrowserUtils.mjs +157 -157
  175. package/lib/msal-browser.cjs +18884 -18855
  176. package/lib/msal-browser.cjs.map +1 -1
  177. package/lib/msal-browser.js +18884 -18855
  178. package/lib/msal-browser.js.map +1 -1
  179. package/lib/msal-browser.min.js +59 -59
  180. package/package.json +2 -2
  181. package/src/config/Configuration.ts +9 -1
  182. package/src/controllers/StandardController.ts +30 -12
  183. package/src/interaction_client/PopupClient.ts +1 -0
  184. package/src/interaction_client/RedirectClient.ts +4 -1
  185. package/src/interaction_client/SilentIframeClient.ts +40 -3
  186. package/src/packageMetadata.ts +1 -1
  187. package/src/request/RedirectRequest.ts +5 -0
@@ -1,35 +1,35 @@
1
- import { InProgressPerformanceEvent, IPerformanceClient, PerformanceClient, PerformanceEvents } from "@azure/msal-common";
2
- import { Configuration } from "../config/Configuration";
3
- export declare class BrowserPerformanceClient extends PerformanceClient implements IPerformanceClient {
4
- constructor(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>);
5
- generateId(): string;
6
- private getPageVisibility;
7
- private deleteIncompleteSubMeasurements;
8
- /**
9
- * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
10
- * Also captures browser page visibilityState.
11
- *
12
- * @param {PerformanceEvents} measureName
13
- * @param {?string} [correlationId]
14
- * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
15
- */
16
- startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
17
- /**
18
- * Adds pre-queue time to preQueueTimeByCorrelationId map.
19
- * @param {PerformanceEvents} eventName
20
- * @param {?string} correlationId
21
- * @returns
22
- */
23
- setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
24
- /**
25
- * Calculates and adds queue time measurement for given performance event.
26
- *
27
- * @param {PerformanceEvents} eventName
28
- * @param {?string} correlationId
29
- * @param {?number} queueTime
30
- * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
31
- * @returns
32
- */
33
- addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
34
- }
1
+ import { InProgressPerformanceEvent, IPerformanceClient, PerformanceClient, PerformanceEvents } from "@azure/msal-common";
2
+ import { Configuration } from "../config/Configuration";
3
+ export declare class BrowserPerformanceClient extends PerformanceClient implements IPerformanceClient {
4
+ constructor(configuration: Configuration, intFields?: Set<string>, abbreviations?: Map<string, string>);
5
+ generateId(): string;
6
+ private getPageVisibility;
7
+ private deleteIncompleteSubMeasurements;
8
+ /**
9
+ * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
10
+ * Also captures browser page visibilityState.
11
+ *
12
+ * @param {PerformanceEvents} measureName
13
+ * @param {?string} [correlationId]
14
+ * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
15
+ */
16
+ startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
17
+ /**
18
+ * Adds pre-queue time to preQueueTimeByCorrelationId map.
19
+ * @param {PerformanceEvents} eventName
20
+ * @param {?string} correlationId
21
+ * @returns
22
+ */
23
+ setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
24
+ /**
25
+ * Calculates and adds queue time measurement for given performance event.
26
+ *
27
+ * @param {PerformanceEvents} eventName
28
+ * @param {?string} correlationId
29
+ * @param {?number} queueTime
30
+ * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
31
+ * @returns
32
+ */
33
+ addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
34
+ }
35
35
  //# sourceMappingURL=BrowserPerformanceClient.d.ts.map
@@ -1,171 +1,171 @@
1
- /*! @azure/msal-browser v3.20.0 2024-07-23 */
1
+ /*! @azure/msal-browser v3.22.0 2024-08-28 */
2
2
  'use strict';
3
3
  import { PerformanceClient, Constants, Logger } from '@azure/msal-common';
4
4
  import { name, version } from '../packageMetadata.mjs';
5
5
  import { BrowserCacheLocation, BROWSER_PERF_ENABLED_KEY } from '../utils/BrowserConstants.mjs';
6
6
  import { createNewGuid } from '../crypto/BrowserCrypto.mjs';
7
7
 
8
- /*
9
- * Copyright (c) Microsoft Corporation. All rights reserved.
10
- * Licensed under the MIT License.
11
- */
12
- /**
13
- * Returns browser performance measurement module if session flag is enabled. Returns undefined otherwise.
14
- */
15
- function getPerfMeasurementModule() {
16
- let sessionStorage;
17
- try {
18
- sessionStorage = window[BrowserCacheLocation.SessionStorage];
19
- const perfEnabled = sessionStorage?.getItem(BROWSER_PERF_ENABLED_KEY);
20
- if (Number(perfEnabled) === 1) {
21
- return import('./BrowserPerformanceMeasurement.mjs');
22
- }
23
- // Mute errors if it's a non-browser environment or cookies are blocked.
24
- }
25
- catch (e) { }
26
- return undefined;
27
- }
28
- /**
29
- * Returns boolean, indicating whether browser supports window.performance.now() function.
30
- */
31
- function supportsBrowserPerformanceNow() {
32
- return (typeof window !== "undefined" &&
33
- typeof window.performance !== "undefined" &&
34
- typeof window.performance.now === "function");
35
- }
36
- /**
37
- * Returns event duration in milliseconds using window performance API if available. Returns undefined otherwise.
38
- * @param startTime {DOMHighResTimeStamp | undefined}
39
- * @returns {number | undefined}
40
- */
41
- function getPerfDurationMs(startTime) {
42
- if (!startTime || !supportsBrowserPerformanceNow()) {
43
- return undefined;
44
- }
45
- return Math.round(window.performance.now() - startTime);
46
- }
47
- class BrowserPerformanceClient extends PerformanceClient {
48
- constructor(configuration, intFields, abbreviations) {
49
- super(configuration.auth.clientId, configuration.auth.authority || `${Constants.DEFAULT_AUTHORITY}`, new Logger(configuration.system?.loggerOptions || {}, name, version), name, version, configuration.telemetry?.application || {
50
- appName: "",
51
- appVersion: "",
52
- }, intFields, abbreviations);
53
- }
54
- generateId() {
55
- return createNewGuid();
56
- }
57
- getPageVisibility() {
58
- return document.visibilityState?.toString() || null;
59
- }
60
- deleteIncompleteSubMeasurements(inProgressEvent) {
61
- void getPerfMeasurementModule()?.then((module) => {
62
- const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
63
- const isRootEvent = rootEvent &&
64
- rootEvent.eventId === inProgressEvent.event.eventId;
65
- const incompleteMeasurements = [];
66
- if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
67
- rootEvent.incompleteSubMeasurements.forEach((subMeasurement) => {
68
- incompleteMeasurements.push({ ...subMeasurement });
69
- });
70
- }
71
- // Clean up remaining marks for incomplete sub-measurements
72
- module.BrowserPerformanceMeasurement.flushMeasurements(inProgressEvent.event.correlationId, incompleteMeasurements);
73
- });
74
- }
75
- /**
76
- * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
77
- * Also captures browser page visibilityState.
78
- *
79
- * @param {PerformanceEvents} measureName
80
- * @param {?string} [correlationId]
81
- * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
82
- */
83
- startMeasurement(measureName, correlationId) {
84
- // Capture page visibilityState and then invoke start/end measurement
85
- const startPageVisibility = this.getPageVisibility();
86
- const inProgressEvent = super.startMeasurement(measureName, correlationId);
87
- const startTime = supportsBrowserPerformanceNow()
88
- ? window.performance.now()
89
- : undefined;
90
- const browserMeasurement = getPerfMeasurementModule()?.then((module) => {
91
- return new module.BrowserPerformanceMeasurement(measureName, inProgressEvent.event.correlationId);
92
- });
93
- void browserMeasurement?.then((measurement) => measurement.startMeasurement());
94
- return {
95
- ...inProgressEvent,
96
- end: (event, error) => {
97
- const res = inProgressEvent.end({
98
- ...event,
99
- startPageVisibility,
100
- endPageVisibility: this.getPageVisibility(),
101
- durationMs: getPerfDurationMs(startTime),
102
- }, error);
103
- void browserMeasurement?.then((measurement) => measurement.endMeasurement());
104
- this.deleteIncompleteSubMeasurements(inProgressEvent);
105
- return res;
106
- },
107
- discard: () => {
108
- inProgressEvent.discard();
109
- void browserMeasurement?.then((measurement) => measurement.flushMeasurement());
110
- this.deleteIncompleteSubMeasurements(inProgressEvent);
111
- },
112
- };
113
- }
114
- /**
115
- * Adds pre-queue time to preQueueTimeByCorrelationId map.
116
- * @param {PerformanceEvents} eventName
117
- * @param {?string} correlationId
118
- * @returns
119
- */
120
- setPreQueueTime(eventName, correlationId) {
121
- if (!supportsBrowserPerformanceNow()) {
122
- this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
123
- return;
124
- }
125
- if (!correlationId) {
126
- this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
127
- return;
128
- }
129
- const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
130
- /**
131
- * Manually complete queue measurement if there is an incomplete pre-queue event.
132
- * Incomplete pre-queue events are instrumentation bugs that should be fixed.
133
- */
134
- if (preQueueEvent) {
135
- this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
136
- this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
137
- }
138
- this.preQueueTimeByCorrelationId.set(correlationId, {
139
- name: eventName,
140
- time: window.performance.now(),
141
- });
142
- }
143
- /**
144
- * Calculates and adds queue time measurement for given performance event.
145
- *
146
- * @param {PerformanceEvents} eventName
147
- * @param {?string} correlationId
148
- * @param {?number} queueTime
149
- * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
150
- * @returns
151
- */
152
- addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
153
- if (!supportsBrowserPerformanceNow()) {
154
- this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
155
- return;
156
- }
157
- if (!correlationId) {
158
- this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
159
- return;
160
- }
161
- const preQueueTime = super.getPreQueueTime(eventName, correlationId);
162
- if (!preQueueTime) {
163
- return;
164
- }
165
- const currentTime = window.performance.now();
166
- const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
167
- return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
168
- }
8
+ /*
9
+ * Copyright (c) Microsoft Corporation. All rights reserved.
10
+ * Licensed under the MIT License.
11
+ */
12
+ /**
13
+ * Returns browser performance measurement module if session flag is enabled. Returns undefined otherwise.
14
+ */
15
+ function getPerfMeasurementModule() {
16
+ let sessionStorage;
17
+ try {
18
+ sessionStorage = window[BrowserCacheLocation.SessionStorage];
19
+ const perfEnabled = sessionStorage?.getItem(BROWSER_PERF_ENABLED_KEY);
20
+ if (Number(perfEnabled) === 1) {
21
+ return import('./BrowserPerformanceMeasurement.mjs');
22
+ }
23
+ // Mute errors if it's a non-browser environment or cookies are blocked.
24
+ }
25
+ catch (e) { }
26
+ return undefined;
27
+ }
28
+ /**
29
+ * Returns boolean, indicating whether browser supports window.performance.now() function.
30
+ */
31
+ function supportsBrowserPerformanceNow() {
32
+ return (typeof window !== "undefined" &&
33
+ typeof window.performance !== "undefined" &&
34
+ typeof window.performance.now === "function");
35
+ }
36
+ /**
37
+ * Returns event duration in milliseconds using window performance API if available. Returns undefined otherwise.
38
+ * @param startTime {DOMHighResTimeStamp | undefined}
39
+ * @returns {number | undefined}
40
+ */
41
+ function getPerfDurationMs(startTime) {
42
+ if (!startTime || !supportsBrowserPerformanceNow()) {
43
+ return undefined;
44
+ }
45
+ return Math.round(window.performance.now() - startTime);
46
+ }
47
+ class BrowserPerformanceClient extends PerformanceClient {
48
+ constructor(configuration, intFields, abbreviations) {
49
+ super(configuration.auth.clientId, configuration.auth.authority || `${Constants.DEFAULT_AUTHORITY}`, new Logger(configuration.system?.loggerOptions || {}, name, version), name, version, configuration.telemetry?.application || {
50
+ appName: "",
51
+ appVersion: "",
52
+ }, intFields, abbreviations);
53
+ }
54
+ generateId() {
55
+ return createNewGuid();
56
+ }
57
+ getPageVisibility() {
58
+ return document.visibilityState?.toString() || null;
59
+ }
60
+ deleteIncompleteSubMeasurements(inProgressEvent) {
61
+ void getPerfMeasurementModule()?.then((module) => {
62
+ const rootEvent = this.eventsByCorrelationId.get(inProgressEvent.event.correlationId);
63
+ const isRootEvent = rootEvent &&
64
+ rootEvent.eventId === inProgressEvent.event.eventId;
65
+ const incompleteMeasurements = [];
66
+ if (isRootEvent && rootEvent?.incompleteSubMeasurements) {
67
+ rootEvent.incompleteSubMeasurements.forEach((subMeasurement) => {
68
+ incompleteMeasurements.push({ ...subMeasurement });
69
+ });
70
+ }
71
+ // Clean up remaining marks for incomplete sub-measurements
72
+ module.BrowserPerformanceMeasurement.flushMeasurements(inProgressEvent.event.correlationId, incompleteMeasurements);
73
+ });
74
+ }
75
+ /**
76
+ * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
77
+ * Also captures browser page visibilityState.
78
+ *
79
+ * @param {PerformanceEvents} measureName
80
+ * @param {?string} [correlationId]
81
+ * @returns {((event?: Partial<PerformanceEvent>) => PerformanceEvent| null)}
82
+ */
83
+ startMeasurement(measureName, correlationId) {
84
+ // Capture page visibilityState and then invoke start/end measurement
85
+ const startPageVisibility = this.getPageVisibility();
86
+ const inProgressEvent = super.startMeasurement(measureName, correlationId);
87
+ const startTime = supportsBrowserPerformanceNow()
88
+ ? window.performance.now()
89
+ : undefined;
90
+ const browserMeasurement = getPerfMeasurementModule()?.then((module) => {
91
+ return new module.BrowserPerformanceMeasurement(measureName, inProgressEvent.event.correlationId);
92
+ });
93
+ void browserMeasurement?.then((measurement) => measurement.startMeasurement());
94
+ return {
95
+ ...inProgressEvent,
96
+ end: (event, error) => {
97
+ const res = inProgressEvent.end({
98
+ ...event,
99
+ startPageVisibility,
100
+ endPageVisibility: this.getPageVisibility(),
101
+ durationMs: getPerfDurationMs(startTime),
102
+ }, error);
103
+ void browserMeasurement?.then((measurement) => measurement.endMeasurement());
104
+ this.deleteIncompleteSubMeasurements(inProgressEvent);
105
+ return res;
106
+ },
107
+ discard: () => {
108
+ inProgressEvent.discard();
109
+ void browserMeasurement?.then((measurement) => measurement.flushMeasurement());
110
+ this.deleteIncompleteSubMeasurements(inProgressEvent);
111
+ },
112
+ };
113
+ }
114
+ /**
115
+ * Adds pre-queue time to preQueueTimeByCorrelationId map.
116
+ * @param {PerformanceEvents} eventName
117
+ * @param {?string} correlationId
118
+ * @returns
119
+ */
120
+ setPreQueueTime(eventName, correlationId) {
121
+ if (!supportsBrowserPerformanceNow()) {
122
+ this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to set telemetry queue time for ${eventName}`);
123
+ return;
124
+ }
125
+ if (!correlationId) {
126
+ this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to set telemetry queue time`);
127
+ return;
128
+ }
129
+ const preQueueEvent = this.preQueueTimeByCorrelationId.get(correlationId);
130
+ /**
131
+ * Manually complete queue measurement if there is an incomplete pre-queue event.
132
+ * Incomplete pre-queue events are instrumentation bugs that should be fixed.
133
+ */
134
+ if (preQueueEvent) {
135
+ this.logger.trace(`BrowserPerformanceClient: Incomplete pre-queue ${preQueueEvent.name} found`, correlationId);
136
+ this.addQueueMeasurement(preQueueEvent.name, correlationId, undefined, true);
137
+ }
138
+ this.preQueueTimeByCorrelationId.set(correlationId, {
139
+ name: eventName,
140
+ time: window.performance.now(),
141
+ });
142
+ }
143
+ /**
144
+ * Calculates and adds queue time measurement for given performance event.
145
+ *
146
+ * @param {PerformanceEvents} eventName
147
+ * @param {?string} correlationId
148
+ * @param {?number} queueTime
149
+ * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
150
+ * @returns
151
+ */
152
+ addQueueMeasurement(eventName, correlationId, queueTime, manuallyCompleted) {
153
+ if (!supportsBrowserPerformanceNow()) {
154
+ this.logger.trace(`BrowserPerformanceClient: window performance API not available, unable to add queue measurement for ${eventName}`);
155
+ return;
156
+ }
157
+ if (!correlationId) {
158
+ this.logger.trace(`BrowserPerformanceClient: correlationId for ${eventName} not provided, unable to add queue measurement`);
159
+ return;
160
+ }
161
+ const preQueueTime = super.getPreQueueTime(eventName, correlationId);
162
+ if (!preQueueTime) {
163
+ return;
164
+ }
165
+ const currentTime = window.performance.now();
166
+ const resQueueTime = queueTime || super.calculateQueuedTime(preQueueTime, currentTime);
167
+ return super.addQueueMeasurement(eventName, correlationId, resQueueTime, manuallyCompleted);
168
+ }
169
169
  }
170
170
 
171
171
  export { BrowserPerformanceClient };
@@ -1,22 +1,22 @@
1
- import { IPerformanceMeasurement, SubMeasurement } from "@azure/msal-common";
2
- export declare class BrowserPerformanceMeasurement implements IPerformanceMeasurement {
3
- private readonly measureName;
4
- private readonly correlationId;
5
- private readonly startMark;
6
- private readonly endMark;
7
- constructor(name: string, correlationId: string);
8
- private static makeMeasureName;
9
- private static makeStartMark;
10
- private static makeEndMark;
11
- static supportsBrowserPerformance(): boolean;
12
- /**
13
- * Flush browser marks and measurements.
14
- * @param {string} correlationId
15
- * @param {SubMeasurement} measurements
16
- */
17
- static flushMeasurements(correlationId: string, measurements: SubMeasurement[]): void;
18
- startMeasurement(): void;
19
- endMeasurement(): void;
20
- flushMeasurement(): number | null;
21
- }
1
+ import { IPerformanceMeasurement, SubMeasurement } from "@azure/msal-common";
2
+ export declare class BrowserPerformanceMeasurement implements IPerformanceMeasurement {
3
+ private readonly measureName;
4
+ private readonly correlationId;
5
+ private readonly startMark;
6
+ private readonly endMark;
7
+ constructor(name: string, correlationId: string);
8
+ private static makeMeasureName;
9
+ private static makeStartMark;
10
+ private static makeEndMark;
11
+ static supportsBrowserPerformance(): boolean;
12
+ /**
13
+ * Flush browser marks and measurements.
14
+ * @param {string} correlationId
15
+ * @param {SubMeasurement} measurements
16
+ */
17
+ static flushMeasurements(correlationId: string, measurements: SubMeasurement[]): void;
18
+ startMeasurement(): void;
19
+ endMeasurement(): void;
20
+ flushMeasurement(): number | null;
21
+ }
22
22
  //# sourceMappingURL=BrowserPerformanceMeasurement.d.ts.map
@@ -1,96 +1,96 @@
1
- /*! @azure/msal-browser v3.20.0 2024-07-23 */
1
+ /*! @azure/msal-browser v3.22.0 2024-08-28 */
2
2
  'use strict';
3
- /*
4
- * Copyright (c) Microsoft Corporation. All rights reserved.
5
- * Licensed under the MIT License.
6
- */
7
- class BrowserPerformanceMeasurement {
8
- constructor(name, correlationId) {
9
- this.correlationId = correlationId;
10
- this.measureName = BrowserPerformanceMeasurement.makeMeasureName(name, correlationId);
11
- this.startMark = BrowserPerformanceMeasurement.makeStartMark(name, correlationId);
12
- this.endMark = BrowserPerformanceMeasurement.makeEndMark(name, correlationId);
13
- }
14
- static makeMeasureName(name, correlationId) {
15
- return `msal.measure.${name}.${correlationId}`;
16
- }
17
- static makeStartMark(name, correlationId) {
18
- return `msal.start.${name}.${correlationId}`;
19
- }
20
- static makeEndMark(name, correlationId) {
21
- return `msal.end.${name}.${correlationId}`;
22
- }
23
- static supportsBrowserPerformance() {
24
- return (typeof window !== "undefined" &&
25
- typeof window.performance !== "undefined" &&
26
- typeof window.performance.mark === "function" &&
27
- typeof window.performance.measure === "function" &&
28
- typeof window.performance.clearMarks === "function" &&
29
- typeof window.performance.clearMeasures === "function" &&
30
- typeof window.performance.getEntriesByName === "function");
31
- }
32
- /**
33
- * Flush browser marks and measurements.
34
- * @param {string} correlationId
35
- * @param {SubMeasurement} measurements
36
- */
37
- static flushMeasurements(correlationId, measurements) {
38
- if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
39
- try {
40
- measurements.forEach((measurement) => {
41
- const measureName = BrowserPerformanceMeasurement.makeMeasureName(measurement.name, correlationId);
42
- const entriesForMeasurement = window.performance.getEntriesByName(measureName, "measure");
43
- if (entriesForMeasurement.length > 0) {
44
- window.performance.clearMeasures(measureName);
45
- window.performance.clearMarks(BrowserPerformanceMeasurement.makeStartMark(measureName, correlationId));
46
- window.performance.clearMarks(BrowserPerformanceMeasurement.makeEndMark(measureName, correlationId));
47
- }
48
- });
49
- }
50
- catch (e) {
51
- // Silently catch and return null
52
- }
53
- }
54
- }
55
- startMeasurement() {
56
- if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
57
- try {
58
- window.performance.mark(this.startMark);
59
- }
60
- catch (e) {
61
- // Silently catch
62
- }
63
- }
64
- }
65
- endMeasurement() {
66
- if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
67
- try {
68
- window.performance.mark(this.endMark);
69
- window.performance.measure(this.measureName, this.startMark, this.endMark);
70
- }
71
- catch (e) {
72
- // Silently catch
73
- }
74
- }
75
- }
76
- flushMeasurement() {
77
- if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
78
- try {
79
- const entriesForMeasurement = window.performance.getEntriesByName(this.measureName, "measure");
80
- if (entriesForMeasurement.length > 0) {
81
- const durationMs = entriesForMeasurement[0].duration;
82
- window.performance.clearMeasures(this.measureName);
83
- window.performance.clearMarks(this.startMark);
84
- window.performance.clearMarks(this.endMark);
85
- return durationMs;
86
- }
87
- }
88
- catch (e) {
89
- // Silently catch and return null
90
- }
91
- }
92
- return null;
93
- }
3
+ /*
4
+ * Copyright (c) Microsoft Corporation. All rights reserved.
5
+ * Licensed under the MIT License.
6
+ */
7
+ class BrowserPerformanceMeasurement {
8
+ constructor(name, correlationId) {
9
+ this.correlationId = correlationId;
10
+ this.measureName = BrowserPerformanceMeasurement.makeMeasureName(name, correlationId);
11
+ this.startMark = BrowserPerformanceMeasurement.makeStartMark(name, correlationId);
12
+ this.endMark = BrowserPerformanceMeasurement.makeEndMark(name, correlationId);
13
+ }
14
+ static makeMeasureName(name, correlationId) {
15
+ return `msal.measure.${name}.${correlationId}`;
16
+ }
17
+ static makeStartMark(name, correlationId) {
18
+ return `msal.start.${name}.${correlationId}`;
19
+ }
20
+ static makeEndMark(name, correlationId) {
21
+ return `msal.end.${name}.${correlationId}`;
22
+ }
23
+ static supportsBrowserPerformance() {
24
+ return (typeof window !== "undefined" &&
25
+ typeof window.performance !== "undefined" &&
26
+ typeof window.performance.mark === "function" &&
27
+ typeof window.performance.measure === "function" &&
28
+ typeof window.performance.clearMarks === "function" &&
29
+ typeof window.performance.clearMeasures === "function" &&
30
+ typeof window.performance.getEntriesByName === "function");
31
+ }
32
+ /**
33
+ * Flush browser marks and measurements.
34
+ * @param {string} correlationId
35
+ * @param {SubMeasurement} measurements
36
+ */
37
+ static flushMeasurements(correlationId, measurements) {
38
+ if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
39
+ try {
40
+ measurements.forEach((measurement) => {
41
+ const measureName = BrowserPerformanceMeasurement.makeMeasureName(measurement.name, correlationId);
42
+ const entriesForMeasurement = window.performance.getEntriesByName(measureName, "measure");
43
+ if (entriesForMeasurement.length > 0) {
44
+ window.performance.clearMeasures(measureName);
45
+ window.performance.clearMarks(BrowserPerformanceMeasurement.makeStartMark(measureName, correlationId));
46
+ window.performance.clearMarks(BrowserPerformanceMeasurement.makeEndMark(measureName, correlationId));
47
+ }
48
+ });
49
+ }
50
+ catch (e) {
51
+ // Silently catch and return null
52
+ }
53
+ }
54
+ }
55
+ startMeasurement() {
56
+ if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
57
+ try {
58
+ window.performance.mark(this.startMark);
59
+ }
60
+ catch (e) {
61
+ // Silently catch
62
+ }
63
+ }
64
+ }
65
+ endMeasurement() {
66
+ if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
67
+ try {
68
+ window.performance.mark(this.endMark);
69
+ window.performance.measure(this.measureName, this.startMark, this.endMark);
70
+ }
71
+ catch (e) {
72
+ // Silently catch
73
+ }
74
+ }
75
+ }
76
+ flushMeasurement() {
77
+ if (BrowserPerformanceMeasurement.supportsBrowserPerformance()) {
78
+ try {
79
+ const entriesForMeasurement = window.performance.getEntriesByName(this.measureName, "measure");
80
+ if (entriesForMeasurement.length > 0) {
81
+ const durationMs = entriesForMeasurement[0].duration;
82
+ window.performance.clearMeasures(this.measureName);
83
+ window.performance.clearMarks(this.startMark);
84
+ window.performance.clearMarks(this.endMark);
85
+ return durationMs;
86
+ }
87
+ }
88
+ catch (e) {
89
+ // Silently catch and return null
90
+ }
91
+ }
92
+ return null;
93
+ }
94
94
  }
95
95
 
96
96
  export { BrowserPerformanceMeasurement };