@microsoft/applicationinsights-core-js 2.8.0-nightly.2202-06 → 2.8.0-nightly.2204-06

package/src/JavaScriptSDK.Enums/LoggingEnums.ts

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-export enum LoggingSeverity {
+
+import { createEnumStyle } from "../JavaScriptSDK.Enums/EnumHelperFuncs";
+
+export const enum eLoggingSeverity {
     /**
      * Error will be sent as internal telemetry
      */
@@ -9,97 +12,190 @@ export enum LoggingSeverity {
     /**
      * Error will NOT be sent as internal telemetry, and will only be shown in browser console
      */
-    WARNING = 2,
+    WARNING = 2
+}
+
+export const LoggingSeverity = createEnumStyle<typeof eLoggingSeverity>({
+    CRITICAL: eLoggingSeverity.CRITICAL,
+    WARNING: eLoggingSeverity.WARNING
+});
+export type LoggingSeverity = number | eLoggingSeverity;
+
+export 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,
+
+    // User actionable
+    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
 }
 
 /**
  * Internal message ID. Please create a new one for every conceptually different message. Please keep alphabetically ordered
  */
-export const _InternalMessageId = {
+export const _InternalMessageId = createEnumStyle<typeof _eInternalMessageId>({
     // Non user actionable
-    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,
+    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,
 
     // User actionable
-    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
-};
-export type _InternalMessageId = number | typeof _InternalMessageId;
+    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,
+    CannotParseAiBlobValue: _eInternalMessageId.CannotParseAiBlobValue,
+    InvalidContentBlob: _eInternalMessageId.InvalidContentBlob,
+    TrackPageActionEventFailed: _eInternalMessageId.TrackPageActionEventFailed,
+    FailedAddingCustomDefinedRequestContext: _eInternalMessageId.FailedAddingCustomDefinedRequestContext,
+    InMemoryStorageBufferFull: _eInternalMessageId.InMemoryStorageBufferFull
+});
+export type _InternalMessageId = number | _eInternalMessageId;

package/src/JavaScriptSDK.Enums/SendRequestReason.ts

@@ -38,6 +38,11 @@ export const enum SendRequestReason {
      * The event(s) being sent as a retry
      */
     Retry = 5,
+
+    /**
+     * The SDK is unloading
+     */
+    SdkUnload = 6,
     
     /**
      * Maximum batch size would be exceeded

package/src/JavaScriptSDK.Enums/TelemetryUnloadReason.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * The TelemetryUnloadReason enumeration contains the possible reasons for why a plugin is being unloaded / torndown().
+ */
+export const enum TelemetryUnloadReason {
+    /**
+     * Teardown has been called without any context.
+     */
+    ManualTeardown = 0,
+
+    /**
+     * Just this plugin is being removed
+     */
+    PluginUnload = 1,
+
+    /**
+     * This instance of the plugin is being removed and replaced
+     */
+    PluginReplace = 2,
+
+    /**
+     * The entire SDK is being unloaded
+     */
+    SdkUnload = 50
+}

package/src/JavaScriptSDK.Enums/TelemetryUpdateReason.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * The TelemetryUpdateReason enumeration contains a set of bit-wise values that specify the reason for update request.
+ */
+export const enum TelemetryUpdateReason {
+    /**
+     * Unknown.
+     */
+    Unknown = 0,
+
+    /**
+     * The configuration has ben updated or changed
+     */
+    //ConfigurationChanged = 0x01,
+
+    /**
+     * One or more plugins have been added
+     */
+    PluginAdded = 0x10,
+
+    /**
+     * One or more plugins have been removed
+     */
+    PluginRemoved = 0x20,
+}

package/src/JavaScriptSDK.Interfaces/IAppInsightsCore.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 import { ITelemetryItem } from "./ITelemetryItem";
 import { IChannelControls } from "./IChannelControls";
-import { IPlugin } from "./ITelemetryPlugin";
+import { IPlugin, ITelemetryPlugin } from "./ITelemetryPlugin";
 import { IConfiguration } from "./IConfiguration";
 import { INotificationManager } from "./INotificationManager";
 import { INotificationListener } from "./INotificationListener";
@@ -10,8 +10,31 @@ import { IDiagnosticLogger } from "./IDiagnosticLogger";
 import { IProcessTelemetryContext } from "./IProcessTelemetryContext";
 import { IPerfManagerProvider } from "./IPerfManager";
 import { ICookieMgr } from "./ICookieMgr";
+import { ITelemetryInitializerHandler, TelemetryInitializerFunction } from "./ITelemetryInitializers";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
+import { UnloadHandler } from "../JavaScriptSDK/UnloadHandlerContainer";
+import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
 
-"use strict";
+export 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;
+
+    remove: (isAsync?: boolean, removeCb?: (removed?: boolean) => void) => void;
+}
 
 export interface IAppInsightsCore extends IPerfManagerProvider {
 
@@ -72,6 +95,13 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      */
     removeNotificationListener?(listener: INotificationListener): void;
 
+    /**
+     * Add a telemetry processor to decorate or drop telemetry events.
+     * @param telemetryInitializer - The Telemetry Initializer function
+     * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
+     */
+    addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
+
     pollInternalLogs?(eventName?: string): number;
 
     stopPollingInternalLogs?(): void;
@@ -80,4 +110,54 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
      * Return a new instance of the IProcessTelemetryContext for processing events
      */
     getProcessTelContext() : IProcessTelemetryContext;
+
+    /**
+     * Unload and Tear down the SDK and any initialized plugins, after calling this the SDK will be considered
+     * to be un-initialized and non-operational, re-initializing the SDK should only be attempted if the previous
+     * unload call return `true` stating that all plugins reported that they also unloaded, the recommended
+     * approach is to create a new instance and initialize that instance.
+     * This is due to possible unexpected side effects caused by plugins not supporting unload / teardown, unable
+     * to successfully remove any global references or they may just be completing the unload process asynchronously.
+     * @param isAsync - Can the unload be performed asynchronously (default)
+     * @param unloadComplete - An optional callback that will be called once the unload has completed
+     * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.
+     */
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
+
+    /**
+     * Find and return the (first) plugin with the specified identifier if present
+     * @param pluginIdentifier
+     */
+    getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+  
+    /**
+     * Add a new plugin to the installation
+     * @param plugin - The new plugin to add
+     * @param replaceExisting - should any existing plugin be replaced, default is false
+     * @param doAsync - Should the add be performed asynchronously
+     * @param addCb - [Optional] callback to call after the plugin has been added
+     */
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting?: boolean, doAsync?: boolean, addCb?: (added?: boolean) => void): void;
+  
+    /**
+     * Returns the unique event namespace that should be used when registering events
+     */
+    evtNamespace(): string;
+  
+    /**
+     * Add a handler that will be called when the SDK is being unloaded
+     * @param handler - the handler
+     */
+    addUnloadCb(handler: UnloadHandler): void;
+
+    /**
+     * Flush and send any batched / cached data immediately
+     * @param async - send data asynchronously when true (defaults to true)
+     * @param callBack - if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called.
+     * If the caller doesn't return true the caller should assume that it may never be called.
+     * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
+     * @param cbTimeout - An optional timeout to wait for any flush operations to complete before proceeding with the unload. Defaults to 5 seconds.
+     * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
+     */
+    flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
 }

package/src/JavaScriptSDK.Interfaces/IChannelControls.ts

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
+import { SendRequestReason } from "../JavaScriptSDK.Enums/SendRequestReason";
+import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
 import { ITelemetryPlugin } from "./ITelemetryPlugin";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
 
 "use strict";
 
@@ -20,16 +23,24 @@ export interface IChannelControls extends ITelemetryPlugin {
     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
-     * @param callBack: if specified, notify caller when send is complete
+     * @param async - send data asynchronously when true
+     * @param callBack - if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called.
+     * If the caller doesn't return true the caller should assume that it may never be called.
+     * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
+     * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
      */
-    flush(async: boolean, callBack?: () => void): void;
+    flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
 }
 
 export const MinChannelPriorty: number = 100;

package/src/JavaScriptSDK.Interfaces/IInstrumentHooks.ts

@@ -12,6 +12,11 @@ export type InstrumentorHooksCallback = (funcArgs:IInstrumentCallDetails, ...org
  * You must always supply the error callback
  */
 export interface IInstrumentHooksCallbacks {
+    /**
+     * [Optional] Namespace details (same as the namespace used for events), useful for debugging and testing to
+     * identify the source of the instrumented hooks
+     */
+    ns?: string | string[];
 
     /**
      * The hook callback to call before the original function is called
@@ -40,20 +45,20 @@ export interface IInstrumentHooksCallbacks {
  */
 export interface IInstrumentHook {
     /** Unique Id for this callback on the hooked method */
-    id:number;
+    id: number;
 
     /** Holds the callbacks */
-    cbks:IInstrumentHooksCallbacks;
+    cbks: IInstrumentHooksCallbacks;
 
     /** Remove this hook from the function */
     rm: () => void;
 }
 
 export interface IInstrumentHooks {
-    i:number;               // Used to create unique ids
-    n:string;               // Function name
-    f:any;                  // Original Function
-    h:IInstrumentHook[];    // The hook
+    i: number;               // Used to create unique ids
+    n: string;               // Function name
+    f: any;                  // Original Function
+    h: IInstrumentHook[];    // The hook
 }
 
 export interface IInstrumentCallDetails {
@@ -85,4 +90,9 @@ export interface IInstrumentCallDetails {
      * The error (exception) which occurred while executing the original method
      */
     err?: Error;
+
+    /**
+     * The Event object from (window.event) at the start of the original call
+     */
+    evt?: Event;
 }