@microsoft/applicationinsights-dependencies-js 3.0.0-beta.2208-03 → 3.0.0-beta.2208-16

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.28.7",
+    "toolVersion": "7.29.2",
     "schemaVersion": 1009,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -188,11 +188,7 @@
             },
             {
               "kind": "Content",
-              "text": " "
-            },
-            {
-              "kind": "Content",
-              "text": "implements "
+              "text": " implements "
             },
             {
               "kind": "Reference",
@@ -861,12 +857,12 @@
           },
           "implementsTokenRanges": [
             {
-              "startIndex": 4,
-              "endIndex": 5
+              "startIndex": 3,
+              "endIndex": 4
             },
             {
-              "startIndex": 6,
-              "endIndex": 7
+              "startIndex": 5,
+              "endIndex": 6
             }
           ]
         },
@@ -891,7 +887,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "constructor(traceID: "
+                  "text": "constructor(traceId: "
                 },
                 {
                   "kind": "Content",
@@ -899,7 +895,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", spanID: "
+                  "text": ", spanId: "
                 },
                 {
                   "kind": "Content",
@@ -914,6 +910,15 @@
                   "text": "IDiagnosticLogger",
                   "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", traceCtx?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDistributedTraceContext",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IDistributedTraceContext:interface"
+                },
                 {
                   "kind": "Content",
                   "text": ");"
@@ -924,7 +929,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "traceID",
+                  "parameterName": "traceId",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -932,7 +937,7 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "spanID",
+                  "parameterName": "spanId",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
@@ -946,6 +951,14 @@
                     "endIndex": 6
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "traceCtx",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
                 }
               ]
             },
@@ -1295,6 +1308,36 @@
               "isStatic": false,
               "isProtected": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#eventTraceCtx:member",
+              "docComment": "/**\n * The trace context to use for reporting the remote dependency call\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "eventTraceCtx: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITraceCtx",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!~ITraceCtx:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "eventTraceCtx",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#getAbsoluteUrl:member(1)",
@@ -1325,6 +1368,36 @@
               "isOptional": false,
               "name": "getAbsoluteUrl"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#getPartAProps:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getPartAProps(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: any;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "name": "getPartAProps"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#getPathName:member(1)",
@@ -1737,7 +1810,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#spanID:member",
-              "docComment": "",
+              "docComment": "/**\n * The spanId to use for the dependency call\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1795,7 +1868,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#traceFlags:member",
-              "docComment": "",
+              "docComment": "/**\n * The traceFlags to use for the dependency call\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1824,7 +1897,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-dependencies-js!ajaxRecord#traceID:member",
-              "docComment": "",
+              "docComment": "/**\n * The traceId to use for the dependency call\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2016,8 +2089,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "_DYN_INCLUDE_CORRELATION_0",
-                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!_DYN_INCLUDE_CORRELATION_0"
+                  "text": "_DYN_INCLUDE_CORRELATION_3",
+                  "canonicalReference": "@microsoft/applicationinsights-dependencies-js!_DYN_INCLUDE_CORRELATION_3"
                 },
                 {
                   "kind": "Content",

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

@@ -11,6 +11,7 @@ import { IConfiguration } from '@microsoft/applicationinsights-core-js';
 import { ICorrelationConfig } from '@microsoft/applicationinsights-common';
 import { IDependencyTelemetry } from '@microsoft/applicationinsights-common';
 import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
+import { IDistributedTraceContext } from '@microsoft/applicationinsights-core-js';
 import { IPlugin } from '@microsoft/applicationinsights-core-js';
 import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
@@ -50,7 +51,7 @@ export class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlug
 
 // @public (undocumented)
 export class ajaxRecord {
-    constructor(traceID: string, spanID: string, logger: IDiagnosticLogger);
+    constructor(traceId: string, spanId: string, logger: IDiagnosticLogger, traceCtx?: IDistributedTraceContext);
     // (undocumented)
     aborted: number;
     // (undocumented)
@@ -73,9 +74,15 @@ export class ajaxRecord {
     endTime: number;
     // (undocumented)
     errorStatusText?: boolean;
+    // Warning: (ae-forgotten-export) The symbol "ITraceCtx" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    eventTraceCtx: ITraceCtx;
     // (undocumented)
     getAbsoluteUrl(): string;
     // (undocumented)
+    getPartAProps(): {
+        [key: string]: any;
+    };
+    // (undocumented)
     getPathName(): string;
     // (undocumented)
     method: string;
@@ -103,13 +110,10 @@ export class ajaxRecord {
     responseReceivingDuration: number;
     // (undocumented)
     responseStartedTime: number;
-    // (undocumented)
     spanID: string;
     // (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
     //
@@ -129,10 +133,10 @@ export interface IDependenciesPlugin extends IDependencyListenerContainer {
 
 // @public (undocumented)
 export interface IInstrumentationRequirements extends IDependenciesPlugin {
-    // Warning: (ae-forgotten-export) The symbol "_DYN_INCLUDE_CORRELATION_0" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    // Warning: (ae-forgotten-export) The symbol "_DYN_INCLUDE_CORRELATION_3" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
     //
     // (undocumented)
-    [_DYN_INCLUDE_CORRELATION_0]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
+    [_DYN_INCLUDE_CORRELATION_3]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
 }
 
 // @public (undocumented)

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights XHR dependencies plugin, 3.0.0-beta.2208-03
+ * Microsoft Application Insights XHR dependencies plugin, 3.0.0-beta.2208-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -14,6 +14,7 @@ declare namespace ApplicationInsights {
     import { ICorrelationConfig } from '@microsoft/applicationinsights-common';
     import { IDependencyTelemetry } from '@microsoft/applicationinsights-common';
     import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
+    import { IDistributedTraceContext } from '@microsoft/applicationinsights-core-js';
     import { IPlugin } from '@microsoft/applicationinsights-core-js';
     import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
@@ -81,13 +82,29 @@ declare namespace ApplicationInsights {
         endTime: number;
         xhrMonitoringState: XHRMonitoringState;
         clientFailure: number;
+        /**
+         * The traceId to use for the dependency call
+         */
         traceID: string;
+        /**
+         * The spanId to use for the dependency call
+         */
         spanID: string;
+        /**
+         * The traceFlags to use for the dependency call
+         */
         traceFlags?: number;
-        constructor(traceID: string, spanID: string, logger: IDiagnosticLogger);
+        /**
+         * The trace context to use for reporting the remote dependency call
+         */
+        eventTraceCtx: ITraceCtx;
+        constructor(traceId: string, spanId: string, logger: IDiagnosticLogger, traceCtx?: IDistributedTraceContext);
         getAbsoluteUrl(): string;
         getPathName(): string;
         CreateTrackItem(ajaxType: string, enableRequestHeaderTracking: boolean, getResponse: () => IAjaxRecordResponse): IDependencyTelemetry;
+        getPartAProps(): {
+            [key: string]: any;
+        };
     }
 
     type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => void;
@@ -96,7 +113,7 @@ declare namespace ApplicationInsights {
 
     const _DYN_HEADER_MAP = "headerMap";
 
-    const _DYN_INCLUDE_CORRELATION_0 = "includeCorrelationHeaders";
+    const _DYN_INCLUDE_CORRELATION_3 = "includeCorrelationHeaders";
 
     interface IAjaxRecordResponse {
         statusText: string;
@@ -169,7 +186,13 @@ declare namespace ApplicationInsights {
     }
 
     interface IInstrumentationRequirements extends IDependenciesPlugin {
-        [_DYN_INCLUDE_CORRELATION_0]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
+        [_DYN_INCLUDE_CORRELATION_3]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
+    }
+
+    interface ITraceCtx {
+        traceId: string;
+        spanId: string;
+        traceFlags: number;
     }
 
     class XHRMonitoringState {