@microsoft/sp-diagnostics - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0-plusbeta

CHANGELOG.json

@@ -5,2 +5,15 @@ {
     {
+      "version": "1.7.0",
+      "tag": "@microsoft/sp-diagnostics_v1.7.0",
+      "date": "Thu, 08 Nov 2018 17:05:51 GMT",
+      "comments": {
+        "none": [],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@ms/sp-build-internal-web\" from `~0.22.12` to `~0.22.13`"
+          }
+        ]
+      }
+    },
+    {
       "version": "1.6.0",
@@ -44,2 +57,2 @@ "tag": "@microsoft/sp-diagnostics_v1.6.0",
   ]
-}
+}

CHANGELOG.md

 # Change Log - @microsoft/sp-diagnostics
 
-This log was last generated on Mon, 27 Aug 2018 20:46:09 GMT and should not be manually modified.
+This log was last generated on Thu, 08 Nov 2018 17:05:51 GMT and should not be manually modified.
 
+## 1.7.0
+Thu, 08 Nov 2018 17:05:51 GMT
+
+### Updates
+
+*Version update only*
+
 ## 1.6.0
@@ -6,0 +13,0 @@ Mon, 27 Aug 2018 18:06:28 GMT

dist/78359e4b-07c2-43c6-8d0b-d060b4d577e8.manifest.json

@@ -6,3 +6,3 @@ {
   "componentType": "Library",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "loaderConfig": {
@@ -20,3 +20,3 @@ "entryModuleId": "sp-diagnostics",
         "type": "component",
-        "version": "1.6.0",
+        "version": "1.7.0",
         "id": "7263c7d0-1d6a-45ec-8d85-d4d1d234171b"
@@ -26,3 +26,3 @@ },
         "type": "component",
-        "version": "1.6.0",
+        "version": "1.7.0",
         "id": "73e1dc6c-8441-42cc-ad47-4bd3659f8a3a"
@@ -29,0 +29,0 @@ }

dist/sp-diagnostics.api.json

@@ -0,0 +0,0 @@ {

dist/sp-diagnostics.js

@@ -1,2 +0,2 @@
-define("78359e4b-07c2-43c6-8d0b-d060b4d577e8_1.6.0", ["@microsoft/sp-core-library","@microsoft/sp-lodash-subset"], function(__WEBPACK_EXTERNAL_MODULE_0__, __WEBPACK_EXTERNAL_MODULE_2__) { return /******/ (function(modules) { // webpackBootstrap
+define("78359e4b-07c2-43c6-8d0b-d060b4d577e8_1.7.0", ["@microsoft/sp-core-library","@microsoft/sp-lodash-subset"], function(__WEBPACK_EXTERNAL_MODULE_0__, __WEBPACK_EXTERNAL_MODULE_2__) { return /******/ (function(modules) { // webpackBootstrap
 /******/ 	// The module cache
@@ -474,3 +474,4 @@ /******/ 	var installedModules = {};
     TraceLogger.logErrorWithLogEntry = function (source, logEntry, eventName, resultCode) {
-        sp_core_library_["Validate"].isNotNullOrUndefined(logEntry, 'LogEntry');
+        sp_core_library_["Validate"].isNotNullOrUndefined(source, 'source');
+        sp_core_library_["Validate"].isNotNullOrUndefined(logEntry, 'logEntry');
         this._log(source, logEntry.toString(), eventName, true, resultCode);
@@ -605,7 +606,7 @@ };
         this._initialized = true;
-        this._normalizeSiteIdWebId();
+        this._normalizeContextIds();
     };
     DiagnosticsSettingsManager.updateSettings = function (settings) {
         this.settings = Object(sp_lodash_subset_["merge"])(this.settings, settings);
-        this._normalizeSiteIdWebId();
+        this._normalizeContextIds();
     };
@@ -627,5 +628,11 @@ Object.defineProperty(DiagnosticsSettingsManager, "isInitialized", {
     };
-    DiagnosticsSettingsManager._normalizeSiteIdWebId = function () {
+    DiagnosticsSettingsManager._normalizeContextIds = function () {
         this.settings.siteId = this._normalizeId(this.settings.siteId);
         this.settings.webId = this._normalizeId(this.settings.webId);
+        if (this.settings.listId) {
+            this.settings.listId = this._normalizeId(this.settings.listId);
+            if (this.settings.listItemUniqueId) {
+                this.settings.listItemUniqueId = this._normalizeId(this.settings.listItemUniqueId);
+            }
+        }
     };
@@ -750,4 +757,11 @@ DiagnosticsSettingsManager.enableCircularBufferLogging = sp_core_library_["Guid"].parse('4b6e1a58-3e0c-43e2-b9cb-1a470f6fe402');
         if (lib_DiagnosticsSettingsManager.isInitialized) {
-            data.siteId = lib_DiagnosticsSettingsManager.settings.siteId;
-            data.webId = lib_DiagnosticsSettingsManager.settings.webId;
+            var _a = lib_DiagnosticsSettingsManager.settings, listId = _a.listId, listItemUniqueId = _a.listItemUniqueId, siteId = _a.siteId, webId = _a.webId;
+            data.siteId = siteId;
+            data.webId = webId;
+            if (listId) {
+                data.listId = listId;
+                if (listItemUniqueId) {
+                    data.listItemUniqueId = listItemUniqueId;
+                }
+            }
         }
@@ -754,0 +768,0 @@ };

lib/Api/Engagement/EngagementLogger.d.ts

@@ -30,10 +30,12 @@ /**
     * Engagement logging
+    *
+    * @remarks
     * Use *.Click for all the actions triggered by mouse, keyboard, or touch.
-    * tagName follows <Workload>.controlName.actionName pattern
-    * For example,{ name = "AddButton.Click" },
-    * this logs "<Workload>.AddButton.Click" with default action triggered by mouse, keyboard, or touch.
-    * <Workload> is set in Telemetry settings
-    * IEngagementData interface is mapped to a set of enums for standartization of mapping.
+    * tagName follows `<Workload>.controlName.actionName` pattern
+    * For example, `{ name = "AddButton.Click" }`,
+    * this logs `"<Workload>.AddButton.Click"` with default action triggered by mouse, keyboard, or touch.
+    * `<Workload>` is set in Telemetry settings
+    * `IEngagementData` interface is mapped to a set of enums for standardization of mapping.
     * Add new items to enum in order to register a new item specification.
-    * SiteType is defined in SyteType enum
+    * SiteType is defined in SiteType enum
     * CurrentPage is defined in CurrentPage enum
@@ -46,10 +48,12 @@ * Component is defined in Component enum
      * Engagement logging
+     *
+     * @remarks
      * Use *.Click for all the actions triggered by mouse, keyboard, or touch.
-     * tagName follows <Workload>.controlName.actionName pattern
-     * For example, tagName = "AddButton.Click",
-     * this logs "<Workload>.AddButton.Click" with default action triggered by mouse, keyboard, or touch.
-     * <Workload> is set in Telemetry settings
+     * tagName follows `<Workload>.controlName.actionName` pattern
+     * For example, `tagName = "AddButton.Click"`,
+     * this logs `"<Workload>.AddButton.Click"` with default action triggered by mouse, keyboard, or touch.
+     * `<Workload>` is set in Telemetry settings
      * Use extraData to log the type of action.
-     * For example, actionName = "Keydown" and tagName = "ModernPublish.AddButton.Click"
-     * this logs "<Workload>.AddButton.Click" with the extraData that it was selected using the Keydown   *
+     * For example, `actionName = "Keydown"` and `tagName = "ModernPublish.AddButton.Click"`
+     * this logs `"<Workload>.AddButton.Click"` with the extraData that it was selected using the Keydown
      */
@@ -59,6 +63,12 @@ static logEvent(tagName: string, actionName?: string): void;
      * Engagement logging with LogEntry
-     * Here is an example: {"EngagementName":"SPPage.NavigationAction.SPPageQuickLaunchUpdate",
+     *
+     * @remarks
+     * Here is an example:
+     * ```
+     * {"EngagementName":"SPPage.NavigationAction.SPPageQuickLaunchUpdate"`,
      * "Properties":"{\"message\":\"[NavigationAction] | SPPageQuickLaunchUpdate | 2 | null\"}",
      * "Duration":0,"LogType":0,
      * "ClientTime":1459357627444,"Source":"ClientV2Engagement"}
+     * ```
+     *
      * NavigationAction is moduleName in LogEntry, SPPageQuickLaunchUpdate is log feature name
@@ -65,0 +75,0 @@ * In this example, SPPage is workload name which is set in Telemetry settings.

lib/Api/Engagement/EngagementLogger.js

@@ -64,4 +64,11 @@ import LogManager from '../LogManager/LogManager';
         if (DiagnosticsSettingsManager.isInitialized) {
-            data.siteId = DiagnosticsSettingsManager.settings.siteId;
-            data.webId = DiagnosticsSettingsManager.settings.webId;
+            var _a = DiagnosticsSettingsManager.settings, listId = _a.listId, listItemUniqueId = _a.listItemUniqueId, siteId = _a.siteId, webId = _a.webId;
+            data.siteId = siteId;
+            data.webId = webId;
+            if (listId) {
+                data.listId = listId;
+                if (listItemUniqueId) {
+                    data.listItemUniqueId = listItemUniqueId;
+                }
+            }
         }
@@ -68,0 +75,0 @@ };

lib/Api/Engagement/IEngagementHandler.d.ts

@@ -15,8 +15,8 @@ /**
  * Engagement handler log data action interface
- * Reopresents a subset of Engagement Event Stream fields.
- * Full list can be located at: \odsp-utilities\src\local\logging\events\Engagement.event.json
+ * Represents a subset of Engagement Event Stream fields.
+ * Full list can be located at: `\odsp-utilities\src\local\logging\events\Engagement.event.json`
  * @internal
  */
 export interface IEngagementData {
-    /**  name should follow AppName.ControlName.ActionName pattern **/
+    /**  name should follow `AppName.ControlName.ActionName` pattern **/
     name: string;
@@ -48,2 +48,12 @@ /**  extraData is used to specify additional details regarding the action **/
     isIntentional?: boolean;
+    /**
+     * The Id of the relevant SharePoint list
+     */
+    listId?: string;
+    /**
+     * The Id of the relevant SharePoint document
+     */
+    docId?: string;
+    /** used for tracking the item the user was on when the log was made **/
+    listItemUniqueId?: string;
 }
@@ -111,2 +121,6 @@ /**
     NewsImageArea = "NewsImageArea",
+    NewsItemPinned = "NewsItemPinned",
+    NewsPinnedItemRemoved = "NewsPinnedItemRemoved",
+    NewsPinnedItemSorted = "NewsPinnedItemSorted",
+    SelectNewsToPin = "SelectNewsToPin",
     CreateNewsLinkFromHome = "CreateNewsLinkFromHome",
@@ -142,2 +156,3 @@ CreateNewsPostFromHome = "CreateNewsPostFromHome",
     RejectDone = "RejectDone",
+    CheckedOutButton = "CheckedOutButton",
 }
@@ -144,0 +159,0 @@ /**

lib/Api/Trace/TraceLogger.d.ts

@@ -45,5 +45,7 @@ import ILogEntry from '../ILogEntry';
      * Exception logging intended to replace to logError.
-     * Uses the ILogErrorData interface to prevent excessive undefined parameters
+     *
+     * @remarks
+     * Uses the `ILogErrorData` interface to prevent excessive undefined parameters
      * when calling this function.
-     * This shoule be used whenever you want to log something that might in future help to
+     * This should be used whenever you want to log something that might in future help to
      * debug failures.
@@ -82,3 +84,3 @@ * It will also be uploaded to the server immediately and not wait for next batch log upload.
      * error message should be packed into logProperties
-     * LogType should be LogType.Error and LogProperties should have {error:errorMessage}
+     * LogType should be LogType.Error and LogProperties should have `{error:errorMessage}`
      * Do NOT add PII data!
@@ -85,0 +87,0 @@ **/

lib/Api/Trace/TraceLogger.js

@@ -33,3 +33,4 @@ import { Validate } from '@microsoft/sp-core-library';
     TraceLogger.logErrorWithLogEntry = function (source, logEntry, eventName, resultCode) {
-        Validate.isNotNullOrUndefined(logEntry, 'LogEntry');
+        Validate.isNotNullOrUndefined(source, 'source');
+        Validate.isNotNullOrUndefined(logEntry, 'logEntry');
         this._log(source, logEntry.toString(), eventName, true, resultCode);
@@ -36,0 +37,0 @@ };

lib/DiagnosticsSettingsManager.d.ts

@@ -21,3 +21,3 @@ /**
     private static _normalizeId(id);
-    private static _normalizeSiteIdWebId();
+    private static _normalizeContextIds();
 }

lib/DiagnosticsSettingsManager.js

@@ -9,7 +9,7 @@ import { Guid, _SPKillSwitch } from '@microsoft/sp-core-library';
         this._initialized = true;
-        this._normalizeSiteIdWebId();
+        this._normalizeContextIds();
     };
     DiagnosticsSettingsManager.updateSettings = function (settings) {
         this.settings = merge(this.settings, settings);
-        this._normalizeSiteIdWebId();
+        this._normalizeContextIds();
     };
@@ -31,5 +31,11 @@ Object.defineProperty(DiagnosticsSettingsManager, "isInitialized", {
     };
-    DiagnosticsSettingsManager._normalizeSiteIdWebId = function () {
+    DiagnosticsSettingsManager._normalizeContextIds = function () {
         this.settings.siteId = this._normalizeId(this.settings.siteId);
         this.settings.webId = this._normalizeId(this.settings.webId);
+        if (this.settings.listId) {
+            this.settings.listId = this._normalizeId(this.settings.listId);
+            if (this.settings.listItemUniqueId) {
+                this.settings.listItemUniqueId = this._normalizeId(this.settings.listItemUniqueId);
+            }
+        }
     };
@@ -36,0 +42,0 @@ DiagnosticsSettingsManager.enableCircularBufferLogging = Guid.parse('4b6e1a58-3e0c-43e2-b9cb-1a470f6fe402');

lib/IDiagnosticsSettings.d.ts

@@ -13,3 +13,3 @@ /**
      * The current site id (GUID)
-     * Example: "{440067a7-8e96-4446-8e0e-fafef7a9e9d9}"
+     * Example: `"{440067a7-8e96-4446-8e0e-fafef7a9e9d9}"`
      */
@@ -19,6 +19,16 @@ siteId: string;
      * The current web id (GUID)
-     * Example: "{b29e6452-fe31-4967-872b-ea5d23dbfe07}"
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
      */
     webId: string;
+    /**
+     * The current list id (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    listId?: string;
+    /**
+     * The current list item unique id (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    listItemUniqueId?: string;
 }
 export default IDiagnosticsSettings;

package.json

 {
   "name": "@microsoft/sp-diagnostics",
-  "version": "1.6.0",
+  "version": "1.7.0-plusbeta",
   "description": "Diagnostics tools for the SharePoint Framework",
@@ -15,7 +15,7 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER",
     "@types/webpack-env": "1.13.1",
-    "@ms/sp-build-internal-web": "~0.21.8"
+    "@ms/sp-build-internal-web": "~0.22.13"
   },
   "dependencies": {
-    "@microsoft/sp-core-library": "1.6.0",
-    "@microsoft/sp-lodash-subset": "1.6.0"
+    "@microsoft/sp-core-library": "1.7.0-plusbeta",
+    "@microsoft/sp-lodash-subset": "1.7.0-plusbeta"
   },
@@ -25,2 +25,2 @@ "scripts": {
   }
-}
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1811278

increased by0.15%

Lines of code

3335

increased by2.43%

Worsened metrics

Number of low quality alerts

2

increased by100%

Dependency changes

• + Added@microsoft/sp-core-library@1.7.0-plusbeta(transitive)

• + Added@microsoft/sp-lodash-subset@1.7.0-plusbeta(transitive)

• + Added@microsoft/sp-module-interfaces@1.7.0-plusbeta(transitive)

• - Removed@microsoft/sp-core-library@1.6.0(transitive)

• - Removed@microsoft/sp-lodash-subset@1.6.0(transitive)

• - Removed@microsoft/sp-module-interfaces@1.6.0(transitive)

• Updated@microsoft/sp-core-library@1.7.0-plusbeta

• Updated@microsoft/sp-lodash-subset@1.7.0-plusbeta