@microsoft/applicationinsights-dependencies-js 3.4.0-nightlybeta3.2505-36 → 3.4.0-nightlybeta3.2507-22

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights XHR dependencies plugin, 3.4.0-nightlybeta3.2505-36
+ * Microsoft Application Insights XHR dependencies plugin, 3.4.0-nightlybeta3.2507-22
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -16,13 +16,14 @@ import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
 import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
 import { IConfig } from '@microsoft/applicationinsights-common';
 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';
 import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+import { IW3cTraceState } from '@microsoft/applicationinsights-core-js';
 
 export declare class AjaxPlugin extends BaseTelemetryPlugin implements IDependenciesPlugin, IInstrumentationRequirements, IDependencyListenerContainer {
     static identifier: string;
@@ -38,7 +39,7 @@ export declare class AjaxPlugin extends BaseTelemetryPlugin implements IDependen
     trackDependencyData(dependency: IDependencyTelemetry, properties?: {
         [key: string]: any;
     }): void;
-    includeCorrelationHeaders(ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented): any;
+    includeCorrelationHeaders(ajaxData: IAjaxRecordData, 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.
@@ -68,77 +69,172 @@ export declare class AjaxPlugin extends BaseTelemetryPlugin implements IDependen
     }): void;
 }
 
-export declare class ajaxRecord {
+/**
+ * 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) => boolean | void;
+
+export declare const DfltAjaxCorrelationHeaderExDomains: string[];
+
+declare const _DYN_INCLUDE_CORRELATION_0 = "includeCorrelationHeaders";
+
+/**
+ * Interface for ajax data passed to includeCorrelationHeaders function.
+ * Contains the public properties and methods needed for correlation header processing.
+ *
+ * @public
+ */
+export declare interface IAjaxRecordData {
+    /**
+     * Gets the absolute URL for the request
+     * @returns The absolute URL string or null
+     */
+    getAbsoluteUrl(): string | null;
+    /**
+     * Gets the sanitized path name for the request URL
+     * @returns The sanitized path name string or null
+     */
+    getPathName(): string | null;
+    /**
+     * The distributed trace context for the request containing trace ID, span ID, and trace flags
+     */
+    readonly traceCtx: IDistributedTraceContext;
+    /**
+     * Object containing request headers that have been set for this request
+     */
+    requestHeaders: {
+        [key: string]: string;
+    };
+    /**
+     * Indicates whether the request was aborted (0 = not aborted, 1 = aborted)
+     */
+    aborted: number;
+    /**
+     * Optional context object that can be set by dependency listeners
+     */
+    context?: {
+        [key: string]: any;
+    };
+}
+
+/**
+ * Internal interface that extends the public IAjaxRecordData with additional properties and methods
+ * used internally by the AJAX monitoring implementation.
+ *
+ * @internal
+ */
+declare interface IAjaxRecordInternal extends IAjaxRecordData {
+    /**
+     * Indicates if the ajax call has completed
+     */
     completed: boolean;
+    /**
+     * Size of the request headers in bytes
+     */
     requestHeadersSize: number;
-    requestHeaders: any;
+    /**
+     * Duration of receiving the response in milliseconds
+     */
     responseReceivingDuration: number;
+    /**
+     * Duration of the callback execution in milliseconds
+     */
     callbackDuration: number;
+    /**
+     * Total duration of the ajax call in milliseconds
+     */
     ajaxTotalDuration: number;
-    aborted: number;
+    /**
+     * URL of the page that initiated the request
+     */
     pageUrl: string;
+    /**
+     * The URL of the request
+     */
     requestUrl: string;
+    /**
+     * Size of the request in bytes
+     */
     requestSize: number;
+    /**
+     * HTTP method used for the request
+     */
     method: string;
+    /**
+     * Performance mark associated with this request
+     */
     perfMark: PerformanceMark;
+    /**
+     * Performance timing data from the Resource Timing API
+     */
     perfTiming: PerformanceResourceTiming;
+    /**
+     * Number of attempts to find performance data
+     */
     perfAttempts?: number;
+    /**
+     * Indicates if the request was made asynchronously
+     */
     async?: boolean;
+    /**
+     * Should the Error Status text be included in the response
+     */
     errorStatusText?: boolean;
+    /**
+     * HTTP status code of the response
+     */
     status: string | number;
+    /**
+     * Timestamp when the request was sent
+     */
     requestSentTime: number;
+    /**
+     * Timestamp when the first byte was received
+     */
     responseStartedTime: number;
+    /**
+     * Timestamp when the last byte was received
+     */
     responseFinishedTime: number;
-    callbackFinishedTime: number;
-    endTime: number;
-    xhrMonitoringState: XHRMonitoringState;
-    clientFailure: number;
     /**
-     * The traceId to use for the dependency call
+     * Timestamp when the onreadystatechange callback finished
      */
-    traceID: string;
+    callbackFinishedTime: number;
     /**
-     * The spanId to use for the dependency call
+     * Timestamp when the ajax call ended
      */
-    spanID: string;
+    endTime: number;
     /**
-     * The traceFlags to use for the dependency call
+     * State tracking object for XHR monitoring
      */
-    traceFlags?: number;
+    xhrMonitoringState: IXHRMonitoringState;
     /**
-     * The trace context to use for reporting the remote dependency call
+     * Indicates if a JavaScript exception occurred in xhr.onreadystatechange code (1 if occurred, 0 otherwise)
      */
-    eventTraceCtx: ITraceCtx;
+    clientFailure: number;
     /**
-     * The listener assigned context values that will be passed to any dependency initializer
+     * Creates a telemetry item for tracking this ajax request
+     * @param ajaxType - Type of the ajax request
+     * @param enableRequestHeaderTracking - Whether to include request headers in telemetry
+     * @param getResponse - Function to get response data
+     * @returns Dependency telemetry item or null
      */
-    context?: {
-        [key: string]: any;
-    };
-    constructor(traceId: string, spanId: string, logger: IDiagnosticLogger, traceCtx?: IDistributedTraceContext);
-    getAbsoluteUrl(): string;
-    getPathName(): string;
     CreateTrackItem(ajaxType: string, enableRequestHeaderTracking: boolean, getResponse: () => IAjaxRecordResponse): IDependencyTelemetry;
+    /**
+     * Gets Part A properties for telemetry
+     * @returns Object containing Part A properties or null
+     */
     getPartAProps(): {
         [key: string]: any;
     };
 }
 
-/**
- * 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) => boolean | void;
-
-export declare const DfltAjaxCorrelationHeaderExDomains: string[];
-
-declare const _DYN_INCLUDE_CORRELATION_0 = "includeCorrelationHeaders";
-
 declare interface IAjaxRecordResponse {
     statusText: string;
     headerMap: Object;
@@ -148,6 +244,8 @@ declare interface IAjaxRecordResponse {
     response?: Object;
 }
 
+export { ICorrelationConfig }
+
 export declare interface IDependenciesPlugin extends IDependencyListenerContainer {
     /**
      * Logs dependency call
@@ -240,6 +338,12 @@ export declare interface IDependencyListenerDetails {
      * https://www.w3.org/TR/trace-context/#trace-flags
      */
     traceFlags?: number;
+    /**
+     * The W3C TraceState object that contains the trace state information, this is mutable and changes made to this
+     * instance will be reflected in the distributed trace context. You cannot overwrite the traceState, but you can
+     * modify the values within the traceState.
+     */
+    readonly traceState?: IW3cTraceState;
     /**
      * [Optional] Context that the application can assign that will also be passed to any dependency initializer
      */
@@ -258,22 +362,18 @@ export declare interface IDependencyListenerHandler extends IDependencyHandler {
 }
 
 export declare interface IInstrumentationRequirements extends IDependenciesPlugin {
-    [_DYN_INCLUDE_CORRELATION_0]: (ajaxData: ajaxRecord, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
-}
-
-declare interface ITraceCtx {
-    traceId: string;
-    spanId: string;
-    traceFlags: number;
+    [_DYN_INCLUDE_CORRELATION_0]: (ajaxData: IAjaxRecordData, input?: Request | string, init?: RequestInit, xhr?: XMLHttpRequestInstrumented) => any;
 }
 
-declare class XHRMonitoringState {
+/**
+ * Interface defining the XHR monitoring state properties
+ */
+declare interface IXHRMonitoringState {
     openDone: boolean;
     setRequestHeaderDone: boolean;
     sendDone: boolean;
     abortDone: boolean;
     stateChangeAttached: boolean;
-    constructor();
 }
 
 export declare interface XMLHttpRequestData {
@@ -288,7 +388,7 @@ export declare interface XMLHttpRequestData {
      * The individual tracking data for each AI instance
      */
     i: {
-        [key: string]: ajaxRecord;
+        [key: string]: IAjaxRecordInternal;
     };
 }