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

package/types/ClickAnalyticsPlugin.d.ts

@@ -10,10 +10,7 @@ export declare class ClickAnalyticsPlugin extends BaseTelemetryPlugin {
     identifier: string;
     priority: number;
     static Version: string;
-    private _config;
-    private pageAction;
-    private _autoCaptureHandler;
-    private _contentHandler;
+    constructor();
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
     /**

package/types/Interfaces/Datamodel.d.ts

@@ -2,6 +2,7 @@
  * @copyright Microsoft 2020
  */
 import { IEventTelemetry } from "@microsoft/applicationinsights-common";
+import { IUnloadableComponent } from "@microsoft/applicationinsights-core-js";
 /**
  * ClickAnalytics Configuration
  */
@@ -132,7 +133,7 @@ export interface IPageTags {
 /**
  * Auto capture handler interface
  */
-export interface IAutoCaptureHandler {
+export interface IAutoCaptureHandler extends IUnloadableComponent {
     /**
      * Auto capture click
      */
@@ -169,8 +170,8 @@ export interface IPageActionOverrideValues extends IOverrideValues {
     contentTags?: any;
 }
 /**
-   * Override values interface
-   */
+ * Override values interface
+ */
 export interface IOverrideValues {
     /**
      * One of the awa.behavior values.
@@ -213,9 +214,9 @@ export interface IContent {
     [name: string]: string | number | boolean | string[] | number[] | boolean[] | object | undefined;
 }
 /**
-  * Content handler interface
-  */
-export interface IContentHandler {
+ * Content handler interface
+ */
+export interface IContentHandler extends IUnloadableComponent {
     /**
      * Get meta data
      */

package/types/events/PageAction.d.ts

@@ -2,9 +2,13 @@
  * @copyright Microsoft 2020
  */
 import { WebEvent } from "./WebEvent";
-import { ICustomProperties } from "@microsoft/applicationinsights-core-js";
-import { IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
+import { ICustomProperties, IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+import { IClickAnalyticsConfiguration, IContentHandler, IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
+import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
 export declare class PageAction extends WebEvent {
+    constructor(clickAnalyticsPlugin: ClickAnalyticsPlugin, config: IClickAnalyticsConfiguration, contentHandler: IContentHandler, pageTagsCallback: any, metaTags: {
+        [name: string]: string;
+    }, traceLogger: IDiagnosticLogger);
     /**
      * API to send pageAction event
      * @param pageActionEvent - PageAction event
@@ -21,8 +25,4 @@ export declare class PageAction extends WebEvent {
     capturePageAction(element: Element, overrideValues?: IPageActionOverrideValues, customProperties?: {
         [name: string]: string | number | boolean | string[] | number[] | boolean[] | object;
     }, isRightClick?: boolean): void;
-    private _getTimeToClick;
-    private _populateEventDataIfPresent;
-    private _sanitizePageActionEventContent;
-    private _isUndefinedEvent;
 }

package/types/events/WebEvent.d.ts

@@ -1,10 +1,14 @@
 /**
  * @copyright Microsoft 2020
  */
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, IUnloadableComponent, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
 import { IClickAnalyticsConfiguration, IPageTags, IOverrideValues, IContentHandler, IPageActionTelemetry } from "../Interfaces/Datamodel";
 import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
-export declare class WebEvent {
+export declare class WebEvent implements IUnloadableComponent {
+    protected _pageTags: IPageTags;
+    protected _pageTypeMetaTag: string;
+    protected _marketMetaTag: string;
+    protected _behaviorMetaTag: string;
     protected _clickAnalyticsPlugin: ClickAnalyticsPlugin;
     protected _config: IClickAnalyticsConfiguration;
     protected _contentHandler: IContentHandler;
@@ -13,10 +17,6 @@ export declare class WebEvent {
         [name: string]: string;
     };
     protected _traceLogger: IDiagnosticLogger;
-    protected _pageTags: IPageTags;
-    protected _pageTypeMetaTag: string;
-    protected _marketMetaTag: string;
-    protected _behaviorMetaTag: string;
     /**
      * @param clickAnalyticsPlugin - Click Analytics plugin instance
      * @param config - ClickAnalytics configuration object
@@ -26,15 +26,24 @@ export declare class WebEvent {
      * @param metaTags - Meta tags
      * @param traceLogger - Trace logger to log to console.
      */
-    constructor(_clickAnalyticsPlugin: ClickAnalyticsPlugin, _config: IClickAnalyticsConfiguration, _contentHandler: IContentHandler, _pageTagsCallback: any, _metaTags: {
+    constructor(clickAnalyticsPlugin: ClickAnalyticsPlugin, config: IClickAnalyticsConfiguration, contentHandler: IContentHandler, pageTagsCallback: any, metaTags: {
         [name: string]: string;
-    }, _traceLogger: IDiagnosticLogger);
+    }, traceLogger: IDiagnosticLogger);
     setBasicProperties(event: IPageActionTelemetry, overrideValues: IOverrideValues): void;
     /**
      * Sets common properties for events that are based on the WebEvent schema.
      * @param event - The event
      */
     setCommonProperties(event: IPageActionTelemetry, overrideValues: IOverrideValues): void;
+    /**
+     * Teardown / Unload hook to allow implementations to perform some additional unload operations before the BaseTelemetryPlugin
+     * finishes it's removal.
+     * @param unloadCtx - This is the context that should be used during unloading.
+     * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
+     * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.
+     * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
+     */
+    _doUnload(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean;
     /**
      * Sets pageTags.
      * @param event - The event
@@ -42,13 +51,4 @@ export declare class WebEvent {
     protected _setPageTags(event: IPageActionTelemetry, overrideValues: IOverrideValues): void;
     protected _getBehavior(overrideValues?: IOverrideValues): string | number;
     protected _getValidBehavior(behavior: string | number): string | number;
-    /**
-     * Get the specified metadata value from the collection
-     * If overrideValue is specified in the config that takes precedence.
-     * @param metaTags - Meta data.
-     * @param coreData - Coredata values from configuration.
-     * @param metaTagName - Name of the metaTag to get.
-     * @returns Meta data value
-     */
-    private _getMetaData;
 }

package/types/handlers/AutoCaptureHandler.d.ts

@@ -1,7 +1,7 @@
 /**
  * @copyright Microsoft 2020
  */
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
 import { IAutoCaptureHandler, IClickAnalyticsConfiguration } from "../Interfaces/Datamodel";
 import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
 import { PageAction } from "../events/PageAction";
@@ -16,13 +16,5 @@ export declare class AutoCaptureHandler implements IAutoCaptureHandler {
      */
     constructor(_analyticsPlugin: ClickAnalyticsPlugin, _config: IClickAnalyticsConfiguration, _pageAction: PageAction, _traceLogger: IDiagnosticLogger);
     click(): void;
-    /**
-     * 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;
-    private _processClick;
+    _doUnload(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean;
 }

package/types/handlers/DomContentHandler.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @copyright Microsoft 2020
+ */
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 import { IClickAnalyticsConfiguration, IContent, IContentHandler } from "../Interfaces/Datamodel";
 export declare class DomContentHandler implements IContentHandler {
@@ -23,54 +26,4 @@ export declare class DomContentHandler implements IContentHandler {
      * @returns String representation of the Json array of element attributes
      */
     getElementContent(element: Element): IContent;
-    /**
-     * Capture current level Element content
-     */
-    private _captureElementContentWithDataTag;
-    /**
-     * Walk Up the DOM to capture Element content
-     */
-    private _walkUpDomChainCaptureData;
-    /**
-     * Capture Element content along with Data Tag attributes and values
-     */
-    private _populateElementContent;
-    /**
-     * Capture Element content along with Data Tag attributes and values
-     */
-    private _populateElementContentwithDataTag;
-    /**
-     * Retrieve a specified metadata tag value from the DOM.
-     * @param captureAllMetaDataContent - Flag to capture all metadata content
-     * @param prefix - Prefix to search the metatags with.
-     * @param removePrefix - Specifies if the prefix must be excluded from key names in the returned collection.
-     * @returns Metadata collection/property bag
-     */
-    private _getMetaDataFromDOM;
-    /**
-     * Gets the default content name.
-     * @param element - An html element
-     * @param useDefaultContentNameOrId -Flag indicating if an element is market PII.
-     * @returns Content name
-     */
-    private _getDefaultContentName;
-    /**
-     * Check if the user wants to track the element, which means if the element has any tags with data-* or customDataPrefix
-     * @param element - An html element
-     * @returns true if any data-* exist, otherwise return false
-     */
-    private _isTracked;
-    private _getHtmlIdAndContentName;
-    /**
-    * Computes the parentId of a given element.
-    * @param element - An html element
-    * @returns An object containing the closest parentId , can be empty if nothing was found
-    */
-    private _getParentDetails;
-    /**
-    * Check if parent info already set up, if so take and put into content, if not walk up the DOM to find correct info
-    * @param element - An html element that the user wants to track
-    * @returns An object containing the parent info, can be empty if nothing was found
-    */
-    private _populateParentInfo;
 }

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.4"
+      "packageVersion": "7.19.5"
     }
   ]
 }