@microsoft/1ds-core-js 4.1.1-nightly3.2403-02 → 4.1.1-nightly3.2403-04

package/types/1ds-core-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Core, 4.1.1-nightly3.2403-02
+ * 1DS JS SDK Core, 4.1.1-nightly3.2403-04
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -76,6 +76,12 @@ declare namespace oneDS {
      */
     function addPageUnloadEventListener(listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 
+    /**
+     * append the XHR headers.
+     * @internal
+     */
+    function _appendHeader(theHeaders: any, xhr: XMLHttpRequest, name: string): any;
+
     /**
      * @group Classes
      * @group Entrypoint
@@ -492,6 +498,14 @@ declare namespace oneDS {
      */
     function blockDynamicConversion<T>(value: T): T;
 
+    /**
+     * Converts the XHR getAllResponseHeaders to a map containing the header key and value.
+     * @internal
+     */
+    function convertAllHeadersToMap(headersString: string): {
+        [headerName: string]: string;
+    };
+
     function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
     /**
@@ -1183,6 +1197,10 @@ declare namespace oneDS {
      */
     function forceDynamicConversion<T>(value: T): T;
 
+    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
@@ -1200,6 +1218,12 @@ declare namespace oneDS {
      */
     function generateW3CId(): string;
 
+    /**
+     * get the XHR getAllResponseHeaders.
+     * @internal
+     */
+    function _getAllResponseHeaders(xhr: XMLHttpRequest, isOneDs?: boolean): {};
+
     function getCommonSchemaMetaData(value: string | boolean | number | string[] | number[] | boolean[] | undefined, kind: number | undefined, type?: number | undefined): number;
 
     /**
@@ -1343,6 +1367,8 @@ declare namespace oneDS {
      */
     function getPerformance(): Performance;
 
+    function getResponseText(xhr: XMLHttpRequest | IXDomainRequest): string;
+
     /**
      * Returns the current value from the target object if not null or undefined otherwise sets the new value and returns it
      * @param target - The target object to return or set the default value
@@ -1589,6 +1615,25 @@ declare namespace oneDS {
         getWParam: () => number;
     }
 
+    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
@@ -2496,6 +2541,17 @@ declare namespace oneDS {
         shouldProcess?: (evt: ITelemetryItem) => boolean;
     }
 
+    /**
+     * Internal interface
+     * internal sendpost interface
+     * @internal
+     * @since version after 3.1.0
+     */
+    interface _IInternalXhrOverride extends IXHROverride {
+        _transport?: TransportType;
+        _isSync?: boolean;
+    }
+
     /**
      * An alternate interface which provides automatic removal during unloading of the component
      */
@@ -3266,6 +3322,12 @@ declare namespace oneDS {
         handler: any;
     }
 
+    interface IResponseError {
+        readonly index: number;
+        readonly statusCode: number;
+        readonly message: string;
+    }
+
     /**
      * Checks if the type of value is an Array.
      *
@@ -3334,6 +3396,114 @@ declare namespace oneDS {
      */
     const isDocumentObjectAvailable: 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 async 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;
+        /**
+         * Is FetchKeepAlive disabled during sync sending
+         * Default: false
+         * @since version after 3.1.0
+         */
+        disableFetchKeepAlive?: 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;
+        /**
+         * time wrapper to handle payload timeout
+         * this is for 1ds post channel only
+         * Default: null
+         * @since version after 3.1.0
+         */
+        timeWrapper?: _ITimeoutOverrideWrapper;
+        /**
+         * [Optional] flag to indicate whether the sendBeacon and fetch (with keep-alive flag) should add the "NoResponseBody" query string
+         * value to indicate that the server should return a 204 for successful requests. Defaults to true
+         * this is for 1ds post channel only
+         * Default: true
+         * @since version after 3.1.0
+         */
+        addNoResponse?: boolean;
+    }
+
     /**
      * Checks if the type of value is a Error object.
      * @group Type Identity
@@ -3752,6 +3922,16 @@ declare namespace oneDS {
         removed?: IPlugin[];
     }
 
+    /**
+     * Internal interface
+     * Simple internal timeout wrapper
+     * @internal
+     * @since version after 3.1.0
+     */
+    interface _ITimeoutOverrideWrapper {
+        set: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => ITimerHandler;
+    }
+
     /**
      * A Timer handler which is returned from {@link scheduleTimeout} which contains functions to
      * cancel or restart (refresh) the timeout function.
@@ -4024,6 +4204,17 @@ declare namespace oneDS {
         rm: () => void;
     }
 
+    interface IXDomainRequest extends XMLHttpRequestEventTarget {
+        readonly responseText: string;
+        send(payload: string): void;
+        open(method: string, url: string): void;
+        timeout: number;
+        contentType: string;
+        addEventListener(type: "error", listener: (ev: ErrorEvent) => any, useCapture?: boolean): void;
+        addEventListener(type: "load" | "timeout", listener: (ev: Event) => any, useCapture?: boolean): void;
+        addEventListener(type: "progress", listener: (ev: ProgressEvent) => any, useCapture?: boolean): void;
+    }
+
     /**
      * The IXHROverride interface overrides the way HTTP requests are sent.
      */
@@ -4281,6 +4472,12 @@ declare namespace oneDS {
      */
     function optimizeObject<T>(theObject: T): T;
 
+    /**
+     * 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)
      *
@@ -4380,6 +4577,8 @@ declare namespace oneDS {
      */
     function perfNow(): number;
 
+    function prependTransports(theTransports: TransportType[], newTransports: TransportType | TransportType[]): TransportType[];
+
     /**
      * This class will be removed!
      * @deprecated use createProcessTelemetryContext() instead
@@ -4580,6 +4779,35 @@ declare namespace oneDS {
      */
     function sanitizeProperty(name: string, property: string | number | boolean | string[] | number[] | boolean[] | object | IEventProperty, stringifyObjects?: boolean): IEventProperty | null;
 
+    /**
+     * 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
+         */
+        getSenderInst(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
@@ -4782,11 +5010,6 @@ declare namespace oneDS {
 
     type TraceLevel = number | eTraceLevel;
 
-    /**
-     * An enumeration that identifies the transport type that are requested to be used, if the requested
-     * transport is not available ir supported the SDK may choose the first available transport or it
-     * will log a warning to the diagnostic logger.
-     */
     const enum TransportType {
         /**
          * Use the default available api
@@ -4874,7 +5097,7 @@ declare namespace oneDS {
         constructor(fieldSanitizerProvider?: IFieldValueSanitizerProvider);
     }
 
-    const Version = "4.1.1-nightly3.2403-02";
+    const Version = "4.1.1-nightly3.2403-04";
 
     /**
      * This is a helper method which will call warnToConsole on the passed logger with the provided message.