@microsoft/applicationinsights-web 2.8.0-beta.2203-04 → 2.8.0-beta.2203-07

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.0-beta.2203-04
+ * Microsoft.ApplicationInsights, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -54,16 +54,12 @@ export declare class AppInsightsCore extends BaseCore implements IAppInsightsCor
 
 export declare class ApplicationAnalytics extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
     static Version: string;
-    static getDefaultConfig(config?: IConfig): IConfig;
+    static getDefaultConfig: typeof _getDefaultConfig;
     identifier: string;
     priority: number;
     config: IConfig;
     queue: Array<() => void>;
     autoRoutePVDelay: number;
-    protected _telemetryInitializers: Array<(envelope: ITelemetryItem) => boolean | void>;
-    protected _pageViewManager: PageViewManager;
-    protected _pageViewPerformanceManager: PageViewPerformanceManager;
-    protected _pageVisitTimeManager: PageVisitTimeManager;
     constructor();
     /**
      * Get the current cookie manager for this instance
@@ -187,7 +183,7 @@ export declare class ApplicationAnalytics extends BaseTelemetryPlugin implements
      * @memberof ApplicationInsights
      */
     _onerror(exception: IAutoExceptionTelemetry): void;
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
 }
 
@@ -298,7 +294,7 @@ export declare class ApplicationInsights implements IApplicationInsights {
     }, measurements?: {
         [key: string]: number;
     }): void;
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void | ITelemetryInitializerHandler;
     /**
      * Set the authenticated user id and the account id. Used for identifying a specific signed-in user. Parameters must not contain whitespace or ,;=|
      *
@@ -430,10 +426,20 @@ export declare class BaseCore implements IAppInsightsCore {
      * 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?: () => void): void;
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
-    addPlugin<T extends IPlugin = ITelemetryPlugin>(plugin: T, replaceExisting: boolean, doAsync: boolean, addCb?: (added?: boolean) => void): void;
+    /**
+     * 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
      */
@@ -443,7 +449,23 @@ export declare class BaseCore implements IAppInsightsCore {
      * @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
+     * @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): void;
     protected releaseQueue(): void;
+    /**
+     * Hook for Core extensions to allow them to update their own configuration before updating all of the plugins.
+     * @param updateCtx - The plugin update context
+     * @param updateState - The Update State
+     * @returns boolean - True means the extension class will call updateState otherwise the Core will
+     */
+    protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
 }
 
 /**
@@ -500,6 +522,14 @@ export declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      * @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;
+    /**
+     * Extension hook to allow implementations to perform some additional update operations before the BaseTelemetryPlugin finishes it's removal
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async update operations.
+     * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
+     */
+    protected _doUpdate?: (updateCtx?: IProcessTelemetryUpdateContext, updateState?: ITelemetryUpdateState, asyncCallback?: () => void) => void | boolean;
     constructor();
     initialize(config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     /**
@@ -512,6 +542,13 @@ export declare abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
      */
     teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
     abstract processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * The the plugin should re-evaluate configuration and update any cached configuration settings.
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+     */
+    update(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
     /**
      * Add an unload handler that will be called when the SDK is being unloaded
      * @param handler - the handler
@@ -983,6 +1020,8 @@ declare const enum FieldType {
  */
 declare function _formatErrorCode(errorObj: any): any;
 
+declare function _getDefaultConfig(config?: IConfig): IConfig;
+
 declare const enum GetExtCfgMergeType {
     None = 0,
     MergeDefaultOnly = 1,
@@ -1083,8 +1122,11 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * 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?: () => void): void;
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
     /**
      * Find and return the (first) plugin with the specified identifier if present
      * @param pluginIdentifier
@@ -1093,10 +1135,11 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
     /**
      * Add a new plugin to the installation
      * @param plugin - The new plugin to add
-     * @param replaceExisting - should any existing plugin be replaced
+     * @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;
+    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
      */
@@ -1106,6 +1149,16 @@ export declare interface IAppInsightsCore extends IPerfManagerProvider {
      * @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;
 }
 
 export declare interface IAppInsightsDeprecated {
@@ -2725,6 +2778,11 @@ declare interface IInstrumentHook {
  * You must always supply the error callback
  */
 declare 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
      */
@@ -3305,8 +3363,8 @@ export declare interface IProcessTelemetryContext extends IBaseProcessingContext
 }
 
 /**
- * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
- * between multiple AppInsights instances
+ * The current context for the current call to teardown() implementations, used to support when plugins are being removed
+ * or the SDK is being unloaded.
  */
 declare interface IProcessTelemetryUnloadContext extends IBaseProcessingContext {
     /**
@@ -3325,6 +3383,27 @@ declare interface IProcessTelemetryUnloadContext extends IBaseProcessingContext
     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUnloadContext;
 }
 
+/**
+ * The current context for the current call to the plugin update() implementations, used to support the notifications
+ * for when plugins are added, removed or the configuration was changed.
+ */
+declare interface IProcessTelemetryUpdateContext extends IBaseProcessingContext {
+    /**
+     * This Plugin has finished unloading, so unload the next one
+     * @param updateState - The update State
+     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
+     */
+    processNext: (updateState: ITelemetryUpdateState) => 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) => IProcessTelemetryUpdateContext;
+}
+
 declare interface IPropertiesPlugin {
     readonly context: ITelemetryContext;
 }
@@ -3721,6 +3800,15 @@ declare interface ITelemetryProcessor {
      * to later plugins (vs appending items to the telemetry item)
      */
     processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
+    /**
+     * The the plugin should re-evaluate configuration and update any cached configuration settings or
+     * plugins. If implemented this method will be called whenever a plugin is added or removed and if
+     * the configuration has bee updated.
+     * @param updateCtx - This is the context that should be used during updating.
+     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+     */
+    update?: (updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState) => void | boolean;
 }
 
 declare interface ITelemetryTrace {
@@ -3748,6 +3836,27 @@ declare interface ITelemetryUnloadState {
     flushComplete?: boolean;
 }
 
+declare interface ITelemetryUpdateState {
+    /**
+     * Identifies the reason for the update notification, this is a bitwise numeric value
+     */
+    reason: TelemetryUpdateReason;
+    /**
+     * If this is a configuration update this was the previous configuration that was used
+     */
+    /**
+     * If this is a configuration update is the new configuration that is being used
+     */
+    /**
+     * This holds a collection of plugins that have been added (if the reason identifies that one or more plugins have been added)
+     */
+    added?: IPlugin[];
+    /**
+     * This holds a collection of plugins that have been removed (if the reason identifies that one or more plugins have been removed)
+     */
+    removed?: IPlugin[];
+}
+
 declare interface ITraceState {
 }
 
@@ -4193,26 +4302,6 @@ declare class PageViewData extends EventData {
     constructor();
 }
 
-/**
- * Class encapsulates sending page views and page view performance telemetry.
- */
-declare class PageViewManager {
-    constructor(appInsights: IAppInsightsInternal, overridePageViewDuration: boolean, core: IAppInsightsCore, pageViewPerformanceManager: PageViewPerformanceManager);
-    /**
-     * Currently supported cases:
-     * 1) (default case) track page view called with default parameters, overridePageViewDuration = false. Page view is sent with page view performance when navigation timing data is available.
-     *    a. If navigation timing is not supported then page view is sent right away with undefined duration. Page view performance is not sent.
-     * 2) overridePageViewDuration = true, custom duration provided. Custom duration is used, page view sends right away.
-     * 3) overridePageViewDuration = true, custom duration NOT provided. Page view is sent right away, duration is time spent from page load till now (or undefined if navigation timing is not supported).
-     * 4) overridePageViewDuration = false, custom duration is provided. Page view is sent right away with custom duration.
-     *
-     * In all cases page view performance is sent once (only for the 1st call of trackPageView), or not sent if navigation timing is not supported.
-     */
-    trackPageView(pageView: IPageViewTelemetry, customProperties?: {
-        [key: string]: any;
-    }): void;
-}
-
 /**
  * An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.
  */
@@ -4290,81 +4379,6 @@ export declare class PageViewPerformance extends PageViewPerfData implements ISe
     }, cs4BaseData?: IPageViewPerformanceTelemetry);
 }
 
-/**
- * Class encapsulates sending page view performance telemetry.
- */
-declare class PageViewPerformanceManager {
-    private _logger;
-    private MAX_DURATION_ALLOWED;
-    constructor(core: IAppInsightsCore);
-    populatePageViewPerformanceEvent(pageViewPerformance: IPageViewPerformanceTelemetryInternal): void;
-    getPerformanceTiming(): PerformanceTiming | null;
-    getPerformanceNavigationTiming(): PerformanceNavigationTiming | null;
-    /**
-     * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
-     */
-    isPerformanceNavigationTimingSupported(): boolean;
-    /**
-     * Returns true is window performance timing API is supported, false otherwise.
-     */
-    isPerformanceTimingSupported(): PerformanceTiming;
-    /**
-     * As page loads different parts of performance timing numbers get set. When all of them are set we can report it.
-     * Returns true if ready, false otherwise.
-     */
-    isPerformanceTimingDataReady(): boolean;
-    /**
-     * This method tells if given durations should be excluded from collection.
-     */
-    shouldCollectDuration(...durations: number[]): boolean;
-}
-
-declare class PageVisitData {
-    pageName: string;
-    pageUrl: string;
-    pageVisitStartTime: number;
-    pageVisitTime: number;
-    constructor(pageName: string, pageUrl: string);
-}
-
-/**
- * Used to track page visit durations
- */
-declare class PageVisitTimeManager {
-    private prevPageVisitDataKeyName;
-    private pageVisitTimeTrackingHandler;
-    private _logger;
-    /**
-     * Creates a new instance of PageVisitTimeManager
-     * @param pageVisitTimeTrackingHandler Delegate that will be called to send telemetry data to AI (when trackPreviousPageVisit is called)
-     * @returns {}
-     */
-    constructor(logger: IDiagnosticLogger, pageVisitTimeTrackingHandler: (pageName: string, pageUrl: string, pageVisitTime: number) => void);
-    /**
-     * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
-     * @param currentPageName Name of page to begin timing for visit duration
-     * @param currentPageUrl Url of page to begin timing for visit duration
-     */
-    trackPreviousPageVisit(currentPageName: string, currentPageUrl: string): void;
-    /**
-     * Stops timing of current page (if exists) and starts timing for duration of visit to pageName
-     * @param pageName Name of page to begin timing visit duration
-     * @returns {PageVisitData} Page visit data (including duration) of pageName from last call to start or restart, if exists. Null if not.
-     */
-    restartPageVisitTimer(pageName: string, pageUrl: string): PageVisitData;
-    /**
-     * Starts timing visit duration of pageName
-     * @param pageName
-     * @returns {}
-     */
-    startPageVisitTimer(pageName: string, pageUrl: string): void;
-    /**
-     * Stops timing of current page, if exists.
-     * @returns {PageVisitData} Page visit data (including duration) of pageName from call to start, if exists. Null if not.
-     */
-    stopPageVisitTimer(): PageVisitData;
-}
-
 declare function parseConnectionString(connectionString?: string): ConnectionString;
 
 export declare class PerfEvent implements IPerfEvent {
@@ -4856,6 +4870,27 @@ declare const enum TelemetryUnloadReason {
     SdkUnload = 50
 }
 
+/**
+ * The TelemetryUpdateReason enumeration contains a set of bit-wise values that specify the reason for update request.
+ */
+declare const enum TelemetryUpdateReason {
+    /**
+     * Unknown.
+     */
+    Unknown = 0,
+    /**
+     * The configuration has ben updated or changed
+     */
+    /**
+     * One or more plugins have been added
+     */
+    PluginAdded = 16,
+    /**
+     * One or more plugins have been removed
+     */
+    PluginRemoved = 32
+}
+
 export declare class Trace extends MessageData implements ISerializable {
     static envelopeType: string;
     static dataType: string;

package/dist-esm/ApplicationInsightsContainer.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-04
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 import { AppInsightsDeprecated } from "./ApplicationInsightsDeprecated";

package/dist-esm/ApplicationInsightsDeprecated.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-04
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 import { stringToBoolOrDefault, ProcessLegacy } from "@microsoft/applicationinsights-common";

package/dist-esm/Init.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-04
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/Initialization.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-04
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/applicationinsights-web.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-04
+ * Application Insights JavaScript SDK - Web, 2.8.0-beta.2203-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 export { Initialization as ApplicationInsights, Telemetry } from "./Initialization";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-web",
-    "version": "2.8.0-beta.2203-04",
+    "version": "2.8.0-beta.2203-07",
     "description": "Microsoft Application Insights JavaScript SDK - Web",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -66,12 +66,12 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^1.1.4",
         "@microsoft/applicationinsights-shims": "2.0.1",
-        "@microsoft/applicationinsights-analytics-js": "2.8.0-beta.2203-04",
-        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-04",
-        "@microsoft/applicationinsights-common": "2.8.0-beta.2203-04",
-        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-04",
-        "@microsoft/applicationinsights-dependencies-js": "2.8.0-beta.2203-04",
-        "@microsoft/applicationinsights-properties-js": "2.8.0-beta.2203-04"
+        "@microsoft/applicationinsights-analytics-js": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-channel-js": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-common": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-core-js": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-dependencies-js": "2.8.0-beta.2203-07",
+        "@microsoft/applicationinsights-properties-js": "2.8.0-beta.2203-07"
     },
     "license": "MIT",
     "publishConfig": {

package/types/Initialization.d.ts

@@ -191,7 +191,7 @@ export declare class Initialization implements IApplicationInsights {
     }, measurements?: {
         [key: string]: number;
     }): void;
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void | import("@microsoft/applicationinsights-core-js").ITelemetryInitializerHandler;
     /**
      * Set the authenticated user id and the account id. Used for identifying a specific signed-in user. Parameters must not contain whitespace or ,;=|
      *