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

package/types/common/Utils.d.ts

@@ -1,93 +1,101 @@
 /**
- * @copyright Microsoft 2020
- * File containing utility functions.
- */
+* @copyright Microsoft 2020
+* File containing utility functions.
+*/
+import { _eInternalMessageId } from "@microsoft/applicationinsights-core-js";
 import { IClickAnalyticsConfiguration } from "../Interfaces/Datamodel";
+export declare const enum _eExtendedInternalMessageId {
+    CannotParseAiBlobValue = 101,
+    InvalidContentBlob = 102,
+    TrackPageActionEventFailed = 103
+}
 export declare const _ExtendedInternalMessageId: {
-    CannotParseAiBlobValue: number;
-    InvalidContentBlob: number;
-    TrackPageActionEventFailed: number;
-    BrowserDoesNotSupportLocalStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserDoesNotSupportLocalStorage;
-    BrowserCannotReadLocalStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserCannotReadLocalStorage;
-    BrowserCannotReadSessionStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserCannotReadSessionStorage;
-    BrowserCannotWriteLocalStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserCannotWriteLocalStorage;
-    BrowserCannotWriteSessionStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserCannotWriteSessionStorage;
-    BrowserFailedRemovalFromLocalStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserFailedRemovalFromLocalStorage;
-    BrowserFailedRemovalFromSessionStorage: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.BrowserFailedRemovalFromSessionStorage;
-    CannotSendEmptyTelemetry: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CannotSendEmptyTelemetry;
-    ClientPerformanceMathError: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ClientPerformanceMathError;
-    ErrorParsingAISessionCookie: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ErrorParsingAISessionCookie;
-    ErrorPVCalc: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ErrorPVCalc;
-    ExceptionWhileLoggingError: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ExceptionWhileLoggingError;
-    FailedAddingTelemetryToBuffer: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedAddingTelemetryToBuffer;
-    FailedMonitorAjaxAbort: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxAbort;
-    FailedMonitorAjaxDur: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxDur;
-    FailedMonitorAjaxOpen: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxOpen;
-    FailedMonitorAjaxRSC: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxRSC;
-    FailedMonitorAjaxSend: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxSend;
-    FailedMonitorAjaxGetCorrelationHeader: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxGetCorrelationHeader;
-    FailedToAddHandlerForOnBeforeUnload: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToAddHandlerForOnBeforeUnload;
-    FailedToSendQueuedTelemetry: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToSendQueuedTelemetry;
-    FailedToReportDataLoss: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToReportDataLoss;
-    FlushFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FlushFailed;
-    MessageLimitPerPVExceeded: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.MessageLimitPerPVExceeded;
-    MissingRequiredFieldSpecification: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.MissingRequiredFieldSpecification;
-    NavigationTimingNotSupported: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.NavigationTimingNotSupported;
-    OnError: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.OnError;
-    SessionRenewalDateIsZero: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SessionRenewalDateIsZero;
-    SenderNotInitialized: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SenderNotInitialized;
-    StartTrackEventFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StartTrackEventFailed;
-    StopTrackEventFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StopTrackEventFailed;
-    StartTrackFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StartTrackFailed;
-    StopTrackFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StopTrackFailed;
-    TelemetrySampledAndNotSent: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TelemetrySampledAndNotSent;
-    TrackEventFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackEventFailed;
-    TrackExceptionFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackExceptionFailed;
-    TrackMetricFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackMetricFailed;
-    TrackPVFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackPVFailed;
-    TrackPVFailedCalc: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackPVFailedCalc;
-    TrackTraceFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackTraceFailed;
-    TransmissionFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TransmissionFailed;
-    FailedToSetStorageBuffer: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToSetStorageBuffer;
-    FailedToRestoreStorageBuffer: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToRestoreStorageBuffer;
-    InvalidBackendResponse: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InvalidBackendResponse;
-    FailedToFixDepricatedValues: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedToFixDepricatedValues;
-    InvalidDurationValue: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InvalidDurationValue;
-    TelemetryEnvelopeInvalid: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TelemetryEnvelopeInvalid;
-    CreateEnvelopeError: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CreateEnvelopeError;
-    CannotSerializeObject: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CannotSerializeObject;
-    CannotSerializeObjectNonSerializable: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CannotSerializeObjectNonSerializable;
-    CircularReferenceDetected: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CircularReferenceDetected;
-    ClearAuthContextFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ClearAuthContextFailed;
-    ExceptionTruncated: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ExceptionTruncated;
-    IllegalCharsInName: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.IllegalCharsInName;
-    ItemNotInArray: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.ItemNotInArray;
-    MaxAjaxPerPVExceeded: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.MaxAjaxPerPVExceeded;
-    MessageTruncated: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.MessageTruncated;
-    NameTooLong: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.NameTooLong;
-    SampleRateOutOfRange: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SampleRateOutOfRange;
-    SetAuthContextFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SetAuthContextFailed;
-    SetAuthContextFailedAccountName: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SetAuthContextFailedAccountName;
-    StringValueTooLong: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StringValueTooLong;
-    StartCalledMoreThanOnce: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StartCalledMoreThanOnce;
-    StopCalledWithoutStart: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.StopCalledWithoutStart;
-    TelemetryInitializerFailed: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TelemetryInitializerFailed;
-    TrackArgumentsNotSpecified: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.TrackArgumentsNotSpecified;
-    UrlTooLong: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.UrlTooLong;
-    SessionStorageBufferFull: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SessionStorageBufferFull;
-    CannotAccessCookie: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.CannotAccessCookie;
-    IdTooLong: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.IdTooLong;
-    InvalidEvent: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InvalidEvent;
-    FailedMonitorAjaxSetRequestHeader: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedMonitorAjaxSetRequestHeader;
-    SendBrowserInfoOnUserInit: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SendBrowserInfoOnUserInit;
-    PluginException: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.PluginException;
-    NotificationException: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.NotificationException;
-    SnippetScriptLoadFailure: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.SnippetScriptLoadFailure;
-    InvalidInstrumentationKey: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InvalidInstrumentationKey;
-    FailedAddingCustomDefinedRequestContext: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.FailedAddingCustomDefinedRequestContext;
-    InMemoryStorageBufferFull: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InMemoryStorageBufferFull;
-    InstrumentationKeyDeprecation: import("@microsoft/applicationinsights-core-js")._eInternalMessageId.InstrumentationKeyDeprecation;
+    [x: number]: string;
+    CannotParseAiBlobValue: _eExtendedInternalMessageId.CannotParseAiBlobValue;
+    InvalidContentBlob: _eExtendedInternalMessageId.InvalidContentBlob;
+    TrackPageActionEventFailed: _eExtendedInternalMessageId.TrackPageActionEventFailed;
+    BrowserDoesNotSupportLocalStorage: _eInternalMessageId.BrowserDoesNotSupportLocalStorage;
+    BrowserCannotReadLocalStorage: _eInternalMessageId.BrowserCannotReadLocalStorage;
+    BrowserCannotReadSessionStorage: _eInternalMessageId.BrowserCannotReadSessionStorage;
+    BrowserCannotWriteLocalStorage: _eInternalMessageId.BrowserCannotWriteLocalStorage;
+    BrowserCannotWriteSessionStorage: _eInternalMessageId.BrowserCannotWriteSessionStorage;
+    BrowserFailedRemovalFromLocalStorage: _eInternalMessageId.BrowserFailedRemovalFromLocalStorage;
+    BrowserFailedRemovalFromSessionStorage: _eInternalMessageId.BrowserFailedRemovalFromSessionStorage;
+    CannotSendEmptyTelemetry: _eInternalMessageId.CannotSendEmptyTelemetry;
+    ClientPerformanceMathError: _eInternalMessageId.ClientPerformanceMathError;
+    ErrorParsingAISessionCookie: _eInternalMessageId.ErrorParsingAISessionCookie;
+    ErrorPVCalc: _eInternalMessageId.ErrorPVCalc;
+    ExceptionWhileLoggingError: _eInternalMessageId.ExceptionWhileLoggingError;
+    FailedAddingTelemetryToBuffer: _eInternalMessageId.FailedAddingTelemetryToBuffer;
+    FailedMonitorAjaxAbort: _eInternalMessageId.FailedMonitorAjaxAbort;
+    FailedMonitorAjaxDur: _eInternalMessageId.FailedMonitorAjaxDur;
+    FailedMonitorAjaxOpen: _eInternalMessageId.FailedMonitorAjaxOpen;
+    FailedMonitorAjaxRSC: _eInternalMessageId.FailedMonitorAjaxRSC;
+    FailedMonitorAjaxSend: _eInternalMessageId.FailedMonitorAjaxSend;
+    FailedMonitorAjaxGetCorrelationHeader: _eInternalMessageId.FailedMonitorAjaxGetCorrelationHeader;
+    FailedToAddHandlerForOnBeforeUnload: _eInternalMessageId.FailedToAddHandlerForOnBeforeUnload;
+    FailedToSendQueuedTelemetry: _eInternalMessageId.FailedToSendQueuedTelemetry;
+    FailedToReportDataLoss: _eInternalMessageId.FailedToReportDataLoss;
+    FlushFailed: _eInternalMessageId.FlushFailed;
+    MessageLimitPerPVExceeded: _eInternalMessageId.MessageLimitPerPVExceeded;
+    MissingRequiredFieldSpecification: _eInternalMessageId.MissingRequiredFieldSpecification;
+    NavigationTimingNotSupported: _eInternalMessageId.NavigationTimingNotSupported;
+    OnError: _eInternalMessageId.OnError;
+    SessionRenewalDateIsZero: _eInternalMessageId.SessionRenewalDateIsZero;
+    SenderNotInitialized: _eInternalMessageId.SenderNotInitialized;
+    StartTrackEventFailed: _eInternalMessageId.StartTrackEventFailed;
+    StopTrackEventFailed: _eInternalMessageId.StopTrackEventFailed;
+    StartTrackFailed: _eInternalMessageId.StartTrackFailed;
+    StopTrackFailed: _eInternalMessageId.StopTrackFailed;
+    TelemetrySampledAndNotSent: _eInternalMessageId.TelemetrySampledAndNotSent;
+    TrackEventFailed: _eInternalMessageId.TrackEventFailed;
+    TrackExceptionFailed: _eInternalMessageId.TrackExceptionFailed;
+    TrackMetricFailed: _eInternalMessageId.TrackMetricFailed;
+    TrackPVFailed: _eInternalMessageId.TrackPVFailed;
+    TrackPVFailedCalc: _eInternalMessageId.TrackPVFailedCalc;
+    TrackTraceFailed: _eInternalMessageId.TrackTraceFailed;
+    TransmissionFailed: _eInternalMessageId.TransmissionFailed;
+    FailedToSetStorageBuffer: _eInternalMessageId.FailedToSetStorageBuffer;
+    FailedToRestoreStorageBuffer: _eInternalMessageId.FailedToRestoreStorageBuffer;
+    InvalidBackendResponse: _eInternalMessageId.InvalidBackendResponse;
+    FailedToFixDepricatedValues: _eInternalMessageId.FailedToFixDepricatedValues;
+    InvalidDurationValue: _eInternalMessageId.InvalidDurationValue;
+    TelemetryEnvelopeInvalid: _eInternalMessageId.TelemetryEnvelopeInvalid;
+    CreateEnvelopeError: _eInternalMessageId.CreateEnvelopeError;
+    CannotSerializeObject: _eInternalMessageId.CannotSerializeObject;
+    CannotSerializeObjectNonSerializable: _eInternalMessageId.CannotSerializeObjectNonSerializable;
+    CircularReferenceDetected: _eInternalMessageId.CircularReferenceDetected;
+    ClearAuthContextFailed: _eInternalMessageId.ClearAuthContextFailed;
+    ExceptionTruncated: _eInternalMessageId.ExceptionTruncated;
+    IllegalCharsInName: _eInternalMessageId.IllegalCharsInName;
+    ItemNotInArray: _eInternalMessageId.ItemNotInArray;
+    MaxAjaxPerPVExceeded: _eInternalMessageId.MaxAjaxPerPVExceeded;
+    MessageTruncated: _eInternalMessageId.MessageTruncated;
+    NameTooLong: _eInternalMessageId.NameTooLong;
+    SampleRateOutOfRange: _eInternalMessageId.SampleRateOutOfRange;
+    SetAuthContextFailed: _eInternalMessageId.SetAuthContextFailed;
+    SetAuthContextFailedAccountName: _eInternalMessageId.SetAuthContextFailedAccountName;
+    StringValueTooLong: _eInternalMessageId.StringValueTooLong;
+    StartCalledMoreThanOnce: _eInternalMessageId.StartCalledMoreThanOnce;
+    StopCalledWithoutStart: _eInternalMessageId.StopCalledWithoutStart;
+    TelemetryInitializerFailed: _eInternalMessageId.TelemetryInitializerFailed;
+    TrackArgumentsNotSpecified: _eInternalMessageId.TrackArgumentsNotSpecified;
+    UrlTooLong: _eInternalMessageId.UrlTooLong;
+    SessionStorageBufferFull: _eInternalMessageId.SessionStorageBufferFull;
+    CannotAccessCookie: _eInternalMessageId.CannotAccessCookie;
+    IdTooLong: _eInternalMessageId.IdTooLong;
+    InvalidEvent: _eInternalMessageId.InvalidEvent;
+    FailedMonitorAjaxSetRequestHeader: _eInternalMessageId.FailedMonitorAjaxSetRequestHeader;
+    SendBrowserInfoOnUserInit: _eInternalMessageId.SendBrowserInfoOnUserInit;
+    PluginException: _eInternalMessageId.PluginException;
+    NotificationException: _eInternalMessageId.NotificationException;
+    SnippetScriptLoadFailure: _eInternalMessageId.SnippetScriptLoadFailure;
+    InvalidInstrumentationKey: _eInternalMessageId.InvalidInstrumentationKey;
+    FailedAddingCustomDefinedRequestContext: _eInternalMessageId.FailedAddingCustomDefinedRequestContext;
+    InMemoryStorageBufferFull: _eInternalMessageId.InMemoryStorageBufferFull;
+    InstrumentationKeyDeprecation: _eInternalMessageId.InstrumentationKeyDeprecation;
 };
+export declare type _ExtendedInternalMessageId = number | _eExtendedInternalMessageId | _eInternalMessageId;
 /**
  * Finds attributes in overrideConfig which are invalid or should be objects
  * and deletes them. useful in override config
@@ -192,16 +200,6 @@ export declare function extractFieldFromObject(obj: Object, fieldName: string):
  * @returns String with surrounding brackets
  */
 export declare function bracketIt(str: string): string;
-/**
- * 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 declare function extend(obj?: any, obj2?: any, obj3?: any, obj4?: any, obj5?: any): any;
 export declare function validateContentNamePrefix(config: IClickAnalyticsConfiguration, defaultDataPrefix: string): boolean;
 /**
  * Merge passed in configuration with default configuration

package/types/events/PageAction.d.ts

@@ -1,10 +1,10 @@
 /**
- * @copyright Microsoft 2020
- */
-import { WebEvent } from "./WebEvent";
+* @copyright Microsoft 2020
+*/
 import { ICustomProperties, IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { IClickAnalyticsConfiguration, IContentHandler, IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
 import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { IClickAnalyticsConfiguration, IContentHandler, IPageActionOverrideValues, IPageActionTelemetry } from "../Interfaces/Datamodel";
+import { WebEvent } from "./WebEvent";
 export declare class PageAction extends WebEvent {
     constructor(clickAnalyticsPlugin: ClickAnalyticsPlugin, config: IClickAnalyticsConfiguration, contentHandler: IContentHandler, pageTagsCallback: any, metaTags: {
         [name: string]: string;

package/types/events/WebEvent.d.ts

@@ -1,9 +1,9 @@
 /**
- * @copyright Microsoft 2020
- */
-import { IDiagnosticLogger, IUnloadableComponent, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
-import { IClickAnalyticsConfiguration, IPageTags, IOverrideValues, IContentHandler, IPageActionTelemetry } from "../Interfaces/Datamodel";
+* @copyright Microsoft 2020
+*/
+import { IDiagnosticLogger, IProcessTelemetryUnloadContext, ITelemetryUnloadState, IUnloadableComponent } from "@microsoft/applicationinsights-core-js";
 import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { IClickAnalyticsConfiguration, IContentHandler, IOverrideValues, IPageActionTelemetry, IPageTags } from "../Interfaces/Datamodel";
 export declare class WebEvent implements IUnloadableComponent {
     protected _pageTags: IPageTags;
     protected _pageTypeMetaTag: string;

package/types/handlers/AutoCaptureHandler.d.ts

@@ -1,9 +1,9 @@
 /**
- * @copyright Microsoft 2020
- */
+* @copyright Microsoft 2020
+*/
 import { IDiagnosticLogger, IProcessTelemetryUnloadContext, ITelemetryUnloadState } from "@microsoft/applicationinsights-core-js";
-import { IAutoCaptureHandler, IClickAnalyticsConfiguration } from "../Interfaces/Datamodel";
 import { ClickAnalyticsPlugin } from "../ClickAnalyticsPlugin";
+import { IAutoCaptureHandler, IClickAnalyticsConfiguration } from "../Interfaces/Datamodel";
 import { PageAction } from "../events/PageAction";
 export declare class AutoCaptureHandler implements IAutoCaptureHandler {
     protected _analyticsPlugin: ClickAnalyticsPlugin;

package/types/handlers/DomContentHandler.d.ts

@@ -1,6 +1,6 @@
 /**
- * @copyright Microsoft 2020
- */
+* @copyright Microsoft 2020
+*/
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 import { IClickAnalyticsConfiguration, IContent, IContentHandler } from "../Interfaces/Datamodel";
 export declare class DomContentHandler implements IContentHandler {

package/types/tsdoc-metadata.json

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