@microsoft/sp-diagnostics 1.23.1 → 1.24.0-beta.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 (223) hide show
  1. package/dist/78359e4b-07c2-43c6-8d0b-d060b4d577e8.manifest.json +6 -11
  2. package/dist/index-internal-beta.d.ts +20 -0
  3. package/dist/index-internal-public.d.ts +20 -0
  4. package/dist/index-internal.d.ts +20 -0
  5. package/dist/sp-diagnostics_none_1b5b73722b91f3231f63.js +1 -0
  6. package/dist/tsdoc-metadata.json +1 -1
  7. package/lib-commonjs/Api/Engagement/EngagementLogger.js +91 -96
  8. package/lib-commonjs/Api/Engagement/IEngagementHandler.js +9 -3
  9. package/lib-commonjs/Api/ExecutionQueue.js +73 -86
  10. package/lib-commonjs/Api/ILogData.js +6 -3
  11. package/lib-commonjs/Api/ILogEntry.js +5 -2
  12. package/lib-commonjs/Api/ILogErrorData.js +6 -3
  13. package/lib-commonjs/Api/ILogSource.js +10 -3
  14. package/lib-commonjs/Api/ILogVerboseData.js +6 -3
  15. package/lib-commonjs/Api/Log/LogHandler.js +27 -26
  16. package/lib-commonjs/Api/LogEntry.js +40 -39
  17. package/lib-commonjs/Api/LogFeature.js +14 -10
  18. package/lib-commonjs/Api/LogLevel.js +22 -19
  19. package/lib-commonjs/Api/LogManager/CircularBuffer.js +56 -64
  20. package/lib-commonjs/Api/LogManager/LogManager.js +61 -78
  21. package/lib-commonjs/Api/LogSource.js +37 -35
  22. package/lib-commonjs/Api/LogType.js +20 -15
  23. package/lib-commonjs/Api/Qos/AutoAlertableQosMonitor.js +68 -82
  24. package/lib-commonjs/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +5 -2
  25. package/lib-commonjs/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +5 -2
  26. package/lib-commonjs/Api/Qos/IQos.js +5 -2
  27. package/lib-commonjs/Api/Qos/IQosEndEvent.js +5 -2
  28. package/lib-commonjs/Api/Qos/IQosExtraData.js +15 -3
  29. package/lib-commonjs/Api/Qos/IQosStartEvent.js +9 -3
  30. package/lib-commonjs/Api/Qos/QosLogger.js +54 -60
  31. package/lib-commonjs/Api/Qos/QosMonitor.js +163 -209
  32. package/lib-commonjs/Api/Qos/QosMonitorShareFailureWithCP.js +72 -92
  33. package/lib-commonjs/Api/Qos/QosResultType.js +14 -7
  34. package/lib-commonjs/Api/Trace/DefaultTraceHandler.js +20 -22
  35. package/lib-commonjs/Api/Trace/ITraceHandler.js +9 -3
  36. package/lib-commonjs/Api/Trace/ITraceLogger.js +5 -2
  37. package/lib-commonjs/Api/Trace/LogEvent.js +86 -125
  38. package/lib-commonjs/Api/Trace/TraceLogger.js +149 -161
  39. package/lib-commonjs/Diagnostics.js +57 -72
  40. package/lib-commonjs/DiagnosticsSettingsManager.js +37 -43
  41. package/lib-commonjs/IDiagnosticsSettings.js +5 -2
  42. package/lib-commonjs/common/Killswitches.js +13 -9
  43. package/lib-commonjs/extraData/DisplayApp.js +13 -5
  44. package/lib-commonjs/extraData/IDiagnosticContextInfo.js +5 -2
  45. package/lib-commonjs/extraData/IPageExtraData.js +5 -2
  46. package/lib-commonjs/extraData/PageType.js +15 -8
  47. package/lib-commonjs/extraData/PromotedState.js +18 -13
  48. package/lib-commonjs/extraData/WebTemplateId.js +13 -5
  49. package/lib-commonjs/extraData/setPageExtraData.js +37 -37
  50. package/lib-commonjs/index.js +102 -50
  51. package/{lib → lib-dts}/Api/Engagement/IEngagementHandler.d.ts +2 -0
  52. package/lib-esm/Api/Engagement/EngagementLogger.js +137 -0
  53. package/lib-esm/Api/Engagement/IEngagementHandler.js +9 -0
  54. package/lib-esm/Api/ExecutionQueue.js +114 -0
  55. package/lib-esm/Api/ILogData.js +4 -0
  56. package/lib-esm/Api/ILogEntry.js +3 -0
  57. package/lib-esm/Api/ILogErrorData.js +4 -0
  58. package/lib-esm/Api/ILogSource.js +8 -0
  59. package/lib-esm/Api/ILogVerboseData.js +4 -0
  60. package/lib-esm/Api/Log/LogHandler.js +37 -0
  61. package/lib-esm/Api/LogEntry.js +44 -0
  62. package/lib-esm/Api/LogFeature.js +8 -0
  63. package/lib-esm/Api/LogLevel.js +20 -0
  64. package/lib-esm/Api/LogManager/CircularBuffer.js +83 -0
  65. package/lib-esm/Api/LogManager/LogManager.js +103 -0
  66. package/lib-esm/Api/LogSource.js +32 -0
  67. package/lib-esm/Api/LogType.js +20 -0
  68. package/lib-esm/Api/Qos/AutoAlertableQosMonitor.js +74 -0
  69. package/lib-esm/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +6 -0
  70. package/lib-esm/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +6 -0
  71. package/lib-esm/Api/Qos/IQos.js +6 -0
  72. package/lib-esm/Api/Qos/IQosEndEvent.js +6 -0
  73. package/lib-esm/Api/Qos/IQosExtraData.js +12 -0
  74. package/lib-esm/Api/Qos/IQosStartEvent.js +6 -0
  75. package/lib-esm/Api/Qos/QosLogger.js +64 -0
  76. package/lib-esm/Api/Qos/QosMonitor.js +258 -0
  77. package/lib-esm/Api/Qos/QosMonitorShareFailureWithCP.js +89 -0
  78. package/lib-esm/Api/Qos/QosResultType.js +11 -0
  79. package/lib-esm/Api/Trace/DefaultTraceHandler.js +23 -0
  80. package/lib-esm/Api/Trace/ITraceHandler.js +9 -0
  81. package/lib-esm/Api/Trace/ITraceLogger.js +3 -0
  82. package/lib-esm/Api/Trace/LogEvent.js +104 -0
  83. package/lib-esm/Api/Trace/TraceLogger.js +180 -0
  84. package/lib-esm/Diagnostics.js +67 -0
  85. package/lib-esm/DiagnosticsSettingsManager.js +54 -0
  86. package/lib-esm/IDiagnosticsSettings.js +3 -0
  87. package/{lib → lib-esm}/common/Killswitches.js +3 -4
  88. package/{lib → lib-esm}/extraData/DisplayApp.js +3 -2
  89. package/lib-esm/extraData/IDiagnosticContextInfo.js +7 -0
  90. package/lib-esm/extraData/IPageExtraData.js +3 -0
  91. package/{lib → lib-esm}/extraData/PageType.js +4 -4
  92. package/lib-esm/extraData/PromotedState.js +15 -0
  93. package/{lib → lib-esm}/extraData/WebTemplateId.js +3 -2
  94. package/{lib → lib-esm}/extraData/setPageExtraData.js +14 -20
  95. package/{lib → lib-esm}/index.js +3 -3
  96. package/package.json +33 -6
  97. package/dist/sp-diagnostics_none_e7447a590b1864b48fbc.js +0 -1
  98. package/lib/Api/Engagement/EngagementLogger.d.ts.map +0 -1
  99. package/lib/Api/Engagement/EngagementLogger.js +0 -143
  100. package/lib/Api/Engagement/IEngagementHandler.d.ts.map +0 -1
  101. package/lib/Api/Engagement/IEngagementHandler.js +0 -2
  102. package/lib/Api/ExecutionQueue.d.ts.map +0 -1
  103. package/lib/Api/ExecutionQueue.js +0 -131
  104. package/lib/Api/ILogData.d.ts.map +0 -1
  105. package/lib/Api/ILogData.js +0 -3
  106. package/lib/Api/ILogEntry.d.ts.map +0 -1
  107. package/lib/Api/ILogEntry.js +0 -2
  108. package/lib/Api/ILogErrorData.d.ts.map +0 -1
  109. package/lib/Api/ILogErrorData.js +0 -3
  110. package/lib/Api/ILogSource.d.ts.map +0 -1
  111. package/lib/Api/ILogSource.js +0 -3
  112. package/lib/Api/ILogVerboseData.d.ts.map +0 -1
  113. package/lib/Api/ILogVerboseData.js +0 -3
  114. package/lib/Api/Log/LogHandler.d.ts.map +0 -1
  115. package/lib/Api/Log/LogHandler.js +0 -40
  116. package/lib/Api/LogEntry.d.ts.map +0 -1
  117. package/lib/Api/LogEntry.js +0 -51
  118. package/lib/Api/LogFeature.d.ts.map +0 -1
  119. package/lib/Api/LogFeature.js +0 -11
  120. package/lib/Api/LogLevel.d.ts.map +0 -1
  121. package/lib/Api/LogLevel.js +0 -24
  122. package/lib/Api/LogManager/CircularBuffer.d.ts.map +0 -1
  123. package/lib/Api/LogManager/CircularBuffer.js +0 -98
  124. package/lib/Api/LogManager/LogManager.d.ts.map +0 -1
  125. package/lib/Api/LogManager/LogManager.js +0 -121
  126. package/lib/Api/LogSource.d.ts.map +0 -1
  127. package/lib/Api/LogSource.js +0 -40
  128. package/lib/Api/LogType.d.ts.map +0 -1
  129. package/lib/Api/LogType.js +0 -23
  130. package/lib/Api/Qos/AutoAlertableQosMonitor.d.ts.map +0 -1
  131. package/lib/Api/Qos/AutoAlertableQosMonitor.js +0 -93
  132. package/lib/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.d.ts.map +0 -1
  133. package/lib/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.js +0 -2
  134. package/lib/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.d.ts.map +0 -1
  135. package/lib/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.js +0 -2
  136. package/lib/Api/Qos/IQos.d.ts.map +0 -1
  137. package/lib/Api/Qos/IQos.js +0 -2
  138. package/lib/Api/Qos/IQosEndEvent.d.ts.map +0 -1
  139. package/lib/Api/Qos/IQosEndEvent.js +0 -2
  140. package/lib/Api/Qos/IQosExtraData.d.ts.map +0 -1
  141. package/lib/Api/Qos/IQosExtraData.js +0 -2
  142. package/lib/Api/Qos/IQosStartEvent.d.ts.map +0 -1
  143. package/lib/Api/Qos/IQosStartEvent.js +0 -2
  144. package/lib/Api/Qos/QosLogger.d.ts.map +0 -1
  145. package/lib/Api/Qos/QosLogger.js +0 -74
  146. package/lib/Api/Qos/QosMonitor.d.ts.map +0 -1
  147. package/lib/Api/Qos/QosMonitor.js +0 -304
  148. package/lib/Api/Qos/QosMonitorShareFailureWithCP.d.ts.map +0 -1
  149. package/lib/Api/Qos/QosMonitorShareFailureWithCP.js +0 -114
  150. package/lib/Api/Qos/QosResultType.d.ts.map +0 -1
  151. package/lib/Api/Qos/QosResultType.js +0 -11
  152. package/lib/Api/Trace/DefaultTraceHandler.d.ts.map +0 -1
  153. package/lib/Api/Trace/DefaultTraceHandler.js +0 -30
  154. package/lib/Api/Trace/ITraceHandler.d.ts.map +0 -1
  155. package/lib/Api/Trace/ITraceHandler.js +0 -2
  156. package/lib/Api/Trace/ITraceLogger.d.ts.map +0 -1
  157. package/lib/Api/Trace/ITraceLogger.js +0 -2
  158. package/lib/Api/Trace/LogEvent.d.ts.map +0 -1
  159. package/lib/Api/Trace/LogEvent.js +0 -147
  160. package/lib/Api/Trace/TraceLogger.d.ts.map +0 -1
  161. package/lib/Api/Trace/TraceLogger.js +0 -196
  162. package/lib/Diagnostics.d.ts.map +0 -1
  163. package/lib/Diagnostics.js +0 -82
  164. package/lib/DiagnosticsSettingsManager.d.ts.map +0 -1
  165. package/lib/DiagnosticsSettingsManager.js +0 -62
  166. package/lib/IDiagnosticsSettings.d.ts.map +0 -1
  167. package/lib/IDiagnosticsSettings.js +0 -2
  168. package/lib/common/Killswitches.d.ts.map +0 -1
  169. package/lib/extraData/DisplayApp.d.ts.map +0 -1
  170. package/lib/extraData/IDiagnosticContextInfo.d.ts.map +0 -1
  171. package/lib/extraData/IDiagnosticContextInfo.js +0 -2
  172. package/lib/extraData/IPageExtraData.d.ts.map +0 -1
  173. package/lib/extraData/IPageExtraData.js +0 -2
  174. package/lib/extraData/PageType.d.ts.map +0 -1
  175. package/lib/extraData/PromotedState.d.ts.map +0 -1
  176. package/lib/extraData/PromotedState.js +0 -17
  177. package/lib/extraData/WebTemplateId.d.ts.map +0 -1
  178. package/lib/extraData/setPageExtraData.d.ts.map +0 -1
  179. package/lib/index.d.ts.map +0 -1
  180. /package/{lib → lib-dts}/Api/Engagement/EngagementLogger.d.ts +0 -0
  181. /package/{lib → lib-dts}/Api/ExecutionQueue.d.ts +0 -0
  182. /package/{lib → lib-dts}/Api/ILogData.d.ts +0 -0
  183. /package/{lib → lib-dts}/Api/ILogEntry.d.ts +0 -0
  184. /package/{lib → lib-dts}/Api/ILogErrorData.d.ts +0 -0
  185. /package/{lib → lib-dts}/Api/ILogSource.d.ts +0 -0
  186. /package/{lib → lib-dts}/Api/ILogVerboseData.d.ts +0 -0
  187. /package/{lib → lib-dts}/Api/Log/LogHandler.d.ts +0 -0
  188. /package/{lib → lib-dts}/Api/LogEntry.d.ts +0 -0
  189. /package/{lib → lib-dts}/Api/LogFeature.d.ts +0 -0
  190. /package/{lib → lib-dts}/Api/LogLevel.d.ts +0 -0
  191. /package/{lib → lib-dts}/Api/LogManager/CircularBuffer.d.ts +0 -0
  192. /package/{lib → lib-dts}/Api/LogManager/LogManager.d.ts +0 -0
  193. /package/{lib → lib-dts}/Api/LogSource.d.ts +0 -0
  194. /package/{lib → lib-dts}/Api/LogType.d.ts +0 -0
  195. /package/{lib → lib-dts}/Api/Qos/AutoAlertableQosMonitor.d.ts +0 -0
  196. /package/{lib → lib-dts}/Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails.d.ts +0 -0
  197. /package/{lib → lib-dts}/Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise.d.ts +0 -0
  198. /package/{lib → lib-dts}/Api/Qos/IQos.d.ts +0 -0
  199. /package/{lib → lib-dts}/Api/Qos/IQosEndEvent.d.ts +0 -0
  200. /package/{lib → lib-dts}/Api/Qos/IQosExtraData.d.ts +0 -0
  201. /package/{lib → lib-dts}/Api/Qos/IQosStartEvent.d.ts +0 -0
  202. /package/{lib → lib-dts}/Api/Qos/QosLogger.d.ts +0 -0
  203. /package/{lib → lib-dts}/Api/Qos/QosMonitor.d.ts +0 -0
  204. /package/{lib → lib-dts}/Api/Qos/QosMonitorShareFailureWithCP.d.ts +0 -0
  205. /package/{lib → lib-dts}/Api/Qos/QosResultType.d.ts +0 -0
  206. /package/{lib → lib-dts}/Api/Trace/DefaultTraceHandler.d.ts +0 -0
  207. /package/{lib → lib-dts}/Api/Trace/ITraceHandler.d.ts +0 -0
  208. /package/{lib → lib-dts}/Api/Trace/ITraceLogger.d.ts +0 -0
  209. /package/{lib → lib-dts}/Api/Trace/LogEvent.d.ts +0 -0
  210. /package/{lib → lib-dts}/Api/Trace/TraceLogger.d.ts +0 -0
  211. /package/{lib → lib-dts}/Diagnostics.d.ts +0 -0
  212. /package/{lib → lib-dts}/DiagnosticsSettingsManager.d.ts +0 -0
  213. /package/{lib → lib-dts}/IDiagnosticsSettings.d.ts +0 -0
  214. /package/{lib → lib-dts}/common/Killswitches.d.ts +0 -0
  215. /package/{lib → lib-dts}/extraData/DisplayApp.d.ts +0 -0
  216. /package/{lib → lib-dts}/extraData/IDiagnosticContextInfo.d.ts +0 -0
  217. /package/{lib → lib-dts}/extraData/IPageExtraData.d.ts +0 -0
  218. /package/{lib → lib-dts}/extraData/PageType.d.ts +0 -0
  219. /package/{lib → lib-dts}/extraData/PromotedState.d.ts +0 -0
  220. /package/{lib → lib-dts}/extraData/WebTemplateId.d.ts +0 -0
  221. /package/{lib → lib-dts}/extraData/setPageExtraData.d.ts +0 -0
  222. /package/{lib → lib-dts}/index.d.ts +0 -0
  223. /package/{lib → lib-esm}/sp-diagnostics.manifest.json +0 -0
@@ -1,9 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DisplayApp = void 0;
4
1
  // eslint-disable-next-line @typescript-eslint/typedef
5
- exports.DisplayApp = {
2
+ "use strict";
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ Object.defineProperty(exports, "DisplayApp", {
7
+ enumerable: true,
8
+ get: function() {
9
+ return DisplayApp;
10
+ }
11
+ });
12
+ const DisplayApp = {
6
13
  Sharepoint: 'Sharepoint',
7
14
  Teams: 'Teams'
8
15
  };
9
- //# sourceMappingURL=DisplayApp.js.map
16
+
17
+ //# sourceMappingURL=./DisplayApp.js.map
@@ -1,3 +1,6 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IDiagnosticContextInfo.js.map
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+
6
+ //# sourceMappingURL=./IDiagnosticContextInfo.js.map
@@ -1,3 +1,6 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IPageExtraData.js.map
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+
6
+ //# sourceMappingURL=./IPageExtraData.js.map
@@ -1,19 +1,26 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PageType = void 0;
4
1
  /**
5
2
  * Page Type
6
3
  *
7
4
  * @internal
8
- */
9
- // This is quite similar to CurrentPage but these are simplified names that
5
+ */ // This is quite similar to CurrentPage but these are simplified names that
10
6
  // we want to build dashboards with.
7
+ "use strict";
8
+ Object.defineProperty(exports, "__esModule", {
9
+ value: true
10
+ });
11
+ Object.defineProperty(exports, "PageType", {
12
+ enumerable: true,
13
+ get: function() {
14
+ return PageType;
15
+ }
16
+ });
11
17
  var PageType;
12
- (function (PageType) {
18
+ (function(PageType) {
13
19
  PageType["News"] = "News";
14
20
  PageType["Article"] = "Article";
15
21
  PageType["Home"] = "Home";
16
22
  PageType["Space"] = "Space";
17
23
  PageType["NewsDigest"] = "NewsDigest";
18
- })(PageType || (exports.PageType = PageType = {}));
19
- //# sourceMappingURL=PageType.js.map
24
+ })(PageType || (PageType = {}));
25
+
26
+ //# sourceMappingURL=./PageType.js.map
@@ -1,20 +1,25 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PromotedState = void 0;
4
1
  /**
5
2
  * Promoted state
6
3
  *
7
4
  * @internal
8
- */
5
+ */ "use strict";
6
+ Object.defineProperty(exports, "__esModule", {
7
+ value: true
8
+ });
9
+ Object.defineProperty(exports, "PromotedState", {
10
+ enumerable: true,
11
+ get: function() {
12
+ return PromotedState;
13
+ }
14
+ });
9
15
  var PromotedState;
10
- (function (PromotedState) {
16
+ (function(PromotedState) {
11
17
  /**
12
- * Regular page (can later be promoted to news)
13
- */
14
- PromotedState[PromotedState["NotPromoted"] = 0] = "NotPromoted";
18
+ * Regular page (can later be promoted to news)
19
+ */ PromotedState[PromotedState["NotPromoted"] = 0] = "NotPromoted";
15
20
  /**
16
- * News post (a page with special notifications sent out upon publishing)
17
- */
18
- PromotedState[PromotedState["Promoted"] = 2] = "Promoted";
19
- })(PromotedState || (exports.PromotedState = PromotedState = {}));
20
- //# sourceMappingURL=PromotedState.js.map
21
+ * News post (a page with special notifications sent out upon publishing)
22
+ */ PromotedState[PromotedState["Promoted"] = 2] = "Promoted";
23
+ })(PromotedState || (PromotedState = {}));
24
+
25
+ //# sourceMappingURL=./PromotedState.js.map
@@ -1,13 +1,21 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WebTemplateId = void 0;
4
1
  // One place to find the list is at
5
2
  // https://onedrive.visualstudio.com/SPIN/_git/FFTScripts?path=%2Fsrc%2FCreateDBScripts%2FFFTDashboard-WebTemplateNames.sql&version=GBmaster
6
3
  // eslint-disable-next-line @typescript-eslint/typedef
7
- exports.WebTemplateId = {
4
+ "use strict";
5
+ Object.defineProperty(exports, "__esModule", {
6
+ value: true
7
+ });
8
+ Object.defineProperty(exports, "WebTemplateId", {
9
+ enumerable: true,
10
+ get: function() {
11
+ return WebTemplateId;
12
+ }
13
+ });
14
+ const WebTemplateId = {
8
15
  TeamSite: '1',
9
16
  MySite: '21',
10
17
  GroupSite: '64',
11
18
  SitePagePublishing: '68'
12
19
  };
13
- //# sourceMappingURL=WebTemplateId.js.map
20
+
21
+ //# sourceMappingURL=./WebTemplateId.js.map
@@ -1,67 +1,67 @@
1
1
  "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.setPageExtraData = void 0;
4
- var sp_core_library_1 = require("@microsoft/sp-core-library");
5
- var DisplayApp_1 = require("./DisplayApp");
6
- var WebTemplateId_1 = require("./WebTemplateId");
7
- var PromotedState_1 = require("./PromotedState");
8
- var PageType_1 = require("./PageType");
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ Object.defineProperty(exports, "setPageExtraData", {
6
+ enumerable: true,
7
+ get: function() {
8
+ return setPageExtraData;
9
+ }
10
+ });
11
+ const _spcorelibrary = require("@microsoft/sp-core-library");
12
+ const _DisplayApp = require("./DisplayApp");
13
+ const _WebTemplateId = require("./WebTemplateId");
14
+ const _PromotedState = require("./PromotedState");
15
+ const _PageType = require("./PageType");
9
16
  function setPageExtraData(contextInfo, extraData) {
10
17
  extraData.pageId = contextInfo.pageId;
11
18
  extraData.isHub = contextInfo.isHubSite;
12
19
  if (contextInfo.isHubSite) {
13
20
  extraData.hubSiteId = contextInfo.hubSiteId;
14
21
  extraData.isAssociatedSite = false;
15
- }
16
- else if (!contextInfo.isHubSite && contextInfo.hubSiteId) {
22
+ } else if (!contextInfo.isHubSite && contextInfo.hubSiteId) {
17
23
  // If isHubSite is false, but hubSiteId is set, we call it associatedSite
18
24
  extraData.isAssociatedSite = true;
19
- }
20
- else {
25
+ } else {
21
26
  extraData.isAssociatedSite = false;
22
27
  }
23
28
  if (!extraData.displayApp) {
24
- if (sp_core_library_1._BrowserUtilities.isTeamsHosted()) {
25
- extraData.displayApp = DisplayApp_1.DisplayApp.Teams;
29
+ if (_spcorelibrary._BrowserUtilities.isTeamsHosted()) {
30
+ extraData.displayApp = _DisplayApp.DisplayApp.Teams;
26
31
  if (contextInfo.isEduClass) {
27
32
  extraData.isEduClass = true;
28
33
  }
29
- }
30
- else {
31
- extraData.displayApp = DisplayApp_1.DisplayApp.Sharepoint;
34
+ } else {
35
+ extraData.displayApp = _DisplayApp.DisplayApp.Sharepoint;
32
36
  }
33
37
  }
34
38
  extraData.userAgent = navigator.userAgent;
35
- var webTemplate = contextInfo.webTemplate;
39
+ const webTemplate = contextInfo.webTemplate;
36
40
  extraData.webTemplate = webTemplate;
37
- var siteType;
38
- if (webTemplate === WebTemplateId_1.WebTemplateId.TeamSite) {
41
+ let siteType;
42
+ if (webTemplate === _WebTemplateId.WebTemplateId.TeamSite) {
39
43
  siteType = 'TeamSite';
40
- }
41
- else if (webTemplate === WebTemplateId_1.WebTemplateId.GroupSite) {
44
+ } else if (webTemplate === _WebTemplateId.WebTemplateId.GroupSite) {
42
45
  siteType = 'GroupSite';
43
- }
44
- else if (webTemplate === WebTemplateId_1.WebTemplateId.SitePagePublishing) {
46
+ } else if (webTemplate === _WebTemplateId.WebTemplateId.SitePagePublishing) {
45
47
  siteType = 'CommunicationSite';
46
- }
47
- else if (webTemplate === WebTemplateId_1.WebTemplateId.MySite) {
48
+ } else if (webTemplate === _WebTemplateId.WebTemplateId.MySite) {
48
49
  siteType = 'MySite';
49
50
  }
50
- var promotedState = contextInfo.promotedState;
51
- var pageLayoutType = contextInfo.pageType;
52
- var pageType = pageLayoutType;
53
- if (pageLayoutType === PageType_1.PageType.Article) {
54
- if (promotedState === PromotedState_1.PromotedState.NotPromoted || promotedState === undefined) {
55
- pageType = PageType_1.PageType.Article;
56
- }
57
- else {
58
- pageType = PageType_1.PageType.News;
51
+ const promotedState = contextInfo.promotedState;
52
+ const pageLayoutType = contextInfo.pageType;
53
+ let pageType = pageLayoutType;
54
+ if (pageLayoutType === _PageType.PageType.Article) {
55
+ if (promotedState === _PromotedState.PromotedState.NotPromoted || promotedState === undefined) {
56
+ pageType = _PageType.PageType.Article;
57
+ } else {
58
+ pageType = _PageType.PageType.News;
59
59
  }
60
60
  }
61
61
  extraData.siteType = siteType;
62
62
  extraData.pageType = pageType;
63
- extraData.isDebug = !!sp_core_library_1._BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
63
+ extraData.isDebug = !!_spcorelibrary._BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
64
64
  extraData.hasCopilotLicense = !!contextInfo.hasCopilotLicense;
65
65
  }
66
- exports.setPageExtraData = setPageExtraData;
67
- //# sourceMappingURL=setPageExtraData.js.map
66
+
67
+ //# sourceMappingURL=./setPageExtraData.js.map
@@ -1,55 +1,107 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports._ExecutionQueue = exports._QosResultType = exports._QosLogger = exports._QosMonitorShareFailureWithCP = exports._AutoAlertableMonitorType = exports._AutoAlertableQosMonitor = exports._QosMonitor = exports._LogHandler = exports._EngagementLogger = exports._LogManager = exports._CircularBuffer = exports._LogLevel = exports._LogEvent = exports._PageType = exports._PromotedState = exports._Diagnostics = exports._LogType = exports._logSourceServiceKey = exports._LogSource = exports._LogFeature = exports._LogEntry = exports._TraceLogger = void 0;
7
1
  /**
8
2
  * This package defines the internal diagnostics tools for the SharePoint Framework,
9
3
  * including monitoring, trace, user engagement and performance logging.
10
4
  *
11
5
  * @packagedocumentation
12
- */
13
- var TraceLogger_1 = require("./Api/Trace/TraceLogger");
14
- Object.defineProperty(exports, "_TraceLogger", { enumerable: true, get: function () { return __importDefault(TraceLogger_1).default; } });
15
- var LogEntry_1 = require("./Api/LogEntry");
16
- Object.defineProperty(exports, "_LogEntry", { enumerable: true, get: function () { return __importDefault(LogEntry_1).default; } });
17
- var LogFeature_1 = require("./Api/LogFeature");
18
- Object.defineProperty(exports, "_LogFeature", { enumerable: true, get: function () { return __importDefault(LogFeature_1).default; } });
19
- var LogSource_1 = require("./Api/LogSource");
20
- Object.defineProperty(exports, "_LogSource", { enumerable: true, get: function () { return __importDefault(LogSource_1).default; } });
21
- Object.defineProperty(exports, "_logSourceServiceKey", { enumerable: true, get: function () { return LogSource_1.logSourceServiceKey; } });
22
- var LogType_1 = require("./Api/LogType");
23
- Object.defineProperty(exports, "_LogType", { enumerable: true, get: function () { return __importDefault(LogType_1).default; } });
24
- var Diagnostics_1 = require("./Diagnostics");
25
- Object.defineProperty(exports, "_Diagnostics", { enumerable: true, get: function () { return __importDefault(Diagnostics_1).default; } });
26
- var PromotedState_1 = require("./extraData/PromotedState");
27
- Object.defineProperty(exports, "_PromotedState", { enumerable: true, get: function () { return PromotedState_1.PromotedState; } });
28
- var PageType_1 = require("./extraData/PageType");
29
- Object.defineProperty(exports, "_PageType", { enumerable: true, get: function () { return PageType_1.PageType; } });
30
- var LogEvent_1 = require("./Api/Trace/LogEvent");
31
- Object.defineProperty(exports, "_LogEvent", { enumerable: true, get: function () { return __importDefault(LogEvent_1).default; } });
32
- var LogLevel_1 = require("./Api/LogLevel");
33
- Object.defineProperty(exports, "_LogLevel", { enumerable: true, get: function () { return LogLevel_1.LogLevel; } });
34
- var CircularBuffer_1 = require("./Api/LogManager/CircularBuffer");
35
- Object.defineProperty(exports, "_CircularBuffer", { enumerable: true, get: function () { return __importDefault(CircularBuffer_1).default; } });
36
- var LogManager_1 = require("./Api/LogManager/LogManager");
37
- Object.defineProperty(exports, "_LogManager", { enumerable: true, get: function () { return __importDefault(LogManager_1).default; } });
38
- var EngagementLogger_1 = require("./Api/Engagement/EngagementLogger");
39
- Object.defineProperty(exports, "_EngagementLogger", { enumerable: true, get: function () { return __importDefault(EngagementLogger_1).default; } });
40
- var LogHandler_1 = require("./Api/Log/LogHandler");
41
- Object.defineProperty(exports, "_LogHandler", { enumerable: true, get: function () { return __importDefault(LogHandler_1).default; } });
42
- var QosMonitor_1 = require("./Api/Qos/QosMonitor");
43
- Object.defineProperty(exports, "_QosMonitor", { enumerable: true, get: function () { return __importDefault(QosMonitor_1).default; } });
44
- var AutoAlertableQosMonitor_1 = require("./Api/Qos/AutoAlertableQosMonitor");
45
- Object.defineProperty(exports, "_AutoAlertableQosMonitor", { enumerable: true, get: function () { return AutoAlertableQosMonitor_1.AutoAlertableQosMonitor; } });
46
- Object.defineProperty(exports, "_AutoAlertableMonitorType", { enumerable: true, get: function () { return AutoAlertableQosMonitor_1.AutoAlertableMonitorType; } });
47
- var QosMonitorShareFailureWithCP_1 = require("./Api/Qos/QosMonitorShareFailureWithCP");
48
- Object.defineProperty(exports, "_QosMonitorShareFailureWithCP", { enumerable: true, get: function () { return QosMonitorShareFailureWithCP_1.QosMonitorShareFailureWithCP; } });
49
- var QosLogger_1 = require("./Api/Qos/QosLogger");
50
- Object.defineProperty(exports, "_QosLogger", { enumerable: true, get: function () { return __importDefault(QosLogger_1).default; } });
51
- var QosResultType_1 = require("./Api/Qos/QosResultType");
52
- Object.defineProperty(exports, "_QosResultType", { enumerable: true, get: function () { return QosResultType_1.QosResultType; } });
53
- var ExecutionQueue_1 = require("./Api/ExecutionQueue");
54
- Object.defineProperty(exports, "_ExecutionQueue", { enumerable: true, get: function () { return __importDefault(ExecutionQueue_1).default; } });
55
- //# sourceMappingURL=index.js.map
6
+ */ "use strict";
7
+ Object.defineProperty(exports, "__esModule", {
8
+ value: true
9
+ });
10
+ function _export(target, all) {
11
+ for(var name in all)Object.defineProperty(target, name, {
12
+ enumerable: true,
13
+ get: all[name]
14
+ });
15
+ }
16
+ _export(exports, {
17
+ _AutoAlertableMonitorType: function() {
18
+ return _AutoAlertableQosMonitor.AutoAlertableMonitorType;
19
+ },
20
+ _AutoAlertableQosMonitor: function() {
21
+ return _AutoAlertableQosMonitor.AutoAlertableQosMonitor;
22
+ },
23
+ _CircularBuffer: function() {
24
+ return _CircularBuffer.default;
25
+ },
26
+ _Diagnostics: function() {
27
+ return _Diagnostics.default;
28
+ },
29
+ _EngagementLogger: function() {
30
+ return _EngagementLogger.default;
31
+ },
32
+ _ExecutionQueue: function() {
33
+ return _ExecutionQueue.default;
34
+ },
35
+ _LogEntry: function() {
36
+ return _LogEntry.default;
37
+ },
38
+ _LogEvent: function() {
39
+ return _LogEvent.default;
40
+ },
41
+ _LogFeature: function() {
42
+ return _LogFeature.default;
43
+ },
44
+ _LogHandler: function() {
45
+ return _LogHandler.default;
46
+ },
47
+ _LogLevel: function() {
48
+ return _LogLevel.LogLevel;
49
+ },
50
+ _LogManager: function() {
51
+ return _LogManager.default;
52
+ },
53
+ _LogSource: function() {
54
+ return _LogSource.default;
55
+ },
56
+ _LogType: function() {
57
+ return _LogType.default;
58
+ },
59
+ _PageType: function() {
60
+ return _PageType.PageType;
61
+ },
62
+ _PromotedState: function() {
63
+ return _PromotedState.PromotedState;
64
+ },
65
+ _QosLogger: function() {
66
+ return _QosLogger.default;
67
+ },
68
+ _QosMonitor: function() {
69
+ return _QosMonitor.default;
70
+ },
71
+ _QosMonitorShareFailureWithCP: function() {
72
+ return _QosMonitorShareFailureWithCP.QosMonitorShareFailureWithCP;
73
+ },
74
+ _QosResultType: function() {
75
+ return _QosResultType.QosResultType;
76
+ },
77
+ _TraceLogger: function() {
78
+ return _TraceLogger.default;
79
+ },
80
+ _logSourceServiceKey: function() {
81
+ return _LogSource.logSourceServiceKey;
82
+ }
83
+ });
84
+ const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
85
+ const _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
86
+ const _TraceLogger = /*#__PURE__*/ _interop_require_default._(require("./Api/Trace/TraceLogger"));
87
+ const _LogEntry = /*#__PURE__*/ _interop_require_default._(require("./Api/LogEntry"));
88
+ const _LogFeature = /*#__PURE__*/ _interop_require_default._(require("./Api/LogFeature"));
89
+ const _LogSource = /*#__PURE__*/ _interop_require_wildcard._(require("./Api/LogSource"));
90
+ const _LogType = /*#__PURE__*/ _interop_require_default._(require("./Api/LogType"));
91
+ const _Diagnostics = /*#__PURE__*/ _interop_require_default._(require("./Diagnostics"));
92
+ const _PromotedState = require("./extraData/PromotedState");
93
+ const _PageType = require("./extraData/PageType");
94
+ const _LogEvent = /*#__PURE__*/ _interop_require_default._(require("./Api/Trace/LogEvent"));
95
+ const _LogLevel = require("./Api/LogLevel");
96
+ const _CircularBuffer = /*#__PURE__*/ _interop_require_default._(require("./Api/LogManager/CircularBuffer"));
97
+ const _LogManager = /*#__PURE__*/ _interop_require_default._(require("./Api/LogManager/LogManager"));
98
+ const _EngagementLogger = /*#__PURE__*/ _interop_require_default._(require("./Api/Engagement/EngagementLogger"));
99
+ const _LogHandler = /*#__PURE__*/ _interop_require_default._(require("./Api/Log/LogHandler"));
100
+ const _QosMonitor = /*#__PURE__*/ _interop_require_default._(require("./Api/Qos/QosMonitor"));
101
+ const _AutoAlertableQosMonitor = require("./Api/Qos/AutoAlertableQosMonitor");
102
+ const _QosMonitorShareFailureWithCP = require("./Api/Qos/QosMonitorShareFailureWithCP");
103
+ const _QosLogger = /*#__PURE__*/ _interop_require_default._(require("./Api/Qos/QosLogger"));
104
+ const _QosResultType = require("./Api/Qos/QosResultType");
105
+ const _ExecutionQueue = /*#__PURE__*/ _interop_require_default._(require("./Api/ExecutionQueue"));
106
+
107
+ //# sourceMappingURL=./index.js.map
@@ -50,6 +50,8 @@ export interface IEngagementData {
50
50
  docId?: string;
51
51
  /** used for tracking the item the user was on when the log was made **/
52
52
  listItemUniqueId?: string;
53
+ /** The client application name, e.g. 'SPO'. */
54
+ clientName?: string;
53
55
  }
54
56
  /**
55
57
  * ABExperiment interface.
@@ -0,0 +1,137 @@
1
+ import LogManager from '../LogManager/LogManager';
2
+ import DiagnosticsSettingsManager from '../../DiagnosticsSettingsManager';
3
+ import { setPageExtraData } from '../../extraData/setPageExtraData';
4
+ class EngagementLogger {
5
+ /**
6
+ * Init function for the passed logger object
7
+ */ static _addHandler(logger) {
8
+ EngagementLogger._handler = (e)=>{
9
+ logger.logData(e);
10
+ };
11
+ EngagementLogger._logManager.addHandler(EngagementLogger._handler);
12
+ }
13
+ /**
14
+ * Starts processing logs in real time
15
+ */ static startRealTimeProcessing() {
16
+ if (!this._shouldProcessInRealTime) {
17
+ EngagementLogger._logManager.processAll(EngagementLogger._handler);
18
+ this._shouldProcessInRealTime = true;
19
+ }
20
+ }
21
+ /**
22
+ * Engagement logging
23
+ *
24
+ * @remarks
25
+ * Use *.Click for all the actions triggered by mouse, keyboard, or touch.
26
+ * tagName follows `<Workload>.controlName.actionName` pattern
27
+ * For example, `{ name = "AddButton.Click" }`,
28
+ * this logs `"<Workload>.AddButton.Click"` with default action triggered by mouse, keyboard, or touch.
29
+ * `<Workload>` is set in Telemetry settings
30
+ * `IEngagementData` interface is mapped to a set of enums for standardization of mapping.
31
+ * Add new items to enum in order to register a new item specification.
32
+ * SiteType is defined in SiteType enum
33
+ * CurrentPage is defined in CurrentPage enum
34
+ * Component is defined in Component enum
35
+ * Feature is defined in Feature enum.
36
+ */ static log(engagementData) {
37
+ EngagementLogger._logEngagementData(engagementData);
38
+ }
39
+ /**
40
+ * Engagement logging
41
+ *
42
+ * @remarks
43
+ * Use *.Click for all the actions triggered by mouse, keyboard, or touch.
44
+ * tagName follows `<Workload>.controlName.actionName` pattern
45
+ * For example, `tagName = "AddButton.Click"`,
46
+ * this logs `"<Workload>.AddButton.Click"` with default action triggered by mouse, keyboard, or touch.
47
+ * `<Workload>` is set in Telemetry settings
48
+ * Use extraData to log the type of action.
49
+ * For example, `actionName = "Keydown"` and `tagName = "ModernPublish.AddButton.Click"`
50
+ * this logs `"<Workload>.AddButton.Click"` with the extraData that it was selected using the Keydown
51
+ */ static logEvent(tagName, actionName) {
52
+ const logData = {
53
+ name: tagName
54
+ };
55
+ if (actionName && actionName.length !== 0) {
56
+ logData.extraData = {
57
+ action: actionName
58
+ };
59
+ }
60
+ EngagementLogger._logEngagementData(logData);
61
+ }
62
+ /**
63
+ * Engagement logging with LogEntry
64
+ *
65
+ * @remarks
66
+ * Here is an example:
67
+ * ```
68
+ * {"EngagementName":"SPPage.NavigationAction.SPPageQuickLaunchUpdate"`,
69
+ * "Properties":"{\"message\":\"[NavigationAction] | SPPageQuickLaunchUpdate | 2 | null\"}",
70
+ * "Duration":0,"LogType":0,
71
+ * "ClientTime":1459357627444,"Source":"ClientV2Engagement"}
72
+ * ```
73
+ *
74
+ * NavigationAction is moduleName in LogEntry, SPPageQuickLaunchUpdate is log feature name
75
+ * In this example, SPPage is workload name which is set in Telemetry settings.
76
+ * Do NOT add PII data!
77
+ */ static logEventWithLogEntry(logEntry) {
78
+ const logData = {
79
+ isIntentional: logEntry.isIntentional,
80
+ name: logEntry.moduleName + '.' + logEntry.logFeature,
81
+ extraData: logEntry.logProperties
82
+ };
83
+ EngagementLogger._logEngagementData(logData, true);
84
+ }
85
+ static _logEngagementData(engagementData, isLogEntry = false) {
86
+ if (!engagementData.name || engagementData.name.length === 0) {
87
+ throw new Error('LogEntry is invalid');
88
+ }
89
+ EngagementLogger._checkValidTagName(engagementData, isLogEntry);
90
+ EngagementLogger._addContextData(engagementData);
91
+ EngagementLogger._appendExtraData(engagementData);
92
+ EngagementLogger._logManager.log(engagementData);
93
+ }
94
+ // tagName should follow AppName.ControlName.ActionName pattern
95
+ static _checkValidTagName(engagementData, isLogEntry = false) {
96
+ if (!isLogEntry) {
97
+ const tagNameRegex = /(\w+)\.(\w+).(\w+)/gi;
98
+ if (tagNameRegex.test(engagementData.name) === false) {
99
+ throw new Error(`${engagementData.name} tagName does not follow AppName.ControlName.ActionName pattern`);
100
+ }
101
+ }
102
+ }
103
+ static _addContextData(data) {
104
+ if (DiagnosticsSettingsManager.isInitialized) {
105
+ const { listId, listItemUniqueId, siteId, webId } = DiagnosticsSettingsManager.settings;
106
+ data.siteId = siteId;
107
+ data.webId = webId;
108
+ if (listId) {
109
+ data.listId = listId;
110
+ if (listItemUniqueId) {
111
+ data.docId = listItemUniqueId;
112
+ }
113
+ }
114
+ }
115
+ }
116
+ static _appendExtraData(data) {
117
+ if (DiagnosticsSettingsManager.isInitialized) {
118
+ const { settings: { contextInfo } } = DiagnosticsSettingsManager;
119
+ if (contextInfo) {
120
+ if (!data.extraData) {
121
+ data.extraData = {};
122
+ }
123
+ setPageExtraData(contextInfo, data.extraData);
124
+ }
125
+ }
126
+ }
127
+ }
128
+ EngagementLogger._logManager = new LogManager();
129
+ /**
130
+ * Engagement logging
131
+ * use *.Click for all the actions triggered by mouse, keyboard, or touch.
132
+ * if you want to add more data or the action is not click but keydown.
133
+ * Use extraData to log the type of action or use extraData to log details wrapped in LogEntry
134
+ * @internal
135
+ */ export { EngagementLogger as default };
136
+
137
+ //# sourceMappingURL=./EngagementLogger.js.map
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Engagement logger log data interface
3
+ * @internal
4
+ */ /**
5
+ * Feature list for the feature field in Engagement Event stream.
6
+ * @internal
7
+ */ export { };
8
+
9
+ //# sourceMappingURL=./IEngagementHandler.js.map