@microsoft/applicationinsights-common 3.1.1-nightly3.2403-01 → 3.1.1-nightly3.2403-02

package/types/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.1.1-nightly3.2403-01
+ * Microsoft Application Insights Common JavaScript Library, 3.1.1-nightly3.2403-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -24,16 +24,22 @@ import { ICookieMgr } from '@microsoft/applicationinsights-core-js';
 import { ICustomProperties } from '@microsoft/applicationinsights-core-js';
 import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
 import { IDistributedTraceContext } from '@microsoft/applicationinsights-core-js';
+import { IPayloadData } from '@microsoft/applicationinsights-core-js';
 import { IPlugin } from '@microsoft/applicationinsights-core-js';
+import { IProcessTelemetryUnloadContext } from '@microsoft/applicationinsights-core-js';
 import { isBeaconsSupported as isBeaconApiSupported } from '@microsoft/applicationinsights-core-js';
 import { isSampledFlag } from '@microsoft/applicationinsights-core-js';
 import { isValidSpanId } from '@microsoft/applicationinsights-core-js';
 import { isValidTraceId } from '@microsoft/applicationinsights-core-js';
 import { isValidTraceParent } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryUnloadState } from '@microsoft/applicationinsights-core-js';
 import { ITraceParent } from '@microsoft/applicationinsights-core-js';
 import { IUnloadHook } from '@microsoft/applicationinsights-core-js';
+import { IXHROverride } from '@microsoft/applicationinsights-core-js';
+import { OnCompleteCallback } from '@microsoft/applicationinsights-core-js';
 import { parseTraceParent } from '@microsoft/applicationinsights-core-js';
+import { TransportType } from '@microsoft/applicationinsights-core-js';
 
 /**
  * Data struct to contain only C section with custom fields.
@@ -514,10 +520,16 @@ export { findW3cTraceParent }
  */
 declare function _formatErrorCode(errorObj: any): any;
 
+export declare function formatErrorMessageXdr(xdr: IXDomainRequest, message?: string): string;
+
+export declare function formatErrorMessageXhr(xhr: XMLHttpRequest, message?: string): string;
+
 export { formatTraceParent }
 
 export declare function getExtensionByName(extensions: IPlugin[], identifier: string): IPlugin | null;
 
+export declare function getResponseText(xhr: XMLHttpRequest | IXDomainRequest): string;
+
 export declare const HttpMethod = "http.method";
 
 export declare interface IAppInsights {
@@ -632,6 +644,25 @@ export declare interface IAutoExceptionTelemetry {
     errorSrc?: string;
 }
 
+export declare interface IBackendResponse {
+    /**
+     * Number of items received by the backend
+     */
+    readonly itemsReceived: number;
+    /**
+     * Number of items succesfuly accepted by the backend
+     */
+    readonly itemsAccepted: number;
+    /**
+     * List of errors for items which were not accepted
+     */
+    readonly errors: IResponseError[];
+    /**
+     * App id returned by the backend - not necessary returned, but we don't need it with each response.
+     */
+    readonly appId?: string;
+}
+
 /**
  * Configuration settings for how telemetry is sent
  * @export
@@ -950,6 +981,11 @@ export declare interface IConfig {
     throttleMgrCfg?: {
         [key: number]: IThrottleMgrConfig;
     };
+    /**
+     * [Optional] Specifies a Highest Priority custom endpoint URL where telemetry data will be sent.
+     * This URL takes precedence over the 'config.endpointUrl' and any endpoint in the connection string.
+     */
+    userOverrideEndpointUrl?: string;
 }
 
 export declare interface IContextTagKeys {
@@ -1877,6 +1913,12 @@ export declare interface IRequestHeaders {
     requestContextHeaderLowerCase: string;
 }
 
+declare interface IResponseError {
+    readonly index: number;
+    readonly statusCode: number;
+    readonly message: string;
+}
+
 export declare interface ISample {
     /**
      * Sample rate
@@ -1889,6 +1931,93 @@ export { isBeaconApiSupported }
 
 export declare function isCrossOriginError(message: string | Event, url: string, lineNumber: number, columnNumber: number, error: Error | Event): boolean;
 
+/**
+ * internal interface
+ * Define functions when xhr/xdr/fetch requests are successfully returned. If they are not defined, oncomplete with be called instead
+ * @internal for internal use only
+ */
+export declare interface _ISenderOnComplete {
+    /**
+     * defined xdr onload function to handle response
+     * @param dxr xdr request object
+     * @param oncomplete oncomplete function
+     * @since version after 3.1.0
+     */
+    xdrOnComplete?(xdr: IXDomainRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
+    /**
+     * defined fetch on complete function to handle response
+     * @param response response object
+     * @param onComplete oncomplete function
+     * @param resValue response.text().value
+     * @since version after 3.1.0
+     */
+    fetchOnComplete?(response: Response, onComplete: OnCompleteCallback, resValue?: string, payload?: IPayloadData): void;
+    /**
+     * defined xhr onreadystatechange function to handle response
+     * @param request request object
+     * @param oncomplete oncomplete function
+     * @since version after 3.1.0
+     */
+    xhrOnComplete?(request: XMLHttpRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
+    /**
+     * Define functions during beacon can not send payload after first attempt. If not defined, will be apyload will be retried with fallback sender.
+     * @param data payload data
+     * @param onComplete oncomplete function
+     * @param canSend can the current data sent by beacon sender
+     * @since version after 3.1.0
+     */
+    beaconOnRetry?(data: IPayloadData, onComplete: OnCompleteCallback, canSend: (payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => boolean): void;
+}
+
+/**
+ * Internal interface for SendPostMnager
+ * @internal for internal use only
+ */
+export declare interface _ISendPostMgrConfig {
+    /**
+     * Enable the sender interface to return a promise
+     * Note: Enabling this may cause unhandled promise rejection errors to occur if you do not listen and handle any rejection response,
+     * Defaults to false
+     * @since version after 3.1.0
+     */
+    enableSendPromise?: boolean;
+    /**
+     * Identifies if the sender is 1ds post channel
+     * Default is false
+     * @since version after 3.1.0
+     */
+    isOneDs?: boolean;
+    /**
+     * Identify if Credentials should be disabled for 1ds post channel, application insights sender will igore this config
+     * Default is false
+     * @since version after 3.1.0
+     */
+    disableCredentials?: boolean;
+    /**
+     * Identifies if XMLHttpRequest or XDomainRequest (for IE < 9) should be used
+     * Default: false
+     * @since version after 3.1.0
+     */
+    disableXhr?: boolean;
+    /**
+     * Is beacon disabled during asunc sending
+     * Default: false
+     * @since version after 3.1.0
+     */
+    disableBeacon?: boolean;
+    /**
+     * Is beacon disabled during sync sending
+     * Default: false
+     * @since version after 3.1.0
+     */
+    disableBeaconSync?: boolean;
+    /**
+     * Identifies functions when xhr/xdr/fetch requests are successfully returned. If they are not defined, oncomplete with be called instead
+     * @since version after 3.1.0
+     */
+    senderOnCompleteCallBack?: _ISenderOnComplete;
+}
+
 export declare interface ISerializable {
     /**
      * The set of fields for a serializable object.
@@ -2264,6 +2393,12 @@ export declare interface IWeb {
     domain: string;
 }
 
+export declare interface IXDomainRequest extends XMLHttpRequestEventTarget {
+    readonly responseText: string;
+    send(payload: string): void;
+    open(method: string, url: string): void;
+}
+
 export declare class Metric implements IMetricData, ISerializable {
     static envelopeType: string;
     static dataType: string;
@@ -2433,8 +2568,16 @@ export declare class PageViewPerformance implements IPageViewPerfData, ISerializ
 
 export declare function parseConnectionString(connectionString?: string): ConnectionString;
 
+/**
+ * Parses the response from the backend.
+ * @param response - XMLHttpRequest or XDomainRequest response
+ */
+export declare function parseResponse(response: any, diagLog?: IDiagnosticLogger): IBackendResponse;
+
 export { parseTraceParent }
 
+export declare function prependTransports(theTransports: TransportType[], newTransports: TransportType | TransportType[]): TransportType[];
+
 export declare const ProcessLegacy = "ProcessLegacy";
 
 export declare const PropertiesPluginIdentifier = "AppInsightsPropertiesPlugin";
@@ -2538,6 +2681,35 @@ export declare const RequestHeaders: IRequestHeaders & {
 
 export declare const SampleRate = "sampleRate";
 
+/**
+ * This Internal component
+ * Manager SendPost functions
+ * SendPostManger
+ * @internal for internal use only
+ */
+export declare class SenderPostManager {
+    constructor();
+    initialize(config: _ISendPostMgrConfig, diagLog: IDiagnosticLogger): void;
+    /**
+     * Get size of current sync fetch payload
+     */
+    getSyncFetchPayload(): number;
+    /**
+     * reset Config
+     * @returns True if set is successfully
+     */
+    SetConfig(config: _ISendPostMgrConfig): boolean;
+    /**
+     * Get current xhr instance
+     */
+    getXhrInst(transports: TransportType[], sync?: boolean): IXHROverride;
+    /**
+     * Get current fallback sender instance
+     */
+    getFallbackInst(): IXHROverride;
+    _doTeardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void;
+}
+
 /**
  * Defines the level of severity for the event.
  */

package/types/applicationinsights-common.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.1.1-nightly3.2403-01
+ * Microsoft Application Insights Common JavaScript Library, 3.1.1-nightly3.2403-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -645,6 +645,10 @@ declare namespace ApplicationInsights {
      */
     function _formatErrorCode(errorObj: any): any;
 
+    function formatErrorMessageXdr(xdr: IXDomainRequest, message?: string): string;
+
+    function formatErrorMessageXhr(xhr: XMLHttpRequest, message?: string): string;
+
     /**
      * Format the ITraceParent value as a string using the supported and know version formats.
      * So even if the passed traceParent is a later version the string value returned from this
@@ -657,6 +661,8 @@ declare namespace ApplicationInsights {
 
     function getExtensionByName(extensions: IPlugin[], identifier: string): IPlugin | null;
 
+    function getResponseText(xhr: XMLHttpRequest | IXDomainRequest): string;
+
     const HttpMethod = "http.method";
 
     interface IAppInsights {
@@ -915,6 +921,25 @@ declare namespace ApplicationInsights {
         errorSrc?: string;
     }
 
+    interface IBackendResponse {
+        /**
+         * Number of items received by the backend
+         */
+        readonly itemsReceived: number;
+        /**
+         * Number of items succesfuly accepted by the backend
+         */
+        readonly itemsAccepted: number;
+        /**
+         * List of errors for items which were not accepted
+         */
+        readonly errors: IResponseError[];
+        /**
+         * App id returned by the backend - not necessary returned, but we don't need it with each response.
+         */
+        readonly appId?: string;
+    }
+
     interface IBaseProcessingContext {
         /**
          * The current core instance for the request
@@ -1338,6 +1363,11 @@ declare namespace ApplicationInsights {
         throttleMgrCfg?: {
             [key: number]: IThrottleMgrConfig;
         };
+        /**
+         * [Optional] Specifies a Highest Priority custom endpoint URL where telemetry data will be sent.
+         * This URL takes precedence over the 'config.endpointUrl' and any endpoint in the connection string.
+         */
+        userOverrideEndpointUrl?: string;
     }
 
     /**
@@ -3375,6 +3405,12 @@ declare namespace ApplicationInsights {
         requestContextHeaderLowerCase: string;
     }
 
+    interface IResponseError {
+        readonly index: number;
+        readonly statusCode: number;
+        readonly message: string;
+    }
+
     interface ISample {
         /**
          * Sample rate
@@ -3393,6 +3429,93 @@ declare namespace ApplicationInsights {
 
     function isCrossOriginError(message: string | Event, url: string, lineNumber: number, columnNumber: number, error: Error | Event): boolean;
 
+    /**
+     * internal interface
+     * Define functions when xhr/xdr/fetch requests are successfully returned. If they are not defined, oncomplete with be called instead
+     * @internal for internal use only
+     */
+    interface _ISenderOnComplete {
+        /**
+         * defined xdr onload function to handle response
+         * @param dxr xdr request object
+         * @param oncomplete oncomplete function
+         * @since version after 3.1.0
+         */
+        xdrOnComplete?(xdr: IXDomainRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
+        /**
+         * defined fetch on complete function to handle response
+         * @param response response object
+         * @param onComplete oncomplete function
+         * @param resValue response.text().value
+         * @since version after 3.1.0
+         */
+        fetchOnComplete?(response: Response, onComplete: OnCompleteCallback, resValue?: string, payload?: IPayloadData): void;
+        /**
+         * defined xhr onreadystatechange function to handle response
+         * @param request request object
+         * @param oncomplete oncomplete function
+         * @since version after 3.1.0
+         */
+        xhrOnComplete?(request: XMLHttpRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
+        /**
+         * Define functions during beacon can not send payload after first attempt. If not defined, will be apyload will be retried with fallback sender.
+         * @param data payload data
+         * @param onComplete oncomplete function
+         * @param canSend can the current data sent by beacon sender
+         * @since version after 3.1.0
+         */
+        beaconOnRetry?(data: IPayloadData, onComplete: OnCompleteCallback, canSend: (payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => boolean): void;
+    }
+
+    /**
+     * Internal interface for SendPostMnager
+     * @internal for internal use only
+     */
+    interface _ISendPostMgrConfig {
+        /**
+         * Enable the sender interface to return a promise
+         * Note: Enabling this may cause unhandled promise rejection errors to occur if you do not listen and handle any rejection response,
+         * Defaults to false
+         * @since version after 3.1.0
+         */
+        enableSendPromise?: boolean;
+        /**
+         * Identifies if the sender is 1ds post channel
+         * Default is false
+         * @since version after 3.1.0
+         */
+        isOneDs?: boolean;
+        /**
+         * Identify if Credentials should be disabled for 1ds post channel, application insights sender will igore this config
+         * Default is false
+         * @since version after 3.1.0
+         */
+        disableCredentials?: boolean;
+        /**
+         * Identifies if XMLHttpRequest or XDomainRequest (for IE < 9) should be used
+         * Default: false
+         * @since version after 3.1.0
+         */
+        disableXhr?: boolean;
+        /**
+         * Is beacon disabled during asunc sending
+         * Default: false
+         * @since version after 3.1.0
+         */
+        disableBeacon?: boolean;
+        /**
+         * Is beacon disabled during sync sending
+         * Default: false
+         * @since version after 3.1.0
+         */
+        disableBeaconSync?: boolean;
+        /**
+         * Identifies functions when xhr/xdr/fetch requests are successfully returned. If they are not defined, oncomplete with be called instead
+         * @since version after 3.1.0
+         */
+        senderOnCompleteCallBack?: _ISenderOnComplete;
+    }
+
     interface ISerializable {
         /**
          * The set of fields for a serializable object.
@@ -4125,6 +4248,19 @@ declare namespace ApplicationInsights {
         domain: string;
     }
 
+    interface IXDomainRequest extends XMLHttpRequestEventTarget {
+        readonly responseText: string;
+        send(payload: string): void;
+        open(method: string, url: string): void;
+    }
+
+    /**
+     * The IXHROverride interface overrides the way HTTP requests are sent.
+     */
+    interface IXHROverride {
+        sendPOST: SendPOSTFunction;
+    }
+
     const LoggingSeverity: EnumValue<typeof eLoggingSeverity>;
 
     type LoggingSeverity = number | eLoggingSeverity;
@@ -4172,6 +4308,10 @@ declare namespace ApplicationInsights {
      */
     type OfflineCallback = (onlineState: IOfflineState) => void;
 
+    type OnCompleteCallback = (status: number, headers: {
+        [headerName: string]: string;
+    }, response?: string) => void;
+
     class PageView implements IPageViewData, ISerializable {
         static envelopeType: string;
         static dataType: string;
@@ -4298,6 +4438,12 @@ declare namespace ApplicationInsights {
 
     function parseConnectionString(connectionString?: string): ConnectionString;
 
+    /**
+     * Parses the response from the backend.
+     * @param response - XMLHttpRequest or XDomainRequest response
+     */
+    function parseResponse(response: any, diagLog?: IDiagnosticLogger): IBackendResponse;
+
     /**
      * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
      *
@@ -4307,6 +4453,8 @@ declare namespace ApplicationInsights {
      */
     function parseTraceParent(value: string, selectIdx?: number): ITraceParent;
 
+    function prependTransports(theTransports: TransportType[], newTransports: TransportType | TransportType[]): TransportType[];
+
     const ProcessLegacy = "ProcessLegacy";
 
     const PropertiesPluginIdentifier = "AppInsightsPropertiesPlugin";
@@ -4424,6 +4572,43 @@ declare namespace ApplicationInsights {
 
     const SampleRate = "sampleRate";
 
+    /**
+     * This Internal component
+     * Manager SendPost functions
+     * SendPostManger
+     * @internal for internal use only
+     */
+    class SenderPostManager {
+        constructor();
+        initialize(config: _ISendPostMgrConfig, diagLog: IDiagnosticLogger): void;
+        /**
+         * Get size of current sync fetch payload
+         */
+        getSyncFetchPayload(): number;
+        /**
+         * reset Config
+         * @returns True if set is successfully
+         */
+        SetConfig(config: _ISendPostMgrConfig): boolean;
+        /**
+         * Get current xhr instance
+         */
+        getXhrInst(transports: TransportType[], sync?: boolean): IXHROverride;
+        /**
+         * Get current fallback sender instance
+         */
+        getFallbackInst(): IXHROverride;
+        _doTeardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void;
+    }
+
+    /**
+     * SendPOSTFunction type defines how an HTTP POST request is sent to an ingestion server
+     * @param payload - The payload object that should be sent, contains the url, bytes/string and headers for the request
+     * @param oncomplete - The function to call once the request has completed whether a success, failure or timeout
+     * @param sync - A boolean flag indicating whether the request should be sent as a synchronous request.
+     */
+    type SendPOSTFunction = (payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => void | IPromise<boolean>;
+
     /**
      * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
      */
@@ -4594,6 +4779,25 @@ declare namespace ApplicationInsights {
         });
     }
 
+    const enum TransportType {
+        /**
+         * Use the default available api
+         */
+        NotSet = 0,
+        /**
+         * Use XMLHttpRequest or XMLDomainRequest if available
+         */
+        Xhr = 1,
+        /**
+         * Use the Fetch api if available
+         */
+        Fetch = 2,
+        /**
+         * Use sendBeacon api if available
+         */
+        Beacon = 3
+    }
+
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
     function urlGetAbsoluteUrl(url: string): string;