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

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

@@ -17,16 +17,21 @@ import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
 
+// Warning: (ae-forgotten-export) The symbol "IDependencyListenerContainer" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+//
 // @public (undocumented)
-export class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
+export class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements, IDependencyListenerContainer {
     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
+    addDependencyInitializer(dependencyInitializer: DependencyInitializerFunction): IDependencyInitializerHandler;
     addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
+    // Warning: (ae-forgotten-export) The symbol "_getDefaultConfig" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    //
     // (undocumented)
-    static getDefaultConfig(): ICorrelationConfig;
+    static getDefaultConfig: typeof _getDefaultConfig;
+    // Warning: (ae-forgotten-export) The symbol "_getEmptyConfig" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    //
     // (undocumented)
-    static getEmptyConfig(): ICorrelationConfig;
+    static getEmptyConfig: typeof _getEmptyConfig;
     // (undocumented)
     static identifier: string;
     // (undocumented)
@@ -66,6 +71,9 @@ export class ajaxRecord {
     clientFailure: number;
     // (undocumented)
     completed: boolean;
+    context?: {
+        [key: string]: any;
+    };
     // Warning: (ae-forgotten-export) The symbol "IAjaxRecordResponse" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
     //
     // (undocumented)
@@ -121,22 +129,68 @@ export class ajaxRecord {
     xhrMonitoringState: XHRMonitoringState;
 }
 
+// @public
+export type DependencyInitializerFunction = (item: IDependencyInitializerDetails) => boolean | void;
+
+// @public
+export type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => void;
+
 // @public (undocumented)
 export const DfltAjaxCorrelationHeaderExDomains: string[];
 
-// 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 extends IDependencyListenerContainer {
     trackDependencyData(dependency: IDependencyTelemetry): void;
 }
 
+// @public (undocumented)
+export interface IDependencyHandler {
+    // (undocumented)
+    remove(): void;
+}
+
+// @public (undocumented)
+export interface IDependencyInitializerDetails {
+    context?: {
+        [key: string]: any;
+    };
+    item: IDependencyTelemetry;
+    properties?: {
+        [key: string]: any;
+    };
+    sysProperties?: {
+        [key: string]: any;
+    };
+}
+
+// @public (undocumented)
+export interface IDependencyInitializerHandler extends IDependencyHandler {
+}
+
+// @public (undocumented)
+export interface IDependencyListenerDetails {
+    context?: {
+        [key: string]: any;
+    };
+    core: IAppInsightsCore;
+    init?: RequestInit;
+    input?: Request | string;
+    spanId?: string;
+    traceFlags?: number;
+    traceId?: string;
+    xhr?: XMLHttpRequest;
+}
+
+// @public (undocumented)
+export interface IDependencyListenerHandler extends IDependencyHandler {
+}
+
 // @public (undocumented)
 export interface IInstrumentationRequirements extends IDependenciesPlugin {
-    // Warning: (ae-forgotten-export) The symbol "_DYN_INCLUDE_CORRELATION_3" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
+    // Warning: (ae-forgotten-export) The symbol "_DYN_INCLUDE_CORRELATION_2" needs to be exported by the entry point applicationinsights-dependencies-js.d.ts
     //
     // (undocumented)
-    [_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;
 }
 
 // @public (undocumented)

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights XHR dependencies plugin, 3.0.0-beta.2208-19
+ * Microsoft Application Insights XHR dependencies plugin, 3.0.0-beta.2209-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -20,10 +20,10 @@ declare namespace ApplicationInsights {
     import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
 
-    class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
+    class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements, IDependencyListenerContainer {
         static identifier: string;
-        static getDefaultConfig(): ICorrelationConfig;
-        static getEmptyConfig(): ICorrelationConfig;
+        static getDefaultConfig: typeof _getDefaultConfig;
+        static getEmptyConfig: typeof _getEmptyConfig;
         identifier: string;
         priority: number;
         constructor();
@@ -44,6 +44,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
@@ -98,6 +107,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;
@@ -107,13 +122,26 @@ declare namespace ApplicationInsights {
         };
     }
 
+    /**
+     * 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 DfltAjaxCorrelationHeaderExDomains: string[];
 
     const _DYN_HEADER_MAP = "headerMap";
 
-    const _DYN_INCLUDE_CORRELATION_3 = "includeCorrelationHeaders";
+    const _DYN_INCLUDE_CORRELATION_2 = "includeCorrelationHeaders";
+
+    function _getDefaultConfig(): ICorrelationConfig;
+
+    function _getEmptyConfig(): ICorrelationConfig;
 
     interface IAjaxRecordResponse {
         statusText: string;
@@ -132,6 +160,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
@@ -179,14 +239,19 @@ 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 {
     }
 
     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 ITraceCtx {