@microsoft/applicationinsights-web-basic 3.1.3-nightly3.240329-01 → 3.1.3-nightly3.2404-16

package/dist-es5/__DynamicConstants.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript Web SDK - Basic, 3.1.3-nightly3.240329-01
+ * Application Insights JavaScript Web SDK - Basic, 3.1.3-nightly3.2404-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-es5/index.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript Web SDK - Basic, 3.1.3-nightly3.240329-01
+ * Application Insights JavaScript Web SDK - Basic, 3.1.3-nightly3.2404-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-web-basic",
-    "version": "3.1.3-nightly3.240329-01",
+    "version": "3.1.3-nightly3.2404-16",
     "description": "Microsoft Application Insights JavaScript SDK - Web Basic",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -57,11 +57,11 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^2.0.3",
         "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-common": "3.1.3-nightly3.240329-01",
-        "@microsoft/applicationinsights-channel-js": "3.1.3-nightly3.240329-01",
-        "@microsoft/applicationinsights-core-js": "3.1.3-nightly3.240329-01",
-        "@nevware21/ts-utils": ">= 0.11.0 < 2.x",
-        "@nevware21/ts-async": ">= 0.3.0 < 2.x"
+        "@microsoft/applicationinsights-common": "3.1.3-nightly3.2404-16",
+        "@microsoft/applicationinsights-channel-js": "3.1.3-nightly3.2404-16",
+        "@microsoft/applicationinsights-core-js": "3.1.3-nightly3.2404-16",
+        "@nevware21/ts-utils": ">= 0.11.1 < 2.x",
+        "@nevware21/ts-async": ">= 0.5.1 < 2.x"
     },
     "license": "MIT",
     "publishConfig": {

package/types/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.1.3-nightly3.240329-01
+ * Microsoft.ApplicationInsights, 3.1.3-nightly3.2404-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team

package/types/applicationinsights-web-basic.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.1.3-nightly3.240329-01
+ * Microsoft.ApplicationInsights, 3.1.3-nightly3.2404-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -241,8 +241,8 @@ declare namespace ApplicationInsights {
 
     class ArraySendBuffer extends BaseSendBuffer implements ISendBuffer {
         constructor(logger: IDiagnosticLogger, config: ISenderConfig);
-        markAsSent(payload: string[]): void;
-        clearSent(payload: string[]): void;
+        markAsSent(payload: IInternalStorageItem[]): void;
+        clearSent(payload: IInternalStorageItem[]): void;
     }
 
     /**
@@ -290,15 +290,15 @@ declare namespace ApplicationInsights {
     function arrForEach<T = any>(theArray: ArrayLike<T>, callbackfn: (value: T, index: number, array: T[]) => void | number, thisArg?: any): void;
 
     abstract class BaseSendBuffer {
-        protected _get: () => string[];
-        protected _set: (buffer: string[]) => string[];
+        protected _get: () => IInternalStorageItem[];
+        protected _set: (buffer: IInternalStorageItem[]) => IInternalStorageItem[];
         constructor(logger: IDiagnosticLogger, config: ISenderConfig);
-        enqueue(payload: string): void;
+        enqueue(payload: IInternalStorageItem): void;
         count(): number;
         size(): number;
         clear(): void;
-        getItems(): string[];
-        batchPayloads(payload: string[]): string;
+        getItems(): IInternalStorageItem[];
+        batchPayloads(payload: IInternalStorageItem[]): string;
         createNew(newLogger?: IDiagnosticLogger, newConfig?: ISenderConfig, canUseSessionStorage?: boolean): ArraySendBuffer | SessionStorageSendBuffer;
     }
 
@@ -1820,6 +1820,22 @@ declare namespace ApplicationInsights {
         shouldProcess?: (evt: ITelemetryItem) => boolean;
     }
 
+    /**
+     * Internal interface for sendBuffer, do not export it
+     * @internal
+     * @since 3.1.3
+     */
+    interface IInternalStorageItem {
+        /**
+         * serialized telemetry to be stored.
+         */
+        item: string;
+        /**
+         * total retry count
+         */
+        cnt?: number;
+    }
+
     /**
      * An alternate interface which provides automatic removal during unloading of the component
      */
@@ -2527,33 +2543,6 @@ declare namespace ApplicationInsights {
          * ```
          */
         finally(onfinally?: FinallyPromiseHandler): IPromise<T>;
-        /**
-         * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
-         * resolved value cannot be modified from the callback.
-         * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
-         * @returns A Promise for the completion of the callback.
-         * @example
-         * ```ts
-         * function doFunction() {
-         *   return createPromise((resolve, reject) => {
-         *     if (Math.random() > 0.5) {
-         *       resolve('Function has completed');
-         *     } else {
-         *       reject(new Error('Function failed to process'));
-         *     }
-         *   });
-         * }
-         *
-         * doFunction().then((data) => {
-         *     console.log(data);
-         * }).catch((err) => {
-         *     console.error(err);
-         * }).finally(() => {
-         *     console.log('Function processing completed');
-         * });
-         * ```
-         */
-        finally(onFinally?: FinallyPromiseHandler): Promise<T>;
     }
 
     interface IRequestContext {
@@ -2577,11 +2566,15 @@ declare namespace ApplicationInsights {
         isSampledIn(envelope: ITelemetryItem): boolean;
     }
 
+    /**
+     * Before 3.1.2, payload only allow string
+     * After 3.2.0,  IInternalStorageItem is accepted
+     */
     interface ISendBuffer {
         /**
          * Enqueue the payload
          */
-        enqueue: (payload: string) => void;
+        enqueue: (payload: IInternalStorageItem) => void;
         /**
          * Returns the number of elements in the buffer
          */
@@ -2597,20 +2590,20 @@ declare namespace ApplicationInsights {
         /**
          * Returns items stored in the buffer
          */
-        getItems: () => string[];
+        getItems: () => IInternalStorageItem[];
         /**
          * Build a batch of all elements in the payload array
          */
-        batchPayloads: (payload: string[]) => string;
+        batchPayloads: (payload: IInternalStorageItem[]) => string;
         /**
          * Moves items to the SENT_BUFFER.
          * The buffer holds items which were sent, but we haven't received any response from the backend yet.
          */
-        markAsSent: (payload: string[]) => void;
+        markAsSent: (payload: IInternalStorageItem[]) => void;
         /**
          * Removes items from the SENT_BUFFER. Should be called on successful response from the backend.
          */
-        clearSent: (payload: string[]) => void;
+        clearSent: (payload: IInternalStorageItem[]) => void;
         /**
          * Copy current buffer items to a new buffer.
          * if canUseSessionStorage is undefined, it will set to false.
@@ -2739,6 +2732,14 @@ declare namespace ApplicationInsights {
          * @since 3.1.1
          */
         retryCodes?: number[];
+        /**
+         * (Optional) The specific max retry count for each telemetry item.
+         * Default: 10
+         * if it is set to 0, means no retry allowed
+         * if it is set to undefined, means no limit for retry times
+         * @since 3.2.0
+         */
+        maxRetryCnt?: number;
     }
 
     interface ISerializable {
@@ -3302,8 +3303,9 @@ declare namespace ApplicationInsights {
         /**
          * xhr state changes
          * @deprecated
+         * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility)
          */
-        _xhrReadyStateChange(xhr: XMLHttpRequest, payload: string[], countOfItemsInPayload: number): void;
+        _xhrReadyStateChange(xhr: XMLHttpRequest, payload: string[] | IInternalStorageItem[], countOfItemsInPayload: number): void;
         /**
          * Trigger the immediate send of buffered data; If executing asynchronously (the default) this may (not required) return
          * an [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html) that will resolve once the
@@ -3318,21 +3320,28 @@ declare namespace ApplicationInsights {
         triggerSend(async?: boolean, forcedSender?: SenderFunction, sendReason?: SendRequestReason): void | IPromise<boolean>;
         /**
          * error handler
+         * @Internal
+         * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility)
          */
-        _onError(payload: string[], message: string, event?: ErrorEvent): void;
+        _onError(payload: string[] | IInternalStorageItem[], message: string, event?: ErrorEvent): void;
         /**
          * partial success handler
+         * @Internal
+         * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility)
          */
-        _onPartialSuccess(payload: string[], results: IBackendResponse): void;
+        _onPartialSuccess(payload: string[] | IInternalStorageItem[], results: IBackendResponse): void;
         /**
          * success handler
+         * @Internal
+         * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility)
          */
-        _onSuccess(payload: string[], countOfItemsInPayload: number): void;
+        _onSuccess(payload: string[] | IInternalStorageItem[], countOfItemsInPayload: number): void;
         /**
          * xdr state changes
          * @deprecated
+         * since version 3.2.0, if the payload is string[], this function is no-op (string[] is only used for backwards Compatibility)
          */
-        _xdrOnLoad(xdr: IXDomainRequest, payload: string[]): void;
+        _xdrOnLoad(xdr: IXDomainRequest, payload: string[] | IInternalStorageItem[]): void;
         /**
          * Add header to request
          * @param name - Header name.
@@ -3351,7 +3360,7 @@ declare namespace ApplicationInsights {
         getOfflineSupport(): IInternalOfflineSupport;
     }
 
-    type SenderFunction = (payload: string[], isAsync: boolean) => void | IPromise<boolean>;
+    type SenderFunction = (payload: string[] | IInternalStorageItem[], isAsync: boolean) => void | IPromise<boolean>;
 
     /**
      * SendPOSTFunction type defines how an HTTP POST request is sent to an ingestion server
@@ -3408,14 +3417,15 @@ declare namespace ApplicationInsights {
     }
 
     class SessionStorageSendBuffer extends BaseSendBuffer implements ISendBuffer {
+        static VERSION: string;
         static BUFFER_KEY: string;
         static SENT_BUFFER_KEY: string;
         static MAX_BUFFER_SIZE: number;
         constructor(logger: IDiagnosticLogger, config: ISenderConfig);
-        enqueue(payload: string): void;
+        enqueue(payload: IInternalStorageItem): void;
         clear(): void;
-        markAsSent(payload: string[]): void;
-        clearSent(payload: string[]): void;
+        markAsSent(payload: IInternalStorageItem[]): void;
+        clearSent(payload: IInternalStorageItem[]): void;
         createNew(newLogger?: IDiagnosticLogger, newConfig?: ISenderConfig, canUseSessionStorage?: boolean): ArraySendBuffer | SessionStorageSendBuffer;
     }