@microsoft/applicationinsights-web 2.8.0-beta.2203-03 → 2.8.0-beta.2203-06

package/dist/applicationinsights-web.api.json

@@ -432,7 +432,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare class ApplicationInsights extends "
+              "text": "export declare class AnalyticsPlugin extends "
             },
             {
               "kind": "Reference",
@@ -515,135 +515,10 @@
               ],
               "name": "_onerror"
             },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics#_pageViewManager:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "protected _pageViewManager: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "PageViewManager",
-                  "canonicalReference": "@microsoft/applicationinsights-web!PageViewManager:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "_pageViewManager",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics#_pageViewPerformanceManager:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "protected _pageViewPerformanceManager: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "PageViewPerformanceManager",
-                  "canonicalReference": "@microsoft/applicationinsights-web!PageViewPerformanceManager:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "_pageViewPerformanceManager",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics#_pageVisitTimeManager:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "protected _pageVisitTimeManager: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "PageVisitTimeManager",
-                  "canonicalReference": "@microsoft/applicationinsights-web!PageVisitTimeManager:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "_pageVisitTimeManager",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics#_telemetryInitializers:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "protected _telemetryInitializers: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Array",
-                  "canonicalReference": "!Array:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<(envelope: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ITelemetryItem",
-                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryItem:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ") => boolean | void>"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "_telemetryInitializers",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 5
-              },
-              "isStatic": false
-            },
             {
               "kind": "Constructor",
               "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `ApplicationInsights` class\n */\n",
+              "docComment": "/**\n * Constructs a new instance of the `AnalyticsPlugin` class\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -680,9 +555,14 @@
                   "kind": "Content",
                   "text": "): "
                 },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryInitializerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryInitializerHandler:interface"
+                },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": " | void"
                 },
                 {
                   "kind": "Content",
@@ -693,7 +573,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 5,
-                "endIndex": 6
+                "endIndex": 7
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -794,27 +674,22 @@
               "name": "getCookieMgr"
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics.getDefaultConfig:member(1)",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics.getDefaultConfig:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static getDefaultConfig(config?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-web!IConfig:interface"
+                  "text": "static getDefaultConfig: "
                 },
                 {
                   "kind": "Content",
-                  "text": "): "
+                  "text": "typeof "
                 },
                 {
                   "kind": "Reference",
-                  "text": "IConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-web!IConfig:interface"
+                  "text": "_getDefaultConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-web!~_getDefaultConfig:function"
                 },
                 {
                   "kind": "Content",
@@ -822,23 +697,13 @@
                 }
               ],
               "isOptional": false,
-              "isStatic": true,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
               "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "config",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  }
-                }
-              ],
-              "name": "getDefaultConfig"
+              "name": "getDefaultConfig",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": true
             },
             {
               "kind": "Property",
@@ -2166,7 +2031,12 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "void | import(\"@microsoft/applicationinsights-core-js\")."
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryInitializerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryInitializerHandler:interface"
                 },
                 {
                   "kind": "Content",
@@ -2177,7 +2047,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 5,
-                "endIndex": 6
+                "endIndex": 7
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -2204,7 +2074,7 @@
                 {
                   "kind": "Reference",
                   "text": "ApplicationInsights",
-                  "canonicalReference": "@microsoft/applicationinsights-web!ApplicationInsights:class"
+                  "canonicalReference": "@microsoft/applicationinsights-web!AnalyticsPlugin:class"
                 },
                 {
                   "kind": "Content",
@@ -3596,6 +3466,68 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-web!BaseCore#_updateHook:member(1)",
+              "docComment": "/**\n * Hook for Core extensions to allow them to update their own configuration before updating all of the plugins.\n *\n * @param updateCtx - The plugin update context\n *\n * @param updateState - The Update State\n *\n * @returns boolean - True means the extension class will call updateState otherwise the Core will\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected _updateHook?(updateCtx: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IProcessTelemetryUpdateContext",
+                  "canonicalReference": "@microsoft/applicationinsights-web!IProcessTelemetryUpdateContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", updateState: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUpdateState",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryUpdateState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void | boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "updateCtx",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "parameterName": "updateState",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  }
+                }
+              ],
+              "name": "_updateHook"
+            },
             {
               "kind": "Constructor",
               "canonicalReference": "@microsoft/applicationinsights-web!BaseCore:constructor(1)",
@@ -4690,7 +4622,24 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "() => void"
+                  "text": "(unloadState: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUnloadState",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryUnloadState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", cbTimeout?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -4708,8 +4657,8 @@
               "isOptional": false,
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
+                "startIndex": 9,
+                "endIndex": 10
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -4725,7 +4674,14 @@
                   "parameterName": "unloadComplete",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
-                    "endIndex": 4
+                    "endIndex": 6
+                  }
+                },
+                {
+                  "parameterName": "cbTimeout",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
                   }
                 }
               ],
@@ -4911,6 +4867,51 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web!BaseTelemetryPlugin#_doUpdate:member",
+              "docComment": "/**\n * Extension hook to allow implementations to perform some additional update operations before the BaseTelemetryPlugin finishes it's removal\n *\n * @param updateCtx - This is the context that should be used during updating.\n *\n * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.\n *\n * @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.\n *\n * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected _doUpdate?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(updateCtx?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IProcessTelemetryUpdateContext",
+                  "canonicalReference": "@microsoft/applicationinsights-web!IProcessTelemetryUpdateContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", updateState?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUpdateState",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryUpdateState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", asyncCallback?: () => void) => void | boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "_doUpdate",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 6
+              },
+              "isStatic": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-web!BaseTelemetryPlugin#_getTelCtx:member",
@@ -5455,6 +5456,68 @@
               ],
               "name": "teardown"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-web!BaseTelemetryPlugin#update:member(1)",
+              "docComment": "/**\n * The the plugin should re-evaluate configuration and update any cached configuration settings.\n *\n * @param updateCtx - This is the context that should be used during updating.\n *\n * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.\n *\n * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "update(updateCtx: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IProcessTelemetryUpdateContext",
+                  "canonicalReference": "@microsoft/applicationinsights-web!IProcessTelemetryUpdateContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", updateState: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUpdateState",
+                  "canonicalReference": "@microsoft/applicationinsights-web!ITelemetryUpdateState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void | boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "updateCtx",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "parameterName": "updateState",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  }
+                }
+              ],
+              "name": "update"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-web!BaseTelemetryPlugin#version:member",
@@ -10596,7 +10659,7 @@
                 {
                   "kind": "Reference",
                   "text": "ApplicationInsights",
-                  "canonicalReference": "@microsoft/applicationinsights-web!ApplicationInsights:class"
+                  "canonicalReference": "@microsoft/applicationinsights-web!AnalyticsPlugin:class"
                 },
                 {
                   "kind": "Content",

package/dist/applicationinsights-web.api.md

@@ -16,33 +16,25 @@ export class AppInsightsCore extends BaseCore implements IAppInsightsCore {
 // @public (undocumented)
 export class ApplicationAnalytics extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
     constructor();
+    // Warning: (ae-forgotten-export) The symbol "ITelemetryInitializerHandler" needs to be exported by the entry point applicationinsights-web.d.ts
+    //
     // (undocumented)
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
     // (undocumented)
     autoRoutePVDelay: number;
     // (undocumented)
     config: IConfig;
     // Warning: (ae-forgotten-export) The symbol "ICookieMgr" needs to be exported by the entry point applicationinsights-web.d.ts
     getCookieMgr(): ICookieMgr;
+    // Warning: (ae-forgotten-export) The symbol "_getDefaultConfig" needs to be exported by the entry point applicationinsights-web.d.ts
+    //
     // (undocumented)
-    static getDefaultConfig(config?: IConfig): IConfig;
+    static getDefaultConfig: typeof _getDefaultConfig;
     // (undocumented)
     identifier: string;
     // (undocumented)
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     _onerror(exception: IAutoExceptionTelemetry): void;
-    // Warning: (ae-forgotten-export) The symbol "PageViewManager" needs to be exported by the entry point applicationinsights-web.d.ts
-    //
-    // (undocumented)
-    protected _pageViewManager: PageViewManager;
-    // Warning: (ae-forgotten-export) The symbol "PageViewPerformanceManager" needs to be exported by the entry point applicationinsights-web.d.ts
-    //
-    // (undocumented)
-    protected _pageViewPerformanceManager: PageViewPerformanceManager;
-    // Warning: (ae-forgotten-export) The symbol "PageVisitTimeManager" needs to be exported by the entry point applicationinsights-web.d.ts
-    //
-    // (undocumented)
-    protected _pageVisitTimeManager: PageVisitTimeManager;
     // (undocumented)
     priority: number;
     // (undocumented)
@@ -79,8 +71,6 @@ export class ApplicationAnalytics extends BaseTelemetryPlugin implements IAppIns
         [key: string]: number;
     }): void;
     // (undocumented)
-    protected _telemetryInitializers: Array<(envelope: ITelemetryItem) => boolean | void>;
-    // (undocumented)
     trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
     trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
     trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void;
@@ -97,7 +87,7 @@ export class ApplicationInsights implements IApplicationInsights {
     // (undocumented)
     addHousekeepingBeforeUnload(appInsightsInstance: IApplicationInsights): void;
     // (undocumented)
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void | ITelemetryInitializerHandler;
     // (undocumented)
     appInsights: ApplicationAnalytics;
     clearAuthenticatedUserContext(): void;
@@ -160,7 +150,6 @@ export class BaseCore implements IAppInsightsCore {
     // (undocumented)
     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 applicationinsights-web.d.ts
-    // Warning: (ae-forgotten-export) The symbol "ITelemetryInitializerHandler" needs to be exported by the entry point applicationinsights-web.d.ts
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
     // Warning: (ae-forgotten-export) The symbol "UnloadHandler" needs to be exported by the entry point applicationinsights-web.d.ts
     addUnloadCb(handler: UnloadHandler): void;
@@ -204,7 +193,11 @@ export class BaseCore implements IAppInsightsCore {
     stopPollingInternalLogs(): void;
     // (undocumented)
     track(telemetryItem: ITelemetryItem): void;
-    unload(isAsync?: boolean, unloadComplete?: () => void): void;
+    // Warning: (ae-forgotten-export) The symbol "ITelemetryUnloadState" needs to be exported by the entry point applicationinsights-web.d.ts
+    unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void;
+    // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryUpdateContext" needs to be exported by the entry point applicationinsights-web.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ITelemetryUpdateState" needs to be exported by the entry point applicationinsights-web.d.ts
+    protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
 }
 
 // @public
@@ -216,8 +209,8 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     core: IAppInsightsCore;
     diagLog: (itemCtx?: IProcessTelemetryContext) => IDiagnosticLogger;
     // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryUnloadContext" needs to be exported by the entry point applicationinsights-web.d.ts
-    // Warning: (ae-forgotten-export) The symbol "ITelemetryUnloadState" needs to be exported by the entry point applicationinsights-web.d.ts
     protected _doTeardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
+    protected _doUpdate?: (updateCtx?: IProcessTelemetryUpdateContext, updateState?: ITelemetryUpdateState, asyncCallback?: () => void) => void | boolean;
     protected _getTelCtx: (currentCtx?: IProcessTelemetryContext) => IProcessTelemetryContext;
     // (undocumented)
     identifier: string;
@@ -232,6 +225,7 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     protected setInitialized: (isInitialized: boolean) => void;
     setNextPlugin: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
     teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
+    update(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
     // (undocumented)
     version?: string;
 }