@microsoft/applicationinsights-dependencies-js 2.8.4-nightly.2205-09 → 2.8.5-nightly.2206-02

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.24.0",
+    "toolVersion": "7.24.2",
     "schemaVersion": 1005,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -228,6 +228,54 @@
               "overloadIndex": 1,
               "parameters": []
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin#addDependencyListener:member(1)",
+              "docComment": "/**\n * Add an ajax listener which is called just prior to the request being sent and before the correlation headers are added, to allow you to access the headers and modify the values used to generate the distributed tracing correlation headers.\n *\n * @param dependencyListener - The Telemetry Initializer function\n *\n * @returns - A IDependencyListenerHandler to enable the initializer to be removed\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addDependencyListener(dependencyListener: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DependencyListenerFunction",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!DependencyListenerFunction:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDependencyListenerHandler",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerHandler:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "dependencyListener",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "addDependencyListener"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!AjaxPlugin.getDefaultConfig:member(1)",
@@ -1673,6 +1721,33 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#traceFlags:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "traceFlags?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "traceFlags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#traceID:member",
@@ -1738,7 +1813,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface IDependenciesPlugin "
+              "text": "export interface IDependenciesPlugin extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDependencyListenerContainer",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!IDependencyListenerContainer:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -1791,7 +1875,12 @@
               "name": "trackDependencyData"
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
         },
         {
           "kind": "Interface",

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

@@ -19,6 +19,9 @@ import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
 // @public (undocumented)
 export class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
     constructor();
+    // Warning: (ae-forgotten-export) The symbol "DependencyListenerFunction" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IDependencyListenerHandler" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
     // (undocumented)
     static getDefaultConfig(): ICorrelationConfig;
     // (undocumented)
@@ -105,6 +108,8 @@ export class ajaxRecord {
     // (undocumented)
     status: string | number;
     // (undocumented)
+    traceFlags?: number;
+    // (undocumented)
     traceID: string;
     // Warning: (ae-forgotten-export) The symbol "XHRMonitoringState" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
     //
@@ -112,8 +117,10 @@ export class ajaxRecord {
     xhrMonitoringState: XHRMonitoringState;
 }
 
+// Warning: (ae-forgotten-export) The symbol "IDependencyListenerContainer" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+//
 // @public (undocumented)
-export interface IDependenciesPlugin {
+export interface IDependenciesPlugin extends IDependencyListenerContainer {
     trackDependencyData(dependency: IDependencyTelemetry): void;
 }
 

package/dist/applicationinsights-dependencies-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights XHR dependencies plugin, 2.8.4-nightly.2205-09
+ * Microsoft Application Insights XHR dependencies plugin, 2.8.5-nightly.2206-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -36,6 +36,13 @@ declare namespace ApplicationInsights {
             [key: string]: any;
         }): void;
         includeCorrelationHeaders(ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented): any;
+        /**
+         * Add an ajax listener which is called just prior to the request being sent and before the correlation headers are added, to allow you
+         * to access the headers and modify the values used to generate the distributed tracing correlation headers.
+         * @param dependencyListener - The Telemetry Initializer function
+         * @returns - A IDependencyListenerHandler to enable the initializer to be removed
+         */
+        addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
         /**
          * 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
@@ -76,12 +83,15 @@ declare namespace ApplicationInsights {
         clientFailure: number;
         traceID: string;
         spanID: string;
+        traceFlags?: number;
         constructor(traceID: string, spanID: string, logger: IDiagnosticLogger);
         getAbsoluteUrl(): string;
         getPathName(): string;
         CreateTrackItem(ajaxType: string, enableRequestHeaderTracking: boolean, getResponse: () => IAjaxRecordResponse): IDependencyTelemetry;
     }
 
+    type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => void;
+
     interface IAjaxRecordResponse {
         statusText: string;
         headerMap: Object;
@@ -91,7 +101,7 @@ declare namespace ApplicationInsights {
         response?: Object;
     }
 
-    interface IDependenciesPlugin {
+    interface IDependenciesPlugin extends IDependencyListenerContainer {
         /**
          * Logs dependency call
          * @param dependencyData dependency data object
@@ -99,6 +109,59 @@ declare namespace ApplicationInsights {
         trackDependencyData(dependency: IDependencyTelemetry): void;
     }
 
+    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
+         * to access the headers and modify the values used to generate the distributed tracing correlation headers. (added in v2.8.4)
+         * @param dependencyListener - The Telemetry Initializer function
+         * @returns - A IDependencyListenerHandler to enable the initializer to be removed
+         */
+        addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
+    }
+
+    interface IDependencyListenerDetails {
+        /**
+         * The current core instance
+         */
+        core: IAppInsightsCore;
+        /**
+         * Provided only if the dependency request is an XHR call
+         */
+        xhr?: XMLHttpRequest;
+        /**
+         * 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.
+         */
+        input?: Request | string;
+        /**
+         * 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.
+         */
+        init?: RequestInit;
+        /**
+         * 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
+         */
+        traceId?: string;
+        /**
+         * 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
+         */
+        spanId?: string;
+        /**
+         * An integer representation of the W3C TraceContext trace-flags.
+         * https://www.w3.org/TR/trace-context/#trace-flags
+         */
+        traceFlags?: number;
+    }
+
+    interface IDependencyListenerHandler {
+        remove(): void;
+    }
+
     interface IInstrumentationRequirements extends IDependenciesPlugin {
         includeCorrelationHeaders: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
     }