@microsoft/applicationinsights-core-js 2.8.0-beta.2202-07 → 2.8.0-beta.2203-03

package/dist/applicationinsights-core-js.api.md

@@ -12,19 +12,22 @@ import { strShimPrototype as strPrototype } from '@microsoft/applicationinsights
 import { strShimUndefined as strUndefined } from '@microsoft/applicationinsights-shims';
 
 // @public
-export function addEventHandler(eventName: string, callback: any): boolean;
+export function __getRegisteredEvents(target: any, evtName?: string): _IRegisteredEvents[];
 
 // @public
-export function addEventListeners(events: string[], listener: any, excludeEvents?: string[]): boolean;
+export function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): boolean;
 
 // @public
-export function addPageHideEventListener(listener: any, excludeEvents?: string[]): boolean;
+export function addEventListeners(events: string[], listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 
 // @public
-export function addPageShowEventListener(listener: any, excludeEvents?: string[]): boolean;
+export function addPageHideEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
 
 // @public
-export function addPageUnloadEventListener(listener: any, excludeEvents?: string[]): boolean;
+export function addPageShowEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
+
+// @public
+export function addPageUnloadEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
 
 // @public (undocumented)
 export class AppInsightsCore extends BaseCore implements IAppInsightsCore {
@@ -57,13 +60,17 @@ export function attachEvent(obj: any, eventNameWithoutOn: string, handlerRef: an
 export class BaseCore implements IAppInsightsCore {
     constructor();
     addNotificationListener(listener: INotificationListener): void;
+    // (undocumented)
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
+    addUnloadCb(handler: UnloadHandler): void;
     // (undocumented)
     config: IConfiguration;
     // (undocumented)
     static defaultConfig: IConfiguration;
     // (undocumented)
     eventCnt(): number;
+    evtNamespace(): string;
     // (undocumented)
     _extensions: IPlugin[];
     getCookieMgr(): ICookieMgr;
@@ -95,14 +102,18 @@ export class BaseCore implements IAppInsightsCore {
     stopPollingInternalLogs(): void;
     // (undocumented)
     track(telemetryItem: ITelemetryItem): void;
+    unload(isAsync?: boolean, unloadComplete?: () => void): void;
 }
 
 // @public
 export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     constructor();
     protected _addHook(hooks: IInstrumentHook | IInstrumentHook[]): void;
+    protected _addUnloadCb(handler: UnloadHandler): void;
     core: IAppInsightsCore;
     diagLog: (itemCtx?: IProcessTelemetryContext) => IDiagnosticLogger;
+    // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryUnloadContext" needs to be exported by the entry point applicationinsights-core-js.d.ts
+    protected _doTeardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
     protected _getTelCtx: (currentCtx?: IProcessTelemetryContext) => IProcessTelemetryContext;
     // (undocumented)
     identifier: string;
@@ -116,6 +127,7 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
     protected setInitialized: (isInitialized: boolean) => void;
     setNextPlugin: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
+    teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
     // (undocumented)
     version?: string;
 }
@@ -132,9 +144,21 @@ export function createClassFromInterface<T>(defaults?: T): new () => T;
 // @public (undocumented)
 export function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
+// @public
+export function createEnumStyle<T>(values: T): T;
+
 // @public
 export function createProcessTelemetryContext(telemetryChain: ITelemetryPluginChain, config: IConfiguration, core: IAppInsightsCore, startAt?: IPlugin): IProcessTelemetryContext;
 
+// @public (undocumented)
+export function createUniqueNamespace(name: string, includeVersion?: boolean): string;
+
+// @public (undocumented)
+export function createUnloadHandlerContainer(): {
+    add: (handler: UnloadHandler) => void;
+    run: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
+};
+
 // @public
 export function dateNow(): number;
 
@@ -170,9 +194,189 @@ export function doPerf<T>(mgrSource: IPerfManagerProvider | IPerfManager, getSou
 // @public
 export function dumpObj(object: any): string;
 
+// @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
+}
+
+// @public (undocumented)
+export const enum eLoggingSeverity {
+    CRITICAL = 1,
+    WARNING = 2
+}
+
 // @public (undocumented)
 export const EventHelper: IEventHelper;
 
+// @public
+export function eventOff<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): void;
+
+// @public
+export function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): boolean;
+
 // @public
 export const EventsDiscardedReason: {
     Unknown: number;
@@ -273,9 +477,12 @@ export function hasWindow(): boolean;
 // @public (undocumented)
 export interface IAppInsightsCore extends IPerfManagerProvider {
     addNotificationListener?(listener: INotificationListener): void;
+    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
+    addUnloadCb(handler: UnloadHandler): void;
     // (undocumented)
     config: IConfiguration;
+    evtNamespace(): string;
     getCookieMgr(): ICookieMgr;
     getNotifyMgr(): INotificationManager;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
@@ -295,6 +502,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     stopPollingInternalLogs?(): void;
     // (undocumented)
     track(telemetryItem: ITelemetryItem): void;
+    unload(isAsync?: boolean, unloadComplete?: () => void): void;
 }
 
 // @public
@@ -302,7 +510,7 @@ export interface IChannelControls extends ITelemetryPlugin {
     flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
     pause(): void;
     resume(): void;
-    teardown(): void;
+    teardown: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
 }
 
 // @public
@@ -356,7 +564,7 @@ export interface ICookieMgrConfig {
 
 // @public @deprecated
 export interface ICoreUtils {
-    addEventHandler: (eventName: string, callback: any) => boolean;
+    addEventHandler: (eventName: string, callback: any, evtNamespace?: string | string[]) => boolean;
     arrForEach: <T>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => void | number, thisArg?: any) => void;
     arrIndexOf: <T>(arr: T[], searchElement: T, fromIndex?: number) => number;
     arrMap: <T, R>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => R, thisArg?: any) => R[];
@@ -623,7 +831,7 @@ export const _InternalMessageId: {
 };
 
 // @public (undocumented)
-export type _InternalMessageId = number | typeof _InternalMessageId;
+export type _InternalMessageId = number | _eInternalMessageId;
 
 // @public
 export interface IPerfEvent {
@@ -660,24 +868,24 @@ export interface IPlugin {
     readonly identifier: string;
     initialize: (config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain) => void;
     isInitialized?: () => boolean;
-    teardown?: () => void;
+    teardown?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
     readonly version?: string;
 }
 
+// Warning: (ae-forgotten-export) The symbol "IBaseProcessingContext" needs to be exported by the entry point applicationinsights-core-js.d.ts
+//
 // @public
-export interface IProcessTelemetryContext {
-    core: () => IAppInsightsCore;
+export interface IProcessTelemetryContext extends IBaseProcessingContext {
     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryContext;
-    diagLog: () => IDiagnosticLogger;
-    getCfg: () => IConfiguration;
-    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
-    getExtCfg: <T>(identifier: string, defaultValue?: T | any, mergeDefault?: GetExtCfgMergeType) => T;
-    getNext: () => ITelemetryPluginChain;
-    hasNext: () => boolean;
-    iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
-    onComplete: (onComplete: () => void) => void;
-    processNext: (env: ITelemetryItem) => void;
-    setNext: (nextCtx: ITelemetryPluginChain) => void;
+    processNext: (env: ITelemetryItem) => boolean | void;
+}
+
+// @public (undocumented)
+export interface _IRegisteredEvents {
+    // (undocumented)
+    handler: any;
+    // (undocumented)
+    name: string;
 }
 
 // @public
@@ -774,28 +982,55 @@ export interface ITelemetryItem {
     ver?: string;
 }
 
+// Warning: (ae-forgotten-export) The symbol "ITelemetryProcessor" needs to be exported by the entry point applicationinsights-core-js.d.ts
+//
 // @public
-export interface ITelemetryPlugin extends IPlugin {
+export interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
     readonly priority: number;
-    processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
     setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
 }
 
 // @public
-export interface ITelemetryPluginChain {
+export interface ITelemetryPluginChain extends ITelemetryProcessor {
     getNext: () => ITelemetryPluginChain;
     getPlugin: () => ITelemetryPlugin;
-    processTelemetry: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
+    unload?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
+}
+
+// @public (undocumented)
+export interface ITelemetryUnloadState {
+    // (undocumented)
+    flushComplete?: boolean;
+    // (undocumented)
+    isAsync: boolean;
+    // Warning: (ae-forgotten-export) The symbol "TelemetryUnloadReason" needs to be exported by the entry point applicationinsights-core-js.d.ts
+    //
+    // (undocumented)
+    reason: TelemetryUnloadReason;
+}
+
+// @public (undocumented)
+export interface IUnloadHandlerContainer {
+    // (undocumented)
+    add: (handler: UnloadHandler) => void;
+    // (undocumented)
+    run: (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 }
 
 // @public
 export function _legacyCookieMgr(config?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
 // @public (undocumented)
-export enum LoggingSeverity {
-    CRITICAL = 1,
-    WARNING = 2
-}
+export const LoggingSeverity: {
+    CRITICAL: number;
+    WARNING: number;
+};
+
+// @public (undocumented)
+export type LoggingSeverity = number | eLoggingSeverity;
+
+// @public (undocumented)
+export function mergeEvtNamespace(theNamespace: string, namespaces: string | string[]): string | string[];
 
 // @public (undocumented)
 export const MinChannelPriorty: number;
@@ -833,6 +1068,9 @@ export { objCreate }
 // @public
 export function objDefineAccessors<T>(target: any, prop: string, getProp?: () => T, setProp?: (v: T) => void): boolean;
 
+// @public
+export 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;
+
 // @public
 export function objForEachKey<T = any>(target: T, callbackfn: (name: string, value: T[keyof T]) => void): void;
 
@@ -897,19 +1135,37 @@ export class ProcessTelemetryContext implements IProcessTelemetryContext {
     hasNext: () => boolean;
     iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
     onComplete: (onComplete: () => void) => void;
-    processNext: (env: ITelemetryItem) => void;
+    processNext: (env: ITelemetryItem) => boolean | void;
     setNext: (nextCtx: ITelemetryPluginChain) => void;
 }
 
 // @public
 export function proxyAssign<T, S>(target: T, source: S, chkSet?: (name: string, isFunc?: boolean, source?: S, target?: T) => boolean): T;
 
+// @public (undocumented)
+export function proxyFunctionAs<T, S>(target: T, name: string, source: S | (() => S), theFunc: (keyof S), overwriteTarget?: boolean): void;
+
+// @public
+export function proxyFunctions<T, S>(target: T, source: S | (() => S), functionsToProxy: (keyof S)[], overwriteTarget?: boolean): T;
+
 // @public
 export function random32(signed?: boolean): number;
 
 // @public
 export function randomValue(maxValue: number): number;
 
+// @public
+export function removeEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): void;
+
+// @public
+export function removeEventListeners(events: string[], listener: any, evtNamespace?: string | string[]): void;
+
+// @public
+export function removePageHideEventListener(listener: any, evtNamespace?: string | string[]): void;
+
+// @public
+export function removePageUnloadEventListener(listener: any, evtNamespace?: string | string[]): void;
+
 // @public
 export function safeGetCookieMgr(core: IAppInsightsCore, config?: IConfiguration): ICookieMgr;
 
@@ -924,6 +1180,7 @@ export const enum SendRequestReason {
     NormalSchedule = 1,
     Resumed = 4,
     Retry = 5,
+    SdkUnload = 6,
     SyncEvent = 3,
     Undefined = 0,
     Unload = 2
@@ -991,6 +1248,9 @@ export function uaDisallowsSameSiteNone(userAgent: string): boolean;
 // @public (undocumented)
 export const Undefined = "undefined";
 
+// @public (undocumented)
+export type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
+
 // @public (undocumented)
 export function useXDomainRequest(): boolean | undefined;