@microsoft/applicationinsights-clickanalytics-js 2.8.5-nightly.2206-03 → 2.8.5-nightly.2207-01

package/src/common/Utils.ts

@@ -1,25 +1,34 @@
-/**
- * @copyright Microsoft 2020
- * File containing utility functions.
- */
-
-import { isNullOrUndefined, _InternalMessageId, hasDocument, hasOwnProperty, arrForEach } from "@microsoft/applicationinsights-core-js";
-import {
-    IClickAnalyticsConfiguration
-} from "../Interfaces/Datamodel";
-
-
-const Prototype = "prototype";
+/**
+* @copyright Microsoft 2020
+* File containing utility functions.
+*/
+
+import {
+    _InternalMessageId, _eInternalMessageId, arrForEach, createEnumStyle, hasDocument, hasOwnProperty, isNullOrUndefined, objExtend
+} from "@microsoft/applicationinsights-core-js";
+import { IClickAnalyticsConfiguration } from "../Interfaces/Datamodel";
+
 const DEFAULT_DONOT_TRACK_TAG = "ai-dnt";
 const DEFAULT_AI_BLOB_ATTRIBUTE_TAG = "ai-blob";
 const DEFAULT_DATA_PREFIX = "data-";
 
+export const enum _eExtendedInternalMessageId {
+    CannotParseAiBlobValue = 101,
+    InvalidContentBlob = 102,
+    TrackPageActionEventFailed = 103
+}
+
 export const _ExtendedInternalMessageId = {
     ..._InternalMessageId,
-    CannotParseAiBlobValue: 101,
-    InvalidContentBlob: 102,
-    TrackPageActionEventFailed: 103
-};
+    ...createEnumStyle<typeof _eExtendedInternalMessageId>({
+        CannotParseAiBlobValue: _eExtendedInternalMessageId.CannotParseAiBlobValue,
+        InvalidContentBlob: _eExtendedInternalMessageId.InvalidContentBlob,
+        TrackPageActionEventFailed: _eExtendedInternalMessageId.TrackPageActionEventFailed
+    })
+}
+
+export type _ExtendedInternalMessageId = number | _eExtendedInternalMessageId | _eInternalMessageId;
+
 
 /**
  * Finds attributes in overrideConfig which are invalid or should be objects
@@ -30,7 +39,7 @@ export const _ExtendedInternalMessageId = {
 export function removeNonObjectsAndInvalidElements(overrideConfig: IClickAnalyticsConfiguration, attributeNamesExpectedObjects: Array<string>): void {
     removeInvalidElements(overrideConfig);
     for (var i in attributeNamesExpectedObjects) {
-        if (attributeNamesExpectedObjects.hasOwnProperty(i)) {
+        if (hasOwnProperty(attributeNamesExpectedObjects, i)) {
             var objectName = attributeNamesExpectedObjects[i];
             if (typeof overrideConfig[objectName] === "object") {
                 removeInvalidElements(overrideConfig[objectName]);
@@ -258,54 +267,6 @@ export function bracketIt(str: string): string {
     return "[" + str + "]";
 }
 
-/**
- * Pass in the objects to merge as arguments.
- * @param obj1 - object to merge.  Set this argument to 'true' for a deep extend.
- * @param obj2 - object to merge.
- * @param obj3 - object to merge.
- * @param obj4 - object to merge.
- * @param obj5 - object to merge.
- * @returns The extended object.
- */
-export function extend(obj?: any, obj2?: any, obj3?: any, obj4?: any, obj5?: any): any {
-    // Variables
-    var extended = {};
-    var deep = false;
-    var i = 0;
-    var length = arguments.length;
-    var objProto = Object[Prototype];
-    var theArgs = arguments;
-
-    // Check if a deep merge
-    if (objProto.toString.call(theArgs[0]) === "[object Boolean]") {
-        deep = theArgs[0];
-        i++;
-    }
-
-    // Merge the object into the extended object
-    var merge = (obj: Object) => {
-        for (var prop in obj) {
-            if (hasOwnProperty(obj, prop)) {
-                // If deep merge and property is an object, merge properties
-                if (deep && objProto.toString.call(obj[prop]) === "[object Object]") {
-                    extended[prop] = extend(true, extended[prop], obj[prop]);
-                } else {
-                    extended[prop] = obj[prop];
-                }
-            }
-        }
-    };
-
-    // Loop through each object and conduct a merge
-    for (; i < length; i++) {
-        var obj = theArgs[i];
-        merge(obj);
-    }
-
-    return extended;
-
-}
-
 export function validateContentNamePrefix ( config: IClickAnalyticsConfiguration, defaultDataPrefix: string) {
     return isValueAssigned(config.dataTags.customDataPrefix) && (config.dataTags.customDataPrefix.indexOf(defaultDataPrefix) === 0);
 }
@@ -355,7 +316,7 @@ export function mergeConfig(overrideConfig: IClickAnalyticsConfiguration): IClic
         if(isValueAssigned(overrideConfig.dataTags)) {
             overrideConfig.dataTags.customDataPrefix = validateContentNamePrefix(overrideConfig, DEFAULT_DATA_PREFIX) ? overrideConfig.dataTags.customDataPrefix : DEFAULT_DATA_PREFIX;
         }
-        return extend(true, defaultConfig, overrideConfig);
+        return objExtend(true, defaultConfig, overrideConfig);
     }
 }
 
@@ -379,6 +340,4 @@ export function BehaviorValueValidator (behaviorArray: string[]) {
 
 export function BehaviorEnumValidator (enumObj: any) {
     return (key: string)  => enumObj[key] || "";
-}
-
-
+}

package/src/events/PageAction.ts

@@ -1,16 +1,19 @@
-/**
- * @copyright Microsoft 2020
- */
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import { WebEvent } from "./WebEvent";
-import * as DataCollector from "../DataCollector";
-import { ITelemetryItem, getPerformance, ICustomProperties, eLoggingSeverity, _eInternalMessageId, objForEachKey, IDiagnosticLogger, _throwInternal } from "@microsoft/applicationinsights-core-js"
-import { IClickAnalyticsConfiguration, IContentHandler, IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
-import { extractFieldFromObject, bracketIt, isValueAssigned, extend  } from "../common/Utils";
-import { strNotSpecified } from "@microsoft/applicationinsights-common";
-import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
-
+/**
+* @copyright Microsoft 2020
+*/
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import { strNotSpecified } from "@microsoft/applicationinsights-common";
+import {
+    ICustomProperties, IDiagnosticLogger, ITelemetryItem, _eInternalMessageId, _throwInternal, eLoggingSeverity, getPerformance, objExtend,
+    objForEachKey
+} from "@microsoft/applicationinsights-core-js";
+import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { getClickTarget } from "../DataCollector";
+import { IClickAnalyticsConfiguration, IContentHandler, IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
+import { bracketIt, extractFieldFromObject, isValueAssigned } from "../common/Utils";
+import { WebEvent } from "./WebEvent";
+
 export class PageAction extends WebEvent {
     
     constructor(
@@ -84,7 +87,7 @@ export class PageAction extends WebEvent {
                 }
                 // Fill PartB
                 if (element) {
-                    pageActionEvent.targetUri = DataCollector.getClickTarget(element);
+                    pageActionEvent.targetUri = getClickTarget(element);
         
                     elementContent = _self._contentHandler.getElementContent(element); // collect id,cn tags
         
@@ -116,7 +119,7 @@ export class PageAction extends WebEvent {
                 }
         
                 _sanitizePageActionEventContent(elementContent);
-                pageActionEvent.content = bracketIt(JSON.stringify(extend(
+                pageActionEvent.content = bracketIt(JSON.stringify(objExtend(
                     elementContent,
                     overrideValues && overrideValues.contentTags ? overrideValues.contentTags : {})));
         
@@ -191,4 +194,4 @@ export class PageAction extends WebEvent {
     public capturePageAction(element: Element, overrideValues?: IPageActionOverrideValues, customProperties?: { [name: string]: string | number | boolean | string[] | number[] | boolean[] | object }, isRightClick?: boolean): void {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
-}
+}

package/src/events/WebEvent.ts

@@ -1,16 +1,18 @@
-/**
- * @copyright Microsoft 2020
- */
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import {
-    isValueAssigned, extend
-} from "../common/Utils";
-import * as DataCollector from "../DataCollector";
-import { IDiagnosticLogger, getLocation, hasWindow, IUnloadableComponent, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
-import { IClickAnalyticsConfiguration, IPageTags, IOverrideValues, IContentHandler, ICoreData, IPageActionTelemetry } from "../Interfaces/Datamodel";
-import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
-
+/**
+* @copyright Microsoft 2020
+*/
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import {
+    IDiagnosticLogger, IProcessTelemetryUnloadContext, ITelemetryUnloadState, IUnloadableComponent, getLocation, hasWindow, objExtend
+} from "@microsoft/applicationinsights-core-js";
+import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { getPageName, getUri } from "../DataCollector";
+import {
+    IClickAnalyticsConfiguration, IContentHandler, ICoreData, IOverrideValues, IPageActionTelemetry, IPageTags
+} from "../Interfaces/Datamodel";
+import { isValueAssigned } from "../common/Utils";
+
 export class WebEvent implements IUnloadableComponent {
 
     protected _pageTags: IPageTags;
@@ -56,10 +58,10 @@ export class WebEvent implements IUnloadableComponent {
 
             _self.setBasicProperties = (event: IPageActionTelemetry, overrideValues: IOverrideValues) => {
                 if (!isValueAssigned(event.name)) {
-                    event.pageName = DataCollector.getPageName(_self._config, overrideValues);
+                    event.pageName = getPageName(_self._config, overrideValues);
                 }
                 if (!isValueAssigned(event.uri) && hasWindow) {
-                    event.uri = DataCollector.getUri(_self._config, getLocation());
+                    event.uri = getUri(_self._config, getLocation());
                 }
             };
         
@@ -93,10 +95,10 @@ export class WebEvent implements IUnloadableComponent {
                 // Prepare the pageTags object that is mostly the same for all events.  Event specific pageTags will be added inside event constructors.
                
                 if (_self._pageTagsCallback) {
-                    _self._pageTags = extend(true, _self._pageTags, _self._pageTagsCallback());
+                    _self._pageTags = objExtend(true, _self._pageTags, _self._pageTagsCallback());
                 }
                 if (isValueAssigned(overrideValues.pageTags)) {
-                    _self._pageTags = extend(true, _self._pageTags, overrideValues.pageTags);
+                    _self._pageTags = objExtend(true, _self._pageTags, overrideValues.pageTags);
                 }
                 // If metadata is present add it to pageTags property
                 if (_self._metaTags) {
@@ -197,4 +199,4 @@ export class WebEvent implements IUnloadableComponent {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
         return null;
     }
-}
+}

package/src/handlers/AutoCaptureHandler.ts

@@ -1,18 +1,18 @@
-/**
- * @copyright Microsoft 2020
- */
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import {
-    IDiagnosticLogger, getWindow, getDocument, isNullOrUndefined, IProcessTelemetryUnloadContext, ITelemetryUnloadState,
-    mergeEvtNamespace, createUniqueNamespace, eventOn, eventOff
-} from "@microsoft/applicationinsights-core-js";
-import { IAutoCaptureHandler, IPageActionOverrideValues, IClickAnalyticsConfiguration } from "../Interfaces/Datamodel"
-import { isRightClick, isLeftClick, isKeyboardEnter, isKeyboardSpace, isMiddleClick, isElementDnt } from "../common/Utils";
-import { ActionType } from "../Enums";
-import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
-import { PageAction } from "../events/PageAction";
-
+/**
+* @copyright Microsoft 2020
+*/
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import {
+    IDiagnosticLogger, IProcessTelemetryUnloadContext, ITelemetryUnloadState, createUniqueNamespace, eventOff, eventOn, getDocument,
+    getWindow, isNullOrUndefined, mergeEvtNamespace
+} from "@microsoft/applicationinsights-core-js";
+import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { ActionType } from "../Enums";
+import { IAutoCaptureHandler, IClickAnalyticsConfiguration, IPageActionOverrideValues } from "../Interfaces/Datamodel";
+import { isElementDnt, isKeyboardEnter, isKeyboardSpace, isLeftClick, isMiddleClick, isRightClick } from "../common/Utils";
+import { PageAction } from "../events/PageAction";
+
 const clickCaptureInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
 
 export class AutoCaptureHandler implements IAutoCaptureHandler {
@@ -118,4 +118,4 @@ export class AutoCaptureHandler implements IAutoCaptureHandler {
     public _doUnload(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
-}
+}

package/src/handlers/DomContentHandler.ts

@@ -1,16 +1,14 @@
-/**
- * @copyright Microsoft 2020
- */
-
-import dynamicProto from "@microsoft/dynamicproto-js";
-import {
-    removeInvalidElements,
-    walkUpDomChainWithElementValidation,
-    extend, isValueAssigned
-} from "../common/Utils";
-import { IDiagnosticLogger, eLoggingSeverity, getDocument, isNullOrUndefined, hasDocument, _throwInternal, _eInternalMessageId } from "@microsoft/applicationinsights-core-js";
-import { IClickAnalyticsConfiguration, IContent, IContentHandler } from "../Interfaces/Datamodel";
-
+/**
+* @copyright Microsoft 2020
+*/
+
+import dynamicProto from "@microsoft/dynamicproto-js";
+import {
+    IDiagnosticLogger, _eInternalMessageId, _throwInternal, eLoggingSeverity, getDocument, hasDocument, isNullOrUndefined, objExtend
+} from "@microsoft/applicationinsights-core-js";
+import { IClickAnalyticsConfiguration, IContent, IContentHandler } from "../Interfaces/Datamodel";
+import { isValueAssigned, removeInvalidElements, walkUpDomChainWithElementValidation } from "../common/Utils";
+
 const MAX_CONTENTNAME_LENGTH = 200;
 
 export class DomContentHandler implements IContentHandler {
@@ -64,16 +62,16 @@ export class DomContentHandler implements IContentHandler {
                     } else {
                         // traverse up the DOM to find the closest parent with data-* tag defined
                         //contentElement = walkUpDomChainWithElementValidation(element, _self._isTracked, dataTagPrefix);
-                        elementContent = extend(elementContent, _populateElementContent(element, dataTagPrefix, parentDataTagPrefix, aiBlobAttributeTag));
+                        elementContent = objExtend(elementContent, _populateElementContent(element, dataTagPrefix, parentDataTagPrefix, aiBlobAttributeTag));
                     }
                 } else {
-                    elementContent = extend(elementContent, _populateElementContentwithDataTag(element, dataTagPrefix, parentDataTagPrefix, aiBlobAttributeTag));
+                    elementContent = objExtend(elementContent, _populateElementContentwithDataTag(element, dataTagPrefix, parentDataTagPrefix, aiBlobAttributeTag));
                 }
 
                 removeInvalidElements(elementContent);
 
                 if (parentDataTagPrefix) {
-                    elementContent = extend(elementContent, _getParentDetails(element, elementContent, dataTagPrefix, aiBlobAttributeTag ));
+                    elementContent = objExtend(elementContent, _getParentDetails(element, elementContent, dataTagPrefix, aiBlobAttributeTag ));
                 }
         
                 return elementContent;
@@ -394,4 +392,4 @@ export class DomContentHandler implements IContentHandler {
         // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
         return null;
     }
-}
+}

package/types/ClickAnalyticsPlugin.d.ts

@@ -1,10 +1,10 @@
 /**
- * @copyright Microsoft 2020
- */
-import { IPlugin, IConfiguration, IAppInsightsCore, BaseTelemetryPlugin, ITelemetryItem, IProcessTelemetryContext, ITelemetryPluginChain, ICustomProperties } from "@microsoft/applicationinsights-core-js";
+* @copyright Microsoft 2020
+*/
 import { IConfig } from "@microsoft/applicationinsights-common";
+import { BaseTelemetryPlugin, IAppInsightsCore, IConfiguration, ICustomProperties, IPlugin, IProcessTelemetryContext, ITelemetryItem, ITelemetryPluginChain } from "@microsoft/applicationinsights-core-js";
 import { IPageActionTelemetry } from "./Interfaces/Datamodel";
-import { BehaviorMapValidator, BehaviorValueValidator, BehaviorEnumValidator } from "./common/Utils";
+import { BehaviorEnumValidator, BehaviorMapValidator, BehaviorValueValidator } from "./common/Utils";
 export { BehaviorMapValidator, BehaviorValueValidator, BehaviorEnumValidator };
 export declare class ClickAnalyticsPlugin extends BaseTelemetryPlugin {
     identifier: string;

package/types/DataCollector.d.ts

@@ -1,6 +1,6 @@
 /**
- * @copyright Microsoft 2020
- */
+* @copyright Microsoft 2020
+*/
 import { IClickAnalyticsConfiguration, IOverrideValues } from "./Interfaces/Datamodel";
 /**
  * Get Image href of a given HTMLImageElement

package/types/__DynamicConstants.d.ts

@@ -0,0 +1,48 @@
+export declare const _DYN_EXTENSION_CONFIG = "extensionConfig";
+export declare const _DYN_PAGE_ACTION_PAGE_TAG0 = "pageActionPageTags";
+export declare const _DYN_TRACK_PAGE_ACTION = "trackPageAction";
+export declare const _DYN_LENGTH = "length";
+export declare const _DYN_TAG_NAME = "tagName";
+export declare const _DYN_TO_UPPER_CASE = "toUpperCase";
+export declare const _DYN_PATHNAME = "pathname";
+export declare const _DYN_ADD_EVENT_LISTENER = "addEventListener";
+export declare const _DYN_PAGE_NAME = "pageName";
+export declare const _DYN_CORE_DATA = "coreData";
+export declare const _DYN_REQUEST_URI = "requestUri";
+export declare const _DYN_GET_ATTRIBUTE = "getAttribute";
+export declare const _DYN_PARENT_NODE = "parentNode";
+export declare const _DYN_CUSTOM_DATA_PREFIX = "customDataPrefix";
+export declare const _DYN_INDEX_OF = "indexOf";
+export declare const _DYN_DATA_TAGS = "dataTags";
+export declare const _DYN_USE_DEFAULT_CONTENT_1 = "useDefaultContentNameOrId";
+export declare const _DYN_AI_BLOB_ATTRIBUTE_TA2 = "aiBlobAttributeTag";
+export declare const _DYN_CAPTURE_ALL_META_DAT3 = "captureAllMetaDataContent";
+export declare const _DYN_BEHAVIOR_VALIDATOR = "behaviorValidator";
+export declare const _DYN_NAME = "name";
+export declare const _DYN_DATA = "data";
+export declare const _DYN_PAGE_TYPE = "pageType";
+export declare const _DYN_PROPERTIES = "properties";
+export declare const _DYN_ACTION_TYPE = "actionType";
+export declare const _DYN_BEHAVIOR = "behavior";
+export declare const _DYN_CLICK_COORDINATES = "clickCoordinates";
+export declare const _DYN_CONTENT = "content";
+export declare const _DYN_REF_URI = "refUri";
+export declare const _DYN_PARENT_ID = "parentId";
+export declare const _DYN_CAPTURE_PAGE_ACTION = "capturePageAction";
+export declare const _DYN_SET_COMMON_PROPERTIE4 = "setCommonProperties";
+export declare const _DYN_GET_ELEMENT_CONTENT = "getElementContent";
+export declare const _DYN__GET_VALID_BEHAVIOR = "_getValidBehavior";
+export declare const _DYN_CONTENT_NAME = "contentName";
+export declare const _DYN__TRACE_LOGGER = "_traceLogger";
+export declare const _DYN_CLICK_COORDINATE_X = "clickCoordinateX";
+export declare const _DYN_CLICK_COORDINATE_Y = "clickCoordinateY";
+export declare const _DYN__CONFIG = "_config";
+export declare const _DYN_PARENT_DATA_TAG = "parentDataTag";
+export declare const _DYN__PAGE_TAGS = "_pageTags";
+export declare const _DYN__PAGE_TAGS_CALLBACK = "_pageTagsCallback";
+export declare const _DYN__META_TAGS = "_metaTags";
+export declare const _DYN_SET_BASIC_PROPERTIES = "setBasicProperties";
+export declare const _DYN__PAGE_TYPE_META_TAG = "_pageTypeMetaTag";
+export declare const _DYN__BEHAVIOR_META_TAG = "_behaviorMetaTag";
+export declare const _DYN_PARENT_ELEMENT = "parentElement";
+export declare const _DYN_ATTRIBUTES = "attributes";