@microsoft/applicationinsights-core-js 2.8.0-beta.2203-09 → 2.8.0-beta.2203-12

package/types/JavaScriptSDK/EventHelpers.d.ts

@@ -11,7 +11,7 @@ export interface _IRegisteredEvents {
  * if the eventName also includes a namespace the namespace(s) are merged into a single namespace
  */
 export declare function __getRegisteredEvents(target: any, eventName?: string, evtNamespace?: string | string[]): _IRegisteredEvents[];
-export declare function mergeEvtNamespace(theNamespace: string, namespaces: string | string[]): string | string[];
+export declare function mergeEvtNamespace(theNamespace: string, namespaces?: string | string[] | null): string | string[];
 /**
  * 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.
@@ -23,7 +23,7 @@ export declare function mergeEvtNamespace(theNamespace: string, namespaces: stri
  * @param useCapture [Optional] Defaults to false
  * @returns True if the function was bound successfully to the event, otherwise false
  */
-export declare function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): boolean;
+export declare function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[] | null, useCapture?: boolean): boolean;
 /**
  * Removes an event handler for the specified event
  * @param Object to remove the event from
@@ -36,7 +36,7 @@ export declare function eventOn<T>(target: T, eventName: string, handlerRef: any
  * if the eventName also includes a namespace the namespace(s) are merged into a single namespace
  * @param useCapture [Optional] Defaults to false
  */
-export declare function eventOff<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[], useCapture?: boolean): void;
+export declare function eventOff<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[] | null, 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.
@@ -64,7 +64,7 @@ export declare function detachEvent(obj: any, eventNameWithoutOn: string, handle
  * @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
  */
-export declare function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): boolean;
+export declare function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[] | null): boolean;
 /**
  * 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,
@@ -74,7 +74,7 @@ export declare function addEventHandler(eventName: string, callback: any, evtNam
  * 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.
  */
-export declare function removeEventHandler(eventName: string, callback: any, evtNamespace?: string | string[]): void;
+export declare function removeEventHandler(eventName: string, callback: any, evtNamespace?: string | string[] | null): void;
 /**
  * Bind the listener to the array of events
  * @param events An string array of event names to bind the listener to
@@ -102,7 +102,7 @@ export declare function removeEventListeners(events: string[], listener: any, ev
  * @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
  */
-export declare function addPageUnloadEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
+export declare function addPageUnloadEventListener(listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 /**
  * Remove any matching 'beforeunload', 'unload' and 'pagehide' events that may have been added via addEventListener,
  * addEventListeners, addPageUnloadEventListener or addPageHideEventListener.
@@ -123,7 +123,7 @@ export declare function removePageUnloadEventListener(listener: any, evtNamespac
  * 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
  */
-export declare function addPageHideEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
+export declare function addPageHideEventListener(listener: any, excludeEvents?: string[] | null, evtNamespace?: string | string[] | null): boolean;
 /**
  * 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
@@ -131,7 +131,7 @@ export declare function addPageHideEventListener(listener: any, excludeEvents: s
  * @param listener - The specific listener to remove for the 'pageshow' event only (ignored for 'visibilitychange')
  * @param evtNamespace - The unique namespace used when calling addPageShowEventListener
  */
-export declare function removePageHideEventListener(listener: any, evtNamespace?: string | string[]): void;
+export declare function removePageHideEventListener(listener: any, evtNamespace?: string | string[] | null): void;
 /**
  * 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
@@ -143,7 +143,7 @@ export declare function removePageHideEventListener(listener: any, evtNamespace?
  * so that only the matching "removePageShowEventListener" can remove these events.
  * @returns true - when at least one of the events was registered otherwise false
  */
-export declare function addPageShowEventListener(listener: any, excludeEvents: string[], evtNamespace?: string | string[]): boolean;
+export declare function addPageShowEventListener(listener: any, excludeEvents?: string[] | null, evtNamespace?: string | string[] | null): boolean;
 /**
  * Removes the pageShow event listeners added by addPageShowEventListener, because the 'visibilitychange' uses
  * an internal proxy to detect the visibility state you SHOULD use a unique namespace when calling addPageShowEventListener
@@ -151,4 +151,4 @@ export declare function addPageShowEventListener(listener: any, excludeEvents: s
  * @param listener - The specific listener to remove for the 'pageshow' event only (ignored for 'visibilitychange')
  * @param evtNamespace - The unique namespace used when calling addPageShowEventListener
  */
-export declare function removePageShowEventListener(listener: any, evtNamespace?: string | string[]): void;
+export declare function removePageShowEventListener(listener: any, evtNamespace?: string | string[] | null): void;

package/types/JavaScriptSDK/HelperFuncs.d.ts

@@ -1,16 +1,16 @@
 /**
- * Helper used to get the prototype of the target object as getPrototypeOf is not available in an ES3 environment.
- * @ignore
- */
+  * Helper used to get the prototype of the target object as getPrototypeOf is not available in an ES3 environment.
+  * @ignore
+  */
 export declare function _getObjProto(target: any): any;
 export declare function objToString(obj: any): any;
 export declare function isTypeof(value: any, theType: string): boolean;
-export declare function isUndefined(value: any): boolean;
-export declare function isNotUndefined(value: any): boolean;
-export declare function isNullOrUndefined(value: any): boolean;
-export declare function isNotNullOrUndefined(value: any): boolean;
+export declare function isUndefined(value: any): value is undefined;
+export declare function isNotUndefined<T>(value: T): value is T;
+export declare function isNullOrUndefined(value: any): value is null | undefined;
+export declare function isNotNullOrUndefined<T>(value: T): value is T;
 export declare function hasOwnProperty(obj: any, prop: string): boolean;
-export declare function isObject(value: any): boolean;
+export declare function isObject<T>(value: T): value is T;
 export declare function isFunction(value: any): value is Function;
 export declare function isPromiseLike<T>(value: any): value is PromiseLike<T>;
 /**
@@ -121,7 +121,7 @@ export declare function _toISOStringPoly(date: Date): string;
  * @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.
  */
-export declare function arrForEach<T = any>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => void | number, thisArg?: any): void;
+export declare function arrForEach<T = any>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => undefined | void | number, thisArg?: any): void;
 /**
  * Returns the index of the first occurrence of a value 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
@@ -193,7 +193,7 @@ export declare function getExceptionName(object: any): string;
  * @param srcChk - [Optional] Callback to check to original value that if supplied will be called if the new value should be set (if allowed)
  * @returns The existing or new value, depending what was set
  */
-export declare function setValue<T, K extends keyof T>(target: T, field: K, value: T[K], valChk?: (value: T[K]) => boolean, srcChk?: (value: T[K]) => boolean): T[K];
+export declare function setValue<T, K extends keyof T>(target: T, field: K, value: T[K], valChk?: ((value: T[K]) => boolean) | null, srcChk?: ((value: T[K]) => boolean) | null): T[K];
 /**
  * Returns the current value from the target object if not null or undefined otherwise sets the new value and returns it
  * @param target - The target object to return or set the default value

package/types/JavaScriptSDK/PerfManager.d.ts

@@ -46,7 +46,7 @@ export declare class PerfManager implements IPerfManager {
      * Defined as private so it can be visualized via the DebugPlugin
      */
     private ctx;
-    constructor(manager: INotificationManager);
+    constructor(manager?: INotificationManager);
     /**
      * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
      * want to monitor this source event.

package/types/JavaScriptSDK/ProcessTelemetryContext.d.ts

@@ -12,7 +12,7 @@ import { IDiagnosticLogger } from "../JavaScriptSDK.Interfaces/IDiagnosticLogger
  * @param core - The current core instance
  * @param startAt - Identifies the next plugin to execute, if null there is no "next" plugin and if undefined it should assume the start of the chain
  */
-export declare function createProcessTelemetryContext(telemetryChain: ITelemetryPluginChain, config: IConfiguration, core: IAppInsightsCore, startAt?: IPlugin): IProcessTelemetryContext;
+export declare function createProcessTelemetryContext(telemetryChain: ITelemetryPluginChain | null, config: IConfiguration, core: IAppInsightsCore, startAt?: IPlugin): IProcessTelemetryContext;
 /**
  * Creates a new Telemetry Item context with the current config, core and plugin execution chain for handling the unloading of the chain
  * @param plugins - The plugin instances that will be executed
@@ -59,7 +59,7 @@ export declare class ProcessTelemetryContext implements IProcessTelemetryContext
      */
     getCfg: () => IConfiguration;
     getExtCfg: <T>(identifier: string, defaultValue?: T | any) => T;
-    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean) => number | string | boolean;
+    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
     /**
      * Returns the IAppInsightsCore instance for the current request
      */

package/types/JavaScriptSDK/TelemetryHelpers.d.ts

@@ -1,6 +1,8 @@
 import { IPlugin } from "../JavaScriptSDK.Interfaces/ITelemetryPlugin";
-import { IProcessTelemetryContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
+import { IProcessTelemetryContext, IProcessTelemetryUnloadContext } from "../JavaScriptSDK.Interfaces/IProcessTelemetryContext";
 import { IAppInsightsCore } from "../JavaScriptSDK.Interfaces/IAppInsightsCore";
+import { IUnloadableComponent } from "../JavaScriptSDK.Interfaces/IUnloadableComponent";
+import { ITelemetryUnloadState } from "../JavaScriptSDK.Interfaces/ITelemetryUnloadState";
 export interface IPluginState {
     core?: IAppInsightsCore;
     isInitialized?: boolean;
@@ -17,3 +19,13 @@ export declare function _getPluginState(plugin: IPlugin): IPluginState;
  */
 export declare function initializePlugins(processContext: IProcessTelemetryContext, extensions: IPlugin[]): void;
 export declare function sortPlugins<T = IPlugin>(plugins: T[]): T[];
+/**
+ * Teardown / Unload helper to perform teardown/unloading operations for the provided components synchronously or asynchronously, this will call any
+ * _doTeardown() or _doUnload() functions on the provided components to allow them to finish removal.
+ * @param components - The components you want to unload
+ * @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.
+ */
+export declare function unloadComponents(components: any | IUnloadableComponent[], unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void): void | boolean;

package/types/JavaScriptSDK.Interfaces/IProcessTelemetryContext.d.ts

@@ -61,7 +61,7 @@ export interface IBaseProcessingContext {
      * @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

package/types/JavaScriptSDK.Interfaces/IUnloadableComponent.d.ts

@@ -0,0 +1,13 @@
+import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
+import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
+export interface IUnloadableComponent {
+    /**
+    * 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.
+    */
+    _doUnload?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
+}

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

@@ -1,13 +1,14 @@
 export { IConfiguration } from "./JavaScriptSDK.Interfaces/IConfiguration";
 export { IChannelControls, MinChannelPriorty } from "./JavaScriptSDK.Interfaces/IChannelControls";
 export { ITelemetryPlugin, IPlugin } from "./JavaScriptSDK.Interfaces/ITelemetryPlugin";
-export { IAppInsightsCore } from "./JavaScriptSDK.Interfaces/IAppInsightsCore";
+export { IAppInsightsCore, ILoadedPlugin } from "./JavaScriptSDK.Interfaces/IAppInsightsCore";
 export { ITelemetryItem, ICustomProperties, Tags } from "./JavaScriptSDK.Interfaces/ITelemetryItem";
 export { IBaseProcessingContext, IProcessTelemetryContext, IProcessTelemetryUnloadContext, IProcessTelemetryUpdateContext, GetExtCfgMergeType } from "./JavaScriptSDK.Interfaces/IProcessTelemetryContext";
 export { INotificationListener } from "./JavaScriptSDK.Interfaces/INotificationListener";
 export { ITelemetryPluginChain } from "./JavaScriptSDK.Interfaces/ITelemetryPluginChain";
 export { IDiagnosticLogger } from "./JavaScriptSDK.Interfaces/IDiagnosticLogger";
 export { InstrumentorHooksCallback, IInstrumentHooksCallbacks, IInstrumentHooks, IInstrumentHook, IInstrumentCallDetails } from "./JavaScriptSDK.Interfaces/IInstrumentHooks";
+export { IUnloadableComponent } from "./JavaScriptSDK.Interfaces/IUnloadableComponent";
 export { EventsDiscardedReason } from "./JavaScriptSDK.Enums/EventsDiscardedReason";
 export { SendRequestReason } from "./JavaScriptSDK.Enums/SendRequestReason";
 export { TelemetryUpdateReason } from "./JavaScriptSDK.Enums/TelemetryUpdateReason";
@@ -17,7 +18,7 @@ export { BaseCore } from "./JavaScriptSDK/BaseCore";
 export { BaseTelemetryPlugin } from "./JavaScriptSDK/BaseTelemetryPlugin";
 export { randomValue, random32, mwcRandomSeed, mwcRandom32, newId } from "./JavaScriptSDK/RandomHelper";
 export { CoreUtils, ICoreUtils, EventHelper, IEventHelper, Undefined, newGuid, perfNow, generateW3CId, disableCookies, canUseCookies, getCookie, setCookie, deleteCookie, _legacyCookieMgr } from "./JavaScriptSDK/CoreUtils";
-export { isTypeof, isUndefined, isNullOrUndefined, hasOwnProperty, isObject, isFunction, normalizeJsName, objForEachKey, strEndsWith, strStartsWith, isDate, isArray, isError, isString, isNumber, isBoolean, toISOString, arrForEach, arrIndexOf, arrMap, arrReduce, strTrim, objKeys, objDefineAccessors, dateNow, getExceptionName, throwError, strContains, isSymbol, setValue, getSetValue, isNotTruthy, isTruthy, proxyAssign, proxyFunctions, proxyFunctionAs, createClassFromInterface, optimizeObject, isNotUndefined, isNotNullOrUndefined, objFreeze, objSeal, createEnumStyle, objExtend } from "./JavaScriptSDK/HelperFuncs";
+export { isTypeof, isUndefined, isNullOrUndefined, hasOwnProperty, isObject, isFunction, normalizeJsName, objForEachKey, strEndsWith, strStartsWith, isDate, isArray, isError, isString, isNumber, isBoolean, toISOString, arrForEach, arrIndexOf, arrMap, arrReduce, strTrim, objKeys, objDefineAccessors, dateNow, getExceptionName, throwError, strContains, isSymbol, setValue, getSetValue, isNotTruthy, isTruthy, proxyAssign, proxyFunctions, proxyFunctionAs, createClassFromInterface, optimizeObject, isNotUndefined, isNotNullOrUndefined, objFreeze, objSeal, createEnumStyle, objExtend, objToString } from "./JavaScriptSDK/HelperFuncs";
 export { attachEvent, detachEvent, addEventHandler, addEventListeners, addPageUnloadEventListener, addPageHideEventListener, addPageShowEventListener, removeEventHandler, removeEventListeners, removePageUnloadEventListener, removePageHideEventListener, removePageShowEventListener, eventOn, eventOff, mergeEvtNamespace, _IRegisteredEvents, __getRegisteredEvents } from "./JavaScriptSDK/EventHelpers";
 export { getGlobalInst, hasWindow, getWindow, hasDocument, getDocument, getCrypto, getMsCrypto, hasNavigator, getNavigator, hasHistory, getHistory, getLocation, getPerformance, hasJSON, getJSON, isReactNative, getConsole, dumpObj, isIE, getIEVersion, isSafari, setEnableEnvMocks, isBeaconsSupported, isFetchSupported, useXDomainRequest, isXhrSupported } from "./JavaScriptSDK/EnvUtils";
 export { getGlobal, objCreateFn as objCreate, strShimPrototype as strPrototype, strShimFunction as strFunction, strShimUndefined as strUndefined, strShimObject as strObject } from "@microsoft/applicationinsights-shims";
@@ -28,7 +29,7 @@ export { IPerfManager, IPerfManagerProvider } from "./JavaScriptSDK.Interfaces/I
 export { PerfEvent, PerfManager, doPerf, getGblPerfMgr, setGblPerfMgr } from "./JavaScriptSDK/PerfManager";
 export { safeGetLogger, DiagnosticLogger, _InternalLogMessage, _throwInternal } from "./JavaScriptSDK/DiagnosticLogger";
 export { ProcessTelemetryContext, createProcessTelemetryContext } from "./JavaScriptSDK/ProcessTelemetryContext";
-export { initializePlugins, sortPlugins } from "./JavaScriptSDK/TelemetryHelpers";
+export { initializePlugins, sortPlugins, unloadComponents } from "./JavaScriptSDK/TelemetryHelpers";
 export { _InternalMessageId, _eInternalMessageId, LoggingSeverity, eLoggingSeverity } from "./JavaScriptSDK.Enums/LoggingEnums";
 export { InstrumentProto, InstrumentProtos, InstrumentFunc, InstrumentFuncs } from "./JavaScriptSDK/InstrumentHooks";
 export { ICookieMgr, ICookieMgrConfig } from "./JavaScriptSDK.Interfaces/ICookieMgr";

package/types/tsdoc-metadata.json

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