@microsoft/applicationinsights-clickanalytics-js 2.8.15-nightly.2307-19 → 2.8.15-nightly.2307-26

package/dist/applicationinsights-clickanalytics-js.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.35.0",
+    "toolVersion": "7.36.3",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -688,6 +688,297 @@
             "endIndex": 2
           },
           "implementsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration:interface",
+          "docComment": "/**\n * ClickAnalytics Configuration\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IClickAnalyticsConfiguration "
+            }
+          ],
+          "fileUrlPath": "types/Interfaces/Datamodel.d.ts",
+          "releaseTag": "Public",
+          "name": "IClickAnalyticsConfiguration",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#autoCapture:member",
+              "docComment": "/**\n * Automatic capture configuration. Default is true\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "autoCapture?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "autoCapture",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#behaviorValidator:member",
+              "docComment": "/**\n * Validator to use for the data-bhvr value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "behaviorValidator?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(value: string | number) => string | number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "behaviorValidator",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#callback:member",
+              "docComment": "/**\n * Callbacks configuration\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "callback?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IValueCallback",
+                  "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!~IValueCallback:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "callback",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#coreData:member",
+              "docComment": "/**\n * Core data configuration\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "coreData?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ICoreData",
+                  "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!~ICoreData:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "coreData",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#dataTags:member",
+              "docComment": "/**\n * Custom Data Tags provided to ovverride default tags used to capture click data.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "dataTags?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ICustomDataTags",
+                  "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!~ICustomDataTags:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "dataTags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#defaultRightClickBhvr:member",
+              "docComment": "/**\n * Default Behavior value when Right Click event has occured. This value will be ovverriden if the element has the data-*-bhvr attribute present.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "defaultRightClickBhvr?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "defaultRightClickBhvr",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#dropInvalidEvents:member",
+              "docComment": "/**\n * Flag to drop events that do not have custom event names, no parentId and no data in content (basically no useful click data). Default will be false\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "dropInvalidEvents?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "dropInvalidEvents",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#pageTags:member",
+              "docComment": "/**\n * Page tags\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "pageTags?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [name: string]: string | number | boolean | string[] | number[] | boolean[] | object;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "pageTags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#urlCollectHash:member",
+              "docComment": "/**\n * Enables the logging of values after a \"#\" character of the URL. Default is \"false.\"\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "urlCollectHash?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "urlCollectHash",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!IClickAnalyticsConfiguration#urlCollectQuery:member",
+              "docComment": "/**\n * Enables the logging of the query string of the URL. Default is \"false.\"\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "urlCollectQuery?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "urlCollectQuery",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
         }
       ]
     }

package/dist/applicationinsights-clickanalytics-js.api.md

@@ -41,6 +41,25 @@ export class ClickAnalyticsPlugin extends BaseTelemetryPlugin {
     static Version: string;
 }
 
+// @public
+export interface IClickAnalyticsConfiguration {
+    autoCapture?: boolean;
+    behaviorValidator?: (value: string | number) => string | number;
+    // Warning: (ae-forgotten-export) The symbol "IValueCallback" needs to be exported by the entry point applicationinsights-clickanalytics-js.d.ts
+    callback?: IValueCallback;
+    // Warning: (ae-forgotten-export) The symbol "ICoreData" needs to be exported by the entry point applicationinsights-clickanalytics-js.d.ts
+    coreData?: ICoreData;
+    // Warning: (ae-forgotten-export) The symbol "ICustomDataTags" needs to be exported by the entry point applicationinsights-clickanalytics-js.d.ts
+    dataTags?: ICustomDataTags;
+    defaultRightClickBhvr?: string | number;
+    dropInvalidEvents?: boolean;
+    pageTags?: {
+        [name: string]: string | number | boolean | string[] | number[] | boolean[] | object;
+    };
+    urlCollectHash?: boolean;
+    urlCollectQuery?: boolean;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/dist/applicationinsights-clickanalytics-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.15-nightly.2307-19
+ * Microsoft.ApplicationInsights, 2.8.15-nightly.2307-26
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -39,6 +39,112 @@ declare namespace ApplicationInsights {
         trackPageAction(pageAction?: IPageActionTelemetry, customProperties?: ICustomProperties): void;
     }
 
+    /**
+     * ClickAnalytics Configuration
+     */
+    interface IClickAnalyticsConfiguration {
+        /**
+         * Automatic capture configuration. Default is true
+         */
+        autoCapture?: boolean;
+        /**
+         * Callbacks configuration
+         */
+        callback?: IValueCallback;
+        /**
+         * Page tags
+         */
+        pageTags?: {
+            [name: string]: string | number | boolean | string[] | number[] | boolean[] | object;
+        };
+        /**
+         * Core data configuration
+         */
+        coreData?: ICoreData;
+        /**
+         * Custom Data Tags provided to ovverride default tags used to capture click data.
+         */
+        dataTags?: ICustomDataTags;
+        /**
+         * Validator to use for the data-bhvr value
+         */
+        behaviorValidator?: (value: string | number) => string | number;
+        /**
+         * Default Behavior value when Right Click event has occured. This
+         * value will be ovverriden if the element has the data-*-bhvr attribute present.
+         */
+        defaultRightClickBhvr?: string | number;
+        /**
+         * Flag to drop events that do not have custom event names, no parentId and no data in content (basically no useful click data).
+         * Default will be false
+         */
+        dropInvalidEvents?: boolean;
+        /**
+         * Enables the logging of values after a "#" character of the URL. Default is "false."
+         */
+        urlCollectHash?: boolean;
+        /**
+         * Enables the logging of the query string of the URL. Default is "false."
+         */
+        urlCollectQuery?: boolean;
+    }
+
+    /**
+     * Core data configuration
+     */
+    interface ICoreData {
+        /**
+         * document.referrer is the default. This is used to override the default value.
+         */
+        referrerUri?: string;
+        /**
+         * window.location.href is the default. This is used to override the default value.
+         */
+        requestUri?: string;
+        /**
+         * Default page name is derived from the url. This is used to override the default.
+         */
+        pageName?: string;
+        /**
+         * PageType is captured from a meta tag named awa-pageType. This is used to override the value or bypass defining meta tags.
+         */
+        pageType?: string;
+    }
+
+    /**
+     * Custom Data Tags Configuration
+     */
+    interface ICustomDataTags {
+        /**
+         * When a particular element is not tagged with content name prefix or content name prefix is not provided by user, this flag is used to collect standard HTML attribute for contentName and id.
+         */
+        useDefaultContentNameOrId?: boolean;
+        /**
+         * Automatic capture content name and value of elements which are tagged with provided prefix
+         */
+        customDataPrefix?: string;
+        /**
+         * Click Analytics supports a JSON blob content meta data tagging instead of individual data-* attributes. The default attribute is data-ai-blob. This property allows for changing that attribute name.
+         */
+        aiBlobAttributeTag?: string;
+        /**
+         * Automatic capture metadata name and content with provided prefix
+         */
+        metaDataPrefix?: string;
+        /**
+         * Automatic capture all metadata names and content. Default is false. If enabled this will override provided metaTagPrefix.
+         */
+        captureAllMetaDataContent?: boolean;
+        /**
+         * Stop traversing up the DOM to capture content name and value of elements when encountered with this tag
+         */
+        parentDataTag?: string;
+        /**
+         * Custom attribute Tag to not track telemetry data
+         */
+        dntDataTag?: string;
+    }
+
     /**
      * Page Action event
      */
@@ -93,5 +199,39 @@ declare namespace ApplicationInsights {
         parentId?: string;
     }
 
+    /**
+     * PageTags format
+     */
+    interface IPageTags {
+        /**
+         * Meta data tags
+         */
+        metaTags?: {
+            [name: string]: string;
+        };
+        /**
+         * Any other page tag
+         */
+        [name: string]: string | number | boolean | string[] | number[] | boolean[] | object | undefined;
+    }
+
+    /**
+     * Value Callbacks configuration
+     */
+    interface IValueCallback {
+        /**
+         * Function to override the default pageName capturing behavior.
+         */
+        pageName?: () => string;
+        /**
+         * A callback function to augument the default pageTags collected during pageAction event.
+         */
+        pageActionPageTags?: (element?: Element) => IPageTags;
+        /**
+         * A callback function to populate customized contentName.
+         */
+        contentName?: (element?: any, useDefaultContentName?: boolean) => string;
+    }
+
     
 }

package/dist/applicationinsights-clickanalytics-js.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - Click Analytics, 2.8.15-nightly.2307-19
+ * Application Insights JavaScript SDK - Click Analytics, 2.8.15-nightly.2307-26
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -1191,7 +1191,7 @@
     }
 
     var _objDefineProperty = ObjDefineProperty;
-    var version = "2.8.15-nightly.2307-19";
+    var version = "2.8.15-nightly.2307-26";
     var instanceName = "." + newId(6);
     var _dataUid = 0;
     function _createAccessor(target, prop, value) {
@@ -3034,7 +3034,7 @@
             }
             return _this;
         }
-        ClickAnalyticsPlugin.Version = "2.8.15-nightly.2307-19";
+        ClickAnalyticsPlugin.Version = "2.8.15-nightly.2307-26";
         return ClickAnalyticsPlugin;
     }(BaseTelemetryPlugin));