@microsoft/applicationinsights-dependencies-js 3.0.0-beta.2208-19 → 3.0.0-beta.2209-01

package/dist/applicationinsights-dependencies-js.api.json

@@ -204,6 +204,15 @@
               "text": "IInstrumentationRequirements",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IInstrumentationRequirements:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyListenerContainer",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerContainer:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -228,6 +237,55 @@
               "overloadIndex": 1,
               "parameters": []
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin#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-dependencies-js!DependencyInitializerFunction:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDependencyInitializerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!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-dependencies-js!AjaxPlugin#addDependencyListener:member(1)",
@@ -278,66 +336,72 @@
               "name": "addDependencyListener"
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin.getDefaultConfig:member(1)",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin.getDefaultConfig:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static getDefaultConfig(): "
+                  "text": "static getDefaultConfig: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "typeof "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ICorrelationConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-common!ICorrelationConfig:interface"
+                  "text": "_getDefaultConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!~_getDefaultConfig: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-dependencies-js!AjaxPlugin.getEmptyConfig:member(1)",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin.getEmptyConfig:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static getEmptyConfig(): "
+                  "text": "static getEmptyConfig: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "typeof "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ICorrelationConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-common!ICorrelationConfig:interface"
+                  "text": "_getEmptyConfig",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!~_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",
@@ -863,6 +927,10 @@
             {
               "startIndex": 5,
               "endIndex": 6
+            },
+            {
+              "startIndex": 7,
+              "endIndex": 8
             }
           ]
         },
@@ -1165,6 +1233,35 @@
               "isStatic": false,
               "isProtected": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#context:member",
+              "docComment": "/**\n * The listener assigned context values that will be passed to any dependency initializer\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "context?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "context",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#CreateTrackItem:member(1)",
@@ -1956,6 +2053,74 @@
           ],
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!DependencyInitializerFunction:type",
+          "docComment": "/**\n * The initializer function that will be called, if it returns false the event will be dropped and not reported or counted against the `maxAjaxCallsPerView`.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type DependencyInitializerFunction = "
+            },
+            {
+              "kind": "Content",
+              "text": "(item: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyInitializerDetails",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => boolean | void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "DependencyInitializerFunction",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!DependencyListenerFunction:type",
+          "docComment": "/**\n * The function that will get called when the ajax request is about to occur.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type DependencyListenerFunction = "
+            },
+            {
+              "kind": "Content",
+              "text": "(dependencyDetails: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyListenerDetails",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "DependencyListenerFunction",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@microsoft/applicationinsights-dependencies-js!DfltAjaxCorrelationHeaderExDomains:var",
@@ -2055,6 +2220,478 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyHandler:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IDependencyHandler "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IDependencyHandler",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyHandler#remove:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "remove(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "remove"
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IDependencyInitializerDetails "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IDependencyInitializerDetails",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails#context:member",
+              "docComment": "/**\n * The context that the application can assigned via the dependency listener(s)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "context?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "context",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails#item:member",
+              "docComment": "/**\n * The DependencyTelemetry event that will be passed to the `trackDependencyDataInternal` function.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "item: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDependencyTelemetry",
+                  "canonicalReference": "@microsoft/applicationinsights-common!IDependencyTelemetry:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "item",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails#properties:member",
+              "docComment": "/**\n * Additional properties to be added to the event\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "properties?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "properties",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerDetails#sysProperties:member",
+              "docComment": "/**\n * Additional system properties to be added to the event.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "sysProperties?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "sysProperties",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyInitializerHandler:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IDependencyInitializerHandler extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyHandler",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyHandler:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IDependencyInitializerHandler",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IDependencyListenerDetails "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IDependencyListenerDetails",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#context:member",
+              "docComment": "/**\n * [Optional] Context that the application can assign that will also be passed to any dependency initializer\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "context?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "context",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#core:member",
+              "docComment": "/**\n * The current core instance\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "core: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IAppInsightsCore",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "core",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#init:member",
+              "docComment": "/**\n * Provided only if the dependency request is a fetch call, this is the init argument being used, re-assigning this value does not change the value used for the request, however, changing properties of this object will be used.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "init?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RequestInit",
+                  "canonicalReference": "!RequestInit:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "init",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#input:member",
+              "docComment": "/**\n * Provided only if the dependency request is a fetch call, this is the input argument being used, re-assigning this value has not affect on the value used for the request, however, when this is a Request object changing the value of the Request will be used for the outbound request.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "input?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Request",
+                  "canonicalReference": "!Request:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "input",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#spanId:member",
+              "docComment": "/**\n * Self-generated 8-bytes identifier of the incoming request. Must be a hex representation of 8-byte array. Also know as the parentId, used to link requests together\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "spanId?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "spanId",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#traceFlags:member",
+              "docComment": "/**\n * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "traceFlags?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "traceFlags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#traceId:member",
+              "docComment": "/**\n * Returns the unique identifier for a trace. All requests / spans from the same trace share the same traceId. Must be read from incoming headers or generated according to the W3C TraceContext specification, in a hex representation of 16-byte array. A.k.a. trace-id, TraceID or Distributed TraceID\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "traceId?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "traceId",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerDetails#xhr:member",
+              "docComment": "/**\n * Provided only if the dependency request is an XHR call\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "xhr?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "XMLHttpRequest",
+                  "canonicalReference": "!XMLHttpRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "xhr",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerHandler:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IDependencyListenerHandler extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyHandler",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyHandler:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IDependencyListenerHandler",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IInstrumentationRequirements:interface",
@@ -2089,8 +2726,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "_DYN_INCLUDE_CORRELATION_3",
-                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!_DYN_INCLUDE_CORRELATION_3"
+                  "text": "_DYN_INCLUDE_CORRELATION_2",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!_DYN_INCLUDE_CORRELATION_2"
                 },
                 {
                   "kind": "Content",