@microsoft/applicationinsights-core-js 2.8.0-beta.2202-06 → 2.8.0-beta.2203-02

package/dist/applicationinsights-core-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 2.8.0-beta.2202-06
+ * Microsoft Application Insights Core Javascript SDK, 2.8.0-beta.2203-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -14,39 +14,59 @@ declare namespace ApplicationInsights {
     import { strShimPrototype as strPrototype } from '@microsoft/applicationinsights-shims';
     import { strShimUndefined as strUndefined } from '@microsoft/applicationinsights-shims';
 
+    /**
+     * Get all of the registered events on the target object, this is primarily used for testing cleanup but may also be used by
+     * applications to remove their own events
+     * @param target - The EventTarget that has registered events
+     * @param evtName - [Optional] The name of the event to return the registered handlers and full name (with namespaces)
+     */
+    function __getRegisteredEvents(target: any, evtName?: string): _IRegisteredEvents[];
+
     /**
      * Trys to add an event handler for the specified event to the window, body and document
      * @param eventName {string} - The name of the event
      * @param callback {any} - The callback function that needs to be executed for the given event
+     * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
      * @return {boolean} - true if the handler was successfully added
      */
-    function addEventHandler(eventName: string, callback: any): boolean;
+    function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): boolean;
 
     /**
      * Bind the listener to the array of events
      * @param events An string array of event names to bind the listener to
      * @param listener The event callback to call when the event is triggered
      * @param excludeEvents - [Optional] An array of events that should not be hooked (if possible), unless no other events can be.
+     * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
      * @returns true - when at least one of the events was registered otherwise false
      */
-    function addEventListeners(events: string[], listener: any, excludeEvents?: string[]): boolean;
+    function addEventListeners(events: string[], listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 
     /**
-     * Listen to the pagehide and visibility changing to 'hidden' events
+     * Listen to the pagehide and visibility changing to 'hidden' events, because the 'visibilitychange' uses
+     * an internal proxy to detect the visibility state you SHOULD use a unique namespace when if you plan to call
+     * removePageShowEventListener as the remove ignores the listener argument for the 'visibilitychange' event.
      * @param listener - The event callback to call when a page hide event is triggered
      * @param excludeEvents - [Optional] An array of events that should not be hooked (if possible), unless no other events can be.
+     * @param evtNamespace - [Optional] A Namespace to append to the event listeners so they can be uniquely identified and removed
+     * based on this namespace. This call also adds an additional unique "pageshow" namespace to the events
+     * so that only the matching "removePageHideEventListener" can remove these events.
      * Suggestion: pass as true if you are also calling addPageUnloadEventListener as that also hooks pagehide
      * @returns true - when at least one of the events was registered otherwise false
      */
-    function addPageHideEventListener(listener: any, excludeEvents?: string[]): boolean;
+    function addPageHideEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
 
     /**
-     * Listen to the pageshow and visibility changing to 'visible' events
+     * Listen to the pageshow and visibility changing to 'visible' events, because the 'visibilitychange' uses
+     * an internal proxy to detect the visibility state you SHOULD use a unique namespace when if you plan to call
+     * removePageShowEventListener as the remove ignores the listener argument for the 'visibilitychange' event.
      * @param listener - The event callback to call when a page is show event is triggered
      * @param excludeEvents - [Optional] An array of events that should not be hooked (if possible), unless no other events can be.
+     * @param evtNamespace - [Optional/Recommended] A Namespace to append to the event listeners so they can be uniquely
+     * identified and removed based on this namespace. This call also adds an additional unique "pageshow" namespace to the events
+     * so that only the matching "removePageShowEventListener" can remove these events.
      * @returns true - when at least one of the events was registered otherwise false
      */
-    function addPageShowEventListener(listener: any, excludeEvents?: string[]): boolean;
+    function addPageShowEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
 
     /**
      * Listen to the 'beforeunload', 'unload' and 'pagehide' events which indicates a page unload is occurring,
@@ -56,9 +76,10 @@ declare namespace ApplicationInsights {
      * need to listen to the 'addPageHideEventListener' and 'addPageShowEventListener' events.
      * @param listener - The event callback to call when a page unload event is triggered
      * @param excludeEvents - [Optional] An array of events that should not be hooked, unless no other events can be.
+     * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
      * @returns true - when at least one of the events was registered otherwise false
      */
-    function addPageUnloadEventListener(listener: any, excludeEvents?: string[]): boolean;
+    function addPageUnloadEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
 
     class AppInsightsCore extends BaseCore implements IAppInsightsCore {
         constructor();
@@ -111,7 +132,7 @@ declare namespace ApplicationInsights {
     /**
      * Binds the specified function to an event, so that the function gets called whenever the event fires on the object
      * @param obj Object to add the event too.
-     * @param eventNameWithoutOn String that specifies any of the standard DHTML Events without "on" prefix
+     * @param eventNameWithoutOn String that specifies any of the standard DHTML Events without "on" prefix and optional (dot "." prefixed) namespaces "click" "click.mynamespace".
      * @param handlerRef Pointer that specifies the function to call when event fires
      * @param useCapture [Optional] Defaults to false
      * @returns True if the function was bound successfully to the event, otherwise false
@@ -169,6 +190,10 @@ declare namespace ApplicationInsights {
          */
         addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
         getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+        /**
+         * Returns the unique event namespace that should be used
+         */
+        evtNamespace(): string;
         protected releaseQueue(): void;
     }
 
@@ -217,8 +242,26 @@ declare namespace ApplicationInsights {
          * Internal helper to allow setting of the internal initialized setting for inherited instances and unit testing
          */
         protected setInitialized: (isInitialized: boolean) => 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.
+         */
+        protected _doTeardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
         constructor();
         initialize(config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+        /**
+         * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
+         * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
+         * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
+         * @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.
+         * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
+         */
+        teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
         abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
         /**
          * Add this hook so that it is automatically removed during unloading
@@ -250,6 +293,13 @@ declare namespace ApplicationInsights {
 
     function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
+    /**
+     * Create an enum style object which has both the key => value and value => key mappings
+     * @param values - The values to populate on the new object
+     * @returns
+     */
+    function createEnumStyle<T>(values: T): T;
+
     /**
      * Creates a new Telemetry Item context with the current config, core and plugin execution chain
      * @param plugins - The plugin instances that will be executed
@@ -258,6 +308,8 @@ declare namespace ApplicationInsights {
      */
     function createProcessTelemetryContext(telemetryChain: ITelemetryPluginChain, config: IConfiguration, core: IAppInsightsCore, startAt?: IPlugin): IProcessTelemetryContext;
 
+    function createUniqueNamespace(name: string, includeVersion?: boolean): string;
+
     /**
      * Return the current time via the Date now() function (if available) and falls back to (new Date()).getTime() if now() is unavailable (IE8 or less)
      * https://caniuse.com/#search=Date.now
@@ -274,8 +326,11 @@ declare namespace ApplicationInsights {
     /**
      * Removes an event handler for the specified event
      * @param Object to remove the event from
-     * @param eventNameWithoutOn {string} - The name of the event
-     * @param handlerRef {any} - The callback function that needs to be executed for the given event
+     * @param eventNameWithoutOn {string} - The name of the event, with optional namespaces or just the namespaces,
+     * such as "click", "click.mynamespace" or ".mynamespace"
+     * @param handlerRef {any} - The callback function that needs to be removed from the given event, when using a
+     * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
+     * otherwise this will only remove events with this specific handler.
      * @param useCapture [Optional] Defaults to false
      */
     function detachEvent(obj: any, eventNameWithoutOn: string, handlerRef: any, useCapture?: boolean): void;
@@ -356,8 +411,131 @@ declare namespace ApplicationInsights {
      */
     function dumpObj(object: any): string;
 
+    const enum _eInternalMessageId {
+        BrowserDoesNotSupportLocalStorage = 0,
+        BrowserCannotReadLocalStorage = 1,
+        BrowserCannotReadSessionStorage = 2,
+        BrowserCannotWriteLocalStorage = 3,
+        BrowserCannotWriteSessionStorage = 4,
+        BrowserFailedRemovalFromLocalStorage = 5,
+        BrowserFailedRemovalFromSessionStorage = 6,
+        CannotSendEmptyTelemetry = 7,
+        ClientPerformanceMathError = 8,
+        ErrorParsingAISessionCookie = 9,
+        ErrorPVCalc = 10,
+        ExceptionWhileLoggingError = 11,
+        FailedAddingTelemetryToBuffer = 12,
+        FailedMonitorAjaxAbort = 13,
+        FailedMonitorAjaxDur = 14,
+        FailedMonitorAjaxOpen = 15,
+        FailedMonitorAjaxRSC = 16,
+        FailedMonitorAjaxSend = 17,
+        FailedMonitorAjaxGetCorrelationHeader = 18,
+        FailedToAddHandlerForOnBeforeUnload = 19,
+        FailedToSendQueuedTelemetry = 20,
+        FailedToReportDataLoss = 21,
+        FlushFailed = 22,
+        MessageLimitPerPVExceeded = 23,
+        MissingRequiredFieldSpecification = 24,
+        NavigationTimingNotSupported = 25,
+        OnError = 26,
+        SessionRenewalDateIsZero = 27,
+        SenderNotInitialized = 28,
+        StartTrackEventFailed = 29,
+        StopTrackEventFailed = 30,
+        StartTrackFailed = 31,
+        StopTrackFailed = 32,
+        TelemetrySampledAndNotSent = 33,
+        TrackEventFailed = 34,
+        TrackExceptionFailed = 35,
+        TrackMetricFailed = 36,
+        TrackPVFailed = 37,
+        TrackPVFailedCalc = 38,
+        TrackTraceFailed = 39,
+        TransmissionFailed = 40,
+        FailedToSetStorageBuffer = 41,
+        FailedToRestoreStorageBuffer = 42,
+        InvalidBackendResponse = 43,
+        FailedToFixDepricatedValues = 44,
+        InvalidDurationValue = 45,
+        TelemetryEnvelopeInvalid = 46,
+        CreateEnvelopeError = 47,
+        CannotSerializeObject = 48,
+        CannotSerializeObjectNonSerializable = 49,
+        CircularReferenceDetected = 50,
+        ClearAuthContextFailed = 51,
+        ExceptionTruncated = 52,
+        IllegalCharsInName = 53,
+        ItemNotInArray = 54,
+        MaxAjaxPerPVExceeded = 55,
+        MessageTruncated = 56,
+        NameTooLong = 57,
+        SampleRateOutOfRange = 58,
+        SetAuthContextFailed = 59,
+        SetAuthContextFailedAccountName = 60,
+        StringValueTooLong = 61,
+        StartCalledMoreThanOnce = 62,
+        StopCalledWithoutStart = 63,
+        TelemetryInitializerFailed = 64,
+        TrackArgumentsNotSpecified = 65,
+        UrlTooLong = 66,
+        SessionStorageBufferFull = 67,
+        CannotAccessCookie = 68,
+        IdTooLong = 69,
+        InvalidEvent = 70,
+        FailedMonitorAjaxSetRequestHeader = 71,
+        SendBrowserInfoOnUserInit = 72,
+        PluginException = 73,
+        NotificationException = 74,
+        SnippetScriptLoadFailure = 99,
+        InvalidInstrumentationKey = 100,
+        CannotParseAiBlobValue = 101,
+        InvalidContentBlob = 102,
+        TrackPageActionEventFailed = 103,
+        FailedAddingCustomDefinedRequestContext = 104,
+        InMemoryStorageBufferFull = 105
+    }
+
+    const enum eLoggingSeverity {
+        /**
+         * Error will be sent as internal telemetry
+         */
+        CRITICAL = 1,
+        /**
+         * Error will NOT be sent as internal telemetry, and will only be shown in browser console
+         */
+        WARNING = 2
+    }
+
     const EventHelper: IEventHelper;
 
+    /**
+     * Removes an event handler for the specified event
+     * @param Object to remove the event from
+     * @param eventName {string} - The name of the event, with optional namespaces or just the namespaces,
+     * such as "click", "click.mynamespace" or ".mynamespace"
+     * @param handlerRef {any} - The callback function that needs to be removed from the given event, when using a
+     * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
+     * otherwise this will only remove events with this specific handler.
+     * @param evtNamespace - [Optional] Additional namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace,
+     * if the eventName also includes a namespace the namespace(s) are merged into a single namespace
+     * @param useCapture [Optional] Defaults to false
+     */
+    function eventOff<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): void;
+
+    /**
+     * Binds the specified function to an event, so that the function gets called whenever the event fires on the object
+     * @param obj Object to add the event too.
+     * @param eventName String that specifies any of the standard DHTML Events without "on" prefix, if may also include an optional (dot "." prefixed)
+     * namespaces "click" "click.mynamespace" in addition to specific namespaces.
+     * @param handlerRef Pointer that specifies the function to call when event fires
+     * @param evtNamespace - [Optional] Additional namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace,
+     * if the eventName also includes a namespace the namespace(s) are merged into a single namespace
+     * @param useCapture [Optional] Defaults to false
+     * @returns True if the function was bound successfully to the event, otherwise false
+     */
+    function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): boolean;
+
     /**
      * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
      */
@@ -608,6 +786,71 @@ declare namespace ApplicationInsights {
          * @param pluginIdentifier
          */
         getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+        /**
+         * Returns the unique event namespace that should be used when registering events
+         */
+        evtNamespace(): string;
+    }
+
+    interface IBaseProcessingContext {
+        /**
+         * The current core instance for the request
+         */
+        core: () => IAppInsightsCore;
+        /**
+         * THe current diagnostic logger for the request
+         */
+        diagLog: () => IDiagnosticLogger;
+        /**
+         * Gets the current core config instance
+         */
+        getCfg: () => IConfiguration;
+        /**
+         * Gets the named extension config
+         */
+        getExtCfg: <T>(identifier: string, defaultValue?: T | any, mergeDefault?: GetExtCfgMergeType) => T;
+        /**
+         * Gets the named config from either the named identifier extension or core config if neither exist then the
+         * default value is returned
+         * @param identifier The named extension identifier
+         * @param field The config field name
+         * @param defaultValue The default value to return if no defined config exists
+         */
+        getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
+        /**
+         * Helper to allow plugins to check and possibly shortcut executing code only
+         * required if there is a nextPlugin
+         */
+        hasNext: () => boolean;
+        /**
+         * Returns the next configured plugin proxy
+         */
+        getNext: () => ITelemetryPluginChain;
+        /**
+         * Helper to set the next plugin proxy
+         */
+        setNext: (nextCtx: ITelemetryPluginChain) => void;
+        /**
+         * Synchronously iterate over the context chain running the callback for each plugin, once
+         * every plugin has been executed via the callback, any associated onComplete will be called.
+         * @param callback - The function call for each plugin in the context chain
+         */
+        iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
+        /**
+         * Set the function to call when the current chain has executed all processNext or unloadNext items.
+         * @param onComplete - The onComplete to call
+         * @param that - The "this" value to use for the onComplete call, if not provided or undefined defaults to the current context
+         * @param args - Any additional arguments to pass to the onComplete function
+         */
+        onComplete: (onComplete: Function, that?: any, ...args: any[]) => void;
+        /**
+         * Create a new context using the core and config from the current instance, returns a new instance of the same type
+         * @param plugins - The execution order to process the plugins, if null or not supplied
+         *                  then the current execution order will be copied.
+         * @param startAt - The plugin to start processing from, if missing from the execution
+         *                  order then the next plugin will be NOT set.
+         */
+        createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IBaseProcessingContext;
     }
 
     /**
@@ -623,9 +866,14 @@ declare namespace ApplicationInsights {
          */
         resume(): void;
         /**
-         * Tear down transmission pipeline
+         * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
+         * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
+         * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
+         * @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.
+         * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
          */
-        teardown(): void;
+        teardown: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
         /**
          * Flush to send data immediately; channel should default to sending data asynchronously
          * @param async - send data asynchronously when true
@@ -994,7 +1242,7 @@ declare namespace ApplicationInsights {
          * @param callback {any} - The callback function that needs to be executed for the given event
          * @return {boolean} - true if the handler was successfully added
          */
-        addEventHandler: (eventName: string, callback: any) => boolean;
+        addEventHandler: (eventName: string, callback: any, evtNamespace?: string | string[]) => boolean;
         /**
          * Return the current time via the Date now() function (if available) and falls back to (new Date()).getTime() if now() is unavailable (IE8 or less)
          * https://caniuse.com/#search=Date.now
@@ -1230,6 +1478,19 @@ declare namespace ApplicationInsights {
 
     interface ILoadedPlugin<T extends IPlugin> {
         plugin: T;
+        /**
+         * Identifies whether the plugin is enabled and can process events. This is slightly different from isInitialized as the plugin may be initialized but disabled
+         * via the setEnabled() or it may be a shared plugin which has had it's teardown function called from another instance..
+         * @returns boolean = true if the plugin is in a state where it is operational.
+         */
+        isEnabled: () => boolean;
+        /**
+         * You can optionally enable / disable a plugin from processing events.
+         * Setting enabled to true will not necessarily cause the `isEnabled()` to also return true
+         * as the plugin must also have been successfully initialized and not had it's `teardown` method called
+         * (unless it's also been re-initialized)
+         */
+        setEnabled: (isEnabled: boolean) => void;
     }
 
     /**
@@ -1448,7 +1709,7 @@ declare namespace ApplicationInsights {
         InMemoryStorageBufferFull: number;
     };
 
-    type _InternalMessageId = number | typeof _InternalMessageId;
+    type _InternalMessageId = number | _eInternalMessageId;
 
     /**
      * This interface identifies the details of an internal performance event - it does not represent an outgoing reported event
@@ -1569,10 +1830,14 @@ declare namespace ApplicationInsights {
          */
         isInitialized?: () => boolean;
         /**
-         * Tear down the plugin and remove any hooked value, the plugin should remove that it is no longer initialized and
-         * therefore can be re-initialized after being torn down.
+         * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
+         * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
+         * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
+         * @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.
+         * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
          */
-        teardown?: () => void;
+        teardown?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
         /**
          * Extension name
          */
@@ -1587,67 +1852,47 @@ declare namespace ApplicationInsights {
      * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
      * between multiple AppInsights instances
      */
-    interface IProcessTelemetryContext {
-        /**
-         * The current core instance for the request
-         */
-        core: () => IAppInsightsCore;
-        /**
-         * THe current diagnostic logger for the request
-         */
-        diagLog: () => IDiagnosticLogger;
-        /**
-         * Gets the current core config instance
-         */
-        getCfg: () => IConfiguration;
-        /**
-         * Gets the named extension config
-         */
-        getExtCfg: <T>(identifier: string, defaultValue?: T | any, mergeDefault?: GetExtCfgMergeType) => T;
-        /**
-         * Gets the named config from either the named identifier extension or core config if neither exist then the
-         * default value is returned
-         * @param identifier The named extension identifier
-         * @param field The config field name
-         * @param defaultValue The default value to return if no defined config exists
-         */
-        getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
-        /**
-         * Helper to allow plugins to check and possibly shortcut executing code only
-         * required if there is a nextPlugin
-         */
-        hasNext: () => boolean;
-        /**
-         * Returns the next configured plugin proxy
-         */
-        getNext: () => ITelemetryPluginChain;
-        /**
-         * Helper to set the next plugin proxy
-         */
-        setNext: (nextCtx: ITelemetryPluginChain) => void;
+    interface IProcessTelemetryContext extends IBaseProcessingContext {
         /**
          * Call back for telemetry processing before it it is sent
          * @param env - This is the current event being reported
+         * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
          */
-        processNext: (env: ITelemetryItem) => void;
+        processNext: (env: ITelemetryItem) => boolean | void;
         /**
-         * Synchronously iterate over the context chain running the callback for each plugin, once
-         * every plugin has been executed via the callback, any associated onComplete will be called.
-         * @param callback - The function call for each plugin in the context chain
-         */
-        iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
-        /**
-         * Create a new context using the core and config from the current instance
+         * Create a new context using the core and config from the current instance, returns a new instance of the same type
          * @param plugins - The execution order to process the plugins, if null or not supplied
          *                  then the current execution order will be copied.
          * @param startAt - The plugin to start processing from, if missing from the execution
          *                  order then the next plugin will be NOT set.
          */
         createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryContext;
+    }
+
+    /**
+     * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
+     * between multiple AppInsights instances
+     */
+    interface IProcessTelemetryUnloadContext extends IBaseProcessingContext {
         /**
-         * Set the function to call when the current chain has executed all processNext or unloadNext items.
+         * This Plugin has finished unloading, so unload the next one
+         * @param uploadState - The state of the unload process
+         * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
          */
-        onComplete: (onComplete: () => void) => void;
+        processNext: (unloadState: ITelemetryUnloadState) => boolean | void;
+        /**
+         * Create a new context using the core and config from the current instance, returns a new instance of the same type
+         * @param plugins - The execution order to process the plugins, if null or not supplied
+         *                  then the current execution order will be copied.
+         * @param startAt - The plugin to start processing from, if missing from the execution
+         *                  order then the next plugin will be NOT set.
+         */
+        createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUnloadContext;
+    }
+
+    interface _IRegisteredEvents {
+        name: string;
+        handler: any;
     }
 
     /**
@@ -1806,15 +2051,7 @@ declare namespace ApplicationInsights {
     /**
      * Configuration provided to SDK core
      */
-    interface ITelemetryPlugin extends IPlugin {
-        /**
-         * Call back for telemetry processing before it it is sent
-         * @param env - This is the current event being reported
-         * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
-         * can optionally use this to access the current core instance or define / pass additional information
-         * to later plugins (vs appending items to the telemetry item)
-         */
-        processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
+    interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
         /**
          * Set next extension for telemetry processing, this is not optional as plugins should use the
          * processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
@@ -1830,7 +2067,7 @@ declare namespace ApplicationInsights {
     /**
      * Configuration provided to SDK core
      */
-    interface ITelemetryPluginChain {
+    interface ITelemetryPluginChain extends ITelemetryProcessor {
         /**
          * Returns the underlying plugin that is being proxied for the processTelemetry call
          */
@@ -1839,6 +2076,16 @@ declare namespace ApplicationInsights {
          * Returns the next plugin
          */
         getNext: () => ITelemetryPluginChain;
+        /**
+         * This plugin is being unloaded and should remove any hooked events and cleanup any global/scoped values, after this
+         * call the plugin will be removed from the telemetry processing chain and will no longer receive any events..
+         * @param unloadCtx - The unload context to use for this call.
+         * @param unloadState - The details of the unload operation
+         */
+        unload?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
+    }
+
+    interface ITelemetryProcessor {
         /**
          * Call back for telemetry processing before it it is sent
          * @param env - This is the current event being reported
@@ -1846,7 +2093,13 @@ declare namespace ApplicationInsights {
          * can optionally use this to access the current core instance or define / pass additional information
          * to later plugins (vs appending items to the telemetry item)
          */
-        processTelemetry: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
+        processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
+    }
+
+    interface ITelemetryUnloadState {
+        reason: TelemetryUnloadReason;
+        isAsync: boolean;
+        flushComplete?: boolean;
     }
 
     /**
@@ -1861,16 +2114,14 @@ declare namespace ApplicationInsights {
      */
     function _legacyCookieMgr(config?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
-    enum LoggingSeverity {
-        /**
-         * Error will be sent as internal telemetry
-         */
-        CRITICAL = 1,
-        /**
-         * Error will NOT be sent as internal telemetry, and will only be shown in browser console
-         */
-        WARNING = 2
-    }
+    const LoggingSeverity: {
+        CRITICAL: number;
+        WARNING: number;
+    };
+
+    type LoggingSeverity = number | eLoggingSeverity;
+
+    function mergeEvtNamespace(theNamespace: string, namespaces: string | string[]): string | string[];
 
     const MinChannelPriorty: number;
 
@@ -1962,6 +2213,18 @@ declare namespace ApplicationInsights {
      */
     function objDefineAccessors<T>(target: any, prop: string, getProp?: () => T, setProp?: (v: T) => void): boolean;
 
+    /**
+     * Pass in the objects to merge as arguments, this will only "merge" (extend) properties that are owned by the object.
+     * It will NOT merge inherited or non-enumerable properties.
+     * @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 first object.
+     */
+    function objExtend<T1, T2, T3, T4, T5, T6>(obj?: boolean | T1, obj2?: T2, obj3?: T3, obj4?: T4, obj5?: T5, obj6?: T6): T1 & T2 & T3 & T4 & T5 & T6;
+
     /**
      * This is a helper function for the equivalent of arForEach(objKeys(target), callbackFn), this is a
      * performance optimization to avoid the creation of a new array for large objects
@@ -2108,8 +2371,9 @@ declare namespace ApplicationInsights {
          * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
          * can optionally use this to access the current core instance or define / pass additional information
          * to later plugins (vs appending items to the telemetry item)
+         * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
          */
-        processNext: (env: ITelemetryItem) => void;
+        processNext: (env: ITelemetryItem) => boolean | void;
         /**
          * Synchronously iterate over the context chain running the callback for each plugin, once
          * every plugin has been executed via the callback, any associated onComplete will be called.
@@ -2117,7 +2381,6 @@ declare namespace ApplicationInsights {
          */
         iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
         /**
-         /**
          * Create a new context using the core and config from the current instance
          * @param plugins - The execution order to process the plugins, if null or not supplied
          *                  then the current execution order will be copied.
@@ -2155,6 +2418,17 @@ declare namespace ApplicationInsights {
      */
     function proxyAssign<T, S>(target: T, source: S, chkSet?: (name: string, isFunc?: boolean, source?: S, target?: T) => boolean): T;
 
+    function proxyFunctionAs<T, S>(target: T, name: string, source: S | (() => S), theFunc: (keyof S), overwriteTarget?: boolean): void;
+
+    /**
+     * Creates proxy functions on the target which internally will call the source version with all arguments passed to the target method.
+     *
+     * @param target - The target object to be assigned with the source properties and functions
+     * @param source - The source object which will be assigned / called by setting / calling the targets proxies
+     * @param functionsToProxy - An array of function names that will be proxied on the target
+     */
+    function proxyFunctions<T, S>(target: T, source: S | (() => S), functionsToProxy: (keyof S)[], overwriteTarget?: boolean): T;
+
     /**
      * generate a random 32-bit number (0x000000..0xFFFFFFFF) or (-0x80000000..0x7FFFFFFF), defaults un-unsigned.
      * @param signed - True to return a signed 32-bit number (-0x80000000..0x7FFFFFFF) otherwise an unsigned one (0x000000..0xFFFFFFFF)
@@ -2168,6 +2442,43 @@ declare namespace ApplicationInsights {
      */
     function randomValue(maxValue: number): number;
 
+    /**
+     * Trys to remove event handler(s) for the specified event/namespace to the window, body and document
+     * @param eventName {string} - The name of the event, with optional namespaces or just the namespaces,
+     * such as "click", "click.mynamespace" or ".mynamespace"
+     * @param callback {any} - - The callback function that needs to be removed from the given event, when using a
+     * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
+     * otherwise this will only remove events with this specific handler.
+     * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
+     */
+    function removeEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): void;
+
+    /**
+     * Remove the listener from the array of events
+     * @param events An string array of event names to bind the listener to
+     * @param listener The event callback to call when the event is triggered
+     * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
+     */
+    function removeEventListeners(events: string[], listener: any, evtNamespace?: string | string[]): void;
+
+    /**
+     * Removes the pageHide event listeners added by addPageHideEventListener, because the 'visibilitychange' uses
+     * an internal proxy to detect the visibility state you SHOULD use a unique namespace when calling addPageHideEventListener
+     * as the remove ignores the listener argument for the 'visibilitychange' event.
+     * @param listener - The specific listener to remove for the 'pageshow' event only (ignored for 'visibilitychange')
+     * @param evtNamespace - The unique namespace used when calling addPageShowEventListener
+     */
+    function removePageHideEventListener(listener: any, evtNamespace?: string | string[]): void;
+
+    /**
+     * Remove any matching 'beforeunload', 'unload' and 'pagehide' events that may have been added via addEventListener,
+     * addEventListeners, addPageUnloadEventListener or addPageHideEventListener.
+     * @param listener - The specific event callback to to be removed
+     * @param evtNamespace - [Optional] Namespace(s) uniquely identified and removed based on this namespace.
+     * @returns true - when at least one of the events was registered otherwise false
+     */
+    function removePageUnloadEventListener(listener: any, evtNamespace?: string | string[]): void;
+
     /**
      * Helper to return the ICookieMgr from the core (if not null/undefined) or a default implementation
      * associated with the configuration or a legacy default.
@@ -2299,6 +2610,16 @@ declare namespace ApplicationInsights {
 
     type TelemetryInitializerFunction = <T extends ITelemetryItem>(item: T) => boolean | void;
 
+    /**
+     * The TelemetryUnloadReason enumeration contains the possible reasons for why a plugin is being unloaded / torndown().
+     */
+    const enum TelemetryUnloadReason {
+        /**
+         * Teardown has been called without any context.
+         */
+        ManualTeardown = 0
+    }
+
     function throwError(message: string): never;
 
     /**