@microsoft/applicationinsights-clickanalytics-js 2.8.0-beta.2203-08 → 2.8.0-beta.2203-11

package/src/handlers/AutoCaptureHandler.ts

@@ -2,7 +2,8 @@
  * @copyright Microsoft 2020
  */
 
-import { IDiagnosticLogger, _InternalMessageId, getWindow, getDocument, isNullOrUndefined, attachEvent } from "@microsoft/applicationinsights-core-js";
+import dynamicProto from "@microsoft/dynamicproto-js";
+import { IDiagnosticLogger, _InternalMessageId, getWindow, getDocument, isNullOrUndefined, attachEvent, IProcessTelemetryUnloadContext, ITelemetryUnloadState, mergeEvtNamespace, createUniqueNamespace, eventOn, removePageHideEventListener, removePageUnloadEventListener, 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";
@@ -12,97 +13,106 @@ import { PageAction } from "../events/PageAction";
 const clickCaptureInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
 
 export class AutoCaptureHandler implements IAutoCaptureHandler {
-    
+
     /**
      * @param analyticsPlugin - WebAnalytics plugin
      * @param traceLogger - Trace logger to log to console.
      */
-   constructor(protected _analyticsPlugin: ClickAnalyticsPlugin, protected _config: IClickAnalyticsConfiguration, protected _pageAction: PageAction,
-     protected _traceLogger: IDiagnosticLogger) {
-
-    }
-    // handle automatic event firing on user click
-    public click() {
-        let win = getWindow();
-        let doc = getDocument();
-        if (win) {
-            // IE9 onwards addEventListener is available, 'click' event captures mouse click. mousedown works on other browsers
-            const event = (navigator.appVersion.indexOf("MSIE") !== -1) ? "click" : "mousedown";
-            attachEvent(win, event , (evt:any) => { this._processClick(evt); });
-            attachEvent(win, "keyup" , (evt:any) => { this._processClick(evt); });
-        } else if (doc) {
-            // IE8 and below doesn't have addEventListener so it will use attachEvent
-            // attaching to window does not work in IE8
-            attachEvent(doc, "click" , (evt:any) => { this._processClick(evt); });
-            attachEvent(doc, "keyup" , (evt:any) => { this._processClick(evt); });
-        }
-    }
+    constructor(protected _analyticsPlugin: ClickAnalyticsPlugin, protected _config: IClickAnalyticsConfiguration, protected _pageAction: PageAction,
+        protected _traceLogger: IDiagnosticLogger) {
 
-    /**
-     * API to create and send a populated PageAction event
-     * @param element - DOM element
-     * @param overrideValues - PageAction overrides
-     * @param customProperties - Custom properties(Part C)
-     * @param isRightClick - Flag for mouse right clicks
-     */
-    private capturePageAction(element: Element, overrideValues?: IPageActionOverrideValues, customProperties?: { [name: string]: string | number | boolean | string[] | number[] | boolean[] | object }, isRightClick?: boolean): void {
-        const donotTrackTag = this._config.dataTags.customDataPrefix + this._config.dataTags.dntDataTag;
-        if (!isElementDnt(element, donotTrackTag)) {
-            this._pageAction.capturePageAction(element, overrideValues, customProperties, isRightClick);
-        }
+        let _evtNamespace = mergeEvtNamespace(createUniqueNamespace("AutoCaptureHandler"), (_analyticsPlugin as any)._evtNamespace);
 
-    }
+        dynamicProto(AutoCaptureHandler, this, (_self) => {
 
-    // Process click event
-    private _processClick(clickEvent: any) {
-        var clickCaptureElements = { A: true, BUTTON: true, AREA: true, INPUT: true };
-        let win = getWindow();
-        if(isNullOrUndefined(clickEvent) && win) {
-            clickEvent = win.event; // IE 8 does not pass the event
-        }
-        if(clickEvent) {
-            let element = clickEvent.srcElement || clickEvent.target;
+            _self.click = () => {
+                let win = getWindow();
+                let doc = getDocument();
+                if (win) {
+                    // IE9 onwards addEventListener is available, 'click' event captures mouse click. mousedown works on other browsers
+                    const event = (navigator.appVersion.indexOf("MSIE") !== -1) ? "click" : "mousedown";
+                    eventOn(win, event, _processClick, _evtNamespace);
+                    eventOn(win, "keyup", _processClick, _evtNamespace);
+                } else if (doc) {
+                    // IE8 and below doesn't have addEventListener so it will use attachEvent
+                    // attaching to window does not work in IE8
+                    eventOn(doc, "click", _processClick, _evtNamespace);
+                    eventOn(doc, "keyup", _processClick, _evtNamespace);
+                }
+            };
 
-            // populate overrideValues
-            var overrideValues: IPageActionOverrideValues = {
-                clickCoordinateX: clickEvent.pageX,
-                clickCoordinateY: clickEvent.pageY
+            _self._doUnload = (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean => {
+                eventOff(getWindow(), null, null, _evtNamespace);
+                eventOff(getDocument(), null, null, _evtNamespace);
             };
-            var isRightClickObj = isRightClick(clickEvent as MouseEvent);
-            if (isRightClickObj) {
-                overrideValues.actionType = ActionType.CLICKRIGHT;
-            } else if (isLeftClick(clickEvent as MouseEvent)) {
-                overrideValues.actionType = ActionType.CLICKLEFT;
-            } else if (isKeyboardEnter(clickEvent as KeyboardEvent)) {
-                overrideValues.actionType = ActionType.KEYBOARDENTER;
-            } else if (isKeyboardSpace(clickEvent as KeyboardEvent)) {
-                overrideValues.actionType = ActionType.KEYBOARDSPACE;
-            } else if (isMiddleClick(clickEvent as MouseEvent)) {
-                overrideValues.actionType = ActionType.CLICKMIDDLE;
-            } else {
-                return;
+
+            function _capturePageAction(element: Element, overrideValues?: IPageActionOverrideValues, customProperties?: { [name: string]: string | number | boolean | string[] | number[] | boolean[] | object }, isRightClick?: boolean): void {
+                const donotTrackTag = _self._config.dataTags.customDataPrefix + _self._config.dataTags.dntDataTag;
+                if (!isElementDnt(element, donotTrackTag)) {
+                    _self._pageAction.capturePageAction(element, overrideValues, customProperties, isRightClick);
+                }
             }
-    
-            while (element && element.tagName) {
-                // control property will be available for <label> elements with 'for' attribute, only use it when is a
-                // valid JSLL capture element to avoid infinite loops
-                if (element.control && clickCaptureElements[element.control.tagName.toUpperCase()]) {
-                    element = element.control;
+        
+            // Process click event
+            function _processClick(clickEvent: any) {
+                var clickCaptureElements = { A: true, BUTTON: true, AREA: true, INPUT: true };
+                let win = getWindow();
+                if (isNullOrUndefined(clickEvent) && win) {
+                    clickEvent = win.event; // IE 8 does not pass the event
                 }
-                const tagNameUpperCased = element.tagName.toUpperCase();
-                if (!clickCaptureElements[tagNameUpperCased]) {
-                    element = element.parentElement || element.parentNode;
-                    continue;
-                } else {
-                    // Check allowed INPUT types
-                    var sendEvent = tagNameUpperCased === "INPUT" ? clickCaptureInputTypes[element.type.toUpperCase()] : true;
-                    if (sendEvent) {
-                        this.capturePageAction(element, overrideValues, {}, isRightClickObj);
+                if (clickEvent) {
+                    let element = clickEvent.srcElement || clickEvent.target;
+        
+                    // populate overrideValues
+                    var overrideValues: IPageActionOverrideValues = {
+                        clickCoordinateX: clickEvent.pageX,
+                        clickCoordinateY: clickEvent.pageY
+                    };
+                    var isRightClickObj = isRightClick(clickEvent as MouseEvent);
+                    if (isRightClickObj) {
+                        overrideValues.actionType = ActionType.CLICKRIGHT;
+                    } else if (isLeftClick(clickEvent as MouseEvent)) {
+                        overrideValues.actionType = ActionType.CLICKLEFT;
+                    } else if (isKeyboardEnter(clickEvent as KeyboardEvent)) {
+                        overrideValues.actionType = ActionType.KEYBOARDENTER;
+                    } else if (isKeyboardSpace(clickEvent as KeyboardEvent)) {
+                        overrideValues.actionType = ActionType.KEYBOARDSPACE;
+                    } else if (isMiddleClick(clickEvent as MouseEvent)) {
+                        overrideValues.actionType = ActionType.CLICKMIDDLE;
+                    } else {
+                        return;
+                    }
+        
+                    while (element && element.tagName) {
+                        // control property will be available for <label> elements with 'for' attribute, only use it when is a
+                        // valid JSLL capture element to avoid infinite loops
+                        if (element.control && clickCaptureElements[element.control.tagName.toUpperCase()]) {
+                            element = element.control;
+                        }
+                        const tagNameUpperCased = element.tagName.toUpperCase();
+                        if (!clickCaptureElements[tagNameUpperCased]) {
+                            element = element.parentElement || element.parentNode;
+                            continue;
+                        } else {
+                            // Check allowed INPUT types
+                            var sendEvent = tagNameUpperCased === "INPUT" ? clickCaptureInputTypes[element.type.toUpperCase()] : true;
+                            if (sendEvent) {
+                                _capturePageAction(element, overrideValues, {}, isRightClickObj);
+                            }
+                            break;
+                        }
                     }
-                    break;
                 }
             }
-        }
-        
+        });
+    }
+
+    // handle automatic event firing on user click
+    public click() {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
+    }
+
+    public _doUnload(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean {
+        // @DynamicProtoStub -- DO NOT add any code as this will be removed during packaging
     }
 }