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

package/dist/applicationinsights-dependencies-js.rollup.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
@@ -26,10 +26,10 @@ import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
 
-export declare class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements {
+export declare 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();
@@ -50,6 +50,15 @@ export declare class AjaxPlugin extends BaseTelemetryPlugin implements IDependen
      * @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
@@ -104,6 +113,12 @@ export declare class ajaxRecord {
      * 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;
@@ -113,13 +128,26 @@ export declare class ajaxRecord {
     };
 }
 
-declare type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => 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`.
+ */
+export declare type DependencyInitializerFunction = (item: IDependencyInitializerDetails) => boolean | void;
+
+/**
+ * The function that will get called when the ajax request is about to occur.
+ */
+export declare type DependencyListenerFunction = (dependencyDetails: IDependencyListenerDetails) => void;
 
 export declare const DfltAjaxCorrelationHeaderExDomains: string[];
 
 declare const _DYN_HEADER_MAP = "headerMap";
 
-declare const _DYN_INCLUDE_CORRELATION_3 = "includeCorrelationHeaders";
+declare const _DYN_INCLUDE_CORRELATION_2 = "includeCorrelationHeaders";
+
+declare function _getDefaultConfig(): ICorrelationConfig;
+
+declare function _getEmptyConfig(): ICorrelationConfig;
 
 declare interface IAjaxRecordResponse {
     statusText: string;
@@ -138,6 +166,38 @@ export declare interface IDependenciesPlugin extends IDependencyListenerContaine
     trackDependencyData(dependency: IDependencyTelemetry): void;
 }
 
+export declare interface IDependencyHandler {
+    remove(): void;
+}
+
+export declare 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;
+    };
+}
+
+export declare interface IDependencyInitializerHandler extends IDependencyHandler {
+}
+
 declare 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
@@ -148,7 +208,7 @@ declare interface IDependencyListenerContainer {
     addDependencyListener(dependencyListener: DependencyListenerFunction): IDependencyListenerHandler;
 }
 
-declare interface IDependencyListenerDetails {
+export declare interface IDependencyListenerDetails {
     /**
      * The current core instance
      */
@@ -185,14 +245,19 @@ declare interface IDependencyListenerDetails {
      * 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;
+    };
 }
 
-declare interface IDependencyListenerHandler {
-    remove(): void;
+export declare interface IDependencyListenerHandler extends IDependencyHandler {
 }
 
 export declare 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;
 }
 
 declare interface ITraceCtx {

package/dist-esm/DependencyInitializer.js

@@ -0,0 +1,6 @@
+/*
+ * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2209-01
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ */
+export {};
+//# sourceMappingURL=DependencyInitializer.js.map

package/dist-esm/DependencyInitializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DependencyInitializer.js.map","sources":["DependencyInitializer.js"],"sourcesContent":["export {};\r\n//# sourceMappingURL=DependencyInitializer.js.map"],"names":[],"mappings":";;;;AAAA;AACA"}

package/dist-esm/DependencyListener.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2208-19
+ * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2209-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/InternalConstants.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2208-19
+ * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2209-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/__DynamicConstants.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2208-19
+ * Application Insights JavaScript SDK - Dependencies Plugin, 3.0.0-beta.2209-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 
@@ -13,21 +13,21 @@
 // ###########################################################################################################################################
 export var _DYN_REQUEST_URL = "requestUrl"; // Count: 12
 export var _DYN_INST = "inst"; // Count: 5
-export var _DYN_LENGTH = "length"; // Count: 9
+export var _DYN_LENGTH = "length"; // Count: 10
 export var _DYN_TRACE_ID = "traceID"; // Count: 9
 export var _DYN_SPAN_ID = "spanID"; // Count: 8
 export var _DYN_TRACE_FLAGS = "traceFlags"; // Count: 13
-export var _DYN_CORE = "core"; // Count: 6
+export var _DYN_CONTEXT = "context"; // Count: 7
 export var _DYN_TRACE_ID0 = "traceId"; // Count: 5
 export var _DYN_SPAN_ID1 = "spanId"; // Count: 5
-export var _DYN_GET_DEFAULT_CONFIG = "getDefaultConfig"; // Count: 2
-export var _DYN_TRACK_DEPENDENCY_DAT2 = "trackDependencyDataInternal"; // Count: 4
-export var _DYN_INCLUDE_CORRELATION_3 = "includeCorrelationHeaders"; // Count: 4
+export var _DYN_CORE = "core"; // Count: 8
+export var _DYN_INCLUDE_CORRELATION_2 = "includeCorrelationHeaders"; // Count: 4
 export var _DYN_GET_ABSOLUTE_URL = "getAbsoluteUrl"; // Count: 3
 export var _DYN_HEADERS = "headers"; // Count: 6
 export var _DYN_REQUEST_HEADERS = "requestHeaders"; // Count: 13
 export var _DYN_APP_ID = "appId"; // Count: 5
 export var _DYN_SET_REQUEST_HEADER = "setRequestHeader"; // Count: 3
+export var _DYN_TRACK_DEPENDENCY_DAT3 = "trackDependencyDataInternal"; // Count: 2
 export var _DYN_DISTRIBUTED_TRACING_4 = "distributedTracingMode"; // Count: 3
 export var _DYN_START_TIME = "startTime"; // Count: 6
 export var _DYN_TO_LOWER_CASE = "toLowerCase"; // Count: 6

package/dist-esm/__DynamicConstants.js.map

@@ -1 +1 @@
-{"version":3,"file":"__DynamicConstants.js.map","sources":["__DynamicConstants.js"],"sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved.\r\n// Licensed under the MIT License.\r\n// @skip-file-minify\r\n// ##############################################################\r\n// AUTO GENERATED FILE: This file is Auto Generated during build.\r\n// ##############################################################\r\n// ###########################################################################################################################################\r\n// Note: DON'T Export these const from the package as we are still targeting IE this will export a mutable variables that someone could change\r\n// ###########################################################################################################################################\r\nexport var _DYN_REQUEST_URL = \"requestUrl\"; // Count: 12\r\nexport var _DYN_INST = \"inst\"; // Count: 5\r\nexport var _DYN_LENGTH = \"length\"; // Count: 9\r\nexport var _DYN_TRACE_ID = \"traceID\"; // Count: 9\r\nexport var _DYN_SPAN_ID = \"spanID\"; // Count: 8\r\nexport var _DYN_TRACE_FLAGS = \"traceFlags\"; // Count: 13\r\nexport var _DYN_CORE = \"core\"; // Count: 6\r\nexport var _DYN_TRACE_ID0 = \"traceId\"; // Count: 5\r\nexport var _DYN_SPAN_ID1 = \"spanId\"; // Count: 5\r\nexport var _DYN_GET_DEFAULT_CONFIG = \"getDefaultConfig\"; // Count: 2\r\nexport var _DYN_TRACK_DEPENDENCY_DAT2 = \"trackDependencyDataInternal\"; // Count: 4\r\nexport var _DYN_INCLUDE_CORRELATION_3 = \"includeCorrelationHeaders\"; // Count: 4\r\nexport var _DYN_GET_ABSOLUTE_URL = \"getAbsoluteUrl\"; // Count: 3\r\nexport var _DYN_HEADERS = \"headers\"; // Count: 6\r\nexport var _DYN_REQUEST_HEADERS = \"requestHeaders\"; // Count: 13\r\nexport var _DYN_APP_ID = \"appId\"; // Count: 5\r\nexport var _DYN_SET_REQUEST_HEADER = \"setRequestHeader\"; // Count: 3\r\nexport var _DYN_DISTRIBUTED_TRACING_4 = \"distributedTracingMode\"; // Count: 3\r\nexport var _DYN_START_TIME = \"startTime\"; // Count: 6\r\nexport var _DYN_TO_LOWER_CASE = \"toLowerCase\"; // Count: 6\r\nexport var _DYN_ENABLE_REQUEST_HEADE5 = \"enableRequestHeaderTracking\"; // Count: 2\r\nexport var _DYN_ENABLE_AJAX_ERROR_ST6 = \"enableAjaxErrorStatusText\"; // Count: 2\r\nexport var _DYN_ENABLE_AJAX_PERF_TRA7 = \"enableAjaxPerfTracking\"; // Count: 2\r\nexport var _DYN_MAX_AJAX_CALLS_PER_V8 = \"maxAjaxCallsPerView\"; // Count: 2\r\nexport var _DYN_ENABLE_RESPONSE_HEAD9 = \"enableResponseHeaderTracking\"; // Count: 2\r\nexport var _DYN_EXCLUDE_REQUEST_FROM10 = \"excludeRequestFromAutoTrackingPatterns\"; // Count: 2\r\nexport var _DYN_ADD_REQUEST_CONTEXT = \"addRequestContext\"; // Count: 2\r\nexport var _DYN_DISABLE_AJAX_TRACKIN11 = \"disableAjaxTracking\"; // Count: 2\r\nexport var _DYN_DISABLE_FETCH_TRACKI12 = \"disableFetchTracking\"; // Count: 2\r\nexport var _DYN_STATUS = \"status\"; // Count: 10\r\nexport var _DYN_STATUS_TEXT = \"statusText\"; // Count: 8\r\nexport var _DYN_HEADER_MAP = \"headerMap\"; // Count: 8\r\nexport var _DYN_OPEN_DONE = \"openDone\"; // Count: 3\r\nexport var _DYN_SEND_DONE = \"sendDone\"; // Count: 3\r\nexport var _DYN_REQUEST_SENT_TIME = \"requestSentTime\"; // Count: 9\r\nexport var _DYN_ABORT_DONE = \"abortDone\"; // Count: 3\r\nexport var _DYN_GET_TRACE_ID = \"getTraceId\"; // Count: 3\r\nexport var _DYN_GET_TRACE_FLAGS = \"getTraceFlags\"; // Count: 3\r\nexport var _DYN_METHOD = \"method\"; // Count: 10\r\nexport var _DYN_ERROR_STATUS_TEXT = \"errorStatusText\"; // Count: 3\r\nexport var _DYN_STATE_CHANGE_ATTACHE13 = \"stateChangeAttached\"; // Count: 2\r\nexport var _DYN_RESPONSE_TEXT = \"responseText\"; // Count: 5\r\nexport var _DYN_RESPONSE_FINISHED_TI14 = \"responseFinishedTime\"; // Count: 7\r\nexport var _DYN__CREATE_TRACK_ITEM = \"CreateTrackItem\"; // Count: 3\r\nexport var _DYN_RESPONSE = \"response\"; // Count: 4\r\nexport var _DYN_GET_ALL_RESPONSE_HEA15 = \"getAllResponseHeaders\"; // Count: 2\r\nexport var _DYN_GET_PART_APROPS = \"getPartAProps\"; // Count: 3\r\nexport var _DYN_PERF_MARK = \"perfMark\"; // Count: 4\r\nexport var _DYN_AJAX_PERF_LOOKUP_DEL16 = \"ajaxPerfLookupDelay\"; // Count: 2\r\nexport var _DYN_NAME = \"name\"; // Count: 6\r\nexport var _DYN_PERF_TIMING = \"perfTiming\"; // Count: 3\r\nexport var _DYN_AJAX_DIAGNOSTICS_MES17 = \"ajaxDiagnosticsMessage\"; // Count: 3\r\nexport var _DYN_CORRELATION_CONTEXT = \"correlationContext\"; // Count: 3\r\nexport var _DYN_AJAX_TOTAL_DURATION = \"ajaxTotalDuration\"; // Count: 3\r\nexport var _DYN_EVENT_TRACE_CTX = \"eventTraceCtx\"; // Count: 3\r\n//# sourceMappingURL=__DynamicConstants.js.map"],"names":[],"mappings":";;;;AAA4D;AAC1B;AAClC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}
+{"version":3,"file":"__DynamicConstants.js.map","sources":["__DynamicConstants.js"],"sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved.\r\n// Licensed under the MIT License.\r\n// @skip-file-minify\r\n// ##############################################################\r\n// AUTO GENERATED FILE: This file is Auto Generated during build.\r\n// ##############################################################\r\n// ###########################################################################################################################################\r\n// Note: DON'T Export these const from the package as we are still targeting IE this will export a mutable variables that someone could change\r\n// ###########################################################################################################################################\r\nexport var _DYN_REQUEST_URL = \"requestUrl\"; // Count: 12\r\nexport var _DYN_INST = \"inst\"; // Count: 5\r\nexport var _DYN_LENGTH = \"length\"; // Count: 10\r\nexport var _DYN_TRACE_ID = \"traceID\"; // Count: 9\r\nexport var _DYN_SPAN_ID = \"spanID\"; // Count: 8\r\nexport var _DYN_TRACE_FLAGS = \"traceFlags\"; // Count: 13\r\nexport var _DYN_CONTEXT = \"context\"; // Count: 7\r\nexport var _DYN_TRACE_ID0 = \"traceId\"; // Count: 5\r\nexport var _DYN_SPAN_ID1 = \"spanId\"; // Count: 5\r\nexport var _DYN_CORE = \"core\"; // Count: 8\r\nexport var _DYN_INCLUDE_CORRELATION_2 = \"includeCorrelationHeaders\"; // Count: 4\r\nexport var _DYN_GET_ABSOLUTE_URL = \"getAbsoluteUrl\"; // Count: 3\r\nexport var _DYN_HEADERS = \"headers\"; // Count: 6\r\nexport var _DYN_REQUEST_HEADERS = \"requestHeaders\"; // Count: 13\r\nexport var _DYN_APP_ID = \"appId\"; // Count: 5\r\nexport var _DYN_SET_REQUEST_HEADER = \"setRequestHeader\"; // Count: 3\r\nexport var _DYN_TRACK_DEPENDENCY_DAT3 = \"trackDependencyDataInternal\"; // Count: 2\r\nexport var _DYN_DISTRIBUTED_TRACING_4 = \"distributedTracingMode\"; // Count: 3\r\nexport var _DYN_START_TIME = \"startTime\"; // Count: 6\r\nexport var _DYN_TO_LOWER_CASE = \"toLowerCase\"; // Count: 6\r\nexport var _DYN_ENABLE_REQUEST_HEADE5 = \"enableRequestHeaderTracking\"; // Count: 2\r\nexport var _DYN_ENABLE_AJAX_ERROR_ST6 = \"enableAjaxErrorStatusText\"; // Count: 2\r\nexport var _DYN_ENABLE_AJAX_PERF_TRA7 = \"enableAjaxPerfTracking\"; // Count: 2\r\nexport var _DYN_MAX_AJAX_CALLS_PER_V8 = \"maxAjaxCallsPerView\"; // Count: 2\r\nexport var _DYN_ENABLE_RESPONSE_HEAD9 = \"enableResponseHeaderTracking\"; // Count: 2\r\nexport var _DYN_EXCLUDE_REQUEST_FROM10 = \"excludeRequestFromAutoTrackingPatterns\"; // Count: 2\r\nexport var _DYN_ADD_REQUEST_CONTEXT = \"addRequestContext\"; // Count: 2\r\nexport var _DYN_DISABLE_AJAX_TRACKIN11 = \"disableAjaxTracking\"; // Count: 2\r\nexport var _DYN_DISABLE_FETCH_TRACKI12 = \"disableFetchTracking\"; // Count: 2\r\nexport var _DYN_STATUS = \"status\"; // Count: 10\r\nexport var _DYN_STATUS_TEXT = \"statusText\"; // Count: 8\r\nexport var _DYN_HEADER_MAP = \"headerMap\"; // Count: 8\r\nexport var _DYN_OPEN_DONE = \"openDone\"; // Count: 3\r\nexport var _DYN_SEND_DONE = \"sendDone\"; // Count: 3\r\nexport var _DYN_REQUEST_SENT_TIME = \"requestSentTime\"; // Count: 9\r\nexport var _DYN_ABORT_DONE = \"abortDone\"; // Count: 3\r\nexport var _DYN_GET_TRACE_ID = \"getTraceId\"; // Count: 3\r\nexport var _DYN_GET_TRACE_FLAGS = \"getTraceFlags\"; // Count: 3\r\nexport var _DYN_METHOD = \"method\"; // Count: 10\r\nexport var _DYN_ERROR_STATUS_TEXT = \"errorStatusText\"; // Count: 3\r\nexport var _DYN_STATE_CHANGE_ATTACHE13 = \"stateChangeAttached\"; // Count: 2\r\nexport var _DYN_RESPONSE_TEXT = \"responseText\"; // Count: 5\r\nexport var _DYN_RESPONSE_FINISHED_TI14 = \"responseFinishedTime\"; // Count: 7\r\nexport var _DYN__CREATE_TRACK_ITEM = \"CreateTrackItem\"; // Count: 3\r\nexport var _DYN_RESPONSE = \"response\"; // Count: 4\r\nexport var _DYN_GET_ALL_RESPONSE_HEA15 = \"getAllResponseHeaders\"; // Count: 2\r\nexport var _DYN_GET_PART_APROPS = \"getPartAProps\"; // Count: 3\r\nexport var _DYN_PERF_MARK = \"perfMark\"; // Count: 4\r\nexport var _DYN_AJAX_PERF_LOOKUP_DEL16 = \"ajaxPerfLookupDelay\"; // Count: 2\r\nexport var _DYN_NAME = \"name\"; // Count: 6\r\nexport var _DYN_PERF_TIMING = \"perfTiming\"; // Count: 3\r\nexport var _DYN_AJAX_DIAGNOSTICS_MES17 = \"ajaxDiagnosticsMessage\"; // Count: 3\r\nexport var _DYN_CORRELATION_CONTEXT = \"correlationContext\"; // Count: 3\r\nexport var _DYN_AJAX_TOTAL_DURATION = \"ajaxTotalDuration\"; // Count: 3\r\nexport var _DYN_EVENT_TRACE_CTX = \"eventTraceCtx\"; // Count: 3\r\n//# sourceMappingURL=__DynamicConstants.js.map"],"names":[],"mappings":";;;;AAA4D;AAC1B;AAClC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}