@microsoft/applicationinsights-clickanalytics-js 3.4.6-nightly3.2610-15 → 3.4.6

package/README.md

@@ -130,6 +130,14 @@ appInsights.loadAppInsights();
 | [behaviorValidator](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IClickAnalyticsConfiguration.html#behaviorValidator)     | Function                           | null  | Callback function to use for the `data-*-bhvr` value validation. For more information, go to [behaviorValidator section](#behaviorvalidator).|
 | [defaultRightClickBhvr](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IClickAnalyticsConfiguration.html#defaultRightClickBhvr) | string (or) number                 | ''      | Default Behavior value when Right Click event has occurred. This value will be overridden if the element has the `data-*-bhvr` attribute. |
 | [dropInvalidEvents](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IClickAnalyticsConfiguration.html#dropInvalidEvents)     | boolean                            | false   | Flag to drop events that do not have useful click data.                                                                                   |
+| [trackElementTypes](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IClickAnalyticsConfiguration.html#trackElementTypes)     | string                             | "A,BUTTON,AREA,INPUT" | Comma separated list of element tag names that are automatically captured.                                                  |
+| [trackInputTypes](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IClickAnalyticsConfiguration.html#trackInputTypes)     | string                             | "BUTTON,CHECKBOX,RADIO,RESET,SUBMIT" | Comma separated list of `<input>` `type` values that are automatically captured when `INPUT` is included in `trackElementTypes`. See [Input element capture](#input-element-capture). |
+
+### Input element capture
+
+Including `INPUT` in `trackElementTypes` does not capture clicks on every `<input>` element. Only inputs whose `type` is listed in `trackInputTypes` are automatically captured, by default `button`, `checkbox`, `radio`, `reset` and `submit`. Clicks on other input types such as `text`, `email`, `number` or `search` (and inputs without a `type` attribute, which default to `text`) are ignored.
+
+You can add other input types, for example `trackInputTypes: "BUTTON,CHECKBOX,RADIO,RESET,SUBMIT,TEXT,SEARCH"`. To avoid collecting user entered data, the plugin never uses the `value` of these additional input types as the default content name; it falls back to the `name`, `alt` or `id` attribute instead. Review the data your application tags with `data-*` attributes before enabling additional input types.
 
 ### [IValueCallback](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-clickanalytics-js/interfaces/IValueCallback.html)
 

package/browser/es5/{ai.clck.3.4.6-nightly3.2610-15.cjs.js → ai.clck.3.4.6.cjs.js}

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - Click Analytics, 3.4.6-nightly3.2610-15
+ * Application Insights JavaScript SDK - Click Analytics, 3.4.6
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 'use strict';
@@ -1700,7 +1700,7 @@ function newId(maxLength) {
     return result;
 }
 
-var version = '3.4.6-nightly3.2610-15';
+var version = '3.4.6';
 var instanceName = "." + newId(6);
 var _dataUid = 0;
 function _canAcceptData(target) {
@@ -3445,7 +3445,6 @@ var _DYN_CAPTURE_ALL_META_DAT1 = "captureAllMetaDataContent";
 var _DYN_META_DATA_PREFIX = "metaDataPrefix";
 var _DYN_PARENT_DATA_TAG = "parentDataTag";
 var _DYN_DEFAULT_RIGHT_CLICK_2 = "defaultRightClickBhvr";
-var _DYN_TAG_NAME = "tagName";
 var _DYN_TO_UPPER_CASE = "toUpperCase";
 var _DYN_PAGE_NAME = "pageName";
 var _DYN_CORE_DATA = "coreData";
@@ -3606,7 +3605,7 @@ function BehaviorEnumValidator(enumObj) {
     return function (key) { return enumObj[key] || ""; };
 }
 
-var clickCaptureInputTypes$1 = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
+var clickCaptureInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
 function getImageHref(element) {
     var temp = element;
     if (temp) {
@@ -3625,7 +3624,7 @@ function getImageHref(element) {
 }
 function getClickTarget(element) {
     var clickTarget = "";
-    switch (element[_DYN_TAG_NAME ]) {
+    switch (element.tagName) {
         case "A":
         case "AREA":
             clickTarget = element.href || "";
@@ -3635,7 +3634,7 @@ function getClickTarget(element) {
             break;
         case "INPUT":
             var type = element.type;
-            if (type && (clickCaptureInputTypes$1[type[_DYN_TO_UPPER_CASE ]()])) {
+            if (type && (clickCaptureInputTypes[type[_DYN_TO_UPPER_CASE ]()])) {
                 var loc = getLocation() || {};
                 if (element.form) {
                     clickTarget = element.form.action || (loc.pathname || "");
@@ -3891,7 +3890,9 @@ var ActionType = {
     OTHER: "O"
 };
 
-var clickCaptureInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
+function _parseTypes(value) {
+    return arrMap((value || "")[_DYN_TO_UPPER_CASE ]().split(","), function (tag) { return strTrim(tag); });
+}
 var AutoCaptureHandler = /** @class */ (function () {
     function AutoCaptureHandler(_analyticsPlugin, _config, _pageAction, _traceLogger) {
         this._analyticsPlugin = _analyticsPlugin;
@@ -3900,8 +3901,10 @@ var AutoCaptureHandler = /** @class */ (function () {
         this._traceLogger = _traceLogger;
         var _evtNamespace = mergeEvtNamespace(createUniqueNamespace("AutoCaptureHandler"), _analyticsPlugin._evtNamespace);
         var _clickCaptureElements;
+        var _clickCaptureInputTypes;
         var unloadHandler = onConfigChange(_config, function () {
-            _clickCaptureElements = arrMap(_config.trackElementTypes[_DYN_TO_UPPER_CASE ]().split(","), function (tag) { return strTrim(tag); });
+            _clickCaptureElements = _parseTypes(_config.trackElementTypes);
+            _clickCaptureInputTypes = _parseTypes(_config.trackInputTypes);
         });
         dynamicProto(AutoCaptureHandler, this, function (_self) {
             _self.click = function () {
@@ -3960,17 +3963,18 @@ var AutoCaptureHandler = /** @class */ (function () {
                     else {
                         return;
                     }
-                    while (element && element[_DYN_TAG_NAME ]) {
-                        if (element.control && arrIncludes(_clickCaptureElements, element.control[_DYN_TAG_NAME ][_DYN_TO_UPPER_CASE ]())) {
+                    while (element && element.tagName) {
+                        if (element.control && arrIncludes(_clickCaptureElements, element.control.tagName[_DYN_TO_UPPER_CASE ]())) {
                             element = element.control;
                         }
-                        var tagNameUpperCased = element[_DYN_TAG_NAME ][_DYN_TO_UPPER_CASE ]();
+                        var tagNameUpperCased = element.tagName[_DYN_TO_UPPER_CASE ]();
                         if (!arrIncludes(_clickCaptureElements, tagNameUpperCased)) {
                             element = element.parentElement || element[_DYN_PARENT_NODE ];
                             continue;
                         }
                         else {
-                            var sendEvent = tagNameUpperCased === "INPUT" ? clickCaptureInputTypes[element.type[_DYN_TO_UPPER_CASE ]()] : true;
+                            var sendEvent = tagNameUpperCased === "INPUT" ?
+                                arrIncludes(_clickCaptureInputTypes, (element.type || "")[_DYN_TO_UPPER_CASE ]()) : true;
                             if (sendEvent) {
                                 _capturePageAction(element, overrideValues, {}, isRightClickObj);
                             }
@@ -3986,6 +3990,7 @@ var AutoCaptureHandler = /** @class */ (function () {
 }());
 
 var MAX_CONTENTNAME_LENGTH = 200;
+var valueSafeInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
 var DomContentHandler = /** @class */ (function () {
     function DomContentHandler(_config, _traceLogger) {
         this._config = _config;
@@ -4140,12 +4145,12 @@ var DomContentHandler = /** @class */ (function () {
                 return metaData;
             }
             function _getDefaultContentName(element, useDefaultContentName) {
-                if (useDefaultContentName === false || !element[_DYN_TAG_NAME ]) {
+                if (useDefaultContentName === false || !element.tagName) {
                     return "";
                 }
                 var doc = getDocument() || {};
                 var contentName;
-                switch (element[_DYN_TAG_NAME ]) {
+                switch (element.tagName[_DYN_TO_UPPER_CASE ]()) {
                     case "A":
                         contentName = doc.all ? element.innerText || element.innerHTML : element.text || element.innerHTML;
                         break;
@@ -4153,6 +4158,10 @@ var DomContentHandler = /** @class */ (function () {
                     case "AREA":
                         contentName = element.alt;
                         break;
+                    case "INPUT":
+                        contentName = (valueSafeInputTypes[(element.type || "")[_DYN_TO_UPPER_CASE ]()] ? element.value : "") ||
+                            element[_DYN_NAME ] || element.alt || element.id;
+                        break;
                     default:
                         contentName = element.value || element[_DYN_NAME ] || element.alt || element.innerText || element.id;
                 }
@@ -4267,6 +4276,7 @@ var defaultValues = objDeepFreeze((_a = {
     _a.urlCollectHash = false,
     _a.urlCollectQuery = false,
     _a.trackElementTypes = cfgDfString("A,BUTTON,AREA,INPUT"),
+    _a.trackInputTypes = cfgDfString("BUTTON,CHECKBOX,RADIO,RESET,SUBMIT"),
     _a));
 function _dataPrefixChk(val) {
     return val && val[_DYN_INDEX_OF ](DEFAULT_DATA_PREFIX) === 0;
@@ -4280,7 +4290,6 @@ var ClickAnalyticsPlugin = /** @class */ (function (_super) {
         var _pageAction;
         var _autoCaptureHandler;
         var _contentHandler;
-        var _autoCapture;
         dynamicProto(ClickAnalyticsPlugin, _this, function (_self, _base) {
             var _identifier = _self.identifier;
             _initDefaults();
@@ -4339,23 +4348,20 @@ var ClickAnalyticsPlugin = /** @class */ (function (_super) {
                         _autoCaptureHandler._doUnload();
                     }
                     _autoCaptureHandler = new AutoCaptureHandler(_self, _config, _pageAction, logger);
-                    var autoCapture = !!_config.autoCapture;
-                    if (!_autoCapture && autoCapture) {
+                    if (_config.autoCapture) {
                         _autoCaptureHandler.click();
                     }
-                    _autoCapture = autoCapture;
                 }));
             }
             function _initDefaults() {
                 _pageAction = null;
                 _autoCaptureHandler = null;
                 _contentHandler = null;
-                _autoCapture = false;
             }
         });
         return _this;
     }
-    ClickAnalyticsPlugin.Version = '3.4.6-nightly3.2610-15';
+    ClickAnalyticsPlugin.Version = '3.4.6';
     return ClickAnalyticsPlugin;
 }(BaseTelemetryPlugin));
 
@@ -4363,4 +4369,4 @@ exports.BehaviorEnumValidator = BehaviorEnumValidator;
 exports.BehaviorMapValidator = BehaviorMapValidator;
 exports.BehaviorValueValidator = BehaviorValueValidator;
 exports.ClickAnalyticsPlugin = ClickAnalyticsPlugin;
-//# sourceMappingURL=ai.clck.3.4.6-nightly3.2610-15.cjs.js.map
+//# sourceMappingURL=ai.clck.3.4.6.cjs.js.map