@esri/telemetry - npm Package Compare versions

Comparing version 7.0.0 to 7.0.1

dist/esm/index.js

@@ -154,2 +154,7 @@ import sha256 from 'crypto-js/sha256.js';
         if (!reload) {
+            // if the new settings are more permissive than the old
+            // we know that at least some trackers are enabled,
+            // thus telemetry as a whole is not disabled
+            this.disabled = false;
+            // re-initialize the trackers
             this.initializeTrackers();
@@ -295,2 +300,10 @@ }
     }
+    /**
+     * Disable a tracker. This does not deterministically unload
+     * the tracker from the page, but it does prevent events from
+     * this library from being sent to it. Thus, if you need to ensure
+     * that an instantiated tracker is fully disabled, you should reload
+     * the application (thus, the `reload` property on the return value from `updateUserPrivacySettings`)
+     * @param trackerName
+     */
     disableTracker(trackerName) {
@@ -304,2 +317,6 @@ var _a;
     }
+    /**
+     * Enable a specific tracker
+     * @param trackerName
+     */
     enableTracker(trackerName) {
@@ -306,0 +323,0 @@ var _a;

dist/node/index.js

@@ -158,2 +158,7 @@ "use strict";
         if (!reload) {
+            // if the new settings are more permissive than the old
+            // we know that at least some trackers are enabled,
+            // thus telemetry as a whole is not disabled
+            this.disabled = false;
+            // re-initialize the trackers
             this.initializeTrackers();
@@ -299,2 +304,10 @@ }
     }
+    /**
+     * Disable a tracker. This does not deterministically unload
+     * the tracker from the page, but it does prevent events from
+     * this library from being sent to it. Thus, if you need to ensure
+     * that an instantiated tracker is fully disabled, you should reload
+     * the application (thus, the `reload` property on the return value from `updateUserPrivacySettings`)
+     * @param trackerName
+     */
     disableTracker(trackerName) {
@@ -308,2 +321,6 @@ var _a;
     }
+    /**
+     * Enable a specific tracker
+     * @param trackerName
+     */
     enableTracker(trackerName) {
@@ -310,0 +327,0 @@ var _a;

dist/types/index.d.ts

@@ -38,3 +38,15 @@ import { Attributes, EventData, IPrivacySettings, TelemetryOptions, User, Workflow } from './types';
     preProcess(event?: EventData, options?: TelemetryOptions): Record<string, any>;
+    /**
+     * Disable a tracker. This does not deterministically unload
+     * the tracker from the page, but it does prevent events from
+     * this library from being sent to it. Thus, if you need to ensure
+     * that an instantiated tracker is fully disabled, you should reload
+     * the application (thus, the `reload` property on the return value from `updateUserPrivacySettings`)
+     * @param trackerName
+     */
     disableTracker(trackerName: string): void;
+    /**
+     * Enable a specific tracker
+     * @param trackerName
+     */
     enableTracker(trackerName: string): void;
@@ -41,0 +53,0 @@ }

dist/types/types.d.ts

@@ -35,3 +35,10 @@ export declare type GenericObject = {
     logger?: ILogger;
+    /**
+     *  If true, the system will not log any events until the user has accepted the privacy policy.
+     */
     requireConsent?: boolean;
+    /**
+     * Any existing privacy settings for the user. The host application is responsible for
+     * managing these settings via localStorage or cookies.
+     */
     userPrivacySettings?: IPrivacySettings;
@@ -38,0 +45,0 @@ }

dist/umd/telemetry.js

@@ -1344,2 +1344,7 @@ (function (global, factory) {
 	        if (!reload) {
+	            // if the new settings are more permissive than the old
+	            // we know that at least some trackers are enabled,
+	            // thus telemetry as a whole is not disabled
+	            this.disabled = false;
+	            // re-initialize the trackers
 	            this.initializeTrackers();
@@ -1485,2 +1490,10 @@ }
 	    }
+	    /**
+	     * Disable a tracker. This does not deterministically unload
+	     * the tracker from the page, but it does prevent events from
+	     * this library from being sent to it. Thus, if you need to ensure
+	     * that an instantiated tracker is fully disabled, you should reload
+	     * the application (thus, the `reload` property on the return value from `updateUserPrivacySettings`)
+	     * @param trackerName
+	     */
 	    disableTracker(trackerName) {
@@ -1494,2 +1507,6 @@ var _a;
 	    }
+	    /**
+	     * Enable a specific tracker
+	     * @param trackerName
+	     */
 	    enableTracker(trackerName) {
@@ -1496,0 +1513,0 @@ var _a;

dist/umd/telemetry.min.js

@@ -1344,2 +1344,7 @@ (function (global, factory) {
 	        if (!reload) {
+	            // if the new settings are more permissive than the old
+	            // we know that at least some trackers are enabled,
+	            // thus telemetry as a whole is not disabled
+	            this.disabled = false;
+	            // re-initialize the trackers
 	            this.initializeTrackers();
@@ -1485,2 +1490,10 @@ }
 	    }
+	    /**
+	     * Disable a tracker. This does not deterministically unload
+	     * the tracker from the page, but it does prevent events from
+	     * this library from being sent to it. Thus, if you need to ensure
+	     * that an instantiated tracker is fully disabled, you should reload
+	     * the application (thus, the `reload` property on the return value from `updateUserPrivacySettings`)
+	     * @param trackerName
+	     */
 	    disableTracker(trackerName) {
@@ -1494,2 +1507,6 @@ var _a;
 	    }
+	    /**
+	     * Enable a specific tracker
+	     * @param trackerName
+	     */
 	    enableTracker(trackerName) {
@@ -1496,0 +1513,0 @@ var _a;

package.json

 {
   "name": "@esri/telemetry",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "A JavaScript Implementation of the ArcGIS Telemetry Specification",
@@ -55,3 +55,3 @@ "main": "dist/node/index.js",
   },
-  "gitHead": "9ee827e7211634c3d0e4d1ecef56a96340783ea7"
+  "gitHead": "1980bc53f2a3e31f2920443a4f896587322844c3"
 }

No alert changes

Improved metrics

Total package byte prevSize

382405

increased by1.57%

Lines of code

4243

increased by2.09%

No dependency changes