@microsoft/applicationinsights-web 3.0.0-beta.2208-19 → 3.0.0-beta.2209-03

package/dist/applicationinsights-web.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.29.2",
+    "toolVersion": "7.31.1",
     "schemaVersion": 1009,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -2482,7 +2482,7 @@
                 {
                   "kind": "Reference",
                   "text": "_getDefaultConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-web!~_getDefaultConfig:function"
+                  "canonicalReference": "@microsoft/applicationinsights-web!_getDefaultConfig:function"
                 },
                 {
                   "kind": "Content",
@@ -3816,6 +3816,55 @@
                 }
               ]
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-web!ApplicationInsights#addDependencyInitializer:member(1)",
+              "docComment": "/**\n * Add an dependency telemetry initializer callback function to allow populating additional properties or drop the request. It is called after the dependency call has completed and any available performance details are available. A dependency initializer is similar to the TelemetryInitializer function but it allows you to block the reporting of the dependency request so that it doesn't count against the `maxAjaxCallsPerView`.\n *\n * @param dependencyInitializer - The Dependency Telemetry Initializer function\n *\n * @returns - A IDependencyInitializerHandler to enable the initializer to be removed\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addDependencyInitializer(dependencyInitializer: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DependencyInitializerFunction",
+                  "canonicalReference": "@microsoft/applicationinsights-web!DependencyInitializerFunction:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDependencyInitializerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-web!IDependencyInitializerHandler:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "dependencyInitializer",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "name": "addDependencyInitializer"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web!ApplicationInsights#addDependencyListener:member(1)",
@@ -4160,7 +4209,7 @@
                 {
                   "kind": "Reference",
                   "text": "ApplicationInsights",
-                  "canonicalReference": "@microsoft/applicationinsights-web!AnalyticsPlugin:class"
+                  "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics:class"
                 },
                 {
                   "kind": "Content",
@@ -8210,6 +8259,15 @@
               "text": "IInstrumentationRequirements",
               "canonicalReference": "@microsoft/applicationinsights-web!IInstrumentationRequirements:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyListenerContainer",
+              "canonicalReference": "@microsoft/applicationinsights-web!IDependencyListenerContainer:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -8234,6 +8292,55 @@
               "overloadIndex": 1,
               "parameters": []
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin#addDependencyInitializer:member(1)",
+              "docComment": "/**\n * Add an dependency telemetry initializer callback function to allow populating additional properties or drop the request. It is called after the dependency call has completed and any available performance details are available. A dependency initializer is similar to the TelemetryInitializer function but it allows you to block the reporting of the dependency request so that it doesn't count against the `maxAjaxCallsPerView`.\n *\n * @param dependencyInitializer - The Dependency Telemetry Initializer function\n *\n * @returns - A IDependencyInitializerHandler to enable the initializer to be removed\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addDependencyInitializer(dependencyInitializer: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DependencyInitializerFunction",
+                  "canonicalReference": "@microsoft/applicationinsights-web!DependencyInitializerFunction:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDependencyInitializerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-web!IDependencyInitializerHandler:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "dependencyInitializer",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "name": "addDependencyInitializer"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin#addDependencyListener:member(1)",
@@ -8284,66 +8391,72 @@
               "name": "addDependencyListener"
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin.getDefaultConfig:member(1)",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin.getDefaultConfig:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static getDefaultConfig(): "
+                  "text": "static getDefaultConfig: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "typeof "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ICorrelationConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-web!ICorrelationConfig:interface"
+                  "text": "_getDefaultConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-web!_getDefaultConfig_2:function"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": true,
-              "returnTypeTokenRange": {
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "getDefaultConfig",
+              "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "name": "getDefaultConfig"
+              "isStatic": true,
+              "isProtected": false
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin.getEmptyConfig:member(1)",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-web!DependenciesPlugin.getEmptyConfig:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static getEmptyConfig(): "
+                  "text": "static getEmptyConfig: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "typeof "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ICorrelationConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-web!ICorrelationConfig:interface"
+                  "text": "_getEmptyConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-web!_getEmptyConfig:function"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": true,
-              "returnTypeTokenRange": {
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "getEmptyConfig",
+              "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "name": "getEmptyConfig"
+              "isStatic": true,
+              "isProtected": false
             },
             {
               "kind": "Property",
@@ -8869,6 +8982,10 @@
             {
               "startIndex": 5,
               "endIndex": 6
+            },
+            {
+              "startIndex": 7,
+              "endIndex": 8
             }
           ]
         },
@@ -13000,7 +13117,7 @@
                 {
                   "kind": "Reference",
                   "text": "AnalyticsPlugin",
-                  "canonicalReference": "@microsoft/applicationinsights-web!AnalyticsPlugin:class"
+                  "canonicalReference": "@microsoft/applicationinsights-web!ApplicationAnalytics:class"
                 },
                 {
                   "kind": "Content",
@@ -13700,6 +13817,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-web!IConfig#addIntEndpoints:member",
+              "docComment": "/**\n * [Optional] Flag to indicate whether the internal looking endpoints should be automatically added to the `excludeRequestFromAutoTrackingPatterns` collection. (defaults to true). This flag exists as the provided regex is generic and may unexpectedly match a domain that should not be excluded.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addIntEndpoints?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "addIntEndpoints",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-web!IConfig#addRequestContext:member",

package/dist/applicationinsights-web.api.md

@@ -86,6 +86,9 @@ export class ApplicationAnalytics extends BaseTelemetryPlugin implements IAppIns
 // @public
 export class ApplicationInsights implements IApplicationInsights {
     constructor(snippet: Snippet);
+    // Warning: (ae-forgotten-export) The symbol "DependencyInitializerFunction" needs to be exported by the entry point applicationinsights-web.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IDependencyInitializerHandler" needs to be exported by the entry point applicationinsights-web.d.ts
+    addDependencyInitializer(dependencyInitializer: DependencyInitializerFunction): IDependencyInitializerHandler;
     // Warning: (ae-forgotten-export) The symbol "DependencyListenerFunction" needs to be exported by the entry point applicationinsights-web.d.ts
     // Warning: (ae-forgotten-export) The symbol "IDependencyListenerHandler" needs to be exported by the entry point applicationinsights-web.d.ts
     addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
@@ -248,17 +251,21 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
 }
 
 // Warning: (ae-forgotten-export) The symbol "IInstrumentationRequirements" needs to be exported by the entry point applicationinsights-web.d.ts
+// Warning: (ae-forgotten-export) The symbol "IDependencyListenerContainer" needs to be exported by the entry point applicationinsights-web.d.ts
 //
 // @public (undocumented)
-export class DependenciesPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
+export class DependenciesPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements, IDependencyListenerContainer {
     constructor();
+    addDependencyInitializer(dependencyInitializer: DependencyInitializerFunction): IDependencyInitializerHandler;
     addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
-    // Warning: (ae-forgotten-export) The symbol "ICorrelationConfig" needs to be exported by the entry point applicationinsights-web.d.ts
+    // Warning: (ae-forgotten-export) The symbol "_getDefaultConfig_2" needs to be exported by the entry point applicationinsights-web.d.ts
     //
     // (undocumented)
-    static getDefaultConfig(): ICorrelationConfig;
+    static getDefaultConfig: typeof _getDefaultConfig_2;
+    // Warning: (ae-forgotten-export) The symbol "_getEmptyConfig" needs to be exported by the entry point applicationinsights-web.d.ts
+    //
     // (undocumented)
-    static getEmptyConfig(): ICorrelationConfig;
+    static getEmptyConfig: typeof _getEmptyConfig;
     // (undocumented)
     static identifier: string;
     // (undocumented)
@@ -682,6 +689,7 @@ export interface IAutoExceptionTelemetry {
 // @public
 export interface IConfig {
     accountId?: string;
+    addIntEndpoints?: boolean;
     // Warning: (ae-forgotten-export) The symbol "IRequestContext" needs to be exported by the entry point applicationinsights-web.d.ts
     addRequestContext?: (requestContext?: IRequestContext) => ICustomProperties;
     ajaxPerfLookupDelay?: number;
@@ -786,8 +794,6 @@ export interface ICustomProperties {
     [key: string]: any;
 }
 
-// Warning: (ae-forgotten-export) The symbol "IDependencyListenerContainer" needs to be exported by the entry point applicationinsights-web.d.ts
-//
 // @public (undocumented)
 export interface IDependenciesPlugin extends IDependencyListenerContainer {
     trackDependencyData(dependency: IDependencyTelemetry): void;

package/dist/applicationinsights-web.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.0.0-beta.2208-19
+ * Microsoft.ApplicationInsights, 3.0.0-beta.2209-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -50,6 +50,12 @@ declare namespace ApplicationInsights {
          * The trace context to use for reporting the remote dependency call
          */
         eventTraceCtx: ITraceCtx;
+        /**
+         * The listener assigned context values that will be passed to any dependency initializer
+         */
+        context?: {
+            [key: string]: any;
+        };
         constructor(traceId: string, spanId: string, logger: IDiagnosticLogger, traceCtx?: IDistributedTraceContext);
         getAbsoluteUrl(): string;
         getPathName(): string;
@@ -386,6 +392,15 @@ declare namespace ApplicationInsights {
          * @returns - A IDependencyListenerHandler to enable the initializer to be removed
          */
         addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
+        /**
+         * Add an dependency telemetry initializer callback function to allow populating additional properties or drop the request.
+         * It is called after the dependency call has completed and any available performance details are available. A dependency
+         * initializer is similar to the TelemetryInitializer function but it allows you to block the reporting of the dependency
+         * request so that it doesn't count against the `maxAjaxCallsPerView`.
+         * @param dependencyInitializer - The Dependency Telemetry Initializer function
+         * @returns - A IDependencyInitializerHandler to enable the initializer to be removed
+         */
+        addDependencyInitializer(dependencyInitializer: DependencyInitializerFunction): IDependencyInitializerHandler;
         /**
          * Gets the current distributed trace context for this instance if available
          */
@@ -648,10 +663,10 @@ declare namespace ApplicationInsights {
         Aggregation = 1
     }
 
-    class DependenciesPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
+    class DependenciesPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements, IDependencyListenerContainer {
         static identifier: string;
-        static getDefaultConfig(): ICorrelationConfig;
-        static getEmptyConfig(): ICorrelationConfig;
+        static getDefaultConfig: typeof _getDefaultConfig_2;
+        static getEmptyConfig: typeof _getEmptyConfig;
         identifier: string;
         priority: number;
         constructor();
@@ -672,6 +687,15 @@ declare namespace ApplicationInsights {
          * @returns - A IDependencyListenerHandler to enable the initializer to be removed
          */
         addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
+        /**
+         * Add an dependency telemetry initializer callback function to allow populating additional properties or drop the request.
+         * It is called after the dependency call has completed and any available performance details are available. A dependency
+         * initializer is similar to the TelemetryInitializer function but it allows you to block the reporting of the dependency
+         * request so that it doesn't count against the `maxAjaxCallsPerView`.
+         * @param dependencyInitializer - The Dependency Telemetry Initializer function
+         * @returns - A IDependencyInitializerHandler to enable the initializer to be removed
+         */
+        addDependencyInitializer(dependencyInitializer: DependencyInitializerFunction): IDependencyInitializerHandler;
         /**
          * Protected function to allow sub classes the chance to add additional properties to the dependency event
          * before it's sent. This function calls track, so sub-classes must call this function after they have
@@ -685,6 +709,15 @@ declare namespace ApplicationInsights {
         }): void;
     }
 
+    /**
+     * The initializer function that will be called, if it returns false the event will be dropped and not reported
+     * or counted against the `maxAjaxCallsPerView`.
+     */
+    type DependencyInitializerFunction = (item: IDependencyInitializerDetails) => boolean | void;
+
+    /**
+     * The function that will get called when the ajax request is about to occur.
+     */
     type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => void;
 
     const DistributedTracingModes: EnumValue<typeof eDistributedTracingModes>;
@@ -703,7 +736,7 @@ declare namespace ApplicationInsights {
 
     const _DYN_HEADER_MAP = "headerMap";
 
-    const _DYN_INCLUDE_CORRELATION_3 = "includeCorrelationHeaders";
+    const _DYN_INCLUDE_CORRELATION_2 = "includeCorrelationHeaders";
 
     const enum eDistributedTracingModes {
         /**
@@ -934,6 +967,10 @@ declare namespace ApplicationInsights {
 
     function _getDefaultConfig(config?: IConfig): IConfig;
 
+    function _getDefaultConfig_2(): ICorrelationConfig;
+
+    function _getEmptyConfig(): ICorrelationConfig;
+
     const enum GetExtCfgMergeType {
         None = 0,
         MergeDefaultOnly = 1,
@@ -1626,6 +1663,13 @@ declare namespace ApplicationInsights {
          * @defaultValue true
          */
         disableIkeyDeprecationMessage?: boolean;
+        /**
+         * [Optional] Flag to indicate whether the internal looking endpoints should be automatically
+         * added to the `excludeRequestFromAutoTrackingPatterns` collection. (defaults to true).
+         * This flag exists as the provided regex is generic and may unexpectedly match a domain that
+         * should not be excluded.
+         */
+        addIntEndpoints?: boolean;
     }
 
     /**
@@ -1828,6 +1872,18 @@ declare namespace ApplicationInsights {
          * Specifies the path to use for the cookie, defaults to '/'
          */
         path?: string;
+        /**
+         * Specify the cookie name(s) to be ignored, this will cause any matching cookie name to never be read or written.
+         * They may still be explicitly purged or deleted. You do not need to repeat the name in the `blockedCookies`
+         * configuration.(Since v2.8.8)
+         */
+        ignoreCookies?: string[];
+        /**
+         * Specify the cookie name(s) to never be written, this will cause any cookie name to never be created or updated,
+         * they will still be read unless also included in the ignoreCookies and may still be explicitly purged or deleted.
+         * If not provided defaults to the same list provided in ignoreCookies. (Since v2.8.8)
+         */
+        blockedCookies?: string[];
         /**
          * Hook function to fetch the named cookie value.
          * @param name - The name of the cookie
@@ -1897,6 +1953,13 @@ declare namespace ApplicationInsights {
          * Default is undefined.
          */
         addRequestContext?: (requestContext?: IRequestContext) => ICustomProperties;
+        /**
+         * [Optional] Flag to indicate whether the internal looking endpoints should be automatically
+         * added to the `excludeRequestFromAutoTrackingPatterns` collection. (defaults to true).
+         * This flag exists as the provided regex is generic and may unexpectedly match a domain that
+         * should not be excluded.
+         */
+        addIntEndpoints?: boolean;
     }
 
     interface ICustomProperties {
@@ -1945,6 +2008,38 @@ declare namespace ApplicationInsights {
         trackDependencyData(dependency: IDependencyTelemetry): void;
     }
 
+    interface IDependencyHandler {
+        remove(): void;
+    }
+
+    interface IDependencyInitializerDetails {
+        /**
+         * The DependencyTelemetry event that will be passed to the `trackDependencyDataInternal` function.
+         */
+        item: IDependencyTelemetry;
+        /**
+         * Additional properties to be added to the event
+         */
+        properties?: {
+            [key: string]: any;
+        };
+        /**
+         * Additional system properties to be added to the event.
+         */
+        sysProperties?: {
+            [key: string]: any;
+        };
+        /**
+         * The context that the application can assigned via the dependency listener(s)
+         */
+        context?: {
+            [key: string]: any;
+        };
+    }
+
+    interface IDependencyInitializerHandler extends IDependencyHandler {
+    }
+
     interface IDependencyListenerContainer {
         /**
          * Add an ajax listener which is called just prior to the request being sent and before the correlation headers are added, to allow you
@@ -1992,10 +2087,15 @@ declare namespace ApplicationInsights {
          * https://www.w3.org/TR/trace-context/#trace-flags
          */
         traceFlags?: number;
+        /**
+         * [Optional] Context that the application can assign that will also be passed to any dependency initializer
+         */
+        context?: {
+            [key: string]: any;
+        };
     }
 
-    interface IDependencyListenerHandler {
-        remove(): void;
+    interface IDependencyListenerHandler extends IDependencyHandler {
     }
 
     /**
@@ -2338,7 +2438,7 @@ declare namespace ApplicationInsights {
     }
 
     interface IInstrumentationRequirements extends IDependenciesPlugin {
-        [_DYN_INCLUDE_CORRELATION_3]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
+        [_DYN_INCLUDE_CORRELATION_2]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
     }
 
     interface IInstrumentCallDetails {