@microsoft/applicationinsights-clickanalytics-js 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/src/DataCollector.ts

@@ -1,159 +0,0 @@
-/**
-* @copyright Microsoft 2020
-*/
-
-import { getDocument, getLocation, getWindow, hasDocument, isFunction } from "@microsoft/applicationinsights-core-js";
-import { scheduleTimeout } from "@nevware21/ts-utils";
-import { IClickAnalyticsConfiguration, IOverrideValues } from "./Interfaces/Datamodel";
-import { findClosestAnchor, isValueAssigned } from "./common/Utils";
-
-var clickCaptureInputTypes = { BUTTON: true, CHECKBOX: true, RADIO: true, RESET: true, SUBMIT: true };
-
-
-/**
- * Get Image href of a given HTMLImageElement
- * @param element - An html image element
- * @returns Href value.
- */
-export function getImageHref(element: HTMLImageElement): string {
-    var temp = element;
-    if (temp) {
-        var parent = findClosestAnchor(temp as Element);
-        if ((parent as any).length === 1) {
-            const firstParent = parent[0];
-            if (firstParent.href) {
-                return firstParent.href;
-            } else if (firstParent.src) {
-                return (firstParent.src);
-            }
-        }
-    }
-    return "";
-}
-
-
-/**
- * Get click target
- * @returns Click target URI
- */
-export function getClickTarget(element: any) {
-    var clickTarget = "";
-    switch (element.tagName) {
-    case "A":
-    case "AREA":
-        clickTarget = element.href || "";
-        break;
-    case "IMG":
-        clickTarget = getImageHref(element as HTMLImageElement);
-        break;
-    case "INPUT":
-        var type = element.type;
-        if (type && (clickCaptureInputTypes[type.toUpperCase()])) {
-            let loc = getLocation() || ({} as Location);
-            if (element.form) {
-                clickTarget = element.form.action || (loc.pathname || "");
-            } else {
-                clickTarget = loc.pathname || "";
-            }
-        }
-        break;
-    default:
-        break;
-    }
-    return clickTarget;
-}
-
-/**
- * Execute callback when DOM finish loading
- */
-export function onDomLoaded(callback: () => void) {
-    onDomReadyDo(() => {
-        if (hasDocument && document.readyState === "complete") {
-            callback();
-        } else {
-            let win = getWindow();
-            if (win) {
-                if (win.addEventListener) {
-                    win.addEventListener("load", () => {
-                        callback();
-                    }); // NB **not** 'onload'
-                } else if ((win as any).attachEvent) {
-                    (win as any).attachEvent("onload", () => {
-                        callback();
-                    }); // IE8
-                }
-            }
-        }
-    });
-}
-
-// use smallest domready ever for IE8. When IE8 is deprecated, use addEventListener('DomContentLoaded')
-function onDomReadyDo(f: any) {
-    /// <summary> fires function f on domRead </summary>
-    /// <param type='function'>function to call on domRead</param>
-
-    let doc = getDocument() || ({} as Document);
-    /in/.test(doc.readyState) ? scheduleTimeout(() => {
-        onDomReadyDo(f);
-    }, 100) : f.call();
-}
-
-/**
- * Gets the pageName from the DOM or by calling a override if set.
- * @param config - configuration object
- * @returns Page name.
- */
-export function getPageName(config: IClickAnalyticsConfiguration, overrideValues: IOverrideValues) {
-    /// <summary>
-    ///  Gets the pageName from the DOM or by calling a override if set.
-    /// </summary>
-
-    if (overrideValues && overrideValues.pageName) {
-        return overrideValues.pageName;
-    } else if (config.callback && isFunction(config.callback.pageName)) {
-        return config.callback.pageName();
-    } else if (config.coreData && config.coreData.pageName) {
-        return config.coreData.pageName;
-    } else {
-        const doc = getDocument();
-        return doc && doc.title || "";
-    }
-}
-
-/**
- * Sanitize URL values
- * @param config - Configuration
- * @param location - window.location or document.location
- * @returns Flag indicating if an element is market PII.
- */
-export function sanitizeUrl(config: IClickAnalyticsConfiguration, location: Location): string {
-    if (!location) {
-        return null;
-    }
-    var url = location.protocol + "//" + (location.hostname || location.host) +         // location.hostname is not supported on Opera and Opera for Android
-        (isValueAssigned(location.port) ? ":" + location.port : "") +
-        location.pathname;
-        
-    if (!!config.urlCollectHash) { // false by default
-        url += (isValueAssigned(location.hash)? location.hash : "");
-    }
-
-    if (!!config.urlCollectQuery) { // false by default
-        url += (isValueAssigned(location.search)? location.search : "");
-    }
-
-    return url;
-}
-
-/**
- * Get URI, sanitize the value if configured on
- * @param config - Configuration
- * @param location - window.location or document.location
- * @returns Flag indicating if an element is market PII.
- */
-export function getUri(config: IClickAnalyticsConfiguration, location: any): string {
-    if (config.coreData && config.coreData.requestUri && config.coreData.requestUri !== "") {
-        return config.coreData.requestUri;
-    }
-    return sanitizeUrl(config, location);
-}

package/src/Enums.ts

@@ -1,15 +0,0 @@
-/**
- * @copyright Microsoft 2020
- */
-
-export const ActionType = {
-    CLICKLEFT: "CL",
-    CLICKRIGHT: "CR",
-    CLICKMIDDLE: "CM",
-    SCROLL: "S",
-    ZOOM: "Z",
-    RESIZE: "R",
-    KEYBOARDENTER: "KE",
-    KEYBOARDSPACE: "KS",
-    OTHER: "O"
-};

package/src/Interfaces/Datamodel.ts

@@ -1,300 +0,0 @@
-/**
- * @copyright Microsoft 2020
- */
-
-import { IEventTelemetry } from "@microsoft/applicationinsights-common";
-import { IUnloadableComponent } from "@microsoft/applicationinsights-core-js";
-
-/**
- * ClickAnalytics Configuration
- */
-export 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;
-}
-
-/**
- * Custom Data Tags Configuration
- */
-export 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
-}
-
-/**
- * Core data configuration
- */
-export 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;
-}
-
-
-/**
- * Value Callbacks configuration
- */
-export 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;
-}
-
-
-/**
- * PageTags format
- */
-export interface IPageTags {
-    /**
-     * Meta data tags
-     */
-    metaTags?: { [name: string]: string };
-    /**
-     * Any other page tag
-     */
-    [name: string]: string | number | boolean | string[] | number[] | boolean[] | object | undefined;
-}
-
-/**
- * Auto capture handler interface
- */
-export interface IAutoCaptureHandler extends IUnloadableComponent {
-    /**
-     * Auto capture click
-     */
-    click: () => void;
-}
-
-export interface IPageActionOverrideValues extends IOverrideValues {
-    /**
-     * Uri of the referrer page
-     */
-    refUri?: string;
-    /**
-     *  One of the awa.actionType values
-     */
-    actionType?: string;
-    /**
-     * Target uri for PageAction events
-     */
-    targetUri?: string;
-    /**
-     * Click coordinates relative to the top left of the fully rendered content area in the browser
-     */
-    clickCoordinateX?: number;
-    /**
-     * Click coordinates relative to the top left of the fully rendered content area in the browser
-     */
-    clickCoordinateY?: number;
-    /**
-     * KVP of the content
-     */
-    content?: any;
-    /**
-     * KVPs to be added to the content tags collected on a Page Action event; extends the items in the Content blob in Page Action events
-     */
-    contentTags?: any;
-}
-
-/**
- * Override values interface
- */
-export interface IOverrideValues {
-    /**
-     * One of the awa.behavior values.
-     */
-    behavior?: string | number;
-    /**
-     * Page name
-     */
-    pageName?: string;
-    /**
-     * Page type
-     */
-    pageType?: string;
-    /**
-     * KVP to be added to the page tags collected
-     */
-    pageTags?: any;
-    /**
-     * Indicates if the event was fired automatically
-     */
-    isAuto?: boolean;
-}
-
-/**
- * Content interface
- */
-export interface IContent {
-    /**
-     * Friendly name (Content Name) of the content to be used reporting/visualization purposes
-     */
-    cN?: string;
-    /**
-     * Unique identifier (friendly names allowed) of the content (Content Id) as designated by the content provider.
-     * The name should be unique per contentSource such that the two make up the compound key and such that the contentId can be
-     * looked up in the contentSource for additional metadata.
-     */
-    id?: string;
-    /**
-     * User specified custom content properties
-     */
-    [name: string]: string | number | boolean | string[] | number[] | boolean[] | object | undefined;
-}
-
-/**
- * Content handler interface
- */
-export interface IContentHandler extends IUnloadableComponent {
-    /**
-     * Get meta data
-     */
-    getMetadata: () => { [name: string]: string };
-    /**
-     * Get element content
-     */
-    getElementContent: (element: Element) => IContent;
-}
-
-/**
- * Page Action event
- */
-export interface IPageActionTelemetry extends IEventTelemetry {
-    /**
-     * Target uri for PageAction events
-     */
-    targetUri?: string;
-    /**
-     *  One of the awa.actionType values
-     */
-    actionType?: string;
-    /**
-     * One of the awa.behavior values.
-     */
-    behavior?: string | number;
-    /**
-     * X, Y representing the absolute co-ordinates withrespect to topleft corner of the page. This should be normalized for the screen resolution to provide better heat map.
-     */
-    clickCoordinates?: string;
-    /**
-     * JSON-formatted array of content acted upon
-     */
-    content?: any;
-    /**
-     * Version indicating content version which aids in parsing the content.
-     */
-    contentVer?: string;
-    /**
-     * Uri of the referrer, this is a convinence for adaptors to just leverage PageAction for click analytics without linking it to the respective Page Views.
-     */
-    refUri?: string;
-    /**
-     * Time taken in milliseconds since the user saw the page and took the action (such as click on a link, etc.). This will be in seconds.
-     */
-    timeToAction?: number;
-    /**
-     * A relative or absolute URL that identifies the page or other item. Defaults to the window location.
-     */
-    uri?: string;
-    /**
-     * Page type
-     */
-    pageType?: string;
-    /**
-     * Title of the page
-     */
-    pageName?: string;
-    /**
-     * Content Id (Parent Id) of the parent in which the content was located;
-     */
-    parentId?: string;
-}

package/src/__DynamicConstants.ts

@@ -1,61 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-// @skip-file-minify
-
-// ##############################################################
-// AUTO GENERATED FILE: This file is Auto Generated during build.
-// ##############################################################
-
-// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// Note: DON'T Export these const from the package as we are still targeting ES3 this will export a mutable variables that someone could change!!!
-// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-export const _DYN_INDEX_OF = "indexOf";  // Count: 9
-export const _DYN_TRACK_PAGE_ACTION = "trackPageAction";  // Count: 4
-export const _DYN_PAGE_ACTION_PAGE_TAG0 = "pageActionPageTags";  // Count: 2
-export const _DYN__DO_UNLOAD = "_doUnload";  // Count: 3
-export const _DYN_PAGE_NAME = "pageName";  // Count: 10
-export const _DYN_CONTENT_NAME = "contentName";  // Count: 13
-export const _DYN_REQUEST_URI = "requestUri";  // Count: 4
-export const _DYN_PAGE_TYPE = "pageType";  // Count: 7
-export const _DYN_USE_DEFAULT_CONTENT_1 = "useDefaultContentNameOrId";  // Count: 5
-export const _DYN_CAPTURE_ALL_META_DAT2 = "captureAllMetaDataContent";  // Count: 3
-export const _DYN_META_DATA_PREFIX = "metaDataPrefix";  // Count: 3
-export const _DYN_PARENT_DATA_TAG = "parentDataTag";  // Count: 4
-export const _DYN_BEHAVIOR_VALIDATOR = "behaviorValidator";  // Count: 2
-export const _DYN_DEFAULT_RIGHT_CLICK_3 = "defaultRightClickBhvr";  // Count: 2
-export const _DYN_LENGTH = "length";  // Count: 5
-export const _DYN_TAG_NAME = "tagName";  // Count: 4
-export const _DYN_TO_UPPER_CASE = "toUpperCase";  // Count: 4
-export const _DYN_PATHNAME = "pathname";  // Count: 3
-export const _DYN_ADD_EVENT_LISTENER = "addEventListener";  // Count: 2
-export const _DYN_CORE_DATA = "coreData";  // Count: 4
-export const _DYN_GET_ATTRIBUTE = "getAttribute";  // Count: 6
-export const _DYN_PARENT_NODE = "parentNode";  // Count: 3
-export const _DYN_CUSTOM_DATA_PREFIX = "customDataPrefix";  // Count: 3
-export const _DYN_NAME = "name";  // Count: 8
-export const _DYN_DATA = "data";  // Count: 15
-export const _DYN_PROPERTIES = "properties";  // Count: 4
-export const _DYN_ACTION_TYPE = "actionType";  // Count: 9
-export const _DYN_BEHAVIOR = "behavior";  // Count: 7
-export const _DYN_CLICK_COORDINATES = "clickCoordinates";  // Count: 2
-export const _DYN_CONTENT = "content";  // Count: 4
-export const _DYN_REF_URI = "refUri";  // Count: 4
-export const _DYN_PARENT_ID = "parentId";  // Count: 3
-export const _DYN_CAPTURE_PAGE_ACTION = "capturePageAction";  // Count: 2
-export const _DYN_SET_COMMON_PROPERTIE4 = "setCommonProperties";  // Count: 2
-export const _DYN_GET_ELEMENT_CONTENT = "getElementContent";  // Count: 2
-export const _DYN__GET_VALID_BEHAVIOR = "_getValidBehavior";  // Count: 3
-export const _DYN__TRACE_LOGGER = "_traceLogger";  // Count: 3
-export const _DYN_CLICK_COORDINATE_X = "clickCoordinateX";  // Count: 3
-export const _DYN_CLICK_COORDINATE_Y = "clickCoordinateY";  // Count: 3
-export const _DYN__CONFIG = "_config";  // Count: 9
-export const _DYN_DATA_TAGS = "dataTags";  // Count: 6
-export const _DYN__PAGE_TAGS = "_pageTags";  // Count: 6
-export const _DYN__PAGE_TAGS_CALLBACK = "_pageTagsCallback";  // Count: 3
-export const _DYN__META_TAGS = "_metaTags";  // Count: 6
-export const _DYN_SET_BASIC_PROPERTIES = "setBasicProperties";  // Count: 2
-export const _DYN__PAGE_TYPE_META_TAG = "_pageTypeMetaTag";  // Count: 3
-export const _DYN__BEHAVIOR_META_TAG = "_behaviorMetaTag";  // Count: 3
-export const _DYN_PARENT_ELEMENT = "parentElement";  // Count: 3
-export const _DYN_ATTRIBUTES = "attributes";  // Count: 4

package/src/applicationinsights-clickanalytics-js.ts

@@ -1,6 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ClickAnalyticsPlugin, BehaviorMapValidator, BehaviorValueValidator, BehaviorEnumValidator } from "./ClickAnalyticsPlugin";
-export { ClickAnalyticsPlugin, BehaviorMapValidator, BehaviorValueValidator, BehaviorEnumValidator }
-