@microsoft/applicationinsights-web-basic 2.8.0-beta.2203-10 → 2.8.0-beta.2203-13

package/dist/applicationinsights-web-basic.api.md

@@ -9,7 +9,6 @@
 // @public (undocumented)
 export class AppInsightsCore extends BaseCore implements IAppInsightsCore {
     constructor();
-    // Warning: (ae-forgotten-export) The symbol "IPlugin" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "IDiagnosticLogger" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "INotificationManager" needs to be exported by the entry point index.d.ts
     //
@@ -22,44 +21,221 @@ export class AppInsightsCore extends BaseCore implements IAppInsightsCore {
 // @public
 export class ApplicationInsights {
     constructor(config: IConfiguration & IConfig);
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
+    // Warning: (ae-forgotten-export) The symbol "UnloadHandler" needs to be exported by the entry point index.d.ts
+    addUnloadCb(handler: UnloadHandler): void;
     // Warning: (ae-forgotten-export) The symbol "IConfig" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     config: IConfiguration & IConfig;
+    evtNamespace(): string;
     flush(async?: boolean): void;
+    getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
+    // (undocumented)
+    getSKUDefaults(): void;
     initialize(): void;
     // (undocumented)
+    pollInternalLogs(): void;
+    // (undocumented)
     stopPollingInternalLogs(): void;
     track(item: ITelemetryItem): void;
+    unload(isAsync?: boolean, unloadComplete?: () => void): void;
 }
 
+// @public
+export function arrForEach<T = any>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => undefined | void | number, thisArg?: any): void;
+
 // Warning: (ae-forgotten-export) The symbol "ICoreUtils" needs to be exported by the entry point index.d.ts
 //
 // @public @deprecated
 export const CoreUtils: ICoreUtils;
 
+// @public (undocumented)
+export const enum _eInternalMessageId {
+    // (undocumented)
+    BrowserCannotReadLocalStorage = 1,
+    // (undocumented)
+    BrowserCannotReadSessionStorage = 2,
+    // (undocumented)
+    BrowserCannotWriteLocalStorage = 3,
+    // (undocumented)
+    BrowserCannotWriteSessionStorage = 4,
+    // (undocumented)
+    BrowserDoesNotSupportLocalStorage = 0,
+    // (undocumented)
+    BrowserFailedRemovalFromLocalStorage = 5,
+    // (undocumented)
+    BrowserFailedRemovalFromSessionStorage = 6,
+    // (undocumented)
+    CannotAccessCookie = 68,
+    // (undocumented)
+    CannotParseAiBlobValue = 101,
+    // (undocumented)
+    CannotSendEmptyTelemetry = 7,
+    // (undocumented)
+    CannotSerializeObject = 48,
+    // (undocumented)
+    CannotSerializeObjectNonSerializable = 49,
+    // (undocumented)
+    CircularReferenceDetected = 50,
+    // (undocumented)
+    ClearAuthContextFailed = 51,
+    // (undocumented)
+    ClientPerformanceMathError = 8,
+    // (undocumented)
+    CreateEnvelopeError = 47,
+    // (undocumented)
+    ErrorParsingAISessionCookie = 9,
+    // (undocumented)
+    ErrorPVCalc = 10,
+    // (undocumented)
+    ExceptionTruncated = 52,
+    // (undocumented)
+    ExceptionWhileLoggingError = 11,
+    // (undocumented)
+    FailedAddingCustomDefinedRequestContext = 104,
+    // (undocumented)
+    FailedAddingTelemetryToBuffer = 12,
+    // (undocumented)
+    FailedMonitorAjaxAbort = 13,
+    // (undocumented)
+    FailedMonitorAjaxDur = 14,
+    // (undocumented)
+    FailedMonitorAjaxGetCorrelationHeader = 18,
+    // (undocumented)
+    FailedMonitorAjaxOpen = 15,
+    // (undocumented)
+    FailedMonitorAjaxRSC = 16,
+    // (undocumented)
+    FailedMonitorAjaxSend = 17,
+    // (undocumented)
+    FailedMonitorAjaxSetRequestHeader = 71,
+    // (undocumented)
+    FailedToAddHandlerForOnBeforeUnload = 19,
+    // (undocumented)
+    FailedToFixDepricatedValues = 44,
+    // (undocumented)
+    FailedToReportDataLoss = 21,
+    // (undocumented)
+    FailedToRestoreStorageBuffer = 42,
+    // (undocumented)
+    FailedToSendQueuedTelemetry = 20,
+    // (undocumented)
+    FailedToSetStorageBuffer = 41,
+    // (undocumented)
+    FlushFailed = 22,
+    // (undocumented)
+    IdTooLong = 69,
+    // (undocumented)
+    IllegalCharsInName = 53,
+    // (undocumented)
+    InMemoryStorageBufferFull = 105,
+    // (undocumented)
+    InvalidBackendResponse = 43,
+    // (undocumented)
+    InvalidContentBlob = 102,
+    // (undocumented)
+    InvalidDurationValue = 45,
+    // (undocumented)
+    InvalidEvent = 70,
+    // (undocumented)
+    InvalidInstrumentationKey = 100,
+    // (undocumented)
+    ItemNotInArray = 54,
+    // (undocumented)
+    MaxAjaxPerPVExceeded = 55,
+    // (undocumented)
+    MessageLimitPerPVExceeded = 23,
+    // (undocumented)
+    MessageTruncated = 56,
+    // (undocumented)
+    MissingRequiredFieldSpecification = 24,
+    // (undocumented)
+    NameTooLong = 57,
+    // (undocumented)
+    NavigationTimingNotSupported = 25,
+    // (undocumented)
+    NotificationException = 74,
+    // (undocumented)
+    OnError = 26,
+    // (undocumented)
+    PluginException = 73,
+    // (undocumented)
+    SampleRateOutOfRange = 58,
+    // (undocumented)
+    SendBrowserInfoOnUserInit = 72,
+    // (undocumented)
+    SenderNotInitialized = 28,
+    // (undocumented)
+    SessionRenewalDateIsZero = 27,
+    // (undocumented)
+    SessionStorageBufferFull = 67,
+    // (undocumented)
+    SetAuthContextFailed = 59,
+    // (undocumented)
+    SetAuthContextFailedAccountName = 60,
+    // (undocumented)
+    SnippetScriptLoadFailure = 99,
+    // (undocumented)
+    StartCalledMoreThanOnce = 62,
+    // (undocumented)
+    StartTrackEventFailed = 29,
+    // (undocumented)
+    StartTrackFailed = 31,
+    // (undocumented)
+    StopCalledWithoutStart = 63,
+    // (undocumented)
+    StopTrackEventFailed = 30,
+    // (undocumented)
+    StopTrackFailed = 32,
+    // (undocumented)
+    StringValueTooLong = 61,
+    // (undocumented)
+    TelemetryEnvelopeInvalid = 46,
+    // (undocumented)
+    TelemetryInitializerFailed = 64,
+    // (undocumented)
+    TelemetrySampledAndNotSent = 33,
+    // (undocumented)
+    TrackArgumentsNotSpecified = 65,
+    // (undocumented)
+    TrackEventFailed = 34,
+    // (undocumented)
+    TrackExceptionFailed = 35,
+    // (undocumented)
+    TrackMetricFailed = 36,
+    // (undocumented)
+    TrackPageActionEventFailed = 103,
+    // (undocumented)
+    TrackPVFailed = 37,
+    // (undocumented)
+    TrackPVFailedCalc = 38,
+    // (undocumented)
+    TrackTraceFailed = 39,
+    // (undocumented)
+    TransmissionFailed = 40,
+    // (undocumented)
+    UrlTooLong = 66
+}
+
 // Warning: (ae-forgotten-export) The symbol "IPerfManagerProvider" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
 export interface IAppInsightsCore extends IPerfManagerProvider {
     // Warning: (ae-forgotten-export) The symbol "INotificationListener" needs to be exported by the entry point index.d.ts
     addNotificationListener?(listener: INotificationListener): void;
-    // Warning: (ae-forgotten-export) The symbol "ITelemetryPlugin" needs to be exported by the entry point index.d.ts
     addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting?: boolean, doAsync?: boolean, addCb?: (added?: boolean) => void): void;
     // Warning: (ae-forgotten-export) The symbol "TelemetryInitializerFunction" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "ITelemetryInitializerHandler" needs to be exported by the entry point index.d.ts
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
-    // Warning: (ae-forgotten-export) The symbol "UnloadHandler" needs to be exported by the entry point index.d.ts
     addUnloadCb(handler: UnloadHandler): void;
     // (undocumented)
     config: IConfiguration;
     evtNamespace(): string;
-    // Warning: (ae-forgotten-export) The symbol "SendRequestReason" needs to be exported by the entry point index.d.ts
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
     // Warning: (ae-forgotten-export) The symbol "ICookieMgr" needs to be exported by the entry point index.d.ts
     getCookieMgr(): ICookieMgr;
     getNotifyMgr(): INotificationManager;
-    // Warning: (ae-forgotten-export) The symbol "ILoadedPlugin" needs to be exported by the entry point index.d.ts
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
     // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryContext" needs to be exported by the entry point index.d.ts
     getProcessTelContext(): IProcessTelemetryContext;
@@ -163,6 +339,16 @@ export interface IEventTelemetry extends IPartC {
     name: string;
 }
 
+// @public (undocumented)
+export interface ILoadedPlugin<T extends IPlugin> {
+    isEnabled: () => boolean;
+    // (undocumented)
+    plugin: T;
+    // (undocumented)
+    remove: (isAsync?: boolean, removeCb?: (removed?: boolean) => void) => void;
+    setEnabled: (isEnabled: boolean) => void;
+}
+
 // @public (undocumented)
 export interface IMetricTelemetry extends IPartC {
     average: number;
@@ -174,6 +360,95 @@ export interface IMetricTelemetry extends IPartC {
     stdDev?: number;
 }
 
+// @public
+export const _InternalMessageId: {
+    BrowserDoesNotSupportLocalStorage: number;
+    BrowserCannotReadLocalStorage: number;
+    BrowserCannotReadSessionStorage: number;
+    BrowserCannotWriteLocalStorage: number;
+    BrowserCannotWriteSessionStorage: number;
+    BrowserFailedRemovalFromLocalStorage: number;
+    BrowserFailedRemovalFromSessionStorage: number;
+    CannotSendEmptyTelemetry: number;
+    ClientPerformanceMathError: number;
+    ErrorParsingAISessionCookie: number;
+    ErrorPVCalc: number;
+    ExceptionWhileLoggingError: number;
+    FailedAddingTelemetryToBuffer: number;
+    FailedMonitorAjaxAbort: number;
+    FailedMonitorAjaxDur: number;
+    FailedMonitorAjaxOpen: number;
+    FailedMonitorAjaxRSC: number;
+    FailedMonitorAjaxSend: number;
+    FailedMonitorAjaxGetCorrelationHeader: number;
+    FailedToAddHandlerForOnBeforeUnload: number;
+    FailedToSendQueuedTelemetry: number;
+    FailedToReportDataLoss: number;
+    FlushFailed: number;
+    MessageLimitPerPVExceeded: number;
+    MissingRequiredFieldSpecification: number;
+    NavigationTimingNotSupported: number;
+    OnError: number;
+    SessionRenewalDateIsZero: number;
+    SenderNotInitialized: number;
+    StartTrackEventFailed: number;
+    StopTrackEventFailed: number;
+    StartTrackFailed: number;
+    StopTrackFailed: number;
+    TelemetrySampledAndNotSent: number;
+    TrackEventFailed: number;
+    TrackExceptionFailed: number;
+    TrackMetricFailed: number;
+    TrackPVFailed: number;
+    TrackPVFailedCalc: number;
+    TrackTraceFailed: number;
+    TransmissionFailed: number;
+    FailedToSetStorageBuffer: number;
+    FailedToRestoreStorageBuffer: number;
+    InvalidBackendResponse: number;
+    FailedToFixDepricatedValues: number;
+    InvalidDurationValue: number;
+    TelemetryEnvelopeInvalid: number;
+    CreateEnvelopeError: number;
+    CannotSerializeObject: number;
+    CannotSerializeObjectNonSerializable: number;
+    CircularReferenceDetected: number;
+    ClearAuthContextFailed: number;
+    ExceptionTruncated: number;
+    IllegalCharsInName: number;
+    ItemNotInArray: number;
+    MaxAjaxPerPVExceeded: number;
+    MessageTruncated: number;
+    NameTooLong: number;
+    SampleRateOutOfRange: number;
+    SetAuthContextFailed: number;
+    SetAuthContextFailedAccountName: number;
+    StringValueTooLong: number;
+    StartCalledMoreThanOnce: number;
+    StopCalledWithoutStart: number;
+    TelemetryInitializerFailed: number;
+    TrackArgumentsNotSpecified: number;
+    UrlTooLong: number;
+    SessionStorageBufferFull: number;
+    CannotAccessCookie: number;
+    IdTooLong: number;
+    InvalidEvent: number;
+    FailedMonitorAjaxSetRequestHeader: number;
+    SendBrowserInfoOnUserInit: number;
+    PluginException: number;
+    NotificationException: number;
+    SnippetScriptLoadFailure: number;
+    InvalidInstrumentationKey: number;
+    CannotParseAiBlobValue: number;
+    InvalidContentBlob: number;
+    TrackPageActionEventFailed: number;
+    FailedAddingCustomDefinedRequestContext: number;
+    InMemoryStorageBufferFull: number;
+};
+
+// @public (undocumented)
+export type _InternalMessageId = number | _eInternalMessageId;
+
 // @public (undocumented)
 export interface IPageViewPerformanceTelemetry extends IPartC {
     domProcessing?: string;
@@ -200,6 +475,20 @@ export interface IPageViewTelemetry extends IPartC {
     uri?: string;
 }
 
+// @public (undocumented)
+export interface IPlugin {
+    readonly identifier: string;
+    // Warning: (ae-forgotten-export) The symbol "ITelemetryPluginChain" needs to be exported by the entry point index.d.ts
+    initialize: (config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain) => void;
+    isInitialized?: () => boolean;
+    // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryUnloadContext" needs to be exported by the entry point index.d.ts
+    teardown?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
+    readonly version?: string;
+}
+
+// @public (undocumented)
+export function isNullOrUndefined(value: any): value is null | undefined;
+
 // @public
 export interface ITelemetryItem {
     baseData?: {
@@ -219,6 +508,14 @@ export interface ITelemetryItem {
     ver?: string;
 }
 
+// Warning: (ae-forgotten-export) The symbol "ITelemetryProcessor" needs to be exported by the entry point index.d.ts
+//
+// @public
+export interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
+    readonly priority: number;
+    setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
+}
+
 // @public (undocumented)
 export interface ITraceTelemetry extends IPartC {
     iKey?: string;
@@ -226,6 +523,9 @@ export interface ITraceTelemetry extends IPartC {
     severityLevel?: SeverityLevel;
 }
 
+// @public
+export function proxyFunctions<T, S>(target: T, source: S | (() => S), functionsToProxy: (keyof S)[], overwriteTarget?: boolean): T;
+
 // Warning: (ae-forgotten-export) The symbol "BaseTelemetryPlugin" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "IChannelControlsAI" needs to be exported by the entry point index.d.ts
 //
@@ -243,8 +543,6 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
     flush(): void;
     // (undocumented)
     readonly identifier: string;
-    // Warning: (ae-forgotten-export) The symbol "ITelemetryPluginChain" needs to be exported by the entry point index.d.ts
-    //
     // (undocumented)
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     _onError(payload: string[], message: string, event?: ErrorEvent): void;
@@ -266,14 +564,26 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
     _sender: SenderFunction;
     // Warning: (ae-forgotten-export) The symbol "ISenderConfig" needs to be exported by the entry point index.d.ts
     readonly _senderConfig: ISenderConfig;
-    // (undocumented)
-    teardown(): void;
     triggerSend(async?: boolean, forcedSender?: SenderFunction, sendReason?: SendRequestReason): void;
     // Warning: (ae-forgotten-export) The symbol "XDomainRequest" needs to be exported by the entry point index.d.ts
     _xdrOnLoad(xdr: XDomainRequest, payload: string[]): void;
     _xhrReadyStateChange(xhr: XMLHttpRequest, payload: string[], countOfItemsInPayload: number): void;
 }
 
+// @public
+export const enum SendRequestReason {
+    ManualFlush = 1,
+    MaxBatchSize = 10,
+    MaxQueuedEvents = 20,
+    NormalSchedule = 1,
+    Resumed = 4,
+    Retry = 5,
+    SdkUnload = 6,
+    SyncEvent = 3,
+    Undefined = 0,
+    Unload = 2
+}
+
 // @public
 export enum SeverityLevel {
     // (undocumented)
@@ -288,6 +598,9 @@ export enum SeverityLevel {
     Warning = 2
 }
 
+// @public (undocumented)
+export function throwError(message: string): never;
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/dist/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-10
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -19,7 +19,6 @@ declare namespace ApplicationInsights {
      */
     class ApplicationInsights {
         config: IConfiguration & IConfig;
-        private core;
         /**
          * Creates an instance of ApplicationInsights.
          * @param {IConfiguration & IConfig} config
@@ -45,11 +44,51 @@ declare namespace ApplicationInsights {
          * @memberof ApplicationInsights
          */
         flush(async?: boolean): void;
-        private pollInternalLogs;
+        pollInternalLogs(): void;
         stopPollingInternalLogs(): void;
-        private getSKUDefaults;
+        getSKUDefaults(): void;
+        /**
+         * 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.
+         */
+        unload(isAsync?: boolean, unloadComplete?: () => void): 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
+         * @param doAsync - Should the add be performed asynchronously
+         */
+        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
+         */
+        evtNamespace(): string;
+        /**
+         * Add an unload handler that will be called when the SDK is being unloaded
+         * @param handler - the handler
+         */
+        addUnloadCb(handler: UnloadHandler): void;
     }
 
+    /**
+     * Performs the specified action for each element in an array. This helper exists to avoid adding a polyfil for older browsers
+     * that do not define Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page checks for presence/absence of the prototype
+     * implementation. Note: For consistency this will not use the Array.prototype.xxxx implementation if it exists as this would
+     * cause a testing requirement to test with and without the implementations
+     * @param callbackfn  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. It can return -1 to break out of the loop
+     * @param thisArg  [Optional] An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+     */
+    function arrForEach<T = any>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => undefined | void | number, thisArg?: any): void;
+
     class BaseCore implements IAppInsightsCore {
         static defaultConfig: IConfiguration;
         config: IConfiguration;
@@ -599,7 +638,7 @@ declare namespace ApplicationInsights {
          * @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;
+        onComplete: (onComplete: () => void, 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
@@ -2213,6 +2252,8 @@ declare namespace ApplicationInsights {
         aiDataContract: any;
     }
 
+    function isNullOrUndefined(value: any): value is null | undefined;
+
     interface IStackDetails {
         src: string;
         obj: string[];
@@ -2380,6 +2421,15 @@ declare namespace ApplicationInsights {
 
     type LoggingSeverity = number | eLoggingSeverity;
 
+    /**
+     * 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;
+
     class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
         static constructEnvelope(orig: ITelemetryItem, iKey: string, logger: IDiagnosticLogger, convertUndefined?: any): IEnvelope;
         readonly priority: number;
@@ -2424,7 +2474,6 @@ declare namespace ApplicationInsights {
          * Will not flush if the Send has been paused.
          */
         onunloadFlush(): void;
-        teardown(): void;
         initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
         processTelemetry(telemetryItem: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
         /**
@@ -2569,6 +2618,8 @@ declare namespace ApplicationInsights {
         PluginRemoved = 32
     }
 
+    function throwError(message: string): never;
+
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
     interface XDomainRequest extends XMLHttpRequestEventTarget {